MolstarPlugin | @rcsb/rcsb-saguaro-3d

Hierarchy

AbstractPlugin
- MolstarPlugin

Implements

SaguaroPluginInterface

Index

Constructors

constructor

Properties

Constructors

constructor

new MolstarPlugin(props: RcsbFvSelectorManager): MolstarPlugin

Overrides AbstractPlugin.constructor
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:74
Parameters
- props: RcsbFvSelectorManager
Returns MolstarPlugin

Properties

Private Readonly componentMap

componentMap: Map<string, StructureComponentRef> = new Map<string, StructureComponentRef>()

Private innerSelectionFlag

innerSelectionFlag: boolean = false

Private loadingFlag

loadingFlag: boolean = false

Private modelChangeCallback

modelChangeCallback: (chainMap: SaguaroPluginModelMapType) => void

Type declaration

- (chainMap: SaguaroPluginModelMapType): void
- Parameters
  - chainMap: SaguaroPluginModelMapType
  Returns void

Private modelChangeCallbackSubs

modelChangeCallbackSubs: Subscription

Private modelMap

modelMap: Map<string, string | undefined> = new Map<string, string>()

Private selectCallbackSubs

selectCallbackSubs: Subscription

Protected Readonly selection

selection: RcsbFvSelectorManager

Private viewer

viewer: Viewer

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

Implementation of SaguaroPluginInterface.cameraFocus
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:212
Parameters
- modelId: string
- labelAsymId: string
- positions: Array<number>
- Optional operatorName: undefined | string
Returns void
Implementation of SaguaroPluginInterface.cameraFocus
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:213
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: undefined | string
Returns void

Private changeComponentDisplay

changeComponentDisplay(componentLabel: string, visibilityFlag: boolean): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:323
Parameters
- componentLabel: string
- visibilityFlag: boolean
Returns void

clear

clear(): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:84
Returns void

clearFocus

clearFocus(): void

Implementation of SaguaroPluginInterface.clearFocus
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:208
Returns void

clearSelection

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

Implementation of SaguaroPluginInterface.clearSelection
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:193
Parameters
- mode: "select" | "hover"
- Optional option: SaguaroChain
Returns void

colorComponent

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

Implementation of SaguaroPluginInterface.colorComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:278
Parameters
- componentLabel: string
- color: ColorTheme.BuiltIn
Returns Promise<void>

createComponent

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

Implementation of SaguaroPluginInterface.createComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:245
Parameters
- componentLabel: string
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- representationType: StructureRepresentationRegistry.BuiltIn
- Optional operatorName: undefined | string
Returns Promise<void>
Implementation of SaguaroPluginInterface.createComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:246
Parameters
- componentLabel: string
- modelId: string
- labelAsymId: string
- representationType: StructureRepresentationRegistry.BuiltIn
- Optional operatorName: undefined | string
Returns Promise<void>
Implementation of SaguaroPluginInterface.createComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:247
Parameters
- componentLabel: string
- residues: Array<SaguaroPosition>
- representationType: StructureRepresentationRegistry.BuiltIn
Returns Promise<void>
Implementation of SaguaroPluginInterface.createComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:248
Parameters
- componentLabel: string
- residues: Array<SaguaroRange>
- representationType: StructureRepresentationRegistry.BuiltIn
Returns Promise<void>

displayComponent

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

Implementation of SaguaroPluginInterface.displayComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:315
Parameters
- componentLabel: string
Returns boolean
Implementation of SaguaroPluginInterface.displayComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:316
Parameters
- componentLabel: string
- visibilityFlag: boolean
Returns void

Private focusPositions

focusPositions(modelId: string, labelAsymId: string, positions: Array<number>, operatorName?: undefined | string): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:221
Parameters
- modelId: string
- labelAsymId: string
- positions: Array<number>
- Optional operatorName: undefined | string
Returns void

Private focusRange

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

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:237
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: undefined | string
Returns void

Private getChains

getChains(): SaguaroPluginModelMapType

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:478
Returns SaguaroPluginModelMapType

Private getComponentDisplay

getComponentDisplay(componentLabel: string): boolean | undefined

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:339
Parameters
- componentLabel: string
Returns boolean | undefined

getComponentSet

getComponentSet(): Set<string>

Implementation of SaguaroPluginInterface.getComponentSet
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:289
Returns Set<string>

Private getModelId

getModelId(id: string): string

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:506
Parameters
- id: string
Returns string

init

init(target: string | HTMLElement, props?: Partial<ViewerProps>): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:80
Parameters
- target: string | HTMLElement
- Optional props: Partial<ViewerProps>
Returns void

isComponent

isComponent(componentLabel: string): boolean

Implementation of SaguaroPluginInterface.isComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:267
Parameters
- componentLabel: string
Returns boolean

load

