Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Parameter

Represents a parameter in Tableau and provides ways to introspect the parameter and change its values.

Hierarchy

  • Parameter

Index

Properties

Methods

Properties

allowableValues

allowableValues: ParameterDomainRestriction
returns

The allowable set of values this parameter can take.

currentValue

currentValue: DataValue
returns

DataValue representing the current value of the parameter.

dataType

dataType: DataType
returns

The type of data this parameter holds.

id

id: string
returns

A unique identifier for this Parameter.

name

name: string
returns

The display name of this parameter.

Methods

changeValueAsync

  • changeValueAsync(newValue: string | number | boolean | Date): Promise<DataValue>

  • Modifies this parameter and assigns it a new value. The new value must fall within the domain restrictions defined by allowableValues. If the domain restriction is ParameterValueType.Range, be sure to check the allowableValues before assigning a new value. If the new value is out of range, the updated value will be set to either the minValue or the maxValue of the allowable range. If a step size is also specified and the new value does not fall on the step intervals, the updated value will be set to the closest, lower step, or closest, earlier date. If the domain restriction is type ParameterValueType.List, and there are aliases defined for the list, the aliased value should be passed to the method.

    Parameters

    • newValue: string | number | boolean | Date

      The new value to assign to this parameter. Note: For changing Date parameters, UTC Date objects are expected.

    Returns Promise<DataValue>

    The updated DataValue. The promise is rejected if newValue is invalid. However, if the domain restriction is type AllowableValuesType.Range, and the newValue is out of the range bounds, the parameter gets set to the minValue or the maxValue of the range (whichever is closer). If the range has a stepSize or dateStepPeriod, the parameter gets set to the closest, lower step, or the closest, earlier date.