Class

SpotfireTreemap

SpotfireTreemap(treemapProperties)

Represents a Treemap.

Constructor

new SpotfireTreemap(treemapProperties)

Default constructor.

Parameters:
Name Type Description
treemapProperties Object
[ colors ] SpotfireColorAxis
[ size ] Object
[ expression ] SpotfireSizeAxis
[ labels ] Object
showHierarchyHeaders Boolean

Specifies whether or not to show hierarchy headers in the treemap. That is, if the column name for each level in the hierarchy should be visible as headers in the treemap.
showLabels Boolean

Specifies whether or not to show labels in the rectangles at the lowest level of the treemap hierarchy.
[ tooltip ] Object
items Array.<Object>
[].expression String

Specifies the column and the name of the tooltip using an expression in the format: '[column expression] as [tooltip name]'.
[].renderer SpotfireRenderer ▼
type SpotfireValueRendererTypes ▼

Specifies the type of the renderer.
text String
link String
imageFromUrl String
rdkit String

Render value as chemical structure using RDKit (!WARNING! RDKit renderer must be installed on the server)
chemDraw String

Render value as chemical structure using chemDraw (!WARNING! ChemDraw renderer must be installed on the server)
url String

[Available for 'Image from URL' and 'Link' renderers only.] Specifies the target URL.
[].size Number

[Available if the selected tooltip value is some kind of image.] Specifies the size in pixels of the image, between 1 and 1600.
displayItems Array.<string>

Specifies the names of displayed tooltips.
format string

Specifies whether or not the name of the tooltip value should be included along with the value itself. From enum SpotfireTooltipFormats.
[ trellis ] TrellisDescription ▼
trellisMode SpotfireTrellisModes ▼

'Rows and columns': splits the visualization into different panels for all categories in the selected column or hierarchy. The number of values in the specified column or hierarchy controls the number of panels to be displayed in each row, column, or page, respectively.
'Panels': splits the visualization into different panels for all categories in the selected column or hierarchy, without binding any dimensions to either rows or columns. This means that the number of actual values in the column to split by does not control the number of shown rows or columns in any way.
rowsColumns String
panels String
rowAxis trellisAxisDescription ▼

A row with trellis panels will be created for each value in the column or hierarchy.
hierarchyOption SpotfireTrellisAxisHierarchyOptions ▼

[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
nest String
cross String
columnAxis trellisAxisDescription ▼

A column with trellis panels will be created for each value in the column or hierarchy.
hierarchyOption SpotfireTrellisAxisHierarchyOptions ▼

[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
nest String
cross String
pageAxis trellisAxisDescription ▼

A new page with trellis panels will be created for each value in the column or hierarchy.
hierarchyOption SpotfireTrellisAxisHierarchyOptions ▼

[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
nest String
cross String
panelAxis trellisAxisDescription ▼

Specifies the column or hierarchy to define the categories by which the visualization should be split.
hierarchyOption SpotfireTrellisAxisHierarchyOptions ▼

[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
nest String
cross String
manualLayout Boolean

To manually specify the number of rows and columns that should be visible without scrolling.
maxNumberOfRows Number

Specifies the maximum number of panels that should be visible on each page.
maxNumberOfColumns Number

Specifies the maximum number of panels that should be visible on each page.