Top
You are looking at an outdated 7.14.3 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.scales.StockScatterDateTime Improve this Doc

Extends: anychart.core.Base

Stock scatter datetime scale class.

Methods Overview

Specific settings
getFullMaximum()Getter for the full scale maximum.
getFullMinimum()Getter for the full scale minimum.
getMaximum()Getter for the current scale maximum.
getMinimum()Getter for the current scale minimum.
inverseTransform()Processes reverse transformation of the ratio backward to value.
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.

Try it:

getFullMinimum

Getter for the full scale minimum.

Returns:

number - Full scale minimum value.

Try it:

getMaximum

Getter for the current scale maximum.

Returns:

number - Scale maximum.

Try it:

getMinimum

Getter for the current scale minimum.

Returns:

number - Scale minimum.

Try it:

inverseTransform

Processes reverse transformation of the ratio backward to value.

Params:

Name Type Description
ratio number Value to ratio.

Returns:

number - Returns timestamp.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
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:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
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:

removeAllListeners

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:

transform

Transforms values to ratio.

Params:

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

Returns:

number - Value to ratio.

Try it:

unlisten

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

Params:

Name Type Default Description
type string
The event type id.
listener function
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:

unlistenByKey

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: