Constructor
new SpotfireScaleAxis(axisDescription)
Represents a scale 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 | ||
range
|
ScaleAxisRange ▼ | |
min
|
Number | Determines the lower value of the axis range. |
max
|
Number | Determines the upper value of the axis range. |
includeOriginInRange
|
Boolean | [Available for continuous axes only.] Specifies whether or not the value 0 should be included in the axis, regardless of filtering. |
showZoomSlider
|
Boolean | Specifies whether or not a zoom slider that you can manually manipulate to view only the interesting markers in the visualization should be visible. |
showGridLines
|
Boolean | Specifies whether or not vertical grid lines should be visible. |
logScale
|
Boolean | Specifies whether or not the scale changes from a linear scale to a logarithmic base 10 scale. |
reverseScale
|
Boolean | Specifies whether or not the current sort order should be reversed, so that the lowest value is displayed at the top of the scale. |
showLabels
|
Boolean | Specifies whether or not scale labels should be visible. |
labelOrientation
|
String | ['Horizontal'|'Vertical']. Shows scale labels horizontally or
vertically. Available in the |
maxNumberOfLabels
|
Number | Specifies a maximum number of scale labels to be shown, between 0 and 200. |
individualScalingMode
|
String | [Available for Y-axis and Value axis only.]
['Color'|'Trellis'] Specifies if one scale should be displayed for each category used to color the markers by
or for each trellis panel. Available in the |
ranges
|
IndividualScaleRange ▼ | Array of individual scales to apply. Override the range property. |
[].scale
|
String | Specifies the scale on which apply the range. |
[].position
|
String | Specifies if the scale should be placed on the
left-hand side of the visualization or on the right-hand side. Available in the |
[].min
|
Number | Determines the lower value of the scale range. |
[].max
|
Number | Determines the highest value of the scale range. |
[].includeOriginInRange
|
Boolean | [Available for continuous axes only.] Specifies whether or not the value 0 should be included in the axis, regardless of filtering. |
[].reverseScale
|
Boolean | Specifies whether or not the current sort order should be reversed, so that the lowest value is displayed at the top of the scale. |
Methods
addIndividualRange(rangeDescription)
Adds a range for multiple scale axis.
Parameters:
Name | Type | Description |
---|---|---|
rangeDescription
|
ScaleRangeDescription |
defaultValues()
Sets default values for the current axis.
getExpression()
Gets the expression corresponding to the column or hierarchy to display on the axis.
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 |
setLabelOrientation(axisDescription)
Sets the label orientation for the current axis.
Parameters:
Name | Type | Description |
---|---|---|
axisDescription
|
Object | |
labelOrientation
|
SpotfireLabelOrientations {Enum} ▼ | |
Enum options: horizontal, vertical |
setRange(range)
Set the range for scale for unique scale axis
Parameters:
Name | Type | Description |
---|---|---|
range
|
SpotfireRange |
setRanges(ranges)
For scale axis that has multiple scale (case for value), sets the ranges if specified.
Parameters:
Name | Type | Description |
---|---|---|
ranges
|
Array.<ScaleRangeDescription> |