Class PluginState

Hierarchy

PluginComponent
- PluginState

Index

Constructors

constructor

new PluginState(plugin: PluginContext): PluginState
Parameters
- plugin: PluginContext
Returns PluginState
Overrides PluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:70

Properties

`Readonly` behaviors

behaviors: <internal>.State

`Readonly` data

data: <internal>.State

`Readonly` events

Type declaration

Readonly cell: { created: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>; removed: Observable<<internal>.State.ObjectEvent & { parent: string }>; stateUpdated: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }> }
- Readonly created: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>
- Readonly removed: Observable<<internal>.State.ObjectEvent & { parent: string }>
- Readonly stateUpdated: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>
Readonly object: { created: Observable<<internal>.State.ObjectEvent & { obj: StateObject<any, <internal>.StateObject.Type<any>> }>; removed: Observable<<internal>.State.ObjectEvent & { obj?: StateObject<any, <internal>.StateObject.Type<any>> }>; updated: Observable<<internal>.State.ObjectEvent & { action: "in-place" | "recreate"; obj: StateObject<any, <internal>.StateObject.Type<any>>; oldData?: any; oldObj?: StateObject<any, <internal>.StateObject.Type<any>> }> }
- Readonly created: Observable<<internal>.State.ObjectEvent & { obj: StateObject<any, <internal>.StateObject.Type<any>> }>
- Readonly removed: Observable<<internal>.State.ObjectEvent & { obj?: StateObject<any, <internal>.StateObject.Type<any>> }>
- Readonly updated: Observable<<internal>.State.ObjectEvent & { action: "in-place" | "recreate"; obj: StateObject<any, <internal>.StateObject.Type<any>>; oldData?: any; oldObj?: StateObject<any, <internal>.StateObject.Type<any>> }>

`Private` plugin

plugin: any

setSnapshotParams

setSnapshotParams: ((params?: Partial<<internal>.Values<{ animation: BooleanParam; behavior: BooleanParam; camera: BooleanParam; cameraTransition: <internal>.Mapped<NamedParams<Normalize<{ durationInMs: number }>, "animate"> | NamedParams<Normalize<unknown>, "instant">>; canvas3d: BooleanParam; componentManager: BooleanParam; data: BooleanParam; durationInMs: <internal>.Numeric; interactivity: BooleanParam; startAnimation: BooleanParam }>>) => void)

Type declaration

- (params?: Partial<<internal>.Values<{ animation: BooleanParam; behavior: BooleanParam; camera: BooleanParam; cameraTransition: <internal>.Mapped<NamedParams<Normalize<{ durationInMs: number }>, "animate"> | NamedParams<Normalize<unknown>, "instant">>; canvas3d: BooleanParam; componentManager: BooleanParam; data: BooleanParam; durationInMs: <internal>.Numeric; interactivity: BooleanParam; startAnimation: BooleanParam }>>): void
- Parameters
  - Optional params: Partial<<internal>.Values<{ animation: BooleanParam; behavior: BooleanParam; camera: BooleanParam; cameraTransition: <internal>.Mapped<NamedParams<Normalize<{ durationInMs: number }>, "animate"> | NamedParams<Normalize<unknown>, "instant">>; canvas3d: BooleanParam; componentManager: BooleanParam; data: BooleanParam; durationInMs: <internal>.Numeric; interactivity: BooleanParam; startAnimation: BooleanParam }>>
  Returns void

`Readonly` snapshotParams

snapshotParams: BehaviorSubject<Partial<<internal>.Values<{ animation: BooleanParam; behavior: BooleanParam; camera: BooleanParam; cameraTransition: <internal>.Mapped<NamedParams<Normalize<unknown>, "instant"> | NamedParams<Normalize<{ durationInMs: number }>, "animate">>; canvas3d: BooleanParam; componentManager: BooleanParam; data: BooleanParam; durationInMs: <internal>.Numeric; interactivity: BooleanParam; startAnimation: BooleanParam }>>>

Accessors

`Private` animation

get animation(): any
Returns any
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:20

`Protected` ev

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

Methods

dispose

dispose(): void
Returns void
Overrides PluginComponent.dispose
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:69

getSnapshot