load(loadConfig: LoadMolstarInterface | Array<LoadMolstarInterface>): Promise<void>

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:88
Parameters
- loadConfig: LoadMolstarInterface | Array<LoadMolstarInterface>
Returns Promise<void>

Private mapModels

mapModels(loadParams: LoadParams | Array<LoadParams>): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:490
Parameters
- loadParams: LoadParams | Array<LoadParams>
Returns void

pluginCall

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

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:461
Parameters
- f: (plugin: PluginContext) => void
  - - (plugin: PluginContext): void
    - Parameters
      - plugin: PluginContext
      Returns void
Returns void

removeComponent

removeComponent(componentLabel?: undefined | string): void

Implementation of SaguaroPluginInterface.removeComponent
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:303
Parameters
- Optional componentLabel: undefined | string
Returns void

resetCamera

resetCamera(): void

Implementation of SaguaroPluginInterface.resetCamera
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:515
Returns void

select

select(modelId: string, labelAsymId: string, begin: number, end: number, mode: "select" | "hover", operation: "add" | "set", 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

Implementation of SaguaroPluginInterface.select
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:159
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- mode: "select" | "hover"
- operation: "add" | "set"
- Optional operatorName: undefined | string
Returns void
Implementation of SaguaroPluginInterface.select
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:160
Parameters
- selection: Array<SaguaroPosition>
- mode: "select" | "hover"
- operation: "add" | "set"
Returns void
Implementation of SaguaroPluginInterface.select
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:161
Parameters
- selection: Array<SaguaroRange>
- mode: "select" | "hover"
- operation: "add" | "set"
Returns void

Private selectMultipleRanges

selectMultipleRanges(selection: Array<SaguaroRange>, mode: "select" | "hover", operation: "add" | "set"): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:185
Parameters
- selection: Array<SaguaroRange>
- mode: "select" | "hover"
- operation: "add" | "set"
Returns void

Private selectRange

selectRange(modelId: string, labelAsymId: string, begin: number, end: number, mode: "select" | "hover", operation: "add" | "set", operatorName?: undefined | string): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:171
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- mode: "select" | "hover"
- operation: "add" | "set"
- Optional operatorName: undefined | string
Returns void

Private selectSet

selectSet(selection: Array<SaguaroPosition>, mode: "select" | "hover", operation: "add" | "set"): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:178
Parameters
- selection: Array<SaguaroPosition>
- mode: "select" | "hover"
- operation: "add" | "set"
Returns void

setBackground

setBackground(color: number): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:156
Parameters
- color: number
Returns void

setFocus

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

Implementation of SaguaroPluginInterface.setFocus
- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:205
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: undefined | string
Returns void

setHoverCallback

setHoverCallback(g: () => void): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:348
Parameters
- g: () => void
  - - (): void
    - Returns void
Returns void

setModelChangeCallback

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

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:465
Parameters
- f: (modelMap: SaguaroPluginModelMapType) => void
  - - (modelMap: SaguaroPluginModelMapType): void
    - Parameters
      - modelMap: SaguaroPluginModelMapType
      Returns void
Returns void

setRepresentationChangeCallback

setRepresentationChangeCallback(g: () => void): void

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:345
Parameters
- g: () => void
  - - (): void
    - Returns void
Returns void

setSelectCallback

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

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:375
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

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:510
Returns void

Static Private checkLoadData

checkLoadData(loadConfig: LoadMolstarInterface): boolean

- Defined in src/RcsbFvStructure/StructurePlugins/MolstarPlugin.ts:130
Parameters
- loadConfig: LoadMolstarInterface
Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: RcsbFvSelectorManager

Returns MolstarPlugin

Properties

Private Readonly componentMap

Private innerSelectionFlag

Private loadingFlag

Private modelChangeCallback

Type declaration

Parameters

chainMap: SaguaroPluginModelMapType

Returns void

Private modelChangeCallbackSubs

Private modelMap

Private selectCallbackSubs

Protected Readonly selection

Private viewer

Methods

cameraFocus

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

Private changeComponentDisplay

Parameters

componentLabel: string

visibilityFlag: boolean

Returns void

clear

Returns void

clearFocus

Returns void

clearSelection

Parameters

mode: "select" | "hover"

Optional option: SaguaroChain

Returns void

colorComponent

Parameters

componentLabel: string

color: ColorTheme.BuiltIn

Returns Promise<void>

createComponent

Parameters

componentLabel: string

modelId: string

labelAsymId: string

begin: number

end: number

representationType: StructureRepresentationRegistry.BuiltIn

Optional operatorName: undefined | string

Returns Promise<void>

Parameters

componentLabel: string

modelId: string

labelAsymId: string

representationType: StructureRepresentationRegistry.BuiltIn

Optional operatorName: undefined | string

Returns Promise<void>

Parameters

componentLabel: string

residues: Array<SaguaroPosition>

representationType: StructureRepresentationRegistry.BuiltIn