Class StructureViewer<R, L, S>

Type Parameters

R
L
S extends {}

Hierarchy

StructureViewer

Implements

StructureViewerInterface<R, L, S>

Constructors

constructor

new StructureViewer<R, L, S>(structureViewerManagerFactory): StructureViewer<R, L, S>
Type Parameters
- R
- L
- S extends {}
Parameters
- structureViewerManagerFactory: ViewerManagerFactoryInterface<R, L, S>
Returns StructureViewer<R, L, S>
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:21

Properties

`Private` actionManager

actionManager: ViewerActionManagerInterface<R, L>

`Private` callbackManager

callbackManager: ViewerCallbackManagerInterface

`Private` `Readonly` structureViewerManagerFactory

structureViewerManagerFactory: ViewerManagerFactoryInterface<R, L, S>

Methods

cameraFocus

cameraFocus(modelId, labelAsymId, positions, operatorName?): void
Parameters
- modelId: string
- labelAsymId: string
- positions: number[]
- Optional operatorName: string
Returns void
Implementation of StructureViewerInterface.cameraFocus
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:74
cameraFocus(modelId, labelAsymId, begin, end, operatorName?): void
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: string
Returns void
Implementation of StructureViewerInterface.cameraFocus
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:75

clear

clear(): Promise<void>
Returns Promise<void>
Implementation of StructureViewerInterface.clear
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:36

clearFocus

clearFocus(): void
Returns void
Implementation of StructureViewerInterface.clearFocus
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:70

clearSelection

clearSelection(mode, option?): void
Parameters
- mode: "select" | "hover"
- Optional option: SaguaroChain
Returns void
Implementation of StructureViewerInterface.clearSelection
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:63

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>
Implementation of StructureViewerInterface.colorComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:92

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>
Implementation of StructureViewerInterface.createComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:80
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>
Implementation of StructureViewerInterface.createComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:81
createComponent(componentLabel, residues, representationType): Promise<void>
Parameters
- componentLabel: string
- residues: SaguaroPosition[]
- representationType: "label" | "line" | "orientation" | "carbohydrate" | "cartoon" | "ellipsoid" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"
Returns Promise<void>
Implementation of StructureViewerInterface.createComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:82
createComponent(componentLabel, residues, representationType): Promise<void>
Parameters
- componentLabel: string
- residues: SaguaroRange[]
- representationType: "label" | "line" | "orientation" | "carbohydrate" | "cartoon" | "ellipsoid" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill"
Returns Promise<void>
Implementation of StructureViewerInterface.createComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:83

displayComponent

displayComponent(componentLabel): boolean
Parameters
- componentLabel: string
Returns boolean
Implementation of StructureViewerInterface.displayComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:104
displayComponent(componentLabel, visibilityFlag): void
Parameters
- componentLabel: string
- visibilityFlag: boolean
Returns void
Implementation of StructureViewerInterface.displayComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:105

exportLoadedStructures

exportLoadedStructures(): Promise<void>
Returns Promise<void>
Implementation of StructureViewerInterface.exportLoadedStructures
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:142

getComponentSet

getComponentSet(): Set<string>
Returns Set<string>
Implementation of StructureViewerInterface.getComponentSet
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:96

init

init(stateManager, args): void
Parameters
- stateManager: RcsbFvStateInterface
- args: S
Returns void
Implementation of StructureViewerInterface.init
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:25

isComponent

isComponent(componentLabel): boolean
Parameters
- componentLabel: string
Returns boolean
Implementation of StructureViewerInterface.isComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:88

load

load(loadConfig): Promise<undefined | L>
Parameters
- loadConfig: R
Returns Promise<undefined | L>
Implementation of StructureViewerInterface.load
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:40
load(loadConfig): Promise<(undefined | L)[]>
Parameters
- loadConfig: R[]
Returns Promise<(undefined | L)[]>
Implementation of StructureViewerInterface.load
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:41

modelChange

modelChange(): void
Returns void
Implementation of StructureViewerInterface.modelChange
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:130

pluginCall

pluginCall(f): void
Parameters
- f: ((plugin) => void)
  - - (plugin): void
    - Parameters
      plugin: PluginContext
      Returns void
Returns void
Implementation of StructureViewerInterface.pluginCall
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:122

removeComponent

removeComponent(componentLabel?): Promise<void>
Parameters
- Optional componentLabel: string
Returns Promise<void>
Implementation of StructureViewerInterface.removeComponent
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:100

removeStructure

removeStructure(loadConfig): Promise<void>
Parameters
- loadConfig: R | R[]
Returns Promise<void>
Implementation of StructureViewerInterface.removeStructure
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:48

resetCamera

resetCamera(): void
Returns void
Implementation of StructureViewerInterface.resetCamera
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:138

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
Implementation of StructureViewerInterface.select
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:56
select(selection, mode, operation): void
Parameters
- selection: SaguaroPosition[]
- mode: "select" | "hover"
- operation: "set" | "add"
Returns void
Implementation of StructureViewerInterface.select
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:57
select(selection, mode, operation): void
Parameters
- selection: SaguaroRange[]
- mode: "select" | "hover"
- operation: "set" | "add"
Returns void
Implementation of StructureViewerInterface.select
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:58

setBackground

setBackground(color): void
Parameters
- color: number
Returns void
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:53

setFocus

setFocus(modelId, labelAsymId, begin, end, operatorName?): void
Parameters
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- Optional operatorName: string
Returns void
Implementation of StructureViewerInterface.setFocus
- Defined in src/RcsbFvStructure/StructureViewers/StructureViewer.ts:67

Class StructureViewer<R, L, S>

Type Parameters

R

L

S extends {}

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

R

L

S extends {}

Parameters

structureViewerManagerFactory: ViewerManagerFactoryInterface<R, L, S>

Returns StructureViewer<R, L, S>

Properties

Private actionManager

Private callbackManager

Private Readonly structureViewerManagerFactory

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 Promise<void>

clearFocus

Returns void

clearSelection

Parameters

mode: "select" | "hover"

Optional option: SaguaroChain

Returns void

colorComponent

Parameters

componentLabel: string

Returns Promise<void>

createComponent

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>

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>

Parameters

componentLabel: string

residues: SaguaroPosition[]

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

Returns Promise<void>

Parameters

componentLabel: string

residues: SaguaroRange[]

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

Returns Promise<void>

displayComponent

`Private` actionManager

`Private` callbackManager

`Private` `Readonly` structureViewerManagerFactory

`Optional` operatorName: string

`Optional` operatorName: string

`Optional` option: SaguaroChain

`Optional` operatorName: string

`Optional` operatorName: string

`Optional` componentLabel: string

`Optional` operatorName: string