@rcsb/rcsb-saguaro-3d
Preparing search index...
RcsbFvStructure/StructureViewers/MolstarViewer/MolstarActionManager
MolstarActionManager
Class MolstarActionManager<P, L>
Type Parameters
P
L
Implements
ViewerActionManagerInterface
<
LoadMolstarInterface
<
P
,
L
>
,
L
>
Index
Constructors
constructor
Methods
camera
Focus
clear
clear
Focus
clear
Selection
color
Component
create
Component
display
Component
export
Loaded
Structures
get
Component
Set
is
Component
load
remove
Component
remove
Structure
reset
Camera
select
set
Focus
Constructors
constructor
new
MolstarActionManager
<
P
,
L
>
(
config
:
{
innerReprChangeFlag
:
DataContainer
<
boolean
>
;
innerSelectionFlag
:
DataContainer
<
boolean
>
;
loadingFlag
:
DataContainer
<
boolean
>
;
modelMapManager
:
ViewerModelMapManagerInterface
<
LoadMolstarInterface
<
P
,
L
>
,
L
,
>
;
viewer
:
Viewer
;
}
,
)
:
MolstarActionManager
<
P
,
L
>
Type Parameters
P
L
Parameters
config
:
{
innerReprChangeFlag
:
DataContainer
<
boolean
>
;
innerSelectionFlag
:
DataContainer
<
boolean
>
;
loadingFlag
:
DataContainer
<
boolean
>
;
modelMapManager
:
ViewerModelMapManagerInterface
<
LoadMolstarInterface
<
P
,
L
>
,
L
,
>
;
viewer
:
Viewer
;
}
Returns
MolstarActionManager
<
P
,
L
>
Methods
camera
Focus
cameraFocus
(
modelId
:
string
,
labelAsymId
:
string
,
positions
:
number
[]
,
operatorName
?:
string
,
)
:
void
Parameters
modelId
:
string
labelAsymId
:
string
positions
:
number
[]
Optional
operatorName
:
string
Returns
void
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
clear
clear
()
:
Promise
<
void
>
Returns
Promise
<
void
>
clear
Focus
clearFocus
()
:
void
Returns
void
clear
Selection
clearSelection
(
mode
:
"select"
|
"hover"
,
option
?:
SaguaroChain
)
:
void
Parameters
mode
:
"select"
|
"hover"
Optional
option
:
SaguaroChain
Returns
void
color
Component
colorComponent
(
componentLabel
:
string
,
color
:
|
"cartoon"
|
"atom-id"
|
"carbohydrate-symbol"
|
"chain-id"
|
"element-index"
|
"element-symbol"
|
"entity-id"
|
"entity-source"
|
"external-structure"
|
"external-volume"
|
"formal-charge"
|
"hydrophobicity"
|
"illustrative"
|
"model-index"
|
"molecule-type"
|
"occupancy"
|
"operator-hkl"
|
"operator-name"
|
"partial-charge"
|
"polymer-id"
|
"polymer-index"
|
"residue-charge"
|
"residue-name"
|
"secondary-structure"
|
"sequence-id"
|
"shape-group"
|
"structure-index"
|
"trajectory-index"
|
"uncertainty"
|
"unit-index"
|
"uniform"
|
"volume-instance"
|
"volume-segment"
|
"volume-value"
,
)
:
Promise
<
void
>
Parameters
componentLabel
:
string
color
:
|
"cartoon"
|
"atom-id"
|
"carbohydrate-symbol"
|
"chain-id"
|
"element-index"
|
"element-symbol"
|
"entity-id"
|
"entity-source"
|
"external-structure"
|
"external-volume"
|
"formal-charge"
|
"hydrophobicity"
|
"illustrative"
|
"model-index"
|
"molecule-type"
|
"occupancy"
|
"operator-hkl"
|
"operator-name"
|
"partial-charge"
|
"polymer-id"
|
"polymer-index"
|
"residue-charge"
|
"residue-name"
|
"secondary-structure"
|
"sequence-id"
|
"shape-group"
|
"structure-index"
|
"trajectory-index"
|
"uncertainty"
|
"unit-index"
|
"uniform"
|
"volume-instance"
|
"volume-segment"
|
"volume-value"
Returns
Promise
<
void
>
create
Component
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"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
,
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"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
Optional
operatorName
:
string
Returns
Promise
<
void
>
createComponent
(
componentLabel
:
string
,
modelId
:
string
,
labelAsymId
:
string
,
representationType
:
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"carbohydrate"
|
"ellipsoid"
|
"gaussian-surface"
|
"gaussian-volume"
|
"label"
|
"line"
|
"molecular-surface"
|
"orientation"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
,
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"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
Optional
operatorName
:
string
Returns
Promise
<
void
>
createComponent
(
componentLabel
:
string
,
residues
:
SaguaroPosition
[]
,
representationType
:
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"carbohydrate"
|
"ellipsoid"
|
"gaussian-surface"
|
"gaussian-volume"
|
"label"
|
"line"
|
"molecular-surface"
|
"orientation"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
,
)
:
Promise
<
void
>
Parameters
componentLabel
:
string
residues
:
SaguaroPosition
[]
representationType
:
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"carbohydrate"
|
"ellipsoid"
|
"gaussian-surface"
|
"gaussian-volume"
|
"label"
|
"line"
|
"molecular-surface"
|
"orientation"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
Returns
Promise
<
void
>
createComponent
(
componentLabel
:
string
,
residues
:
SaguaroRange
[]
,
representationType
:
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"carbohydrate"
|
"ellipsoid"
|
"gaussian-surface"
|
"gaussian-volume"
|
"label"
|
"line"
|
"molecular-surface"
|
"orientation"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
,
)
:
Promise
<
void
>
Parameters
componentLabel
:
string
residues
:
SaguaroRange
[]
representationType
:
|
"cartoon"
|
"backbone"
|
"ball-and-stick"
|
"carbohydrate"
|
"ellipsoid"
|
"gaussian-surface"
|
"gaussian-volume"
|
"label"
|
"line"
|
"molecular-surface"
|
"orientation"
|
"plane"
|
"point"
|
"putty"
|
"spacefill"
|
"polyhedron"
Returns
Promise
<
void
>
display
Component
displayComponent
(
componentLabel
:
string
)
:
boolean
Parameters
componentLabel
:
string
Returns
boolean
displayComponent
(
componentLabel
:
string
,
visibilityFlag
:
boolean
)
:
void
Parameters
componentLabel
:
string
visibilityFlag
:
boolean
Returns
void
export
Loaded
Structures
exportLoadedStructures
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Component
Set
getComponentSet
()
:
Set
<
string
>
Returns
Set
<
string
>
is
Component
isComponent
(
componentLabel
:
string
)
:
boolean
Parameters
componentLabel
:
string
Returns
boolean
load
load
(
loadConfig
:
LoadMolstarInterface
<
P
,
L
>
)
:
Promise
<
undefined
|
L
>
Parameters
loadConfig
:
LoadMolstarInterface
<
P
,
L
>
Returns
Promise
<
undefined
|
L
>
load
(
loadConfig
:
LoadMolstarInterface
<
P
,
L
>
[]
)
:
Promise
<
(
undefined
|
L
)
[]
>
Parameters
loadConfig
:
LoadMolstarInterface
<
P
,
L
>
[]
Returns
Promise
<
(
undefined
|
L
)
[]
>
remove
Component
removeComponent
(
componentLabel
?:
string
)
:
Promise
<
void
>
Parameters
Optional
componentLabel
:
string
Returns
Promise
<
void
>
remove
Structure
removeStructure
(
loadConfig
:
LoadMolstarInterface
<
P
,
L
>
|
LoadMolstarInterface
<
P
,
L
>
[]
,
)
:
Promise
<
void
>
Parameters
loadConfig
:
LoadMolstarInterface
<
P
,
L
>
|
LoadMolstarInterface
<
P
,
L
>
[]
Returns
Promise
<
void
>
reset
Camera
resetCamera
()
:
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
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
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
camera
Focus
clear
clear
Focus
clear
Selection
color
Component
create
Component
display
Component
export
Loaded
Structures
get
Component
Set
is
Component
load
remove
Component
remove
Structure
reset
Camera
select
set
Focus
src
examples
alignment-provider
providers
alignment-response.d.ts
Alignment
AlignmentGap
AlignmentRegion
AlignmentSummary
ResidueIdentifier
ResponseInfo
SequenceAlignment
StructureAlignmentBlock
StructureAlignmentMetadata
StructureAlignmentResponse
StructureEntry
StructureInstanceSelection
StructureMotifSelection
StructureURL
StructureFileFormat
AlignmentReference.ts
<internal>
AlignmentReference
ExternalAlignmentProvider.ts
<internal>
dataProvider
loadParamsProvider
index.ts
assembly
index.ts
assembly-interface
index.ts
css-config
index.ts
AlignmentManager.ts
AlignmentManager
external-mapping
index.ts
FeatureViewerConfig.ts
fvConfig1
fvConfig2
StructurePreset.ts
RcsbSuperpositionRepresentationPreset
TrajectoryPreset.ts
RcsbRepresentationPreset
multiple-chain
index.tsx
sequence-identity
index.ts
single-chain
index.ts
structural-alignment
index.ts
AlignmentManager.ts
AlignmentManager
uniprot
index.ts
RcsbFv3D
RcsbFv3DAbstract.tsx
RcsbFv3DAbstract
RcsbFv3DAbstractInterface
RcsbFv3DAlignmentProvider.tsx
<internal>
RcsbFv3DAlignmentProvider
RcsbFv3DDataProviderInterface
RcsbFv3DAssembly.tsx
<internal>
RcsbFv3DAssembly
RcsbFv3DAssemblyInterface
RcsbFv3DComponent.tsx
<internal>
RcsbFv3DComponent
RcsbFv3DComponentInterface
RcsbFv3DCssConfig
RcsbFv3DCustom.tsx
RcsbFv3DCustom
RcsbFv3DCustomInterface
RcsbFv3DCustomAbstract.tsx
RcsbFv3DCustomAbstract
RcsbFv3DCustomAbstractInterface
RcsbFv3DCustomComponent.tsx
<internal>
RcsbFv3DCustomComponent
RcsbFv3DCssConfig
RcsbFv3DCustomComponentInterface
RcsbFv3DSequenceIdentity.tsx
<internal>
RcsbFv3DSequenceIdentity
RcsbFv3DSequenceIdentityInterface
RcsbFv3DUniprot.tsx
<internal>
RcsbFv3DUniprot
RcsbFv3DUniprotInterface
RcsbFvConstants
RcsbFvConstants.ts
RcsbFvDOMConstants
RcsbFvContextManager
RcsbFvContextManager.ts
EventType
RcsbFvContextManager
RcsbFvContextManagerInterface
UpdateConfigInterface
RcsbFvCustomContextManager.ts
EventType
RcsbFvCustomContextManager
RcsbFvCustomContextManagerInterface
UpdateConfigInterface
RcsbFvSequence
SequenceViews
CustomView
CustomView.tsx
BlockSelectorManager
CustomView
CustomViewInterface
FeatureBlockInterface
FeatureViewInterface
CustomViewStateInterface
RcsbView
CallbackManagerFactoryImplementation
AssemblyCallbackManager.ts
AssemblyCallbackManagerFactory
MsaCallbackManager.ts
MsaCallbackManagerFactory
Components
HelpLinkComponent.tsx
<internal>
HelpLinkComponent
PfvManagerFactoryImplementation
AssemblyPfvComponents
ChainDisplayComponent.tsx
<internal>
ChainDisplayComponent
MsaPfvComponents
MsaRowMarkComponent.tsx
<internal>
MsaRowMarkComponent
MsaRowTitleCheckboxComponent.tsx
<internal>
MsaRowTitleCheckboxComponent
MsaRowTitleComponent.tsx
<internal>
MsaRowTitleComponent
MsaUiSequenceAlignmentDownload.tsx
MsaUiSequenceAlignmentDownload
MsaUiSequenceAlignmentDownloadInterface
MsaUiSortComponent.tsx
MsaUiSortComponent
MsaUiSortInterface
MsaUiStructureDownload.tsx
MsaUiStructureDownload
MsaUiStructureDownloadInterface
AssemblyPfvManagerFactory.tsx
<internal>
AssemblyPfvManagerFactory
MsaPfvManagerFactory.ts
<internal>
MsaPfvManagerFactory
MsaPfvManagerInterface
RcsbViewBehaviour
AlignmentProviderBehaviour.ts
AlignmentProviderBehaviour
CallbackManagerFactoryInterface.ts
AbstractCallbackManager
CallbackConfigInterface
CallbackManagerFactoryInterface
CallbackManagerInterface
PfvManagerFactoryInterface.ts
AbstractPfvManager
BuildPfvInterface
PfvManagerFactoryConfigInterface
PfvManagerFactoryInterface
PfvManagerInterface
RcsbView.tsx
RcsbView
RcsbViewInterface
RcsbViewBehaviourInterface.ts
RcsbViewBehaviourInterface
AbstractView.tsx
AbstractView
AbstractViewInterface
SequenceViewInterface.ts
SequenceViewInterface
RcsbFvCustomSequence.tsx
<internal>
RcsbFvCustomSequence
RcsbFvCustomSequenceInterface
RcsbFvSequence.tsx
RcsbFvSequence
RcsbFvSequenceInterface
RcsbFvState
AssemblyModelSate.ts
<internal>
AssemblyModelSate
RcsbFvSelectorManager.ts
<internal>
RcsbFvSelectorManager
RegionSelectionInterface
RcsbFvStateInterface.ts
RcsbFvStateInterface
RcsbFvStateType
RcsbFvStateManager.ts
RcsbFvStateManager
RcsbFvStructure
StructureUtils
ComponentActionInterface.ts
ComponentActionFactoryInterface
ComponentActionInterface
StructureLoaderInterface.ts
LoadParamsProviderInterface
StructureLoaderInterface
RigidTransformType
TransformMatrixType
StructureViewerBehaviour
AssemblyBehaviour.ts
AssemblyBehaviourObserver
MsaBehaviour.ts
<internal>
MsaBehaviourObserver
NullBehaviour.ts
NullBehaviourObserver
StructureViewers
MolstarViewer
MolstarUtils
MolstarAlignmentLoader.ts
MolstarAlignmentLoader
MolstarAssemblyLoader.ts
MolstarAssemblyLoader
MolstarTools.ts
MolstarTools
TrajectoryPresetProvider
FocusTheme
FocusColoring.ts
FOCUS_RESIDUE_COLOR
FocusResidueColorThemeProvider
AlignmentRepresentationPresetProvider.ts
<internal>
AlignmentRepresentationPresetProvider
AlignmentTrajectoryPresetProvider.ts
<internal>
AlignmentTrajectoryParamsType
AlignmentTrajectoryPresetProvider
AssemblyRepresentationPresetProvider.ts
<internal>
AssemblyRepresentationPresetProvider
AssemblyTrajectoryPresetProvider.ts
<internal>
AssemblyTrajectoryParamsType
AssemblyTrajectoryPresetProvider
FlexibleAlignmentBuiltIn.ts
FlexibleAlignmentBuiltIn
FlexibleAlignmentRepresentationPresetProvider.ts
FlexibleAlignmentRepresentationPresetProvider
FlexibleAlignmentTrajectoryPresetProvider.ts
<internal>
FlexibleAlignmentTrajectoryPresetProvider
MolstarActionManager.ts
<internal>
LoadMethod
MolstarActionManager
LoadMolstarInterface
LoadMolstarReturnType
MolstarCallbackManager.ts
<internal>
MolstarCallbackManager
MolstarManagerFactory.ts
MolstarManagerFactory
MolstarModelMapManager.ts
<internal>
MolstarModelMapManager
StructureViewer.ts
StructureViewer
RcsbFvStructure.tsx
<internal>
RcsbFvStructure
RcsbFvStructureConfigInterface
StructureViewerBehaviourInterface.ts
StructureViewerBehaviourInterface
StructureViewerBehaviourObserverInterface
StructureViewerInterface.ts
SaguaroChain
SaguaroPosition
SaguaroRange
SaguaroRegionList
SaguaroSet
StructureViewerInterface
StructureViewerPublicInterface
ViewerActionManagerInterface
ViewerCallbackManagerInterface
ViewerManagerFactoryInterface
ViewerModelMapManagerInterface
ChainInfo
ChainType
OperatorInfo
SaguaroPluginModelMapType
Utils
AlignmentMapper.ts
AlignmentMapper
DataContainer.ts
DataContainer
DataContainerReader
Download.ts
download
getFullDate
textToFile
FunctionCall.ts
FunctionCall
RcsbIdParser.ts
parseEntityOrInstance
app.ts
alignmentProvider
assembly
custom
sequenceIdentity
uniprot
config.ts
rcsbFvWebAppPath
*.json
*.module.css
*.module.sass
*.module.scss
boxicons/*.svg