Constructor
new SpotfireRangeShowHideItemsRules(rangeShowHideItemsRulesDefinition)
Parameters:
| Name | Type | Description |
|---|---|---|
rangeShowHideItemsRulesDefinition
|
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. |
isBottom
|
Boolean | true if it is a bottom rule, false if it is a top rule |
startValue
|
Object | |
type = SpotfireConditionalValueTypes.literal
|
String | define the type of conditional value applied. Can be found using SpotfireConditionalValueTypes members |
value = 5
|
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. |
endValue
|
Object | |
type = SpotfireConditionalValueTypes.literal
|
String | define the type of conditional value applied. Can be found using SpotfireConditionalValueTypes members. |
value = 5
|
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. |