Class EndableActionEditor<T>

A factory that assists in editing an endable action

Type Parameters

T extends IEndableActionConfiguration = IEndableActionConfiguration

Hierarchy (View Summary)

ActionEditor<T>
- EndableActionEditor
  - TimelineActionEditor

Index

Constructors

constructor

new EndableActionEditor<
    T extends IEndableActionConfiguration = IEndableActionConfiguration,
>(
    actionConfig: T,
    configurationFactory: ConfigurationFactory,
): EndableActionEditor<T>
Type Parameters
- T extends IEndableActionConfiguration = IEndableActionConfiguration
Parameters
- actionConfig: T
- configurationFactory: ConfigurationFactory
Returns EndableActionEditor<T>
Inherited from ActionEditor.constructor
- Defined in configuration/api/action-editor.ts:36

Properties

`Protected`actionConfig

actionConfig: T

`Protected` `Readonly`configurationFactory

configurationFactory: ConfigurationFactory

Methods

addEndOperation

addEndOperation<
    T extends
        | "forEach"
        | "animate"
        | "removeClass"
        | "endForEach"
        | "log"
        | "when"
        | "endWhen"
        | "otherwise"
        | "addClass"
        | "addControllerToElement"
        | "addGlobalsToOperation"
        | "animateWithClass"
        | "breakForEach"
        | "broadcastEvent"
        | "calc"
        | "clearElement"
        | "clearOperationData"
        | "continueForEach"
        | "createElement"
        | "customFunction"
        | "endAction"
        | "extendController"
        | "getAttributesFromElement"
        | "getControllerFromElement"
        | "getControllerInstance"
        | "getElementDimensions"
        | "getImport"
        | "getQueryParams"
        | "invokeObjectMethod"
        | "loadJson"
        | "math"
        | "removeControllerFromElement"
        | "removeElement"
        | "removePropertiesFromOperationData"
        | "reparentElement"
        | "requestAction"
        | "selectElement"
        | "setData"
        | "setElementAttributes"
        | "setElementContent"
        | "setGlobalData"
        | "setOperationData"
        | "setStyle"
        | "setVariable"
        | "startAction"
        | "toggleClass"
        | "toggleElement"
        | "wait",
    O extends Partial<ExtractOperationDataType<GetOperationByName<T>>>,
