Class UiConfigMethods

Constructors

constructor

Properties

_renderer

Methods

clickButton dispatchOnChange dispatchOnChangeSync getBinding getChildren getLabel getValue initUiConfig runAtEvent setValue

Constructors

constructor

Properties

Protected_renderer

_renderer: UiConfigRendererBase<any>

Methods

clickButton

  • clickButton(config, options?): Promise<void>

  • Parameters

    • config: UiObjectConfig<any, string, any>
    • Optionaloptions: {
          args: any[];
      }
      • args: any[]

    Returns Promise<void>

dispatchOnChange

  • dispatchOnChange<T>(config, props): Promise<void>

  • Type Parameters

    • T

    Parameters

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

      only last needs to be set. check the docs for setValue

      • Optionalconfig?: UiObjectConfig<any, string, any>
      • OptionalconfigPath?: UiObjectConfig<any, string, any>[]
      • Optionallast?: boolean
      • OptionallastValue?: any
      • Optionalvalue?: any

    Returns Promise<void>

dispatchOnChangeSync

  • dispatchOnChangeSync(config, props, ...args): void

  • Parameters

    • config: UiObjectConfig<any, string, any>
    • props: {
          config?: UiObjectConfig<any, string, any>;
          configPath?: UiObjectConfig<any, string, any>[];
          last?: boolean;
          lastValue?: any;
          value?: any;
      }
      • Optionalconfig?: UiObjectConfig<any, string, any>
      • OptionalconfigPath?: UiObjectConfig<any, string, any>[]
      • Optionallast?: boolean
      • OptionallastValue?: any
      • Optionalvalue?: any
    • Rest...args: any[]

    Returns void

getBinding

getChildren

getLabel

getValue

initUiConfig

runAtEvent

setValue

  • setValue<T>(config, value, props, forceOnChange?): Promise<boolean>

  • Type Parameters

    • T

    Parameters

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

      only the prop last need to be set, rest are optional. lastValue can be set if known. config, configPath are for parentOnChange, no need to set that.

      • Optionalconfig?: UiObjectConfig<any, string, any>
      • OptionalconfigPath?: UiObjectConfig<any, string, any>[]
      • Optionallast?: boolean
      • OptionallastValue?: T
    • OptionalforceOnChange: boolean

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods