Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGumballTransformParameterApi

Hierarchy

  • IInteractionParameterApi
    • IGumballTransformParameterApi

Index

Properties

Methods

Properties

hidden

hidden: boolean

id

id: string

interactionType

interactionType: InteractionParameterSettingsType

name

name: string

sessionValue

sessionValue: string

The value that corresponds to the latest successful call to ISessionApi.customize. This property will be updated immediately before ISessionApi.customize returns.

Readonly settings

settings: IGumballTransformParameterProps

type

type: PARAMETER_TYPE

value

value: string

The current value.

Validation happens immediately when setting this property. An error will be thrown in case validation fails. Use isValid to test whether a value passes validation.

In case ISessionApi.automaticSceneUpdate is true, setting the value will immediately trigger a customization (see ISessionApi.customize).

Optional choices

choices?: string[]

Optional decimalplaces

decimalplaces?: number

Optional defval

defval?: string

Optional displayname

displayname?: string

Optional expression

expression?: string

Optional format

format?: string[]

Optional group

group?: CommonsGroup

Optional hint

hint?: string

Optional interval

interval?: number

Optional max

max?: number

Optional min

min?: number

Optional order

order?: number

Optional structure

structure?: ResStructureType

Optional tooltip

tooltip?: string

Optional umax

umax?: number

Optional umin

umin?: number

Optional visualization

visualization?: PARAMETER_VISUALIZATION

Optional vmax

vmax?: number

Optional vmin

vmin?: number

Methods

isValid

  • isValid(value: unknown, throwError?: boolean): boolean

  • Evaluates if a given value is valid for this parameter.

    Parameters

    • value: unknown

      the value to evaluate

    • Optional throwError: boolean

      if true, an error is thrown if validation does not pass (default: false)

    Returns boolean

resetToDefaultValue

  • resetToDefaultValue(): void

  • Resets the value to the default value.

    Returns void

resetToSessionValue

  • resetToSessionValue(): void

  • Resets the value to sessionValue.

    Returns void

stringify

  • stringify(value?: unknown): string

  • Returns the current value as a string, or attempts to stringify a given value if provided.

    Parameters

    • Optional value: unknown

      the value to stringify

    Returns string