Interface StructureViewerInterface<R, L, S>

Type Parameters

Hierarchy

StructureViewerPublicInterface<R, L>
ViewerCallbackManagerInterface
- StructureViewerInterface

Properties

init

init: ((stateManager: RcsbFvStateInterface, args: S) => void)

Type declaration

- (stateManager: RcsbFvStateInterface, args: S): void
- Parameters
  - stateManager: RcsbFvStateInterface
  - args: S
  Returns void

Methods

cameraFocus

cameraFocus(modelId: string, labelAsymId: string, positions: number[], operatorName?: string): void
Parameters
- modelId: string
- labelAsymId: string
- positions: number[]
- Optional operatorName: string
Returns void
Inherited from StructureViewerPublicInterface.cameraFocus
- Defined in RcsbFvStructure/StructureViewerInterface.ts:67
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
Inherited from StructureViewerPublicInterface.cameraFocus
- Defined in RcsbFvStructure/StructureViewerInterface.ts:68

clear

clear(): Promise<void>
Returns Promise<void>
Inherited from StructureViewerPublicInterface.clear
- Defined in RcsbFvStructure/StructureViewerInterface.ts:63

clearFocus

clearFocus(): void
Returns void
Inherited from StructureViewerPublicInterface.clearFocus
- Defined in RcsbFvStructure/StructureViewerInterface.ts:66

clearSelection

clearSelection(mode: "select" | "hover", option?: SaguaroChain): void
Parameters
- mode: "select" | "hover"
- Optional option: SaguaroChain
Returns void
Inherited from StructureViewerPublicInterface.clearSelection
- Defined in RcsbFvStructure/StructureViewerInterface.ts:64

colorComponent

