Class StructureComponentManager

Hierarchy

StatefulPluginComponent<StructureComponentManagerState>
- StructureComponentManager

Constructors

constructor

new StructureComponentManager(plugin: PluginContext): StructureComponentManager
Parameters
- plugin: PluginContext
Returns StructureComponentManager
Overrides StatefulPluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:57

Properties

`Private` clearComponents

clearComponents: any

`Readonly` events

events: { optionsUpdated: Subject<undefined> }

Type declaration

optionsUpdated: Subject<undefined>

`Private` modifyComponent

modifyComponent: any

plugin

plugin: PluginContext

`Private` syncPreset

syncPreset: any

`Private` tryFindComponent

tryFindComponent: any

`Private` updateInterationProps

updateInterationProps: any

`Private` updateReprParams

updateReprParams: any

Accessors

currentStructures

get currentStructures(): readonly StructureRef[]
Returns readonly StructureRef[]
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:27

`Private` dataState

get dataState(): any
Returns any
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:55

`Protected` ev

get ev(): RxEventHelper
Returns RxEventHelper
Inherited from StatefulPluginComponent.ev
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:14

pivotStructure

get pivotStructure(): undefined | StructureRef
Returns undefined | StructureRef
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:28

state

get state(): State
Returns State
Inherited from StatefulPluginComponent.state
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:20

Methods

add

add(params: AddParams, structures?: readonly StructureRef[]): Promise<void>
Parameters
- params: AddParams
- Optional structures: readonly StructureRef[]
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:51

addRepresentation

addRepresentation(components: readonly StructureComponentRef[], type: string): undefined | Promise<void>
Parameters
- components: readonly StructureComponentRef[]
- type: string
Returns undefined | Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:49

applyPreset

applyPreset<P>(structures: readonly StructureRef[], provider: P, params?: <internal>.Params<P>): Promise<any>
Type Parameters
- P extends <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result, P>
Parameters
- structures: readonly StructureRef[]
- provider: P
- Optional params: <internal>.Params<P>
Returns Promise<any>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:32

applyTheme

applyTheme(params: <internal>.Values<{ action: <internal>.Mapped<NamedParams<Normalize<{ color: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color }>, "color"> | NamedParams<Normalize<{ material: Normalize<{ bumpiness: number; metalness: number; roughness: number }> }>, "material"> | NamedParams<Normalize<{ value: number }>, "transparency"> | NamedParams<Normalize<{ excludeGroups: ("one" | "two" | "three" | "four" | "five" | "six")[] }>, "clipping"> | NamedParams<Normalize<unknown>, "resetColor"> | NamedParams<Normalize<unknown>, "resetMaterial">>; representations: <internal>.MultiSelect<string>; selection: <internal>.Select<<internal>.StructureSelectionQuery> }>, structures?: readonly StructureRef[]): Promise<void>
Parameters
- params: <internal>.Values<{ action: <internal>.Mapped<NamedParams<Normalize<{ color: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color }>, "color"> | NamedParams<Normalize<{ material: Normalize<{ bumpiness: number; metalness: number; roughness: number }> }>, "material"> | NamedParams<Normalize<{ value: number }>, "transparency"> | NamedParams<Normalize<{ excludeGroups: ("one" | "two" | "three" | "four" | "five" | "six")[] }>, "clipping"> | NamedParams<Normalize<unknown>, "resetColor"> | NamedParams<Normalize<unknown>, "resetMaterial">>; representations: <internal>.MultiSelect<string>; selection: <internal>.Select<<internal>.StructureSelectionQuery> }>
- Optional structures: readonly StructureRef[]
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:52

canBeModified

canBeModified(ref: StructureHierarchyRef): boolean
Parameters
- ref: StructureHierarchyRef
Returns boolean
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:36

clear

clear(structures: readonly StructureRef[]): Promise<void>
Parameters
- structures: readonly StructureRef[]
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:34

dispose

dispose(): void
Returns void
Inherited from StatefulPluginComponent.dispose
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:15

modifyByCurrentSelection

modifyByCurrentSelection(components: readonly StructureComponentRef[], action: ModifyAction): Promise<void>
Parameters
- components: readonly StructureComponentRef[]
- action: ModifyAction
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:37

removeRepresentations

removeRepresentations(components: readonly StructureComponentRef[], pivot?: StructureRepresentationRef): undefined | Promise<void>
Parameters
- components: readonly StructureComponentRef[]
- Optional pivot: StructureRepresentationRef
Returns undefined | Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:39

selectThis

selectThis(components: readonly StructureComponentRef[]): void
Parameters
- components: readonly StructureComponentRef[]
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:35

setOptions

setOptions(options: <internal>.Values<{ clipObjects: <internal>.Group<Normalize<{ objects: Normalize<{ invert: any; position: any; rotation: any; scale: any; type: any }>[]; variant: <internal>.Variant }>>; ignoreLight: BooleanParam; interactions: <internal>.Group<Normalize<{ contacts: Normalize<{ lineOfSightDistFactor: any }>; providers: Normalize<{ cation-pi: any; halogen-bonds: any; hydrogen-bonds: any; hydrophobic: any; ionic: any; metal-coordination: any; pi-stacking: any; weak-hydrogen-bonds: any }> }>>; materialStyle: <internal>.Group<Normalize<{ bumpiness: number; metalness: number; roughness: number }>>; showHydrogens: BooleanParam; visualQuality: <internal>.Select<"auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"> }>): Promise<void>
Parameters
- options: <internal>.Values<{ clipObjects: <internal>.Group<Normalize<{ objects: Normalize<{ invert: any; position: any; rotation: any; scale: any; type: any }>[]; variant: <internal>.Variant }>>; ignoreLight: BooleanParam; interactions: <internal>.Group<Normalize<{ contacts: Normalize<{ lineOfSightDistFactor: any }>; providers: Normalize<{ cation-pi: any; halogen-bonds: any; hydrogen-bonds: any; hydrophobic: any; ionic: any; metal-coordination: any; pi-stacking: any; weak-hydrogen-bonds: any }> }>>; materialStyle: <internal>.Group<Normalize<{ bumpiness: number; metalness: number; roughness: number }>>; showHydrogens: BooleanParam; visualQuality: <internal>.Select<"auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"> }>
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:29

