Preparing search index...
The search index is not available
@rcsb/rcsb-saguaro-3d
@rcsb/rcsb-saguaro-3d
RcsbFvStructure/StructureViewerInterface
StructureViewerPublicInterface
Interface StructureViewerPublicInterface<R, L>
Type Parameters
R
L
Hierarchy
ViewerActionManagerInterface
<
R
,
L
>
StructureViewerPublicInterface
StructureViewerInterface
Index
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
Methods
camera
Focus
camera
Focus
(
modelId
,
labelAsymId
,
positions
,
operatorName
?
)
:
void
Parameters
modelId
:
string
labelAsymId
:
string
positions
:
number
[]
Optional
operatorName
:
string
Returns
void
camera
Focus
(
modelId
,
labelAsymId
,
begin
,
end
,
operatorName
?
)
:
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
,
option
?
)
:
void
Parameters
mode
:
"select"
|
"hover"
Optional
option
:
SaguaroChain
Returns
void
color
Component
color
Component
(
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
>
create
Component
create
Component
(
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
>
create
Component
(
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
>
create
Component
(
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
>
create
Component
(
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
>
display
Component
display
Component
(
componentLabel
)
:
boolean
Parameters
componentLabel
:
string
Returns
boolean
display
Component
(
componentLabel
,
visibilityFlag
)
:
void
Parameters
componentLabel
:
string
visibilityFlag
:
boolean
Returns
void
export
Loaded
Structures
export
Loaded
Structures
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Component
Set
get
Component
Set
(
)
:
Set
<
string
>
Returns
Set
<
string
>
is
Component
is
Component
(
componentLabel
)
:
boolean
Parameters
componentLabel
:
string
Returns
boolean
load
load
(
loadConfig
)
:
Promise
<
undefined
|
L
>
Parameters
loadConfig
:
R
Returns
Promise
<
undefined
|
L
>
load
(
loadConfig
)
:
Promise
<
(
undefined
|
L
)
[]
>
Parameters
loadConfig
:
R
[]
Returns
Promise
<
(
undefined
|
L
)
[]
>
remove
Component
remove
Component
(
componentLabel
?
)
:
Promise
<
void
>
Parameters
Optional
componentLabel
:
string
Returns
Promise
<
void
>
remove
Structure
remove
Structure
(
removeConfig
)
:
Promise
<
void
>
Parameters
removeConfig
:
R
|
R
[]
Returns
Promise
<
void
>
reset
Camera
reset
Camera
(
)
:
void
Returns
void
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
select
(
selection
,
mode
,
operation
)
:
void
Parameters
selection
:
SaguaroPosition
[]
mode
:
"select"
|
"hover"
operation
:
"set"
|
"add"
Returns
void
select
(
selection
,
mode
,
operation
)
:
void
Parameters
selection
:
SaguaroRange
[]
mode
:
"select"
|
"hover"
operation
:
"set"
|
"add"
Returns
void
set
Focus
set
Focus
(
modelId
,
labelAsymId
,
begin
,
end
,
operatorName
?
)
:
void
Parameters
modelId
:
string
labelAsymId
:
string
begin
:
number
end
:
number
Optional
operatorName
:
string
Returns
void
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
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
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
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
FocusResidueColorTheme
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
examples
alignment-provider
providers
AlignmentReference.ts
<internal>
AlignmentReference
ExternalAlignmentProvider.ts
<internal>
dataProvider
loadParamsProvider
alignment-response.d.ts
Alignment
AlignmentGap
AlignmentRegion
AlignmentSummary
ResidueIdentifier
ResponseInfo
SequenceAlignment
StructureAlignmentBlock
StructureAlignmentMetadata
StructureAlignmentResponse
StructureEntry
StructureInstanceSelection
StructureMotifSelection
StructureURL
StructureFileFormat
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
app.ts
alignmentProvider
assembly
custom
sequenceIdentity
uniprot
config.ts
rcsbFvWebAppPath
"*.json"
"*.module.css"
"*.module.sass"
"*.module.scss"
"boxicons/*.svg"
Generated using
TypeDoc