Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SaguaroPluginInterface

Hierarchy

Implemented by

Index

Properties

Methods

Properties

clear

clear: () => void

Type declaration

    • (): void

    • Returns void

init

init: (elementId: string, props?: any) => void

Type declaration

    • (elementId: string, props?: any): void

    • Parameters

      • elementId: string
      • Optional props: any

      Returns void

load

load: (args: LoadMolstarInterface | Array<LoadMolstarInterface>) => void

Type declaration

pluginCall

pluginCall: (f: (plugin: PluginContext) => void) => void

Type declaration

    • (f: (plugin: PluginContext) => void): void

    • Parameters

      • f: (plugin: PluginContext) => void
          • (plugin: PluginContext): void

          • Parameters

            • plugin: PluginContext

            Returns void

      Returns void

setHoverCallback

setHoverCallback: (g: (flag?: undefined | false | true) => void) => void

Type declaration

    • (g: (flag?: undefined | false | true) => void): void

    • Parameters

      • g: (flag?: undefined | false | true) => void
          • (flag?: undefined | false | true): void

          • Parameters

            • Optional flag: undefined | false | true

            Returns void

      Returns void

setModelChangeCallback

setModelChangeCallback: (f: (modelMap: SaguaroPluginModelMapType) => void) => void

Type declaration

setRepresentationChangeCallback

setRepresentationChangeCallback: (g: (flag?: undefined | false | true) => void) => void

Type declaration

    • (g: (flag?: undefined | false | true) => void): void

    • Parameters

      • g: (flag?: undefined | false | true) => void
          • (flag?: undefined | false | true): void

          • Parameters

            • Optional flag: undefined | false | true

            Returns void

      Returns void

setSelectCallback

setSelectCallback: (g: (flag?: undefined | false | true) => void) => void

Type declaration

    • (g: (flag?: undefined | false | true) => void): void

    • Parameters

      • g: (flag?: undefined | false | true) => void
          • (flag?: undefined | false | true): void

          • Parameters

            • Optional flag: undefined | false | true

            Returns void

      Returns void

unsetCallbacks

unsetCallbacks: () => void

Type declaration

    • (): void

    • Returns void

Methods

cameraFocus

  • cameraFocus(modelId: string, labelAsymId: string, positions: Array<number>, operatorName?: undefined | string): void
  • cameraFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: undefined | string): void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • positions: Array<number>
    • Optional operatorName: undefined | string

    Returns void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • begin: number
    • end: number
    • Optional operatorName: undefined | string

    Returns void

clearFocus

  • clearFocus(): void

clearSelection

  • clearSelection(mode: "select" | "hover", option?: SaguaroChain): void

colorComponent

  • colorComponent(componentId: string, color: ColorTheme.BuiltIn): Promise<void>

  • Parameters

    • componentId: string
    • color: ColorTheme.BuiltIn

    Returns Promise<void>

createComponent

  • createComponent(componentId: string, modelId: string, labelAsymId: string, begin: number, end: number, representationType: StructureRepresentationRegistry.BuiltIn, operatorName?: undefined | string): Promise<void>
  • createComponent(componentId: string, modelId: string, labelAsymId: string, representationType: StructureRepresentationRegistry.BuiltIn, operatorName?: undefined | string): Promise<void>
  • createComponent(componentId: string, residues: Array<SaguaroPosition>, representationType: StructureRepresentationRegistry.BuiltIn): Promise<void>
  • createComponent(componentId: string, residues: Array<SaguaroRange>, representationType: StructureRepresentationRegistry.BuiltIn): Promise<void>

  • Parameters

    • componentId: string
    • modelId: string
    • labelAsymId: string
    • begin: number
    • end: number
    • representationType: StructureRepresentationRegistry.BuiltIn
    • Optional operatorName: undefined | string

    Returns Promise<void>

  • Parameters

    • componentId: string
    • modelId: string
    • labelAsymId: string
    • representationType: StructureRepresentationRegistry.BuiltIn
    • Optional operatorName: undefined | string

    Returns Promise<void>

  • Parameters

    • componentId: string
    • residues: Array<SaguaroPosition>
    • representationType: StructureRepresentationRegistry.BuiltIn

    Returns Promise<void>

  • Parameters

    • componentId: string
    • residues: Array<SaguaroRange>
    • representationType: StructureRepresentationRegistry.BuiltIn

    Returns Promise<void>

displayComponent

  • displayComponent(componentLabel: string, visibilityFlag: boolean): void
  • displayComponent(componentLabel: string): boolean

getComponentSet

  • getComponentSet(): Set<string>

isComponent

  • isComponent(componentId: string): boolean

removeComponent

  • removeComponent(componentId?: undefined | string): void

resetCamera

  • resetCamera(): void

select

  • select(modelId: string, labelAsymId: string, x: number, y: number, mode: "select" | "hover", operation: "set" | "add", operatorName?: undefined | string): void
  • select(selection: Array<SaguaroPosition>, mode: "select" | "hover", operation: "add" | "set"): void
  • select(selection: Array<SaguaroRange>, mode: "select" | "hover", operation: "add" | "set"): void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • x: number
    • y: number
    • mode: "select" | "hover"
    • operation: "set" | "add"
    • Optional operatorName: undefined | string

    Returns void

  • Parameters

    • selection: Array<SaguaroPosition>
    • mode: "select" | "hover"
    • operation: "add" | "set"

    Returns void

  • Parameters

    • selection: Array<SaguaroRange>
    • mode: "select" | "hover"
    • operation: "add" | "set"

    Returns void

setFocus

  • setFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: undefined | string): void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • begin: number
    • end: number
    • Optional operatorName: undefined | string

    Returns void

Generated using TypeDoc