class anychart.scales.StockOrdinalDateTime Improve this Doc

Extends: anychart.scales.StockScatterDateTime

The StockOrdinalDateTime class contains methods for configuring ordinal date time 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.
transform()	Transforms values to ratio.
Events
listen()	Adds an event listener
listenOnce()	Adds a single time event listener
removeAllListeners()	Removes all listeners
unlisten()	Removes the listener
unlistenByKey()	Removes the listener by the key

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

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method. Function that looks like: function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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.StockOrdinalDateTime - 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.StockOrdinalDateTime - Self instance for method chaining.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

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

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object):boolean\|undefined		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name	Type	Description
key	Object	The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample