class anychart.core.axes.StockDateTime Improve this Doc

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

background()Since version 7.7.0

Getter for axis background settings.

Returns:

anychart.core.ui.Background - Axis background.

Try it:

Usage sample

background(value)Since version 7.7.0

Setter for axis background settings.

Detailed description

Sets axis background settings depending on parameter type:

null/boolean - disable or enable axis background.
object - sets axis background settings.
string - sets background fill color.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null \| string	false	Background settings.

Returns:

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

Try it:

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

height

height()Since version 7.7.0

Getter for the axis height.

Returns:

number - Axis height.

Try it:

Usage sample

height(value)Since version 7.7.0

Setter for the axis height.

Params:

Name	Type	Default	Description
value	number	25	Axis height

Returns:

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

Try it:

Usage sample

labels

labels()Since version 7.7.0

Getter for axis labels settings.

Returns:

anychart.core.ui.LabelsFactory - Axis labels.

Try it:

Usage sample

labels(value)Since version 7.7.0

Setter for axis labels settings.

Detailed description

Sets axis labels settings depending on parameter type:

null/boolean - disable or enable axis labels.
object - sets axis labels settings.

Note: If you use "false" to turn off the labels on ordinal scale, the first label will be disabled, and other labels will be minor.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Axis labels settings.

Returns:

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

Try it:

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		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		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

minorLabels

minorLabels()Since version 7.7.0

Getter for minor labels settings.

Returns:

anychart.core.ui.LabelsFactory - Axis labels settings.

Try it:

Usage sample

minorLabels(value)Since version 7.7.0

Setter for minor labels settings.

Detailed description

Sets axis minor labels settings depending on parameter type:

null/boolean - disable or enable axis minor labels.
object - sets axis minor labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Axis labels settings.

Returns:

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

Try it:

minorTicks

minorTicks()Since version 7.7.0

Getter for minor ticks.

Returns:

anychart.core.axes.StockTicks - Axis minor ticks settings.

Try it:

Usage sample

minorTicks(value)Since version 7.7.0

Setter for the minor ticks.

Detailed description

Sets axis minor ticks settings depending on parameter type:

null/boolean - disable or enable axis minor ticks.
object - sets axis minor ticks settings.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	false	Axis minor ticks.

Returns:

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

Try it:

overlapMode

overlapMode()Since version 7.7.0

Getter for labels overlap mode.

Returns:

anychart.enums.StockLabelsOverlapMode - Overlap mode.

Try it:

Usage sample

overlapMode(value)Since version 7.7.0

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

Params:

Name	Type	Default	Description
value	anychart.enums.StockLabelsOverlapMode	"noOverlap"	Value to set.

Returns:

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

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

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

showHelperLabel

showHelperLabel()Since version 7.7.0

Getter for the drawing helper label.

Returns:

boolean - Drawing state.

Try it:

Usage sample

showHelperLabel(value)Since version 7.7.0

Setter for the drawing helper label. Whether to draw helper label (leftmost hanging label).

Params:

Name	Type	Default	Description
value	boolean	true	Boolean flag.

Returns:

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

Try it:

Usage sample

ticks

ticks()Since version 7.7.0

Getter for axis ticks.

Returns:

anychart.core.axes.StockTicks - Axis ticks settings.

Try it:

Usage sample

ticks(value)Since version 7.7.0

Getter for axis ticks.

Detailed description

Sets axis ticks settings depending on parameter type:

null/boolean - disable or enable axis ticks.
object - sets axis ticks settings.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	false	Axis ticks.

Returns:

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

Try it:

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		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.