Class

SpotfireScaleAxis

SpotfireScaleAxis([axisDescription])

Represents a scale axis description.

Constructor

new SpotfireScaleAxis([axisDescription])

Parameters:
Name Type Description
[ axisDescription ] SpotfireAxisDescription ▼
type string

The type of the axis to create.
columns 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 string

Specifies whether the column or hierarchy should be treated as continuous or categorical. From SpotfireAxisModes
categoryMode string

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. From SpotfireCategoryModes
evaluationMode string

Determines how to evaluate the axis. 'Auto': to automatically evaluate the axis based on the data; 'Manual': to manually evaluate the axis based on the specified range. From SpotfireAxisEvaluationMode
[ columns ] 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 ] SpotfireAxisModes ▼

Specifies whether the column or hierarchy should be treated as continuous or categorical.
continuous String

For numerical columns, when you want the values to be treated as continuous, numerical values.
Other available value: 'Continuous'.
categorical String

When you want the values to be seen as categories rather than numerical values.
Other available value: 'Categorical'.
[ categoryMode ] SpotfireCategoryModes ▼

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.
showFiltered String

To display values available after current filtering only. This means that those categories that are visible will change with the filtering and that categories currently without any values will be hidden from the visualization.
Other available values: 'Show filtered values', 'ShowFiltered'.
showFilteredRange String

To hide empty categories on both ends of the currently visible range. This means that those categories that are visible will change with the filtering, and that empty categories within the currently visible range will remain visible.
Other available values: 'Show filtered range', 'ShowFilteredRange'.
showAll String

To keep all categories visible even if data for some categories have been filtered out.
Other available values: 'Show all values', 'ShowAll'.
[ evaluationMode ] SpotfireAxisEvaluationMode ▼

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.
allData String

Apply to all data.
Other available values: 'All data', 'AllData'.
filteredData String

Apply to filtered data.
Other available values: 'Current filtering only', 'FilteredData'.
[ range ] Object
min Object

Determines the lower value of the axis range.
max Object

Determines the lower value of the axis range.
dataType SpotfireDataTypes

Specifies the data type of the range values if you want to force the formatting. It is particularly useful for the DateTime format.
[ 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 ] SpotfireLabelOrientations ▼

Shows scale labels horizontally or vertically.
horizontal String
vertical String
[ maxNumberOfLabels ] Number

Specifies a maximum number of scale labels to be shown, between 0 and 200.
[ individualScalingMode ] SpotfireIndividualScalingModes ▼

[Available for Y-axis and Value axis only.] Specifies if one scale should be displayed for each category used to color the markers by or for each trellis panel.
Note: you should apply a coloring or a trellis before applying this property, see the visualization examples SpotfireBarChart.
color String
trellis String
[ ranges ] Array.<Object>

Array of individual scales to apply. Override the range property.
[].scale String

Specifies the scale on which apply the range.
[].position SpotfireScaleDockPositions ▼

Specifies if the scale should be placed on the left-hand side of the visualization or on the right-hand side.
left String
right String
[].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

defaultValues()

Sets default values for the current axis.

setAxisMode(axisMode)

Sets the axis mode.

Overrides:
Parameters:
Name Type Description
axisMode string

Label or enumeration value of the axis mode.

setCategoryMode(categoryMode)

Sets the category axis mode.

Overrides:
Parameters:
Name Type Description
categoryMode string

Label or enumeration value of the category mode.

setEvaluationMode(evaluationMode)

Sets the axis evaluation mode.

Overrides:
Parameters:
Name Type Description
evaluationMode string

Label or enumeration value of the evaluation mode.