Interface SaguaroPluginPublicInterface
Hierarchy
- SaguaroPluginPublicInterface
Methods
cameraFocus
- cameraFocus(modelId: string, labelAsymId: string, positions: number[], operatorName?: string): void
- cameraFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: string): void
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
clearFocus
Returns void
clearSelection
- clearSelection(mode: "select" | "hover", option?: SaguaroChain): void
Parameters
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>
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>
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
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
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
Parameters
componentLabel: string
visibilityFlag: boolean
Returns void
Parameters
Returns boolean
getComponentSet
- getComponentSet(): Set<string>
Returns Set<string>
isComponent
- isComponent(componentId: string): boolean
Parameters
Returns boolean
removeComponent
- removeComponent(componentId?: string): void
Parameters
Optional componentId: string
Returns void
resetCamera
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
Parameters
modelId: string
labelAsymId: string
x: number
y: number
mode: "select" | "hover"
operation: "add" | "set"
Optional operatorName: string
Returns void
Parameters
mode: "select" | "hover"
operation: "add" | "set"
Returns void
Parameters
mode: "select" | "hover"
operation: "add" | "set"
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