Top
You are looking at an outdated 7.10.0 version of this document. Switch to the 8.0.1 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 width.
zIndex()Z-index of the element.

Methods Description

background

Getter for the current axis background settings.

Returns:

anychart.core.ui.Background - The current axis background.

Try it:

Setter for the axis background settings.

Params:

Name Type Description
value Object | boolean | null | string 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.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

height

Getter for the current axis height.

Returns:

number - The current axis height.

Try it:

Setter for the axis height.

Params:

Name Type Default Description
value number
18
Axis height

Returns:

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

Try it:

labels

Getter for the current axis labels settings.

Returns:

anychart.core.ui.LabelsFactory - Axis labels.

Try it:

Setter for the axis labels settings.

Params:

Name Type Default Description
value Object | 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:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

minorLabels

Getter for the current minor labels settings.

Returns:

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

Try it:

Setter for the minor labels settings.

Params:

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

Returns:

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

minorTicks

Getter for the current minor ticks.

Returns:

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

Try it:

Setter for the minor ticks.

Params:

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

Returns:

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

overlapMode

Getter for the current overlap mode.

Returns:

anychart.enums.StockLabelsOverlapMode - Overlap mode.

Try it:

Setter for the 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:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
landscape boolean
false
Flag of landscape.

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:

showHelperLabel

Gets boolean flag for drawing helper label.

Returns:

boolean - Drawing state.

Try it:

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:

ticks

Getter for the current axis ticks.

Returns:

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

Try it:

Getter for the axis ticks.

Params:

Name Type Default Description
value Object | 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:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: