SaguaroPluginInterface | @rcsb/rcsb-saguaro-3d

Hierarchy

SaguaroPluginPublicInterface
- SaguaroPluginInterface

Methods

cameraFocus

cameraFocus(modelId: string, labelAsymId: string, positions: number[], operatorName?: string): void
cameraFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: string): void

Inherited from SaguaroPluginPublicInterface.cameraFocus
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:64
Parameters
- modelId: string
- labelAsymId: string
- positions: number[]
- Optional operatorName: string
Returns void
Inherited from SaguaroPluginPublicInterface.cameraFocus
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:65
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: string
Returns void

clear

clear(): void

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:39
Returns void

clearFocus

clearFocus(): void

Inherited from SaguaroPluginPublicInterface.clearFocus
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:63
Returns void

clearSelection

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

Inherited from SaguaroPluginPublicInterface.clearSelection
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:51
Parameters
- mode: "select" | "hover"
- Optional option: SaguaroChain
Returns void

colorComponent

colorComponent(componentId: string, color: "atom-id" | "carbohydrate-symbol" | "chain-id" | "element-index" | "element-symbol" | "entity-id" | "entity-source" | "hydrophobicity" | "illustrative" | "model-index" | "molecule-type" | "occupancy" | "operator-hkl" | "operator-name" | "partial-charge" | "polymer-id" | "polymer-index" | "residue-name" | "secondary-structure" | "sequence-id" | "shape-group" | "uncertainty" | "unit-index" | "uniform" | "volume-value"): Promise<void>

Inherited from SaguaroPluginPublicInterface.colorComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:56
Parameters
- componentId: string
- color: "atom-id" | "carbohydrate-symbol" | "chain-id" | "element-index" | "element-symbol" | "entity-id" | "entity-source" | "hydrophobicity" | "illustrative" | "model-index" | "molecule-type" | "occupancy" | "operator-hkl" | "operator-name" | "partial-charge" | "polymer-id" | "polymer-index" | "residue-name" | "secondary-structure" | "sequence-id" | "shape-group" | "uncertainty" | "unit-index" | "uniform" | "volume-value"
Returns Promise<void>

createComponent

createComponent(componentId: string, modelId: string, labelAsymId: string, begin: number, end: number, representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty", operatorName?: string): Promise<void>
createComponent(componentId: string, modelId: string, labelAsymId: string, representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty", operatorName?: string): Promise<void>
createComponent(componentId: string, residues: SaguaroPosition[], representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"): Promise<void>
createComponent(componentId: string, residues: SaguaroRange[], representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"): Promise<void>

Inherited from SaguaroPluginPublicInterface.createComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:52
Parameters
- componentId: string
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"
- Optional operatorName: string
Returns Promise<void>
Inherited from SaguaroPluginPublicInterface.createComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:53
Parameters
- componentId: string
- modelId: string
- labelAsymId: string
- representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"
- Optional operatorName: string
Returns Promise<void>
Inherited from SaguaroPluginPublicInterface.createComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:54
Parameters
- componentId: string
- residues: SaguaroPosition[]
- representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"
Returns Promise<void>
Inherited from SaguaroPluginPublicInterface.createComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:55
Parameters
- componentId: string
- residues: SaguaroRange[]
- representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"
Returns Promise<void>

displayComponent

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

Inherited from SaguaroPluginPublicInterface.displayComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:59
Parameters
- componentLabel: string
- visibilityFlag: boolean
Returns void
Inherited from SaguaroPluginPublicInterface.displayComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:60
Parameters
- componentLabel: string
Returns boolean

getComponentSet

getComponentSet(): Set<string>

Inherited from SaguaroPluginPublicInterface.getComponentSet
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:61
Returns Set<string>

init

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

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:36
Parameters
- elementId: string
- Optional props: any
Returns void

isComponent

isComponent(componentId: string): boolean

Inherited from SaguaroPluginPublicInterface.isComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:58
Parameters
- componentId: string
Returns boolean

load

load(args: LoadMolstarInterface | LoadMolstarInterface[]): void

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:37
Parameters
- args: LoadMolstarInterface | LoadMolstarInterface[]
Returns void

pluginCall

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

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:38
Parameters
- f: (plugin: PluginContext) => void
  - - (plugin: PluginContext): void
    - Parameters
      - plugin: PluginContext
      Returns void
Returns void

removeComponent

removeComponent(componentId?: string): void

Inherited from SaguaroPluginPublicInterface.removeComponent
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:57
Parameters
- Optional componentId: string
Returns void

resetCamera

resetCamera(): void

Inherited from SaguaroPluginPublicInterface.resetCamera
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:66
Returns void

select

select(modelId: string, labelAsymId: string, x: number, y: number, mode: "select" | "hover", operation: "add" | "set", operatorName?: string): void
select(selection: SaguaroPosition[], mode: "select" | "hover", operation: "add" | "set"): void
select(selection: SaguaroRange[], mode: "select" | "hover", operation: "add" | "set"): void

Inherited from SaguaroPluginPublicInterface.select
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:48
Parameters
- modelId: string
- labelAsymId: string
- x: number
- y: number
- mode: "select" | "hover"
- operation: "add" | "set"
- Optional operatorName: string
Returns void
Inherited from SaguaroPluginPublicInterface.select
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:49
Parameters
- selection: SaguaroPosition[]
- mode: "select" | "hover"
- operation: "add" | "set"
Returns void
Inherited from SaguaroPluginPublicInterface.select
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:50
Parameters
- selection: SaguaroRange[]
- mode: "select" | "hover"
- operation: "add" | "set"
Returns void

setFocus

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

Inherited from SaguaroPluginPublicInterface.setFocus
- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:62
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: string
Returns void

setHoverCallback

setHoverCallback(g: (flag?: boolean) => void): void

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:42
Parameters
- g: (flag?: boolean) => void
  - - (flag?: boolean): void
    - Parameters
      - Optional flag: boolean
      Returns void
Returns void

setModelChangeCallback

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

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:41
Parameters
- f: (modelMap: SaguaroPluginModelMapType) => void
  - - (modelMap: SaguaroPluginModelMapType): void
    - Parameters
      - modelMap: SaguaroPluginModelMapType
      Returns void
Returns void

setRepresentationChangeCallback

setRepresentationChangeCallback(g: (flag?: boolean) => void): void

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:43
Parameters
- g: (flag?: boolean) => void
  - - (flag?: boolean): void
    - Parameters
      - Optional flag: boolean
      Returns void
Returns void

setSelectCallback

setSelectCallback(g: (flag?: boolean) => void): void

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:40
Parameters
- g: (flag?: boolean) => void
  - - (flag?: boolean): void
    - Parameters
      - Optional flag: boolean
      Returns void
Returns void

unsetCallbacks

unsetCallbacks(): void

- Defined in src/RcsbFvStructure/SaguaroPluginInterface.ts:44
Returns void

Hierarchy

Index

Methods

Methods

cameraFocus

Parameters

modelId: string

labelAsymId: string

positions: number[]

Optional operatorName: string

Returns void

Parameters

modelId: string

labelAsymId: string

begin: number

end: number

Optional operatorName: string

Returns void

clear

Returns void

clearFocus

Returns void

clearSelection

Parameters

mode: "select" | "hover"

Optional option: SaguaroChain

Returns void

colorComponent

Parameters

componentId: string

Returns Promise<void>

createComponent

Parameters

componentId: string

modelId: string

labelAsymId: string

begin: number

end: number

representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"

Optional operatorName: string

Returns Promise<void>

Parameters

componentId: string

modelId: string

labelAsymId: string

representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"

Optional operatorName: string

Returns Promise<void>

Parameters

componentId: string

residues: SaguaroPosition[]

representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"

Returns Promise<void>

Parameters

componentId: string

residues: SaguaroRange[]

representationType: "label" | "cartoon" | "spacefill" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "line" | "molecular-surface" | "orientation" | "point" | "putty"

Returns Promise<void>

displayComponent

Parameters

componentLabel: string

visibilityFlag: boolean

Returns void

Parameters

componentLabel: string

Returns boolean

getComponentSet

Returns Set<string>

init

Parameters

elementId: string

Optional props: any

Returns void

isComponent

Parameters

componentId: string

Returns boolean

load

Parameters

args: LoadMolstarInterface | LoadMolstarInterface[]