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