>(
    systemName:
        | "forEach"
        | "animate"
        | "removeClass"
        | "endForEach"
        | "log"
        | "when"
        | "endWhen"
        | "otherwise"
        | "addClass"
        | "addControllerToElement"
        | "addGlobalsToOperation"
        | "animateWithClass"
        | "breakForEach"
        | "broadcastEvent"
        | "calc"
        | "clearElement"
        | "clearOperationData"
        | "continueForEach"
        | "createElement"
        | "customFunction"
        | "endAction"
        | "extendController"
        | "getAttributesFromElement"
        | "getControllerFromElement"
        | "getControllerInstance"
        | "getElementDimensions"
        | "getImport"
        | "getQueryParams"
        | "invokeObjectMethod"
        | "loadJson"
        | "math"
        | "removeControllerFromElement"
        | "removeElement"
        | "removePropertiesFromOperationData"
        | "reparentElement"
        | "requestAction"
        | "selectElement"
        | "setData"
        | "setElementAttributes"
        | "setElementContent"
        | "setGlobalData"
        | "setOperationData"
        | "setStyle"
        | "setVariable"
        | "startAction"
        | "toggleClass"
        | "toggleElement"
        | "wait",
    operationData: O,
): OperationEditor<
    EndableActionEditor<T>,

        | TOperation<IAddClassOperationData>
        | TOperation<IAddControllerToElementOperationData<TOperationData>>
        | TOperation<IAddGlobalsToOperationData>
        | TOperation<IAnimateOperationData>
        | TOperation<
            IAnimateWithClassOperationData,
            Promise<IAnimateWithClassOperationData>,
        >
        | TOperation<TOperationData>
        | TOperation<IForEachOperationData>
        | TOperation<IBroadcastEventOperationData>
        | TOperation<ICalcOperationData>
        | TOperation<IClearElementOperationData>
        | TOperation<IClearOperationDataOperationData>
        | TOperation<
            ICreateElementOperationData<keyof HTMLElementTagNameMap>,
            RequireKeys<
                ICreateElementOperationData<keyof HTMLElementTagNameMap>,
                "template",
            >,
        >
        | TOperation<ICustomFunctionOperationData>
        | TOperation<IEndActionOperationData>
        | TOperation<Record<string, unknown>>
        | TOperation<IExtendControllerOperationData>
        | TOperation<IGetAttributesFromElementOperationData>
        | TOperation<IGetControllerFromElementOperationData>
        | TOperation<IGetControllerInstanceOperationData>
        | TOperation<IGetElementDimensionsOperationData>
        | TOperation<
            IGetImportOperationData,
            Omit<
                RequireKeys<IGetImportOperationData, "importedInstance">,
                "systemName",
            >,
        >
        | TOperation<IGetQueryParamsOperationData>
        | TOperation<
            IInvokeObjectMethodOperationData,
            Omit<IInvokeObjectMethodOperationData, "methodName" | "methodArguments">,
        >
        | TOperation<ILoadJSONOperationData>
        | TOperation<ILogOperationData>
        | TOperation<
            IMathOperationData,
            Omit<IMathOperationData, "args" | "functionName">,
        >
        | TOperation<IRemoveClassOperationData>
        | TOperation<IRemoveControllerFromElementOperationData>
        | TOperation<IRemoveElementOperationData>
        | TOperation<
            IRemovePropertiesFromOperationDataOperationData,
            Omit<IRemovePropertiesFromOperationDataOperationData, "propertyNames">,
        >
        | TOperation<IReparentElementOperationData>
        | TOperation<
            IRequestActionOperationData,
            Required<IRequestActionOperationData>,
        >
        | TOperation<ISelectElementOperationData>
        | TOperation<ISetDataOperationData>
        | TOperation<ISetElementAttributesOperationData>
        | TOperation<ISetElementContentOperationData>
        | TOperation<
            ISetGlobalDataOperationData,
            Omit<ISetGlobalDataOperationData, "propertyNames">,
        >
        | TOperation<
            ISetOperationData,
            Omit<ISetOperationData, "properties" | "override">,
        >
        | TOperation<ISetStyleOperationData>
        | TOperation<ISetVariableOperationData>
        | TOperation<IStartActionOperationData>
        | TOperation<IToggleClassOperationData>
        | TOperation<IToggleElementOperationData>
        | TOperation<IWaitOperationData>
        | TOperation<IWhenOperationData>,
>
Adds the operation data for a start operation specified by the given system name
Type Parameters
- T extends
      | "forEach"
      | "animate"
      | "removeClass"
      | "endForEach"
      | "log"
      | "when"
      | "endWhen"
      | "otherwise"
      | "addClass"
      | "addControllerToElement"
      | "addGlobalsToOperation"
      | "animateWithClass"
      | "breakForEach"
      | "broadcastEvent"
      | "calc"
      | "clearElement"
      | "clearOperationData"
      | "continueForEach"
      | "createElement"
      | "customFunction"
      | "endAction"
      | "extendController"
      | "getAttributesFromElement"
      | "getControllerFromElement"
      | "getControllerInstance"
      | "getElementDimensions"
      | "getImport"
      | "getQueryParams"
      | "invokeObjectMethod"
      | "loadJson"
      | "math"
      | "removeControllerFromElement"
      | "removeElement"
      | "removePropertiesFromOperationData"
      | "reparentElement"
      | "requestAction"
      | "selectElement"
      | "setData"
      | "setElementAttributes"
      | "setElementContent"
      | "setGlobalData"
      | "setOperationData"
      | "setStyle"
      | "setVariable"
      | "startAction"
      | "toggleClass"
      | "toggleElement"
      | "wait"