`Protected` subscribe

subscribe<T>(obs: Observable<T>, action: ((v: T) => void)): { unsubscribe: (() => void) }
Type Parameters
- T
Parameters
- obs: Observable<T>
- action: ((v: T) => void)
  - - (v: T): void
    - Parameters
      
      v: T
      
      Returns void
Returns { unsubscribe: (() => void) }
- unsubscribe: (() => void)
  - - (): void
    - Returns void
Inherited from StatefulPluginComponent.subscribe
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:11

toggleVisibility

toggleVisibility(components: readonly StructureComponentRef[], reprPivot?: StructureRepresentationRef): void
Parameters
- components: readonly StructureComponentRef[]
- Optional reprPivot: StructureRepresentationRef
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:38

updateLabel

updateLabel(component: StructureComponentRef, label: string): void
Parameters
- component: StructureComponentRef
- label: string
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:54

updateRepresentations

updateRepresentations(components: readonly StructureComponentRef[], pivot: StructureRepresentationRef, params: Normalize<{ colorTheme: NamedParams<any, string>; sizeTheme: NamedParams<any, string>; type: NamedParams<any, string> }>): Promise<void>
Parameters
- components: readonly StructureComponentRef[]
- pivot: StructureRepresentationRef
- params: Normalize<{ colorTheme: NamedParams<any, string>; sizeTheme: NamedParams<any, string>; type: NamedParams<any, string> }>
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:40

updateRepresentationsTheme

updateRepresentationsTheme<C, S>(components: readonly StructureComponentRef[], params: UpdateThemeParams<C, S>): undefined | Promise<any>
To update theme for all selected structures, use plugin.dataTransaction(async () => { for (const s of structure.hierarchy.selection.structures) await updateRepresentationsTheme(s.componets, ...); }, { canUndo: 'Update Theme' });
Type Parameters
- C extends "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"
- S extends "uniform" | "physical" | "shape-group" | "uncertainty"
Parameters
- components: readonly StructureComponentRef[]
- params: UpdateThemeParams<C, S>
Returns undefined | Promise<any>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:47
updateRepresentationsTheme<C, S>(components: readonly StructureComponentRef[], params: ((c: StructureComponentRef, r: StructureRepresentationRef) => UpdateThemeParams<C, S>)): undefined | Promise<any>
Type Parameters
- C extends "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"
- S extends "uniform" | "physical" | "shape-group" | "uncertainty"
Parameters
- components: readonly StructureComponentRef[]
- params: ((c: StructureComponentRef, r: StructureRepresentationRef) => UpdateThemeParams<C, S>)
  - - (c: StructureComponentRef, r: StructureRepresentationRef): UpdateThemeParams<C, S>
    - Parameters
      
      c: StructureComponentRef
      
      r: StructureRepresentationRef
      
      Returns UpdateThemeParams<C, S>
Returns undefined | Promise<any>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/component.d.ts:48

`Protected` updateState

updateState(...states: Partial<StructureComponentManagerState>[]): boolean
Parameters
- Rest ...states: Partial<StructureComponentManagerState>[]
Returns boolean
Inherited from StatefulPluginComponent.updateState
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:19

Class StructureComponentManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns StructureComponentManager

Properties

Private clearComponents

Readonly events

Type declaration

optionsUpdated: Subject<undefined>

Private modifyComponent

plugin

Private syncPreset

Private tryFindComponent

Private updateInterationProps

Private updateReprParams

Accessors

currentStructures

Returns readonly StructureRef[]

Private dataState

Returns any

Protected ev

Returns RxEventHelper

pivotStructure

Returns undefined | StructureRef

state

Returns State

Methods

add

Parameters

params: AddParams

Optional structures: readonly StructureRef[]

Returns Promise<void>

addRepresentation

Parameters

components: readonly StructureComponentRef[]

type: string

Returns undefined | Promise<void>

applyPreset

Type Parameters

P extends <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result, P>

Parameters

structures: readonly StructureRef[]

provider: P

Optional params: <internal>.Params<P>

Returns Promise<any>

applyTheme

Parameters

Optional structures: readonly StructureRef[]

Returns Promise<void>

canBeModified

Parameters

ref: StructureHierarchyRef

Returns boolean

clear

Parameters

structures: readonly StructureRef[]

Returns Promise<void>

dispose

Returns void

modifyByCurrentSelection

Parameters

components: readonly StructureComponentRef[]

action: ModifyAction

Returns Promise<void>

removeRepresentations

Parameters

components: readonly StructureComponentRef[]

Optional pivot: StructureRepresentationRef

Returns undefined | Promise<void>

selectThis

Parameters

components: readonly StructureComponentRef[]

`Private` clearComponents

`Readonly` events

`Private` modifyComponent

`Private` syncPreset

`Private` tryFindComponent

`Private` updateInterationProps

`Private` updateReprParams

`Private` dataState

`Protected` ev

`Optional` structures: readonly StructureRef[]

`Optional` params: <internal>.Params<P>

`Optional` structures: readonly StructureRef[]

`Optional` pivot: StructureRepresentationRef

`Protected` subscribe

`Optional` reprPivot: StructureRepresentationRef

`Protected` updateState

`Rest` ...states: Partial<StructureComponentManagerState>[]