Class Root

Hierarchy

Root

Implements

<internal>.StateBuilder

Index

Constructors

constructor

new Root(tree: StateTree, state?: <internal>.State): <internal>.Root
Parameters
- tree: StateTree
- Optional state: <internal>.State
Returns <internal>.Root
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:59

Properties

`Private` state

state: any

Accessors

currentTree

get currentTree(): TransientTree
Returns TransientTree
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:50

editInfo

get editInfo(): <internal>.StateBuilder.EditInfo
Returns <internal>.StateBuilder.EditInfo
Implementation of StateBuilder.editInfo
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:49

Methods

commit

commit(options?: Partial<<internal>.State.UpdateOptions>): Promise<void>
Parameters
- Optional options: Partial<<internal>.State.UpdateOptions>
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:58

delete

delete(obj: StateObjectRef<StateObject<any, <internal>.StateObject.Type<any>>>): <internal>.Root
Parameters
- obj: StateObjectRef<StateObject<any, <internal>.StateObject.Type<any>>>
Returns <internal>.Root
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:56

getTree

getTree(): StateTree
Returns StateTree
Implementation of StateBuilder.getTree
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:57

to

to<A, T>(ref: string): <internal>.StateBuilder.To<A, T>
Type Parameters
- A extends StateObject<any, <internal>.StateObject.Type<any>, A>
- T extends <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any, T>
Parameters
- ref: string
Returns <internal>.StateBuilder.To<A, T>
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:51
to<A, T>(ref: StateObjectRef<A>): <internal>.StateBuilder.To<A, T>
Type Parameters
- A extends StateObject<any, <internal>.StateObject.Type<any>, A>
- T extends <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any, T>
Parameters
- ref: StateObjectRef<A>
Returns <internal>.StateBuilder.To<A, T>
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:52
to<C>(cell: C): <internal>.StateBuilder.To<<internal>.StateObjectCell.Obj<C>, <internal>.StateObjectCell.Transformer<C>>
Type Parameters
- C extends StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, C>
Parameters
- cell: C
Returns <internal>.StateBuilder.To<<internal>.StateObjectCell.Obj<C>, <internal>.StateObjectCell.Transformer<C>>
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:53
to<S>(selector: S): <internal>.StateBuilder.To<<internal>.Obj<S>, <internal>.Transformer<S>>
Type Parameters
- S extends StateObjectSelector<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>, S>
Parameters
- selector: S
Returns <internal>.StateBuilder.To<<internal>.Obj<S>, <internal>.Transformer<S>>
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:54

toRoot

toRoot<A>(): <internal>.StateBuilder.To<A, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
Type Parameters
- A extends StateObject<any, <internal>.StateObject.Type<any>, A>
Returns <internal>.StateBuilder.To<A, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
- Defined in node_modules/molstar/lib/mol-state/state/builder.d.ts:55

Class Root

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

tree: StateTree

Optional state: <internal>.State

Returns <internal>.Root

Properties

Private state

Accessors

currentTree

Returns TransientTree

editInfo

Returns <internal>.StateBuilder.EditInfo

Methods

commit

Parameters

Optional options: Partial<<internal>.State.UpdateOptions>

Returns Promise<void>

delete

Parameters

obj: StateObjectRef<StateObject<any, <internal>.StateObject.Type<any>>>

Returns <internal>.Root

getTree

Returns StateTree

to

Type Parameters

A extends StateObject<any, <internal>.StateObject.Type<any>, A>

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

Parameters

ref: string

Returns <internal>.StateBuilder.To<A, T>

Type Parameters

A extends StateObject<any, <internal>.StateObject.Type<any>, A>

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

Parameters

ref: StateObjectRef<A>

Returns <internal>.StateBuilder.To<A, T>

Type Parameters

C extends StateObjectCell<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, C>

Parameters

cell: C

Returns <internal>.StateBuilder.To<<internal>.StateObjectCell.Obj<C>, <internal>.StateObjectCell.Transformer<C>>

Type Parameters

S extends StateObjectSelector<StateObject<any, <internal>.StateObject.Type<any>>, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>, S>

Parameters

selector: S

Returns <internal>.StateBuilder.To<<internal>.Obj<S>, <internal>.Transformer<S>>

toRoot

Type Parameters

A extends StateObject<any, <internal>.StateObject.Type<any>, A>

Returns <internal>.StateBuilder.To<A, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

Settings

Member Visibility

Theme

`Optional` state: <internal>.State

`Private` state

`Optional` options: Partial<<internal>.State.UpdateOptions>