Class

SpotfireScaleAxis

SpotfireScaleAxis(axisDescription)

Constructor

new SpotfireScaleAxis(axisDescription)

Represents a scale axis description.

Parameters:
Name Type Description
axisDescription scaleAxisDescription
range Object
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 SpotfireLabelOrientations  {Enum} 

Shows scale labels horizontally or vertically.

Enum options: horizontal, vertical
maxNumberOfLabels Number

Specifies a maximum number of scale labels to be shown, between 0 and 200.

individualScalingMode SpotfireIndividualScalingModes  {Enum} 

[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.

Enum options: color, trellis
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  {Enum} 

Specifies if the scale should be placed on the left-hand side of the visualization or on the right-hand side.

Enum options: left, right
[].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.