Class

SpotfireHeatMapMeasureAxis

SpotfireHeatMapMeasureAxis(axisDescription)

Represents a heat map measure axis description.

Constructor

new SpotfireHeatMapMeasureAxis(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
axisMode SpotfireAxisModes ▼

Read-only parameter, set to 'Continuous'.
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 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'.

Methods

getExpression()

Gets the expression corresponding to the column(s) to display on the 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.