Interface ViewerActionManagerInterface<R>
Hierarchy
- ViewerActionManagerInterface
Methods
cameraFocus
- cameraFocus(modelId: string, labelAsymId: string, positions: number[], operatorName?: string): void
-
Parameters
-
modelId: string
-
labelAsymId: string
-
positions: number[]
-
Optional operatorName: string
Returns void
- cameraFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: string): void
-
Parameters
-
modelId: string
-
labelAsymId: string
-
begin: number
-
end: number
-
Optional operatorName: string
Returns void
clear
- clear(): Promise<void>
-
Returns Promise<void>
clearFocus
- clearFocus(): void
-
Returns void
clearSelection
- clearSelection(mode: "select" | "hover", option?: SaguaroChain): void
-
Returns void
colorComponent
- colorComponent(componentLabel: string, color: "uniform" | "occupancy" | "element-index" | "element-symbol" | "shape-group" | "uncertainty" | "atom-id" | "carbohydrate-symbol" | "chain-id" | "operator-name" | "entity-id" | "entity-source" | "hydrophobicity" | "molecule-type" | "illustrative" | "model-index" | "operator-hkl" | "partial-charge" | "polymer-id" | "polymer-index" | "residue-name" | "secondary-structure" | "sequence-id" | "unit-index" | "volume-value"): Promise<void>
-
Parameters
-
componentLabel: string
-
color: "uniform" | "occupancy" | "element-index" | "element-symbol" | "shape-group" | "uncertainty" | "atom-id" | "carbohydrate-symbol" | "chain-id" | "operator-name" | "entity-id" | "entity-source" | "hydrophobicity" | "molecule-type" | "illustrative" | "model-index" | "operator-hkl" | "partial-charge" | "polymer-id" | "polymer-index" | "residue-name" | "secondary-structure" | "sequence-id" | "unit-index" | "volume-value"
Returns Promise<void>
createComponent
- createComponent(componentLabel: string, modelId: string, labelAsymId: string, begin: number, end: number, representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill", operatorName?: string): Promise<void>
-
Parameters
-
componentLabel: string
-
modelId: string
-
labelAsymId: string
-
begin: number
-
end: number
-
representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"
-
Optional operatorName: string
Returns Promise<void>
- createComponent(componentLabel: string, modelId: string, labelAsymId: string, representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill", operatorName?: string): Promise<void>
-
Parameters
-
componentLabel: string
-
modelId: string
-
labelAsymId: string
-
representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"
-
Optional operatorName: string
Returns Promise<void>
- createComponent(componentLabel: string, residues: SaguaroPosition[], representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"): Promise<void>
-
Parameters
-
componentLabel: string
-
-
representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"
Returns Promise<void>
- createComponent(componentLabel: string, residues: SaguaroRange[], representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"): Promise<void>
-
Parameters
-
componentLabel: string
-
-
representationType: "label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"
Returns Promise<void>
displayComponent
- displayComponent(componentLabel: string): boolean
-
Returns boolean
- displayComponent(componentLabel: string, visibilityFlag: boolean): void
-
Parameters
-
componentLabel: string
-
visibilityFlag: boolean
Returns void
getComponentSet
- getComponentSet(): Set<string>
-
Returns Set<string>
isComponent
- isComponent(componentLabel: string): boolean
-
Returns boolean
load
- load(loadConfig: R | R[]): Promise<void>
-
Returns Promise<void>
removeComponent
- removeComponent(componentLabel?: string): Promise<void>
-
Parameters
-
Optional componentLabel: string
Returns Promise<void>
removeStructure
- removeStructure(removeConfig: R | R[]): Promise<void>
-
Returns Promise<void>
resetCamera
- resetCamera(): void
-
Returns void
select
- select(modelId: string, labelAsymId: string, begin: number, end: number, mode: "select" | "hover", operation: "set" | "add", operatorName?: string): void
-
Parameters
-
modelId: string
-
labelAsymId: string
-
begin: number
-
end: number
-
mode: "select" | "hover"
-
operation: "set" | "add"
-
Optional operatorName: string
Returns void
- select(selection: SaguaroPosition[], mode: "select" | "hover", operation: "set" | "add"): void
-
Parameters
-
-
mode: "select" | "hover"
-
operation: "set" | "add"
Returns void
- select(selection: SaguaroRange[], mode: "select" | "hover", operation: "set" | "add"): void
-
Parameters
-
-
mode: "select" | "hover"
-
operation: "set" | "add"
Returns void
setFocus
- setFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: string): void
-
Parameters
-
modelId: string
-
labelAsymId: string
-
begin: number
-
end: number
-
Optional operatorName: string
Returns void