Tableau Embedding API
    Preparing search index...

    Interface ParameterDomainRestriction

    Represents the allowable set of values which a parameter can be set to.

    interface ParameterDomainRestriction {
        allowableValues?: DataValue[];
        dateStepPeriod?: PeriodType;
        maxValue?: DataValue;
        minValue?: DataValue;
        stepSize?: number;
        type: ParameterValueType;
    }
    Index

    Properties

    allowableValues? dateStepPeriod? maxValue? minValue? stepSize? type

    Properties

    allowableValues?: DataValue[]

    If ParameterValueType.List, the array will be the list of values which the parameter is allowed to take.

    dateStepPeriod?: PeriodType

    If ParameterValueType.Range, this defines the step date period used in the Parameter UI control slider. Note that if you specify a new value for the parameter, using the changeValueAsync() method, that does not align on the dateStepPeriod interval, the value will be set to the closest, earlier date.

    maxValue?: DataValue

    If ParameterValueType.Range, the value will be the upper bound of allowable values for the parameter.

    minValue?: DataValue

    If ParameterValueType.Range, the value will be the lower bound of allowable values for the parameter.

    stepSize?: number

    If ParameterValueType.Range, the value will define the step size used in the parameter UI control slider. Note that if you specify a new value for the parameter, using the changeValueAsync() method, that does not align on the stepSize interval, the value will be set to the closest, lower interval. For example, if the stepSize was 5 and the steps were 1, 5, 10, if the new value specified was 8, the value 5 would be used instead.

    type: ParameterValueType

    The type of restriction we have on the parameter's domain. This value will effect what other properties are configured on this object.

    Settings

    Member Visibility

    On This Page

    Properties