Class TimelineActionCreator

actionConfig

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,
  ): TimelineActionCreator

  Adds the operation data for an end 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 TimelineActionCreator

addEndOperationByType

• addEndOperationByType<
      T extends TOperationType,
      Dt extends Partial<ExtractOperationDataType<T>>,
  >(
      operationClass: T,
      operationData: Dt,
  ): TimelineActionCreator

  Adds the operation data for an end operation specified by the given type

  Type Parameters

  • T extends TOperationType
  • Dt extends Partial<ExtractOperationDataType<T>>

  Parameters

  • operationClass: T
  • operationData: Dt

  Returns TimelineActionCreator

addStartOperation

• addStartOperation<
      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: T,
      operationData: O,
  ): TimelineActionCreator

  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: T
  • operationData: O

  Returns TimelineActionCreator

addStartOperationByType

• addStartOperationByType<
      T extends TOperationType,
      Dt extends Partial<ExtractOperationDataType<T>>,
  >(
      operationClass: T,
      operationData: Dt,
  ): TimelineActionCreator

  Adds the operation data for a start operation specified by the given type

  Type Parameters

  • T extends TOperationType
  • Dt extends Partial<ExtractOperationDataType<T>>

  Parameters

  • operationClass: T
  • operationData: Dt

  Returns TimelineActionCreator

getConfiguration

• getConfiguration(
      callBack: (
          config: ITimelineActionConfiguration,
      ) => ITimelineActionConfiguration,
  ): TimelineActionCreator

  Returns a copy of the internal state of the ActionCreator

  Parameters

  • callBack: (config: ITimelineActionConfiguration) => ITimelineActionConfiguration

  Returns TimelineActionCreator

getId

• getId(): string

  The unique id of the action

  Returns string

next

• next(): ActionCreatorFactory

  Returns the fluent scope back to the ActionCreatorFactory

  Returns ActionCreatorFactory

setName

• setName(name: string): TimelineActionCreator

  Sets the name of the action

  Parameters

  • name: string

  Returns TimelineActionCreator