Class

SpotfireThresholdShowHideItemsRules

SpotfireThresholdShowHideItemsRules(thresholdShowHideItemsDescription)

Constructor

new SpotfireThresholdShowHideItemsRules(thresholdShowHideItemsDescription)

ShowHideItems rule based on threshold definition and a comparison operator

Parameters:
Name Type Description
thresholdShowHideItemsDescription Object
expression [Inherited] String

Specifies which column the rule should be applied to.

enabled [Inherited] Boolean

Specifies whether or not the rule should be active in the visualization.

type [Inherited] SpotfireShowHideItemsRulesTypes {Enum}

Specifies which rule type to add. Which types are available depends on the data type of the column the rule is applied to.

Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, string
hideMatchedItems [Inherited] Boolean

Specifies whether or not all the items that match the rule should be hidden.

evaluatePerTrellis [Inherited] Boolean

Specifies whether or not, if the visualization is trellised, the rule should be applied once for each trellis panel.

displayName [Inherited] String

Specifies a descriptive name for the rule. The name is used to identify the rule in the Visualization Properties dialog, and it can be displayed in the legend of the visualization.

threshold Object
type SpotfireConditionalValueTypes {Enum}
Enum options: min, max, average, median, literal, percent, percentile, expression
value Number