Class

SpotfireTrellis

SpotfireTrellis(trellisDescription)

Represents a trellis description.

Constructor

new SpotfireTrellis(trellisDescription)

Parameters:
Name Type Description
trellisDescription trellisDescription
trellisMode SpotfireTrellisModes  {Enum} 

'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.

Enum options: rowsColumns, panels
rowAxis trellisAxisDescription

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

hierarchyOption SpotfireTrellisAxisHierarchyOptions  {Enum} 

[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.

Enum options: nest, cross
columnAxis trellisAxisDescription

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

hierarchyOption SpotfireTrellisAxisHierarchyOptions  {Enum} 

[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.

Enum options: nest, cross
pageAxis trellisAxisDescription

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

hierarchyOption SpotfireTrellisAxisHierarchyOptions  {Enum} 

[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.

Enum options: nest, cross
panelAxis trellisAxisDescription

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

hierarchyOption SpotfireTrellisAxisHierarchyOptions  {Enum} 

[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.

Enum options: nest, cross
manualLayout Boolean

[Available for 'Panels' only.] To manually specify the number of rows and columns that should be visible without scrolling.

maxNumberOfRows Number

[Available for 'Panels' only.] Specifies the maximum number of panels that should be visible on each page.

maxNumberOfColumns Number

[Available for 'Panels' only.] Specifies the maximum number of panels that should be visible on each page.