AnyChart
API Reference
Still have questions?
Contact support
Top

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
settingsObject | boolean | null | string
false
Background settings.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state 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
heightnumber
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
settingsObject | 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:

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.

minorLabels

Getter for minor labels settings.

Returns:

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

Params:

NameTypeDescription
settingsObject | boolean | nullAxis labels settings.

Returns:

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

minorTicks

Getter for minor ticks.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Axis minor ticks.

Returns:

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

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.StockLabelsOverlapMode | string - Overlap mode.
Setter for labels overlap mode. Whether to allow labels to overlap.

Params:

NameTypeDefaultDescription
modeanychart.enums.StockLabelsOverlapMode | string
'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
settingsboolean
true
Boolean flag.

Returns:

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

ticks

Getter for axis ticks.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | 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:

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.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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