StateTree | @rcsb/rcsb-saguaro-3d

Index

Interfaces

Functions

create

create(nodes: Transforms, children: Children, dependencies: Dependencies): StateTree

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:48
Parameters
- nodes: Transforms
- children: Children
- dependencies: Dependencies
Returns StateTree

createEmpty

createEmpty(customRoot?: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>): StateTree

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:47
Create an instance of an immutable tree.

Parameters
- Optional customRoot: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
Returns StateTree

doPostOrder

doPostOrder<S>(tree: StateTree, root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, state: S, f: (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S) => undefined | boolean | void): S

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:52
Visit all nodes in a subtree in "post order", meaning leafs get visited first.

Type parameters
- S
Parameters
- tree: StateTree
- root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
- state: S
- f: (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S) => undefined | boolean | void
  - - (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S): undefined | boolean | void
    - Parameters
      - node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
      - tree: StateTree
      - state: S
      Returns undefined | boolean | void
Returns S

doPreOrder

doPreOrder<S>(tree: StateTree, root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, state: S, f: (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S) => undefined | boolean | void): S

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:57
Visit all nodes in a subtree in "pre order", meaning leafs get visited last. If the visitor function returns false, the visiting for that branch is interrupted.

Type parameters
- S
Parameters
- tree: StateTree
- root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
- state: S
- f: (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S) => undefined | boolean | void
  - - (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S): undefined | boolean | void
    - Parameters
      - node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
      - tree: StateTree
      - state: S
      Returns undefined | boolean | void
Returns S

dump

dump(tree: StateTree): void

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:68
Parameters
- tree: StateTree
Returns void

fromJSON

fromJSON(data: <internal>.StateTree.Serialized): StateTree

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:67
Parameters
- data: <internal>.StateTree.Serialized
Returns StateTree

getDecoratorRoot

getDecoratorRoot(tree: StateTree, ref: string): <internal>.Transform.Ref

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:71
Parameters
- tree: StateTree
- ref: string
Returns <internal>.Transform.Ref

subtreeHasRef

subtreeHasRef(tree: StateTree, root: string, ref: string): boolean

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:70
Check if the subtree with the given root has the provided ref

Parameters
- tree: StateTree
- root: string
- ref: string
Returns boolean

subtreePostOrder

subtreePostOrder(tree: StateTree, root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>): <internal>.Transform<"/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-state/transformer">[]

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:61
Get all nodes in a subtree, leafs come first.

Parameters
- tree: StateTree
- root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
Returns <internal>.Transform<"/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-state/transformer">[]

toJSON

toJSON(tree: StateTree): <internal>.StateTree.Serialized

- Defined in node_modules/molstar/lib/mol-state/tree/immutable.d.ts:66
Parameters
- tree: StateTree
Returns <internal>.StateTree.Serialized

Index

Interfaces

Functions

Functions

create

Parameters

nodes: Transforms

children: Children

dependencies: Dependencies

Returns StateTree

createEmpty

Parameters

Optional customRoot: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

Returns StateTree

doPostOrder

Type parameters

S

Parameters

tree: StateTree

root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

state: S

f: (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S) => undefined | boolean | void

Parameters

node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

tree: StateTree

state: S

Returns undefined | boolean | void

Returns S

doPreOrder

Type parameters

S

Parameters

tree: StateTree

root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

state: S

f: (node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>, tree: StateTree, state: S) => undefined | boolean | void

Parameters

node: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

tree: StateTree

state: S

Returns undefined | boolean | void

Returns S

dump

Parameters

tree: StateTree

Returns void

fromJSON

Parameters

data: <internal>.StateTree.Serialized

Returns StateTree

getDecoratorRoot

Parameters

tree: StateTree

ref: string

Returns <internal>.Transform.Ref

subtreeHasRef

Parameters

tree: StateTree

root: string

ref: string

Returns boolean

subtreePostOrder

Parameters

tree: StateTree

root: <internal>.Transform<<internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

Returns <internal>.Transform<"/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-state/transformer">[]

toJSON

Parameters

tree: StateTree

Returns <internal>.StateTree.Serialized