getSnapshot(params?: Partial<<internal>.Values<{ animation: BooleanParam; behavior: BooleanParam; camera: BooleanParam; cameraTransition: <internal>.Mapped<NamedParams<Normalize<{ durationInMs: number }>, "animate"> | NamedParams<Normalize<unknown>, "instant">>; canvas3d: BooleanParam; componentManager: BooleanParam; data: BooleanParam; durationInMs: <internal>.Numeric; interactivity: BooleanParam; startAnimation: BooleanParam }>>): <internal>.PluginState.Snapshot
Parameters
- Optional params: Partial<<internal>.Values<{ animation: BooleanParam; behavior: BooleanParam; camera: BooleanParam; cameraTransition: <internal>.Mapped<NamedParams<Normalize<{ durationInMs: number }>, "animate"> | NamedParams<Normalize<unknown>, "instant">>; canvas3d: BooleanParam; componentManager: BooleanParam; data: BooleanParam; durationInMs: <internal>.Numeric; interactivity: BooleanParam; startAnimation: BooleanParam }>>
Returns <internal>.PluginState.Snapshot
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:65

setSnapshot

setSnapshot(snapshot: <internal>.PluginState.Snapshot): Promise<void>
Parameters
- snapshot: <internal>.PluginState.Snapshot
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:66

`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

updateBehavior

updateBehavior<T>(behavior: T, params: ((old: <internal>.Transformer.Params<T>) => void | <internal>.Transformer.Params<T>)): Promise<void>
Type Parameters
- T extends <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any, T>
Parameters
- behavior: T
- params: ((old: <internal>.Transformer.Params<T>) => void | <internal>.Transformer.Params<T>)
  - - (old: <internal>.Transformer.Params<T>): void | <internal>.Transformer.Params<T>
    - Parameters
      
      old: <internal>.Transformer.Params<T>
      
      Returns void | <internal>.Transformer.Params<T>
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:68

updateTransform

updateTransform(state: <internal>.State, a: string, params: any, canUndo?: string | boolean): Promise<void>
Parameters
- state: <internal>.State
- a: string
- params: any
- Optional canUndo: string | boolean
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin/state.d.ts:67

Class PluginState

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns PluginState

Properties

Readonly behaviors

Readonly data

Readonly events

Type declaration

Readonly created: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>

Readonly removed: Observable<<internal>.State.ObjectEvent & { parent: string }>

Readonly stateUpdated: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>

Readonly created: Observable<<internal>.State.ObjectEvent & { obj: StateObject<any, <internal>.StateObject.Type<any>> }>

Readonly removed: Observable<<internal>.State.ObjectEvent & { obj?: StateObject<any, <internal>.StateObject.Type<any>> }>

Readonly updated: Observable<<internal>.State.ObjectEvent & { action: "in-place" | "recreate"; obj: StateObject<any, <internal>.StateObject.Type<any>>; oldData?: any; oldObj?: StateObject<any, <internal>.StateObject.Type<any>> }>

Private plugin

setSnapshotParams

Type declaration

Parameters

Returns void

Readonly snapshotParams

Accessors

Private animation

Returns any

Protected ev

Returns RxEventHelper

Methods

dispose

Returns void

getSnapshot

Parameters

Returns <internal>.PluginState.Snapshot

setSnapshot

Parameters

snapshot: <internal>.PluginState.Snapshot

Returns 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

updateBehavior

Type Parameters

T extends <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any, T>

Parameters

behavior: T

params: ((old: <internal>.Transformer.Params<T>) => void | <internal>.Transformer.Params<T>)

Parameters

old: <internal>.Transformer.Params<T>

Returns void | <internal>.Transformer.Params<T>

Returns Promise<void>

updateTransform

Parameters

state: <internal>.State

a: string

params: any

Optional canUndo: string | boolean

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` behaviors

`Readonly` data

`Readonly` events

`Readonly` created: Observable<<internal>.State.ObjectEvent & { cell: StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>> }>

`Readonly` removed: Observable<<internal>.State.ObjectEvent & { parent: string }>

`Readonly` created: Observable<<internal>.State.ObjectEvent & { obj: StateObject<any, <internal>.StateObject.Type<any>> }>

`Readonly` removed: Observable<<internal>.State.ObjectEvent & { obj?: StateObject<any, <internal>.StateObject.Type<any>> }>

`Readonly` updated: Observable<<internal>.State.ObjectEvent & { action: "in-place" | "recreate"; obj: StateObject<any, <internal>.StateObject.Type<any>>; oldData?: any; oldObj?: StateObject<any, <internal>.StateObject.Type<any>> }>

`Private` plugin

`Readonly` snapshotParams

`Private` animation

`Protected` ev

`Protected` subscribe

`Optional` canUndo: string | boolean