SelectionCriteria | Tableau Embedding API

Interface SelectionCriteria

SelectionCriteria interface is used to specify to the fieldName to values for Hierarchical, Categorical and Range based selections.

interface SelectionCriteria {
    fieldName: string;
    value: CategoricalValue | RangeValue;
}
Index

Properties

Properties

fieldName: string

Fieldname of the mark that is intended to be selected. Hierarchical fields follow the convention of "[{parentField}].[{selectingField}]"

Value that is intended to be selected. This can be specified as the list of values or a single value. Range-based selections need to provide the value in the format of RangeValue interface. To select a single quantitative value, use the RangeValue interface where both max and min are the value you want to select.