class anychart.scales.ScatterBase Improve this Doc

Extends: anychart.scales.Base

The ScatterBase class contains methods for configuring all scatter scales (Linear, Logarithmic and DateTime).
Doesn't declare any ticks, so different scales can declare their own.

Methods Overview

Specific settings
alignMaximum()	Align maximum settings.
alignMinimum()	Align minimum settings.
extendDataRange()	Extends the current input domain with the passed values (if such don't exist in the domain).
finishAutoCalc()	Informs the scale that an auto-range calculation started for the chart in past was ended.
inverseTransform()	Returns tick by its position ratio.
inverted()	Inversion state.
maxTicksCount()	Maximum ticks count.
maximum()	Scale maximum.
minimum()	Scale minimum.
startAutoCalc()	Informs scale that an auto-range calculation started for the chart, so it should reset its data range on the first
transform()	Returns tick position ratio by its name.

Methods Description

alignMaximum

alignMaximum()Since version 8.2.0

Getter for a flag if the maximum should be aligned by major ticks interval.

Returns:

boolean - Whether to enable maximum alignment by interval.

See listing

var scale = chart.yScale();
var alignMaximum = scale.alignMaximum();

alignMaximum(enabled)Since version 8.2.0

Getter for a flag if the maximum should be aligned by major ticks interval.

Detailed description

This method allows to align the maximum value on a scale by the major interval.
If set to false, the scale bounds don't align.

Params:

Name	Type	Description
enabled	boolean	Whether to enable maximum alignment by interval.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

alignMinimum

alignMinimum()Since version 8.2.0

Setter for a flag if the minimum should be aligned by major ticks interval.

Returns:

boolean - Whether to enable minimum alignment by interval.

See listing

var scale = chart.yScale();
var alignMinimum = scale.alignMinimum();

alignMinimum(enabled)Since version 8.2.0

Setter for a flag if the minimum should be aligned by major ticks interval.

Detailed description

This method allows to align the minimum value on a scale by the major interval.
If set to false, the scale bounds don't align.

Params:

Name	Type	Description
enabled	boolean	Whether to enable minimum alignment by interval.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

extendDataRange

extendDataRange(var_args)

Extends the current input domain with the passed values (if such don't exist in the domain).
Note: Attention! anychart.scales.Base#finishAutoCalc drops all passed values.

Params:

Name	Type	Description
var_args	*	Values that are supposed to extend the input domain.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

Usage sample

finishAutoCalc

finishAutoCalc(silently)

Informs the scale that an auto-range calculation started for the chart in past was ended.

Params:

Name	Type	Description
silently	boolean	If this flag is set, do not dispatch an event if reapplication needed.

Returns:

boolean - If the calculation changed the scale and it needs to be reapplied.

inverseTransform

inverseTransform(ratio)

Returns tick by its position ratio.
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().

Params:

Name	Type	Description
ratio	number	Value to transform in input scope.

Returns:

* - Value transformed to output scope.

Try it:

Usage sample

inverted

inverted()

Getter for the scale inversion.

Returns:

boolean - The inversion state.

inverted(enabled)

Setter for scale inversion.
If the scale is inverted, axes and series go upside-down or right-to-left instead of bottom-to-top and left-to-right.

Params:

Name	Type	Default	Description
enabled	boolean	false	Inverted state to set.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

Usage sample

maxTicksCount

maxTicksCount()Since version 7.13.0

Getter for the maximum ticks count.

Returns:

number - Maximum ticks count.

See listing

var maxTicksCount = scale.maxTicksCount();

maxTicksCount(count)Since version 7.13.0

Setter for the maximum ticks count.

Detailed description

Use this method only if you set the ticks with the anychart.scales.ScatterTicks#interval method. It is ignored if the number of ticks is set manually via the method anychart.scales.ScatterTicks#count.
The method does not summarize both major and minor ticks, considering each separately, but the whole range from minimum to maximum.
If the number of ticks is greater than the passed value, the auto-calculation drops the interval from 4 to 6 ticks.

Params:

Name	Type	Default	Description
count	number	1000	Maximum ticks count to set.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

Usage sample

maximum

maximum()

Getter for the scale maximum.

Returns:

number - Scale maximum.

See listing

var scale = chart.yScale();
var maximum = scale.maximum();

maximum(maximum)

Setter for the scale maximum.

Params:

Name	Type	Default	Description
maximum	number	null	Maximum value to set.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

Usage sample

minimum

minimum()

Getter for the scale minimum.

Returns:

number - Scale minimum.

See listing

var scale = chart.yScale();
var minimum = scale.minimum();

minimum(minimum)

Setter for the scale minimum.

Params:

Name	Type	Default	Description
minimum	number	null	Scale minimum to set.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

Try it:

Usage sample

startAutoCalc

startAutoCalc()

Informs scale that an auto-range calculation started for the chart, so it should reset its data range on the first call of this method if needed.

Returns:

anychart.scales.ScatterBase - Self instance for method chaining.

transform

transform(value)

Returns tick position ratio by its name.
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().

Params:

Name	Type	Description
value	*	Value to transform in input scope.

Returns:

number - Value transformed to scope [0, 1].

Try it:

Usage sample