Preparing search index...
The search index is not available
@rcsb/rcsb-saguaro-3d
@rcsb/rcsb-saguaro-3d
RcsbFv3DAssembly
<internal>
StructureViewerInterface
Interface StructureViewerInterface<R, S>
Type Parameters
R
S
Hierarchy
StructureViewerPublicInterface
<
R
>
ViewerCallbackManagerInterface
StructureViewerInterface
Index
Properties
init
Methods
camera
Focus
clear
clear
Focus
clear
Selection
color
Component
create
Component
display
Component
get
Component
Set
is
Component
load
model
Change
plugin
Call
remove
Component
reset
Camera
select
set
Focus
subscribe
Hover
subscribe
Model
Change
subscribe
Representation
Change
subscribe
Selection
unsubscribe
Properties
init
init
:
(
(
stateManager
:
RcsbFvStateManager
, args
:
S
)
=>
void
)
Type declaration
(
stateManager
:
RcsbFvStateManager
, args
:
S
)
:
void
Parameters
stateManager:
RcsbFvStateManager
args:
S
Returns
void
Methods
camera
Focus
camera
Focus
(
modelId
:
string
, labelAsymId
:
string
, positions
:
number
[]
, operatorName
?:
string
)
:
void
Parameters
modelId:
string
labelAsymId:
string
positions:
number
[]
Optional
operatorName:
string
Returns
void
camera
Focus
(
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
>
clear
Focus
clear
Focus
(
)
:
void
Returns
void
clear
Selection
clear
Selection
(
mode
:
"select"
|
"hover"
, option
?:
SaguaroChain
)
:
void
Parameters
mode:
"select"
|
"hover"
Optional
option:
SaguaroChain
Returns
void
color
Component
color
Component
(
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
>
create
Component
create
Component
(
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
>
create
Component
(
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
>
create
Component
(
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
residues:
SaguaroPosition
[]
representationType:
"label"
|
"line"
|
"orientation"
|
"carbohydrate"
|
"ellipsoid"
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"gaussian-surface"
|
"gaussian-volume"
|
"molecular-surface"
|
"point"
|
"putty"
|
"spacefill"
Returns
Promise
<
void
>
create
Component
(
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
residues:
SaguaroRange
[]
representationType:
"label"
|
"line"
|
"orientation"
|
"carbohydrate"
|
"ellipsoid"
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"gaussian-surface"
|
"gaussian-volume"
|
"molecular-surface"
|
"point"
|
"putty"
|
"spacefill"
Returns
Promise
<
void
>
display
Component
display
Component
(
componentLabel
:
string
)
:
boolean
Parameters
componentLabel:
string
Returns
boolean
display
Component
(
componentLabel
:
string
, visibilityFlag
:
boolean
)
:
void
Parameters
componentLabel:
string
visibilityFlag:
boolean
Returns
void
get
Component
Set
get
Component
Set
(
)
:
Set
<
string
>
Returns
Set
<
string
>
is
Component
is
Component
(
componentLabel
:
string
)
:
boolean
Parameters
componentLabel:
string
Returns
boolean
load
load
(
loadConfig
:
R
|
R
[]
)
:
Promise
<
void
>
Parameters
loadConfig:
R
|
R
[]
Returns
Promise
<
void
>
model
Change
model
Change
(
)
:
void
Returns
void
plugin
Call
plugin
Call
(
f
:
(
(
plugin
:
PluginContext
)
=>
void
)
)
:
void
Parameters
f:
(
(
plugin
:
PluginContext
)
=>
void
)
(
plugin
:
PluginContext
)
:
void
Parameters
plugin:
PluginContext
Returns
void
Returns
void
remove
Component
remove
Component
(
componentLabel
?:
string
)
:
Promise
<
void
>
Parameters
Optional
componentLabel:
string
Returns
Promise
<
void
>
reset
Camera
reset
Camera
(
)
:
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
selection:
SaguaroPosition
[]
mode:
"select"
|
"hover"
operation:
"set"
|
"add"
Returns
void
select
(
selection
:
SaguaroRange
[]
, mode
:
"select"
|
"hover"
, operation
:
"set"
|
"add"
)
:
void
Parameters
selection:
SaguaroRange
[]
mode:
"select"
|
"hover"
operation:
"set"
|
"add"
Returns
void
set
Focus
set
Focus
(
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
subscribe
Hover
subscribe
Hover
(
)
:
<internal>
.
Subscription
Returns
<internal>
.
Subscription
subscribe
Model
Change
subscribe
Model
Change
(
)
:
<internal>
.
Subscription
Returns
<internal>
.
Subscription
subscribe
Representation
Change
subscribe
Representation
Change
(
)
:
<internal>
.
Subscription
Returns
<internal>
.
Subscription
subscribe
Selection
subscribe
Selection
(
)
:
<internal>
.
Subscription
Returns
<internal>
.
Subscription
unsubscribe
unsubscribe
(
)
:
void
Returns
void
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@rcsb/rcsb-
saguaro-
3d
Rcsb
Fv3DAssembly
<internal>
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
geo/geometry/text/font-
atlas"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
gl/render-
object"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
gl/renderable/schema"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
model/structure/model"
Indexed
Custom
Property
Symmetry
Types
Bond
Type
Secondary
Structure
Type
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
model/structure/model/properties/atomic"
Atomic
Hierarchy
Atomic
Index
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/builder/structure/representation"
Structure
Representation
Builder
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/transforms/data"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/transforms/misc"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/transforms/model"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/transforms/representation"
Volume
Representation3DHelpers
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/transforms/shape"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
plugin-
state/transforms/volume"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
repr/structure/representation"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
repr/volume/representation"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
script/language/symbol"
Arguments
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
script/language/type"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
state/state/builder"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
state/transformer"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
task/execution/synchronous"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
util/binding"
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
util/clip"
Clip
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
util/color/color"
Color
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
util/color/index"
Color
Color
Scale
"/
Users/joan/devel/rcsb-
saguaro-
3d/node_
modules/molstar/lib/mol-
util/uuid"
Arguments
Array
Encoder
Assembly
Asset
Atomic
Hierarchy
Atomic
Index
Axes3D
Binding
Trigger
Bit
Flags
Box3D
Bundle
Buttons
Type
Camera
Camera
Transition
Manager
Canvas3D
Canvas3DContext
Category
Cell
Cif
Category
Cif
Export
Context
Cif
Field
Clipping
Groups
Coarse
Hierarchy
Collection
Indexed
Keyed
Set
Color
Color
Theme
Column
Schema
Compiled
Query
Fn
Coordinates
Cube
File
Custom
Property
Descriptor
Cylinders
Direct
Volume
Dx
File
Encoding
Expression
Field
Generators
Geometry
Grid
Image
Indexed
Indexed
Input
Observer
Int
Adjacency
Graph
Int
Map
Inter
Unit
Bonds
Inter
Unit
Graph
Interactivity
Manager
Interval
Intra
Unit
Bonds
Iterator
Keyed
Lines
List
Location
Loci
Loci
Loci
Log
Entry
Map
Marker
Actions
Mat3
Mat4
Material
Mesh
Model
Modifiers
Keys
Mol
Script
Builder
Object3D
Object
Event
Ordered
Map
Ordered
Set
Ordered
Set
Overpaint
Picking
Id
Pixel
Data
Plugin
Animation
Manager
Plugin
Behavior
Plugin
Command
Plugin
Spec
Plugin
State
Plugin
State
Animation
Plugin
State
Snapshot
Manager
Plugin
Toast
Manager
Points
Principal
Axes
Progress
Quat
Query
Runtime
Arguments
Query
Symbol
Runtime
Renderer
Representation
Loci
Representation
Provider
Result
Runtime
Context
Rx
Event
Helper
Scene
Script
Segmentation
Seq
Indexed
Keyed
Set
Sequence
Set
Set
Shape
Size
Theme
Sorted
Array
Sorted
Ranges
Spacegroup
Spacegroup
Cell
Sphere3D
Spheres
Stack
State
Object
Event
State
Action
Builder
State
Builder
State
Object
State
Object
Cell
State
Object
Ref
State
Object
Selector
State
Tree
State
Tree
Spine
Stereo
Camera
Structure
Structure
Structure
Component
Manager
Structure
Hierarchy
Manager
Structure
Query
Structure
Representation
Builder
Structure
Representation
Preset
Provider
Structure
Representation
Registry
Structure
Result
Structure
Selection
Structure
Sequence
Substance
Symmetry
Group
Symmetry
Operator
Table
Task
Task
Manager
Tensor
Text
Texture
Mesh
Theme
Time
Topology
Traits
Trajectory
Hierarchy
Preset
Provider
Transform
Transformer
Builder
Transparency
Type
UUID
Unit
Symmetry
Group
Traits
Unit
Ring
Unit
Rings
Value
Box
Value
Cell
Value
Ref
Vec2
Vec3
Vec4
Viewport
Viewport
Screenshot
Helper
Visual
Visual
Update
State
Volume
Cell
Iso
Value
Isosurface
Volume
Hierarchy
Manager
Volume
Representation
Registry
Volume
Server
Header
Value
Type
Volume
Server
Info
Volume
Streaming
Rcsb
Fv3DCustom
Structure
Viewer
Interface
init
camera
Focus
clear
clear
Focus
clear
Selection
color
Component
create
Component
display
Component
get
Component
Set
is
Component
load
model
Change
plugin
Call
remove
Component
reset
Camera
select
set
Focus
subscribe
Hover
subscribe
Model
Change
subscribe
Representation
Change
subscribe
Selection
unsubscribe
Generated using
TypeDoc