Class

SpotfireThresholdShowHideItemsRules

SpotfireThresholdShowHideItemsRules(thresholdShowHideItemsDescription)

ShowHideItems rule based on threshold definition and a comparison operator

Constructor

new SpotfireThresholdShowHideItemsRules(thresholdShowHideItemsDescription)

Parameters:
Name Type Description
thresholdShowHideItemsDescription RulesDescription ▼
expression String

Specifies which column the rule should be applied to.
enabled Boolean

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

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

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

Specifies whether or not, if the visualization is trellised, the rule should be applied once for each trellis panel.
displayName 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 ▼
min String
max String
average String
median String
literal String
percent String
percentile String
expression String
value Number
type SpotfireShowHideItemsRulesTypes ▼
top String

Shows or hides the top number of items. Specify the number of items in the Value field.
bottom String

Shows or hides the bottom number of items. Specify the number of items in the Value field.
between String

Shows or hides all the items representing values between the two specified values. Specify the values in the two Value fields.
equalTo String

Shows or hides all the items representing values that are equal to the specified value.
notEqualTo String

Shows or hides all the items representing values that are not equal to the specified value.
greaterThan String

Shows or hides all the items representing values greater than the specified value.
greaterThanOrEqual String

Shows or hides all the items representing values greater than or equal to the specified value.
lessThan String

Shows or hides all the items representing values less than the specified value.
lessThanOrEqual String

Shows or hides all the items representing values less than or equal to the specified value.
booleanExpression String

Lets you define a boolean expression. All the items for which the expression is true will be shown (or hidden, depending on which you select).
string String