Class UiConfigMethods

constructor

• new UiConfigMethods(_renderer: UiConfigRendererBase): UiConfigMethods

  Parameters

  • _renderer: UiConfigRendererBase

  Returns UiConfigMethods

undoEditingWaitTime

undoPresets

clickButton

• clickButton(config: UiObjectConfig, options?: { args: any[] }): Promise<void>

  Parameters

  • config: UiObjectConfig
  • Optionaloptions: { args: any[] }

  Returns Promise<void>

dispatchOnChange

• dispatchOnChange<T>(
      config: UiObjectConfig<T>,
      props: SetValueCommandProps<PrimitiveVal> & {
          value?: PrimitiveVal;
          [key: string]: any;
      },
  ): Promise<void>

  Type Parameters

  • T

  Parameters

  • config: UiObjectConfig<T>
  • props: SetValueCommandProps<PrimitiveVal> & {
        value?: PrimitiveVal;
        [key: string]: any;
    }

    only last needs to be set, rest are optional. lastValue can be set if known (but it should be exactly equal to the value in the binding and not cloned). config, configPath are for parentOnChange, no need to set that.

  Returns Promise<void>

dispatchOnChangeSync

• dispatchOnChangeSync(
      config: UiObjectConfig,
      props: {
          config?: UiObjectConfig<any, string, any>;
          configPath?: UiObjectConfig<any, string, any>[];
          last?: boolean;
          lastValue?: any;
          value?: any;
      },
      ...args: any[],
  ): void

  Parameters

  • config: UiObjectConfig
  • props: {
        config?: UiObjectConfig<any, string, any>;
        configPath?: UiObjectConfig<any, string, any>[];
        last?: boolean;
        lastValue?: any;
        value?: any;
    }
  • ...args: any[]

  Returns void

getBinding

• getBinding(config: UiObjectConfig, parent?: boolean): [any, string | number]

  Parameters

  • config: UiObjectConfig
  • parent: boolean = true

  Returns [any, string | number]

getBounds

• getBounds(
      config: UiObjectConfig,
      unbounded?: boolean,
  ): { max: number; min: number; step: number }

  Parameters

  • config: UiObjectConfig
  • unbounded: boolean = false

  Returns { max: number; min: number; step: number }

getChildren

• getChildren(config: UiObjectConfig): UiObjectConfig<any, string, any>[]

  Parameters

  • config: UiObjectConfig

  Returns UiObjectConfig<any, string, any>[]

getLabel

• getLabel(config: UiObjectConfig): string

  Parameters

  • config: UiObjectConfig

  Returns string

getRawValue

• getRawValue<T extends unknown>(config: UiObjectConfig<T>): undefined | T

  Type Parameters

  • T extends unknown

  Parameters

  • config: UiObjectConfig<T>

  Returns undefined | T

getValue

• getValue<T extends PrimitiveVal>(
      config: UiObjectConfig<T>,
      val: undefined | T,
      copyOnEqual?: boolean,
  ): undefined | T

  Get the value from config

  Type Parameters

  • T extends PrimitiveVal

  Parameters

  • config: UiObjectConfig<T>
  • val: undefined | T

    existing value, new value can be copied to this if not equal.
  • copyOnEqual: boolean = true

    whether the value should be copied to val if equal. Default is true.

  Returns undefined | T

  The value from the binding, cloned or copied if possible. If the value is equal and copyOnEqual is false, then undefined is returned. this can be used to check if the value is changed

initUiConfig

• initUiConfig(config: UiObjectConfig): void

  Parameters

  • config: UiObjectConfig

  Returns void

performAction

• performAction<T extends AnyFunction>(
      targ: any,
      action: T,
      args: Parameters<T>,
      config: UiObjectConfig,
      onUndoRedo?: (c: ActionCommand) => void,
  ): Promise<void>

  Performs an action with undo/redo support.

  Type Parameters

  • T extends AnyFunction

  Parameters

  • targ: any

    the target object to call the action on
  • action: T

    a function that returns - 1. an undo function, 2. an object with undo and redo functions (and optional action)
  • args: Parameters<T>

    the arguments to pass to the action function
  • config: UiObjectConfig

    ui config
  • OptionalonUndoRedo: (c: ActionCommand) => void

    optional callback function to be called on undo/redo of the command. Not called on first action execution, only on undo/redo.

  Returns Promise<void>

recordUndo

• recordUndo(com: SetValueCommand<PrimitiveVal> | ActionCommand<any[]>): void

  Parameters

  • com: SetValueCommand<PrimitiveVal> | ActionCommand<any[]>

  Returns void

runAtEvent

• runAtEvent<T>(config: UiObjectConfig, run: () => T | Promise<T>): Promise<T>

  Type Parameters

  • T

  Parameters

  • config: UiObjectConfig
  • run: () => T | Promise<T>

  Returns Promise<T>

setValue

• setValue<T extends PrimitiveVal>(
      config: UiObjectConfig<T>,
      value: T,
      props: {
          config?: UiObjectConfig<any, string, any>;
          configPath?: UiObjectConfig<any, string, any>[];
          last?: boolean;
          lastValue?: any;
          value?: any;
      },
      forceOnChange?: boolean,
      trackUndo?: boolean,
  ): Promise<boolean>

  Type Parameters

  • T extends PrimitiveVal

  Parameters

  • config: UiObjectConfig<T>
  • value: T
  • props: {
        config?: UiObjectConfig<any, string, any>;
        configPath?: UiObjectConfig<any, string, any>[];
        last?: boolean;
        lastValue?: any;
        value?: any;
    }

    only the prop last need to be set, rest are optional. lastValue can be set if known (but it should be exactly equal to the value in the binding and not cloned).
  • OptionalforceOnChange: boolean
  • trackUndo: boolean = true

  Returns Promise<boolean>