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.
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(settings)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
settings	Object \| boolean \| null \| string	false	Background settings.

Returns:

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

Try it:

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

height

height()Since version 7.7.0

Getter for the axis height.

Returns:

number - Axis height.

Try it:

Usage sample

height(height)Since version 7.7.0

Setter for the axis height.

Params:

Name	Type	Default	Description
height	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(settings)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
settings	Object \| boolean \| null	true	Axis labels settings.

Returns:

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

Try it:

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(settings)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
settings	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.Ticks - Axis minor ticks settings.

Try it:

Usage sample

minorTicks(settings)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
settings	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 | string - Overlap mode.

Try it:

Usage sample

overlapMode(mode)Since version 7.7.0

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

Params:

Name	Type	Default	Description
mode	anychart.enums.StockLabelsOverlapMode \| string	'noOverlap'	Value to set.

Returns:

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

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(settings)Since version 7.7.0

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

Params:

Name	Type	Default	Description
settings	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.Ticks - Axis ticks settings.

Try it:

Usage sample

ticks(settings)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
settings	Object \| boolean \| null	false	Axis ticks.

Returns:

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

Try it:

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

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

Try it:

Usage sample