Interface Definition<A, T, P>

Type Parameters

A extends StateObject = StateObject
T = any
P extends {} = {}

Hierarchy

<internal>.StateAction.DefinitionBase<A, T, P>
- Definition

Index

Properties

Methods

isApplicable? params? run

Properties

`Readonly` display

display: { description?: string; name: string }

Type declaration

Optional Readonly description?: string
Readonly name: string

`Readonly` from

from: <internal>.StateObject.Ctor<StateObject<any, <internal>.StateObject.Type<any>>>[]

Methods

`Optional` isApplicable

isApplicable(a: A, aTransform: <internal>.Transform<<internal>.Transformer<any, A, any>>, globalCtx: unknown): boolean
Test if the transform can be applied to a given node
Parameters
- a: A
- aTransform: <internal>.Transform<<internal>.Transformer<any, A, any>>
- globalCtx: unknown
Returns boolean
Inherited from DefinitionBase.isApplicable
- Defined in node_modules/molstar/lib/mol-state/action.d.ts:47

`Optional` params

params(a: A, globalCtx: unknown): { [ K in string | number | symbol]: <internal>.Any }
Parameters
- a: A
- globalCtx: unknown
Returns { [ K in string | number | symbol]: <internal>.Any }
- Defined in node_modules/molstar/lib/mol-state/action.d.ts:55

run

run(params: <internal>.StateAction.ApplyParams<A, P>, globalCtx: unknown): T | Task<T>
Apply an action that modifies the State specified in Params.
Parameters
- params: <internal>.StateAction.ApplyParams<A, P>
- globalCtx: unknown
Returns T | Task<T>
Inherited from DefinitionBase.run
- Defined in node_modules/molstar/lib/mol-state/action.d.ts:45

Generated using TypeDoc