AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.scales.StockScatterDateTime Improve this Doc

Extends: anychart.core.Base

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

Getter for the full scale maximum.

Returns:

number - Full scale minimum value.

getFullMinimum

Getter for the full scale minimum.

Returns:

number - Full scale minimum value.

getMaximum

Getter for the scale maximum.

Returns:

number - Scale maximum.

getMinimum

Getter for the scale minimum.

Returns:

number - Scale minimum.

inverseTransform

Processes reverse transformation of the ratio backward to value.

Params:

NameTypeDescription
rationumberValue to ratio.

Returns:

number - Returns timestamp.

maximumGap

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();
Setter for the scale maximum gap.

Params:

NameTypeDescription
maxGapanychart.scales.StockScatterDateTime.GapConfig | nullMaximum 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.

minimumGap

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();
Setter for the scale minimum gap.

Params:

NameTypeDescription
minGapanychart.scales.StockScatterDateTime.GapConfig | nullMinimum 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.

ticks

Getter for scale ticks.
See listing
var xScale = chart.xScale();
var ticks = xScale.ticks();
Setter for scale ticks.

Params:

NameTypeDescription
ticksanychart.scales.StockScatterDateTime.TicksSettingsTicks settings to set.

Returns:

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

ticksCount

Getter for the minor ticks count.

Returns:

number - Returns minor ticks count
See listing
var xScale = chart.xScale();
var ticksCount = xScale.ticksCount();
Setter for the minor ticks count.

Params:

NameTypeDefaultDescription
countnumber
6
Ticks count to set.

Returns:

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

transform

Transforms values to ratio.

Params:

NameTypeDescription
valuenumber | string | DateValue to transform.

Returns:

number - Value to ratio.