- O extends Partial<ExtractOperationDataType<GetOperationByName<T>>>
Parameters
- systemName:
      | "forEach"
      | "animate"
      | "removeClass"
      | "endForEach"
      | "log"
      | "when"
      | "endWhen"
      | "otherwise"
      | "addClass"
      | "addControllerToElement"
      | "addGlobalsToOperation"
      | "animateWithClass"
      | "breakForEach"
      | "broadcastEvent"
      | "calc"
      | "clearElement"
      | "clearOperationData"
      | "continueForEach"
      | "createElement"
      | "customFunction"
      | "endAction"
      | "extendController"
      | "getAttributesFromElement"
      | "getControllerFromElement"
      | "getControllerInstance"
      | "getElementDimensions"
      | "getImport"
      | "getQueryParams"
      | "invokeObjectMethod"
      | "loadJson"
      | "math"
      | "removeControllerFromElement"
      | "removeElement"
      | "removePropertiesFromOperationData"
      | "reparentElement"
      | "requestAction"
      | "selectElement"
      | "setData"
      | "setElementAttributes"
      | "setElementContent"
      | "setGlobalData"
      | "setOperationData"
      | "setStyle"
      | "setVariable"
      | "startAction"
      | "toggleClass"
      | "toggleElement"
      | "wait"
- operationData: O
Returns OperationEditor<
    EndableActionEditor<T>,

        | TOperation<IAddClassOperationData>
        | TOperation<IAddControllerToElementOperationData<TOperationData>>
        | TOperation<IAddGlobalsToOperationData>
        | TOperation<IAnimateOperationData>
        | TOperation<
            IAnimateWithClassOperationData,
            Promise<IAnimateWithClassOperationData>,
        >
        | TOperation<TOperationData>
        | TOperation<IForEachOperationData>
        | TOperation<IBroadcastEventOperationData>
        | TOperation<ICalcOperationData>
        | TOperation<IClearElementOperationData>
        | TOperation<IClearOperationDataOperationData>
        | TOperation<
            ICreateElementOperationData<keyof HTMLElementTagNameMap>,
            RequireKeys<
                ICreateElementOperationData<keyof HTMLElementTagNameMap>,
                "template",
            >,
        >
        | TOperation<ICustomFunctionOperationData>
        | TOperation<IEndActionOperationData>
        | TOperation<Record<string, unknown>>
        | TOperation<IExtendControllerOperationData>
        | TOperation<IGetAttributesFromElementOperationData>
        | TOperation<IGetControllerFromElementOperationData>
        | TOperation<IGetControllerInstanceOperationData>
        | TOperation<IGetElementDimensionsOperationData>
        | TOperation<
            IGetImportOperationData,
            Omit<
                RequireKeys<IGetImportOperationData, "importedInstance">,
                "systemName",
            >,
        >
        | TOperation<IGetQueryParamsOperationData>
        | TOperation<
            IInvokeObjectMethodOperationData,
            Omit<IInvokeObjectMethodOperationData, "methodName" | "methodArguments">,
        >
        | TOperation<ILoadJSONOperationData>
        | TOperation<ILogOperationData>
        | TOperation<
            IMathOperationData,
            Omit<IMathOperationData, "args" | "functionName">,
        >
        | TOperation<IRemoveClassOperationData>
        | TOperation<IRemoveControllerFromElementOperationData>
        | TOperation<IRemoveElementOperationData>
        | TOperation<
            IRemovePropertiesFromOperationDataOperationData,
            Omit<IRemovePropertiesFromOperationDataOperationData, "propertyNames">,
        >
        | TOperation<IReparentElementOperationData>
        | TOperation<
            IRequestActionOperationData,
            Required<IRequestActionOperationData>,
        >
        | TOperation<ISelectElementOperationData>
        | TOperation<ISetDataOperationData>
        | TOperation<ISetElementAttributesOperationData>
        | TOperation<ISetElementContentOperationData>
        | TOperation<
            ISetGlobalDataOperationData,
            Omit<ISetGlobalDataOperationData, "propertyNames">,
        >
        | TOperation<
            ISetOperationData,
            Omit<ISetOperationData, "properties" | "override">,
        >
        | TOperation<ISetStyleOperationData>
        | TOperation<ISetVariableOperationData>
        | TOperation<IStartActionOperationData>
        | TOperation<IToggleClassOperationData>
        | TOperation<IToggleElementOperationData>
        | TOperation<IWaitOperationData>
        | TOperation<IWhenOperationData>,
>
- Defined in configuration/api/action-editor.ts:289

addEndOperationByType

addEndOperationByType<
    T extends TOperationType,
    Dt extends Partial<ExtractOperationDataType<T>>,
>(
    operationClass: T,
    operationData: Dt,
): OperationEditor<EndableActionEditor<T>, TOperationType>
Adds the operation data for a end operation specified by the given type
Type Parameters
- T extends TOperationType
- Dt extends Partial<ExtractOperationDataType<T>>
Parameters
- operationClass: T
- operationData: Dt
Returns OperationEditor<EndableActionEditor<T>, TOperationType>
- Defined in configuration/api/action-editor.ts:263

addStartOperation

addStartOperation(
    systemName:
        | "forEach"
        | "animate"
        | "removeClass"
        | "endForEach"
        | "log"
        | "when"
        | "endWhen"
        | "otherwise"
        | "addClass"
        | "addControllerToElement"
        | "addGlobalsToOperation"
        | "animateWithClass"
        | "breakForEach"
        | "broadcastEvent"
        | "calc"
        | "clearElement"
        | "clearOperationData"
        | "continueForEach"
        | "createElement"
        | "customFunction"
        | "endAction"
        | "extendController"
        | "getAttributesFromElement"
        | "getControllerFromElement"
        | "getControllerInstance"
        | "getElementDimensions"
        | "getImport"
        | "getQueryParams"
        | "invokeObjectMethod"
        | "loadJson"
        | "math"
        | "removeControllerFromElement"
        | "removeElement"
        | "removePropertiesFromOperationData"
        | "reparentElement"
        | "requestAction"
        | "selectElement"
        | "setData"
        | "setElementAttributes"
        | "setElementContent"
        | "setGlobalData"
        | "setOperationData"
        | "setStyle"
        | "setVariable"
        | "startAction"
        | "toggleClass"
        | "toggleElement"
        | "wait",
    operationData: TOperationData,
    id?: string,
): OperationEditor<EndableActionEditor<T>, TOperation<TOperationData>>
Adds the operation data for a start operation specified by the given system name
Parameters
- systemName:
      | "forEach"
      | "animate"
      | "removeClass"
      | "endForEach"
      | "log"
      | "when"
      | "endWhen"
      | "otherwise"
      | "addClass"
      | "addControllerToElement"
      | "addGlobalsToOperation"
      | "animateWithClass"
      | "breakForEach"
      | "broadcastEvent"
      | "calc"
      | "clearElement"
      | "clearOperationData"
      | "continueForEach"
      | "createElement"
      | "customFunction"
      | "endAction"
      | "extendController"
      | "getAttributesFromElement"
      | "getControllerFromElement"
      | "getControllerInstance"
      | "getElementDimensions"
      | "getImport"
      | "getQueryParams"
      | "invokeObjectMethod"
      | "loadJson"
      | "math"
      | "removeControllerFromElement"
      | "removeElement"
      | "removePropertiesFromOperationData"
      | "reparentElement"
      | "requestAction"
      | "selectElement"
      | "setData"
      | "setElementAttributes"
      | "setElementContent"
      | "setGlobalData"
      | "setOperationData"
      | "setStyle"
      | "setVariable"
      | "startAction"
      | "toggleClass"
      | "toggleElement"
      | "wait"
- operationData: TOperationData
- id: string = ...
Returns OperationEditor<EndableActionEditor<T>, TOperation<TOperationData>>
Inherited from ActionEditor.addStartOperation
- Defined in configuration/api/action-editor.ts:121

addStartOperationByType

addStartOperationByType<T extends TOperation<TOperationData>>(
operationClass: T,
operationData: Partial<ExtractOperationDataType<T>>,
): OperationEditor<EndableActionEditor<T>, T>
Adds the operation data for a start operation specified by the given type
Type Parameters
- T extends TOperation<TOperationData>
Parameters
- operationClass: T
- operationData: Partial<ExtractOperationDataType<T>>
Returns OperationEditor<EndableActionEditor<T>, T>
Inherited from ActionEditor.addStartOperationByType
- Defined in configuration/api/action-editor.ts:94

editEndOperation

