Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IParameterApi<T>

The api for a parameter of a corresponding session.

Parameters represent the channels through which data can be input into the model represented by a session.

The current value can be changed by setting the value property.

Type Parameters

  • T

Hierarchy

Index

Properties

hidden: boolean
id: string
name: string
sessionValue: string | T

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

value: string | T

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).

choices?: string[]
decimalplaces?: number
defval?: string
displayname?: string
expression?: string
format?: string[]
group?: ResParameterGroup
hint?: string
interval?: number
max?: number
min?: number
order?: number
settings?: object
structure?: ResStructureType
tooltip?: string
umax?: number
umin?: number
visualization?: PARAMETER_VISUALIZATION
vmax?: number
vmin?: number

Methods

  • 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(): void
  • Resets the value to the default value.

    Returns void

  • resetToSessionValue(): void
  • 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