Class

SpotfireGroupByAxis

SpotfireGroupByAxis(axisDescription)

Represents a group by axis description.

Constructor

new SpotfireGroupByAxis(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).

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.