colorComponent(componentLabel: 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" | "structure-index" | "trajectory-index" | "uncertainty" | "unit-index" | "uniform" | "volume-segment" | "volume-value" | "external-volume"): Promise<void>
Parameters
- componentLabel: 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" | "structure-index" | "trajectory-index" | "uncertainty" | "unit-index" | "uniform" | "volume-segment" | "volume-value" | "external-volume"
Returns Promise<void>
Inherited from StructureViewerPublicInterface.colorComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:74

createComponent

createComponent(componentLabel: string, modelId: string, labelAsymId: string, begin: number, end: number, representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill", operatorName?: string): Promise<void>
Parameters
- componentLabel: string
- modelId: string
- labelAsymId: string
- begin: number
- end: number
- representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"
- Optional operatorName: string
Returns Promise<void>
Inherited from StructureViewerPublicInterface.createComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:69
createComponent(componentLabel: string, modelId: string, labelAsymId: string, representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill", operatorName?: string): Promise<void>
Parameters
- componentLabel: string
- modelId: string
- labelAsymId: string
- representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"
- Optional operatorName: string
Returns Promise<void>
Inherited from StructureViewerPublicInterface.createComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:70
createComponent(componentLabel: string, residues: SaguaroPosition[], representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"): Promise<void>
Parameters
- componentLabel: string
- residues: SaguaroPosition[]
- representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"
Returns Promise<void>
Inherited from StructureViewerPublicInterface.createComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:71
createComponent(componentLabel: string, residues: SaguaroRange[], representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"): Promise<void>
Parameters
- componentLabel: string
- residues: SaguaroRange[]
- representationType: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"
Returns Promise<void>
Inherited from StructureViewerPublicInterface.createComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:72

displayComponent

displayComponent(componentLabel: string): boolean
Parameters
- componentLabel: string
Returns boolean
Inherited from StructureViewerPublicInterface.displayComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:77
displayComponent(componentLabel: string, visibilityFlag: boolean): void
Parameters
- componentLabel: string
- visibilityFlag: boolean
Returns void
Inherited from StructureViewerPublicInterface.displayComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:78

exportLoadedStructures

exportLoadedStructures(): Promise<void>
Returns Promise<void>
Inherited from StructureViewerPublicInterface.exportLoadedStructures
- Defined in RcsbFvStructure/StructureViewerInterface.ts:80

getComponentSet

getComponentSet(): Set<string>
Returns Set<string>
Inherited from StructureViewerPublicInterface.getComponentSet
- Defined in RcsbFvStructure/StructureViewerInterface.ts:75

isComponent

isComponent(componentLabel: string): boolean
Parameters
- componentLabel: string
Returns boolean
Inherited from StructureViewerPublicInterface.isComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:73

load

load(loadConfig: R): Promise<undefined | L>
Parameters
- loadConfig: R
Returns Promise<undefined | L>
Inherited from StructureViewerPublicInterface.load
- Defined in RcsbFvStructure/StructureViewerInterface.ts:57
load(loadConfig: R[]): Promise<(undefined | L)[]>
Parameters
- loadConfig: R[]
Returns Promise<(undefined | L)[]>
Inherited from StructureViewerPublicInterface.load
- Defined in RcsbFvStructure/StructureViewerInterface.ts:58

modelChange

modelChange(): void
Returns void
Inherited from ViewerCallbackManagerInterface.modelChange
- Defined in RcsbFvStructure/StructureViewerInterface.ts:51

pluginCall

pluginCall(f: ((plugin: PluginContext) => void)): void
Parameters
- f: ((plugin: PluginContext) => void)
  - - (plugin: PluginContext): void
    - Parameters
      
      plugin: PluginContext
      
      Returns void
Returns void
Inherited from ViewerCallbackManagerInterface.pluginCall
- Defined in RcsbFvStructure/StructureViewerInterface.ts:53

removeComponent

removeComponent(componentLabel?: string): Promise<void>
Parameters
- Optional componentLabel: string
Returns Promise<void>
Inherited from StructureViewerPublicInterface.removeComponent
- Defined in RcsbFvStructure/StructureViewerInterface.ts:76

removeStructure

removeStructure(removeConfig: R | R[]): Promise<void>
Parameters
- removeConfig: R | R[]
Returns Promise<void>
Inherited from StructureViewerPublicInterface.removeStructure
- Defined in RcsbFvStructure/StructureViewerInterface.ts:59

resetCamera

resetCamera(): void
Returns void
Inherited from StructureViewerPublicInterface.resetCamera
- Defined in RcsbFvStructure/StructureViewerInterface.ts:79

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
Inherited from StructureViewerPublicInterface.select
- Defined in RcsbFvStructure/StructureViewerInterface.ts:60
select(selection: SaguaroPosition[], mode: "select" | "hover", operation: "set" | "add"): void
Parameters
- selection: SaguaroPosition[]
- mode: "select" | "hover"
- operation: "set" | "add"
Returns void
Inherited from StructureViewerPublicInterface.select
- Defined in RcsbFvStructure/StructureViewerInterface.ts:61
select(selection: SaguaroRange[], mode: "select" | "hover", operation: "set" | "add"): void
Parameters
- selection: SaguaroRange[]
- mode: "select" | "hover"
- operation: "set" | "add"
Returns void
Inherited from StructureViewerPublicInterface.select
- Defined in RcsbFvStructure/StructureViewerInterface.ts:62

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
Inherited from StructureViewerPublicInterface.setFocus
- Defined in RcsbFvStructure/StructureViewerInterface.ts:65

Interface StructureViewerInterface<R, L, S>

Type Parameters

R

L

S

Hierarchy

Index

Properties

Methods

Properties

init

Type declaration

Parameters

stateManager: RcsbFvStateInterface

args: S

Returns void

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: "cartoon" | "backbone" | "ball-and-stick" | "carbohydrate" | "ellipsoid" | "gaussian-surface" | "gaussian-volume" | "label" | "line" | "molecular-surface" | "orientation" | "point" | "putty" | "spacefill"

Optional operatorName: string

Returns Promise<void>

Parameters

componentLabel: string

modelId: string

labelAsymId: string

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

Optional operatorName: string

Returns Promise<void>

Parameters

componentLabel: string

residues: SaguaroPosition[]

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

Returns Promise<void>

Parameters

componentLabel: string

residues: SaguaroRange[]

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

Returns Promise<void>

displayComponent

Parameters

componentLabel: string

Returns boolean

Parameters

componentLabel: string

visibilityFlag: boolean

Returns void

exportLoadedStructures

`Optional` operatorName: string

`Optional` operatorName: string

`Optional` option: SaguaroChain

`Optional` operatorName: string

`Optional` operatorName: string

`Optional` componentLabel: string

`Optional` operatorName: string

`Optional` operatorName: string