AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.axes.Timeline Improve this Doc

Extends: anychart.core.VisualBase

Timeline chart axis.

Methods Overview

Coloring
fill()Fill settings.
stroke()Stroke settings.
Miscellaneous
height()Height settings.
labels()Labels settings.
ticks()Ticks settings.

Methods Description

fill

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill - Fill settings (empty fill is always 'none').
Setter for fill settings using an object, an array or a string.
Accepts: or a color as a string, along with opacity, if needed, format is "Color Opacity", e.g. "red 0.5".

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Fill as an object, an array or a string.

Returns:

anychart.core.axes.Timeline - Self instance for method chaining.
Fill as a color with opacity.

Params:

NameTypeDescription
colorstringFill color as a string.
opacitynumberFill opacity.

Returns:

anychart.core.axes.Timeline - Self instance for method chaining.
Linear gradient fill.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.axes.Timeline - Self instance for method chaining.
Radial gradient fill.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

height

Getter for the height.

Returns:

number - Axis height
Setter for the height.

Params:

NameTypeDescription
heightnumberHeight value.

Returns:

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

labels

Axis labels settings getter.

Returns:

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

Params:

NameTypeDescription
configObjectLabels settings.

Returns:

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

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
Setter for axis stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
'#CECECE'
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.axes.Timeline - Self instance for method chaining.
Setter for axis stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

ticks

Axis ticks getter.

Returns:

anychart.core.axes.TimelineTicks - Ticks settings.
Axis ticks setter.

Params:

NameTypeDescription
configObjectAxis ticks settings.

Returns:

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