Constructor
new SpotfireThresholdColoringRules(thresholdColoringRuleDescription)
Coloring rule based on threshold definition and a comparison operator
Parameters:
Name | Type | Description |
---|---|---|
thresholdColoringRuleDescription
|
Object | |
displayName
[Inherited]
|
String | Specifies the name of the rule. |
color
[Inherited]
|
String | Object | Specifies the color to use for the rule, in the hexadecimal format, or the ARGB object. |
a
[Inherited]
|
Number | [0-255] |
r
[Inherited]
|
Number | [0-255] |
g
[Inherited]
|
Number | [0-255] |
b
[Inherited]
|
Number | [0-255] |
type
|
SpotfireColoringRulesTypes {Enum} ▼ | type of coloring rules. Can be [equal|not equal to], [greater|less] [than|than or equal] |
Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, gradient, segments, uniqueValues, string | ||
threshold
|
ThresholdColoringRuleDescription ▼ | the definition of the threshold conditional value used for evaluating the rules |
type
|
SpotfireConditionalValueTypes {Enum} ▼ | the type of conditional values to be used |
Enum options: min, max, average, median, literal, percent, percentile, expression | ||
value
|
number | used to set the value to be used for comparison |
Members
SpotfireComparisonOperators
comparisonOperator
the comparison operator to be used when evaluating the rule
Methods
setComparisonOperator(thresholdColoringRulesType)
Set the comparison operator based on the type of the rules
Parameters:
Name | Type | Description |
---|---|---|
thresholdColoringRulesType
|
SpotfireColoringRulesTypes {Enum} ▼ | |
Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, gradient, segments, uniqueValues, string |
setThreshold(thresholdConfiguration)
Set the threshold based on the threshold definition
Parameters:
Name | Type | Description |
---|---|---|
thresholdConfiguration
|
ThresholdColoringRuleDescription ▼ | |
type
|
SpotfireConditionalValueTypes {Enum} ▼ | the type of conditional values to be used |
Enum options: min, max, average, median, literal, percent, percentile, expression | ||
value
|
number | used to set the value to be used for comparison |