editEndOperation(
id: string,
): OperationEditor<EndableActionEditor<T>, TOperation<TOperationData>>
Starts an editor for the end operation associated with the given id
Parameters
- id: string
Returns OperationEditor<EndableActionEditor<T>, TOperation<TOperationData>>
- Defined in configuration/api/action-editor.ts:322

editStartOperation

editStartOperation(
id: string,
): OperationEditor<ActionEditor<T>, TOperation<TOperationData>>
Starts an editor for the start operation associated with the given id
Parameters
- id: string
Returns OperationEditor<ActionEditor<T>, TOperation<TOperationData>>
Inherited from ActionEditor.editStartOperation
- Defined in configuration/api/action-editor.ts:160

getConfiguration

getConfiguration(callBack: (config: T) => T | undefined): EndableActionEditor<T>
Returns a copy of the current internal state of the factory
Parameters
- callBack: (config: T) => T | undefined
Returns EndableActionEditor<T>
Inherited from ActionEditor.getConfiguration
- Defined in configuration/api/action-editor.ts:52

getName

getName(): string
Gets the action name

Returns string
Inherited from ActionEditor.getName
- Defined in configuration/api/action-editor.ts:82

moveEndOperation

moveEndOperation(id: string, direction: "up" | "down"): EndableActionEditor<T>
Moves the end operation associated with the given id in the specified direction
Parameters
- id: string
- direction: "up" | "down"
Returns EndableActionEditor<T>
- Defined in configuration/api/action-editor.ts:371

moveStartOperation

moveStartOperation(id: string, direction: "up" | "down"): EndableActionEditor<T>
Moves the start operation associated with the given id in the given direction
Parameters
- id: string
- direction: "up" | "down"
Returns EndableActionEditor<T>
Inherited from ActionEditor.moveStartOperation
- Defined in configuration/api/action-editor.ts:212

next(): ConfigurationFactory
Return the fluent scopt to the ConfigurationFactory

Returns ConfigurationFactory
Inherited from ActionEditor.next
- Defined in configuration/api/action-editor.ts:242

removeEndOperation

removeEndOperation(id: string): EndableActionEditor<T>
Removes the end operation associated with the given id
Parameters
- id: string
Returns EndableActionEditor<T>
- Defined in configuration/api/action-editor.ts:340

removeStartOperation

removeStartOperation(id: string): EndableActionEditor<T>
Removes the start operation associated with the given id
Parameters
- id: string
Returns EndableActionEditor<T>
Inherited from ActionEditor.removeStartOperation
- Defined in configuration/api/action-editor.ts:181

setName

setName(name: string): EndableActionEditor<T>
Sets the action name
Parameters
- name: string
Returns EndableActionEditor<T>
Inherited from ActionEditor.setName
- Defined in configuration/api/action-editor.ts:68

updateConfiguration

updateConfiguration(): void
Returns void
Inherited from ActionEditor.updateConfiguration
- Defined in configuration/api/action-editor.ts:41

Class EndableActionEditor<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EndableActionEditor<T>

Properties

ProtectedactionConfig

Protected ReadonlyconfigurationFactory

Methods

addEndOperation

Type Parameters

Parameters

addEndOperationByType

Type Parameters

Parameters

Returns OperationEditor<EndableActionEditor<T>, TOperationType>

addStartOperation

Parameters

Returns OperationEditor<EndableActionEditor<T>, TOperation<TOperationData>>

addStartOperationByType

Type Parameters

Parameters

Returns OperationEditor<EndableActionEditor<T>, T>

editEndOperation

Parameters

Returns OperationEditor<EndableActionEditor<T>, TOperation<TOperationData>>

editStartOperation

Parameters

Returns OperationEditor<ActionEditor<T>, TOperation<TOperationData>>

getConfiguration

Parameters

Returns EndableActionEditor<T>

getName

Returns string

moveEndOperation

Parameters

Returns EndableActionEditor<T>

moveStartOperation

Parameters

Returns EndableActionEditor<T>

next

Returns ConfigurationFactory

removeEndOperation

Parameters

Returns EndableActionEditor<T>

removeStartOperation

Parameters

Returns EndableActionEditor<T>

setName

Parameters

Returns EndableActionEditor<T>

updateConfiguration

Returns void

Settings

On This Page

`Protected`actionConfig

`Protected` `Readonly`configurationFactory