Class StructureHierarchyManager

Hierarchy

PluginComponent
- StructureHierarchyManager

Index

Constructors

constructor

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

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
Returns <internal>.StructureHierarchy
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:28

currentComponentGroups

get currentComponentGroups(): StructureComponentRef[][]
Returns StructureComponentRef[][]
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:25

`Private` dataState

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

`Protected` ev

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

selection

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

seletionSet

get seletionSet(): Set<string>
Returns Set<string>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:27

Methods

applyPreset

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

dispose

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

findStructure

findStructure(structure: undefined | <internal>.Structure): undefined | StructureRef
Parameters
- structure: undefined | <internal>.Structure
Returns undefined | StructureRef
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/hierarchy.d.ts:35

getStructuresWithSelection

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

remove

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

`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 PluginComponent.subscribe
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:11

toggleVisibility

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

updateCurrent

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

updateStructure

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

Class StructureHierarchyManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns StructureHierarchyManager

Properties

Private _currentComponentGroups

Private _currentSelectionSet

Readonly behaviors

Type declaration

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

Private clearTrajectory

Private plugin

Private state

Private sync

Private syncCurrent

Accessors

current

Returns <internal>.StructureHierarchy

currentComponentGroups

Returns StructureComponentRef[][]

Private dataState

Returns any

Protected ev

Returns RxEventHelper

selection

Returns { models: readonly ModelRef[]; structures: readonly StructureRef[]; trajectories: readonly TrajectoryRef[] }

models: readonly ModelRef[]

structures: readonly StructureRef[]

trajectories: readonly TrajectoryRef[]

seletionSet

Returns Set<string>

Methods

applyPreset

Type Parameters

P = any

S = {}

Parameters

trajectories: readonly TrajectoryRef[]

provider: <internal>.TrajectoryHierarchyPresetProvider<P, S>

Optional params: P

Returns Promise<any>

dispose

Returns void

findStructure

Parameters

structure: undefined | <internal>.Structure

Returns undefined | StructureRef

getStructuresWithSelection

Returns StructureRef[]

remove

Parameters

refs: (string | StructureHierarchyRef)[]

Optional canUndo: boolean

Returns undefined | Promise<void>

Protected subscribe

Type Parameters

T

Parameters

obs: Observable<T>

action: ((v: T) => void)

Parameters

v: T

Returns void

Returns { unsubscribe: (() => void) }

unsubscribe: (() => void)

Returns void

toggleVisibility

Parameters

refs: readonly StructureHierarchyRef[]

Optional action: "hide" | "show"

Returns void

updateCurrent

`Private` _currentComponentGroups

`Private` _currentSelectionSet

`Readonly` behaviors

`Private` clearTrajectory

`Private` plugin

`Private` state

`Private` sync

`Private` syncCurrent

`Private` dataState

`Protected` ev

`Optional` params: P

`Optional` canUndo: boolean

`Protected` subscribe

`Optional` action: "hide" | "show"