AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.axes.StockDateTime Improve this Doc

Extends: anychart.core.VisualBase

Stock date time axis class.

Methods Overview

Specific settings
labels()Labels settings.
minorLabels()Minor labels settings.
minorTicks()Minor ticks settings.
overlapMode()Overlap mode.
showHelperLabel()Drawing helper label.
ticks()Ticks settings.
Coloring
background()Background settings.
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.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
height()Axis height.
zIndex()Z-index of the element.

Methods Description

background

Getter for axis background settings.

Returns:

anychart.core.ui.Background - Axis background.
Setter for axis background settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null | string
false
Background settings.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

height

Getter for the axis height.

Returns:

number - Axis height.
Setter for the axis height.

Params:

NameTypeDefaultDescription
valuenumber
25
Axis height

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

labels

Getter for axis labels settings.

Returns:

anychart.core.ui.LabelsFactory - Axis labels.
Setter for axis labels settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Axis labels settings.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

minorLabels

Getter for minor labels settings.

Returns:

anychart.core.ui.LabelsFactory - Axis labels settings.
Setter for minor labels settings.

Params:

NameTypeDescription
valueObject | boolean | nullAxis labels settings.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

minorTicks

Getter for minor ticks.

Returns:

anychart.core.axes.StockTicks - Axis minor ticks settings.
Setter for the minor ticks.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Axis minor ticks.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

overlapMode

Getter for labels overlap mode.
Setter for labels overlap mode. Whether to allow labels to overlap.

Params:

NameTypeDefaultDescription
valueanychart.enums.StockLabelsOverlapMode
"noOverlap"
Value to set.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

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.

showHelperLabel

Getter for the drawing helper label.

Returns:

boolean - Drawing state.
Setter for the drawing helper label. Whether to draw helper label (leftmost hanging label).

Params:

NameTypeDefaultDescription
valueboolean
true
Boolean flag.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.StockTicks - Axis ticks settings.
Getter for axis ticks.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Axis ticks.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.core.axes.StockDateTime - Self instance for method chaining.