Constructor
new SpotfireHeatMap(heatMapProperties)
Parameters:
| Name | Type | Description |
|---|---|---|
[ heatMapProperties ]
|
Object | |
[ general ]
|
Object | |
title
|
String | The title of the visualization. |
description
|
String | The description of the visualization. |
showTitleBar
|
Boolean | Specifies whether or not to show the visualization title. |
[ data ]
|
visualDataDescription ▼ | |
dataTable
|
String | Specifies the data table on which the visualization will work. |
marking
|
String | Specifies the marking that will be used to mark items in the visualization. |
limiting
|
Object | Settings used for limiting the data shown in the visualization. |
byMarkings
|
Object | Settings used for limiting the data shown in the visualization using the markings. |
markingNames
|
String | Array.<String> | Lists the available markings that can be used to limit what is shown in the visualization. This means that the visualization only displays data that has been marked in other visualizations (master visualizations). |
combinationBehavior
|
String | ['AND'|'OR'], specifies how the data in the markings should be combined if you have listed more than one marking. AND: to show the intersection of the selected markings; OR: to show the union of the selected markings. |
emptyBehavior
|
String | ['ALL','EMPTY','MESSAGE'], specifies what the visualization should show when no items have been marked in its master visualizations. ALL: to show all the data from the master visualizations that control the content, if no items have been marked in those visualizations; EMPTY: to display only the scales and axis selectors if no items have been marked in the master visualizations; MESSAGE: to display a message if no items have been marked in the master visualizations. The axis selectors will also be visible. |
emptyMessage
|
String | The message that will be displayed if no items have been marked in the master visualizations. |
byFilterings
|
Object | Defines how different filtering schemes in the analysis should affect the visualization. |
filteringNames
|
String | Array.<String> | Lists the available filtering schemes that can be used to limit what is shown in the visualization. |
useCurrentFilteringFromPage
|
Boolean | Specifies whether or not the visualization should utilize the filtering scheme that is used on the page where the visualization is located. If you move the visualization to a new page, then the visualization will automatically start reacting on the filtering scheme that is used on the new page. |
byExpression
|
String | Specifies the boolean expression to use for limiting the data in the visualization. |
[ appearance ]
|
Object | |
useSeparateColorForMarkedItems
|
Boolean | Specifies whether or not the marking color should be used to distinguish marked items in the visualization. |
[ fonts ]
|
Object | |
legend
|
visualFontDescription ▼ | To change the font settings of the legend. |
fontFamily
|
String | Specifies a specific font to use. |
size
|
Number | Specifies a specific font size to use. |
bold
|
Boolean | Specifies if the font style Bold should be used. |
italic
|
Boolean | Specifies if the font style Italic should be used. |
detailsVisualizationMessage
|
visualFontDescription ▼ | To change the font settings of the details visualization message. |
fontFamily
|
String | Specifies a specific font to use. |
size
|
Number | Specifies a specific font size to use. |
bold
|
Boolean | Specifies if the font style Bold should be used. |
italic
|
Boolean | Specifies if the font style Italic should be used. |
[ legend ]
|
Object | |
visible
|
Boolean | Specifies whether or not the legend should be shown in the visualization. |
position
|
SpotfireLegendPositions {Enum} ▼ | Specifies which side of the visualization the legend should be positioned: the right-hand side or the left-hand side. |
| Enum options: left, right | ||
width
|
Number | Specifies the width, in pixels, of the legend as it is displayed in the user interface. |
legendItems
|
Array.<visualLegendItemDescription> ▼ | Defines how the legend items should be displayed. The available options vary between legend items. |
[].name
|
String | The name of the legend item to modify, as it is displayed in the user interface. |
[].visible
|
Boolean | Specifies whether or not the legend item should be shown. |
[].showTitle
|
Boolean | Specifies whether or not the legend item title should be shown. |
[].showAxisSelector
|
Boolean | Specifies whether or not the axis selector for the legend item should be shown. |
[ showHideItemsRules ]
|
Array.<visualShowHideItemsRuleDescription> ▼ | |
[].expression
|
String | Specifies which column the rule should be applied to. |
[].type
|
SpotfireShowHideItemsRulesTypes {Enum} ▼ | Specifies the rule type. 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
|
String | Specifies whether or not the items that match the rule should be hidden. |
[].evaluatePerTrellis
|
String | If the visualization is trellised , specifies whether or not the rule should be applied once for each trellis panel. |
[].displayName
|
String | The name of the rule. |
[].enabled
|
Boolean | Specifies whether or not the rule should be active. |
[].ruleCondition
|
Object | |
comparisonOperator
|
String | |
threshold
|
Object | |
type
|
String | |
value
|
Number | |
stringValue
|
Object | |
type
|
String | |
value
|
Number | |
isBottom
|
Boolean | |
rank
|
Object | |
type
|
String | |
value
|
Number | |
startValue
|
Object | |
type
|
String | |
value
|
Number | |
endValue
|
Object | |
type
|
String | |
value
|
Number | |
expression
|
String |