Constructor
new SpotfireTrellisAxis(axisDescription)
Represents a trellis axis description.
Parameters:
Name | Type | Description |
---|---|---|
axisDescription
|
Object | |
columns
[Inherited]
|
Array.<String> | Specifies the column or hierarchy to use for the Axis. Note: We strongly recommend to escape the column names using square brackets (column names must be identical to the 'Edit expression' field in TIBCO Spotfire). |
axisMode
[Inherited]
|
SpotfireAxisModes {Enum} ▼ | Specifies whether the column or hierarchy should be treated as continuous or categorical. |
Enum options: continuous, categorical | ||
categoryMode
[Inherited]
|
SpotfireCategoryModes {Enum} ▼ | Determines how to display the categories. 'Show filtered values': to display values available after current filtering only; 'Show filtered range': to hide empty categories on both ends of the currently visible range; 'Show all values': to keep all categories visible even if data for some categories have been filtered out. |
Enum options: showFiltered, showFilteredRange, showAll | ||
evaluationMode
[Inherited]
|
SpotfireAxisEvaluationMode {Enum} ▼ | Only applicable when the range of the available values on the axis is determined by the expression itself, that is, for column-based expressions such as ranking or binning. 'All data': to evaluate the axis expression before filtering is applied and use all of the data to calculate the available ranges; 'Current filtering only': to take the current filtering (as specified on the Data page) into account when evaluating axis expressions. |
Enum options: allData, filteredData | ||
hierarchyOption
|
String | [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. Available in the |
Methods
setAxisMode(axisMode)
Sets the axis mode.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
axisMode
|
SpotfireAxisModes {Enum} ▼ | can be the label (GUI style) or the real enumeration value. |
Enum options: continuous, categorical |
setCategoryMode(categoryMode)
Sets the category axis mode.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
categoryMode
|
SpotfireCategoryModes {Enum} ▼ | can be the label (GUI style) or the real enumeration value. |
Enum options: showFiltered, showFilteredRange, showAll |
setEvaluationMode(evaluationMode)
Sets the axis evaluation mode.
- Inherited From:
Parameters:
Name | Type | Description |
---|---|---|
evaluationMode
|
SpotfireAxisEvaluationMode {Enum} ▼ | can be the label (GUI style) or the real enumeration value. |
Enum options: allData, filteredData |