Class PluginStateSnapshotManager

Hierarchy

StatefulPluginComponent<{ current?: UUID; entries: <internal>.List<<internal>.PluginStateSnapshotManager.Entry>; isPlaying: boolean; nextSnapshotDelayInMs: number }>
- PluginStateSnapshotManager

Index

Constructors

constructor

new PluginStateSnapshotManager(plugin: PluginContext): PluginStateSnapshotManager
Parameters
- plugin: PluginContext
Returns PluginStateSnapshotManager
Overrides StatefulPluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:52

Properties

`Private` entryMap

entryMap: any

`Readonly` events

events: { changed: Subject<unknown> }

Type declaration

changed: Subject<unknown>

`Private` next

next: any

`Private` plugin

plugin: any

`Private` syncCurrent

syncCurrent: any

`Private` timeoutHandle

timeoutHandle: any

`Static` DefaultNextSnapshotDelayInMs

DefaultNextSnapshotDelayInMs: number

Accessors

`Protected` ev

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

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(e: <internal>.PluginStateSnapshotManager.Entry): void
Parameters
- e: <internal>.PluginStateSnapshotManager.Entry
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:28

clear

clear(): void
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:31

dispose

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

getEntry

getEntry(id: undefined | string): undefined | <internal>.PluginStateSnapshotManager.Entry
Parameters
- id: undefined | string
Returns undefined | <internal>.PluginStateSnapshotManager.Entry
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:26

getIndex

getIndex(e: <internal>.PluginStateSnapshotManager.Entry): number
Parameters
- e: <internal>.PluginStateSnapshotManager.Entry
Returns number
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:25

getNextId

getNextId(id: undefined | string, dir: 1 | -1): undefined | UUID
Parameters
- id: undefined | string
- dir: 1 | -1
Returns undefined | UUID
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:33

getStateSnapshot

getStateSnapshot(options?: { description?: string; name?: string; 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 }>>; playOnLoad?: boolean }): StateSnapshot
Parameters
- Optional options: { description?: string; name?: string; 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 }>>; playOnLoad?: boolean }
  - Optional description?: string
  - Optional name?: string
  - 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 }>>
  - Optional playOnLoad?: boolean
Returns StateSnapshot
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:36

move

move(id: string, dir: 1 | -1): void
Parameters
- id: string
- dir: 1 | -1
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:30

open

open(file: <internal>.File): Promise<undefined | <internal>.PluginState.Snapshot>
Parameters
- file: <internal>.File
Returns Promise<undefined | <internal>.PluginState.Snapshot>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:46

play

play(delayFirst?: boolean): void
Parameters
- Optional delayFirst: boolean
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:49

remove

remove(id: string): void
Parameters
- id: string
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:27

replace

replace(id: string, snapshot: <internal>.PluginState.Snapshot): void
Parameters
- id: string
- snapshot: <internal>.PluginState.Snapshot
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:29

serialize

serialize(options?: { 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 }>>; type: "json" | "zip" | "molj" | "molx" }): Promise<Blob>
Parameters
- Optional options: { 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 }>>; type: "json" | "zip" | "molj" | "molx" }
  - 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 }>>
  - type: "json" | "zip" | "molj" | "molx"
Returns Promise<Blob>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:42

setCurrent

setCurrent(id: string): undefined | <internal>.PluginState.Snapshot
Parameters
- id: string
Returns undefined | <internal>.PluginState.Snapshot
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:32

setStateSnapshot

setStateSnapshot(snapshot: StateSnapshot): Promise<undefined | <internal>.PluginState.Snapshot>
Parameters
- snapshot: StateSnapshot
Returns Promise<undefined | <internal>.PluginState.Snapshot>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:34

stop

stop(): void
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:50

`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

togglePlay

togglePlay(): void
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/snapshots.d.ts:51

`Protected` updateState

updateState(...states: Partial<{ current?: UUID; entries: <internal>.List<<internal>.PluginStateSnapshotManager.Entry>; isPlaying: boolean; nextSnapshotDelayInMs: number }>[]): boolean
Parameters
- Rest ...states: Partial<{ current?: UUID; entries: <internal>.List<<internal>.PluginStateSnapshotManager.Entry>; isPlaying: boolean; nextSnapshotDelayInMs: number }>[]
Returns boolean
Inherited from StatefulPluginComponent.updateState
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:19

Class PluginStateSnapshotManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns PluginStateSnapshotManager

Properties

Private entryMap

Readonly events

Type declaration

changed: Subject<unknown>

Private next

Private plugin

Private syncCurrent

Private timeoutHandle

Static DefaultNextSnapshotDelayInMs

Accessors

Protected ev

Returns RxEventHelper

state

Returns State

Methods

add

Parameters

e: <internal>.PluginStateSnapshotManager.Entry

Returns void

clear

Returns void

dispose

Returns void

getEntry

Parameters

id: undefined | string

Returns undefined | <internal>.PluginStateSnapshotManager.Entry

getIndex

Parameters

e: <internal>.PluginStateSnapshotManager.Entry

Returns number

getNextId

Parameters

id: undefined | string

dir: 1 | -1

Returns undefined | UUID

getStateSnapshot

Parameters

Optional description?: string

Optional name?: string

Optional playOnLoad?: boolean

Returns StateSnapshot

move

Parameters

id: string

dir: 1 | -1

Returns void

open

Parameters

file: <internal>.File

Returns Promise<undefined | <internal>.PluginState.Snapshot>

play

Parameters

Optional delayFirst: boolean

Returns void

remove

Parameters

id: string

Returns void

replace

Parameters

id: string

snapshot: <internal>.PluginState.Snapshot

Returns void

serialize

Parameters

type: "json" | "zip" | "molj" | "molx"

`Private` entryMap

`Readonly` events

`Private` next

`Private` plugin

`Private` syncCurrent

`Private` timeoutHandle

`Static` DefaultNextSnapshotDelayInMs

`Protected` ev

`Optional` description?: string

`Optional` name?: string

`Optional` playOnLoad?: boolean

`Optional` delayFirst: boolean

`Protected` subscribe

`Protected` updateState

`Rest` ...states: Partial<{ current?: UUID; entries: <internal>.List<<internal>.PluginStateSnapshotManager.Entry>; isPlaying: boolean; nextSnapshotDelayInMs: number }>[]