Class

SpotfireTopBottomShowHideItemsRules

SpotfireTopBottomShowHideItemsRules(topBottomRulesDescription)

Constructor

new SpotfireTopBottomShowHideItemsRules(topBottomRulesDescription)

Parameters:
Name Type Description
topBottomRulesDescription 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.

isBottom Boolean

true if it is a bottom rule, false if it is a top rule

rank Object
type String

define the type of conditional value applied. Can be found using SpotfireConditionalValueTypes members.

value String | Number

depend on the type. Example: SpotfireConditionalValueTypes.min has no value, as it represents the minimum of the current datacolumn where the condition will be applied. SpotfireConditionalValueTypes.literal is a literal value, so it needs a number.