Class StructureHierarchyManager

Hierarchy

PluginComponent
- StructureHierarchyManager

Index

Constructors

constructor

new StructureHierarchyManager(plugin: PluginContext): StructureHierarchyManager

Overrides PluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:42
Parameters
- plugin: PluginContext
Returns StructureHierarchyManager

Properties

Private _currentComponentGroups

_currentComponentGroups: any

Private _currentSelectionSet

_currentSelectionSet: any

Readonly behaviors

behaviors: { selection: BehaviorSubject<{ hierarchy: <internal>.StructureHierarchy; models: readonly ModelRef[]; structures: readonly StructureRef[]; trajectories: readonly TrajectoryRef[] }> }

Type declaration

selection: BehaviorSubject<{ hierarchy: <internal>.StructureHierarchy; models: readonly ModelRef[]; structures: readonly StructureRef[]; trajectories: readonly TrajectoryRef[] }>

Private clearTrajectory

clearTrajectory: any

Private plugin

plugin: any

Private state

state: any

Private sync

sync: any

Private syncCurrent

syncCurrent: any

Accessors

current

get current(): <internal>.StructureHierarchy

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:27
Returns <internal>.StructureHierarchy

currentComponentGroups

get currentComponentGroups(): StructureComponentRef[][]

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:24
Returns StructureComponentRef[][]

Private dataState

get dataState(): any

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:22
Returns any

Protected ev

get ev(): RxEventHelper

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

selection

get selection(): { models: readonly ModelRef[]; structures: readonly StructureRef[]; trajectories: readonly TrajectoryRef[] }

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:28
Returns { models: readonly ModelRef[]; structures: readonly StructureRef[]; trajectories: readonly TrajectoryRef[] }
- models: readonly ModelRef[]
- structures: readonly StructureRef[]
- trajectories: readonly TrajectoryRef[]

seletionSet

get seletionSet(): Set<string>

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:26
Returns Set<string>

Methods

applyPreset

applyPreset<P, S>(trajectories: readonly TrajectoryRef[], provider: <internal>.TrajectoryHierarchyPresetProvider<P, S>, params?: P): Promise<any>

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:39
Type parameters
- P = any
- S = {}
Parameters
- trajectories: readonly TrajectoryRef[]
- provider: <internal>.TrajectoryHierarchyPresetProvider<P, S>
- Optional params: P
Returns Promise<any>

dispose

dispose(): void

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

getStructuresWithSelection

getStructuresWithSelection(): StructureRef[]

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:33
Returns StructureRef[]

remove

remove(refs: (string | StructureHierarchyRef)[], canUndo?: boolean): undefined | Promise<void>

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:37
Parameters
- refs: (string | StructureHierarchyRef)[]
- Optional canUndo: boolean
Returns undefined | Promise<void>

Protected subscribe

subscribe<T>(obs: Observable<T>, action: (v: T) => void): { unsubscribe: any }

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

toggleVisibility

toggleVisibility(refs: readonly StructureHierarchyRef[], action?: "hide" | "show"): void

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:38
Parameters
- refs: readonly StructureHierarchyRef[]
- Optional action: "hide" | "show"
Returns void

updateCurrent

updateCurrent(refs: StructureHierarchyRef[], action: "add" | "remove"): void

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:36
Parameters
- refs: StructureHierarchyRef[]
- action: "add" | "remove"
Returns void

updateStructure

updateStructure(s: StructureRef, params: any): Promise<void>

- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:40
Parameters
- s: StructureRef
- params: any
Returns Promise<void>

Generated using TypeDoc