class anychart.scales.StockScatterDateTime Improve this Doc

The StockScatterDateTime class contains methods for configuring scatter datetime scale on the Stock.

Methods Overview

Specific settings
getFullMaximum()	Getter for the full scale maximum.
getFullMinimum()	Getter for the full scale minimum.
getMaximum()	Getter for the scale maximum.
getMinimum()	Getter for the scale minimum.
inverseTransform()	Processes reverse transformation of the ratio backward to value.
maximumGap()	Maximum gap settings.
minimumGap()	Minimum gap settings.
ticks()	Ticks settings
ticksCount()	Minor ticks count
transform()	Transforms values to ratio.

Methods Description

getFullMaximum

getFullMaximum()Since version 7.7.0

Getter for the full scale maximum.

Returns:

number - Full scale minimum value.

Try it:

Usage sample

getFullMinimum

getFullMinimum()Since version 7.7.0

Getter for the full scale minimum.

Returns:

number - Full scale minimum value.

Try it:

Usage sample

getMaximum

getMaximum()Since version 7.7.0

Getter for the scale maximum.

Returns:

number - Scale maximum.

Try it:

Usage sample

getMinimum

getMinimum()Since version 7.7.0

Getter for the scale minimum.

Returns:

number - Scale minimum.

Try it:

Usage sample

inverseTransform

inverseTransform(ratio)Since version 7.7.0

Processes reverse transformation of the ratio backward to value.

Params:

Name	Type	Description
ratio	number	Value to ratio.

Returns:

number - Returns timestamp.

Try it:

Usage sample

maximumGap

maximumGap()Since version 8.4.2

Getter for the scale maximum gap.

Returns:

anychart.scales.StockScatterDateTime.GapConfig - Returns the maximum gap configuration.

See listing

var scale = chart.xScale();
var maximumGap = scale.maximumGap();

maximumGap(maxGap)Since version 8.4.2

Setter for the scale maximum gap.

Detailed description

The maximumGap() method adds a gap to the scale. It looks like empty space on the X axis near the maximum value.
Allows to add annotations or markers (lineMarker, textMarker, rangeMarker) with a 'consider' mode (lineMarker.scaleRangeMode('consider')) out of the interval defined by the data.

Params:

Name	Type	Description
maxGap	anychart.scales.StockScatterDateTime.GapConfig \| null	Maximum gap configuration to set. The null parameter resets the gap configuration to the default value ({intervalsCount: 0}). It is recommended to set unitType or unitCount in the configuration because otherwise these values will be set from anychart.core.stock.Grouping#getCurrentDataInterval that depends on the current zoom. If unitType or unitCount is not set, it might provide an unexpected behavior for the user.

Returns:

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

Try it:

Usage sample

minimumGap

minimumGap()Since version 8.4.2

Getter for the scale minimum gap.

Returns:

anychart.scales.StockScatterDateTime.GapConfig - Returns the minimum gap configuration.

See listing

var scale = chart.xScale();
var minimumGap = scale.minimumGap();

minimumGap(minGap)Since version 8.4.2

Setter for the scale minimum gap.

Detailed description

The minimumGap() method adds a gap to the scale. It looks like empty space on the X axis near the minimum value.
Allows to add annotations or markers (lineMarker, textMarker, rangeMarker) with a 'consider' mode (lineMarker.scaleRangeMode('consider')) out of the interval defined by the data.

Params:

Name	Type	Description
minGap	anychart.scales.StockScatterDateTime.GapConfig \| null	Minimum gap configuration to set. The null parameter resets the gap configuration to the default value ({intervalsCount: 0}). It is recommended to set unitType or unitCount in the configuration because otherwise these values will be set from anychart.core.stock.Grouping#getCurrentDataInterval that depends on the current zoom. If unitType or unitCount is not set, it might provide an unexpected behavior for the user.

Returns:

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

Try it:

Usage sample

ticks

ticks()

Getter for scale ticks.

Returns:

anychart.scales.StockScatterDateTime.TicksSettings - Ticks settings.

See listing

var xScale = chart.xScale();
var ticks = xScale.ticks();

ticks(ticks)

Setter for scale ticks.

Params:

Name	Type	Description
ticks	anychart.scales.StockScatterDateTime.TicksSettings	Ticks settings to set.

Returns:

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

Try it:

Usage sample

ticksCount

ticksCount()

Getter for the minor ticks count.

Returns:

number - Returns minor ticks count

See listing

var xScale = chart.xScale();
var ticksCount = xScale.ticksCount();

ticksCount(count)

Setter for the minor ticks count.

Params:

Name	Type	Default	Description
count	number	6	Ticks count to set.

Returns:

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

Try it:

Usage sample

transform

transform(value)Since version 7.7.0

Transforms values to ratio.

Params:

Name	Type	Description
value	number \| string \| Date	Value to transform.

Returns:

number - Value to ratio.

Try it:

Usage sample