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.
ticks()Ticks settings
ticksCount()Minor ticks count
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

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.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

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.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.