Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AbstractWamParameterInfo

Hierarchy

Index

Properties

choices: string[]

A list of human-readable choices corresponding to each valid value in the parameter's range, if applicable.

defaultValue: number

The parameter's default value. Must be within range [minValue, maxValue].

discreteStep: number

The distance between adjacent valid integer values, if applicable.

exponent: number

The nonlinear (exponential) skew of the parameter's range, if applicable.

id: string

The parameter's unique identifier.

label: string

The parameter's human-readable name.

maxValue: number

The maximum valid value of the parameter's range.

minValue: number

The minimum valid value of the parameter's range.

The parameter's data type.

units: string

A human-readable string representing the units of the parameter's range, if applicable.

Methods

  • denormalize(valueNorm: number): number
  • Convert a value from normalized range [0, 1] to the parameter's denormalized range [minValue, maxValue].

    Parameters

    • valueNorm: number

    Returns number

  • normalize(value: number): number
  • Convert a value from the parameter's denormalized range [minValue, maxValue] to normalized range [0, 1].

    Parameters

    • value: number

    Returns number

  • valueString(value: number): string
  • Get a human-readable string representing the given value, including units if applicable.

    Parameters

    • value: number

    Returns string

Generated using TypeDoc