AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.core.resource.TimeLine Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Resource Chart Timeline element.

Methods Overview

Specific settings
drawBottomLine()Drawing of the bottom line.
drawLeftLine()Drawing of the left line.
drawRightLine()Drawing of the right line.
drawTopLine()Drawing of the top line.
format()Function to format content text.
holidays()Padding settings
overlay()Overlay element.
Advanced Text Settings
maxFontSize()Maximum font size settings.
minFontSize()Minimum font size settings.
Coloring
background()Background settings.
fill()Fill settings.
stroke()Stroke settings.
Content Text Settings
useHtml()Use HTML option.
vAlign()Text vertical align 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
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
Text Settings
adjustFontSize()Adjusting settings.
disablePointerEvents()Pointer events settings.
fontColor()Font color settings.
fontDecoration()Font decoration setting.
fontFamily()Font family settings.
fontOpacity()Font opacity settings.
fontSize()Font size settings.
fontStyle()Font style settings.
fontVariant()Font variant settings.
fontWeight()Font weight settings.
hAlign()Text horizontal align settings.
letterSpacing()Text letter spacing settings.
lineHeight()Text line height setting.
selectable()Text selectable option.
textDirection()Text direction settings.
textIndent()Text indent settings.
textOverflow()Text overflow settings.
textWrap()Text wrap setting.
Miscellaneous
levelHeight()Getter for the level height.

Methods Description

adjustFontSize

Getter for the adjusting font size.

Returns:

number - An adjusted font size.
See listing
var timeLine = chart.timeLine();
var adjustFontSize = timeLine.adjustFontSize();
Setter for the adjusting font size.

Params:

NameTypeDescription
adjustOrAdjustByWidthboolean | Array.<boolean> | ObjectIs font needs to be adjusted in case of 1 argument and adjusted by width in case of 2 arguments.
adjustByHeightbooleanIs font needs to be adjusted by height.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

background

Getter for the background.

Returns:

anychart.core.ui.Background - Background settings.
Setter for the background.

Params:

NameTypeDescription
valuestring | Object | null | booleanValue to set

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

bottom

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

anychart.core.resource.TimeLine - Returns self for method chaining.

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

disablePointerEvents

Getter for the pointer events settings.

Returns:

boolean - The pointer events settings.
See listing
var timeLine = chart.timeLine();
var disablePointerEvents = timeLine.disablePointerEvents();
Setter for the pointer events setting.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

drawBottomLine

Getter for the bottom line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawBottomLine();
Setter for the bottom line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawLeftLine

Getter for the left line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawLeftLine();
Setter for the left line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawRightLine

Getter for the right line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawRightLine();
Setter for the right line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawTopLine

Getter for the top line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawTopLine();
Setter for the top line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

fill

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill - The fill color.
See listing
var currentTimeLine = chart.timeLine();
var currentFill = currentTimeLine.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.
Fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

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.resource.TimeLine - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontColor

Getter for font color settings.

Returns:

string - Font color settings.
Example
var timeLine = chart.timeLine();
var fontColor = timeLine.fontColor();
Setter for font color settings.

Params:

NameTypeDescription
valuestringValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontDecoration

Getter for font decoration settings.

Returns:

anychart.graphics.vector.Text.Decoration - Font decoration settings.
Example
var timeLine = chart.timeLine();
var fontDecoration = timeLine.fontDecoration();
Setter for font decoration settings.

Params:

NameTypeDescription
valueanychart.graphics.vector.Text.Decoration | stringValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontFamily

Getter for font family settings.

Returns:

string - Font family settings.
See listing
var timeLine = chart.timeLine();
var fontFamily = timeLine.fontFamily();
Setter for font family settings.

Params:

NameTypeDefaultDescription
valuestring
"Helvetica Neue", Helvetica, sans-serif
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontOpacity

Getter for font opacity settings.

Returns:

number - Font opacity settings.
Example
var timeLine = chart.timeLine();
var fontOpacity = timeLine.fontOpacity();
Setter for font opacity settings.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontSize

Getter for font size settings.

Returns:

number - Font size settings.
Example
var currentTooltipSettings = chart.tooltip();
var currentValue = currentTooltipSettings.fontSize();
Setter for font size settings.

Params:

NameTypeDefaultDescription
valuenumber | string
11
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontStyle

Getter for font style settings.

Returns:

anychart.graphics.vector.Text.FontStyle - Font style settings.
Example
var timeLine = chart.timeLine();
var fontStyle = timeLine.fontStyle();
Setter for font style settings.

Params:

NameTypeDescription
valuestring | anychart.graphics.vector.Text.FontStyleValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontVariant

Getter for font variant settings.

Returns:

anychart.graphics.vector.Text.FontVariant - Font variant settings.
Example
var timeLine = chart.timeLine();
var fontVariant = timeLine.fontVariant();
Setter for font variant settings.

Params:

NameTypeDescription
valuestring | anychart.graphics.vector.Text.FontVariantValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

fontWeight

Getter for font weight settings.

Returns:

string | number - Font weight settings.
Example
var timeLine = chart.timeLine();
var fontWeight = timeLine.fontWeight();
Setter for font weight settings.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

format

Getter for the function content text.

Returns:

function | string - Token or function to format text.
Example
var format = timeLine.format();
Setter for the function content text.
Learn more about using format() method.

Params:

NameTypeDescription
valuefunction | stringFunction or string token to format content text.

Returns:

anychart.core.resource.TimeLineLevelHolidaysSettings - Self instance for method chaining.

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

hAlign

Getter for text horizontal align settings.

Returns:

anychart.graphics.vector.Text.HAlign - Horizontal align settings.
Example
var timeLine = chart.timeLine();
var hAlign = timeLine.hAlign();
Setter for the text horizontal align settings.

Params:

NameTypeDescription
valuestring | anychart.graphics.vector.Text.HAlignValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

height

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.
Sets element height setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

anychart.core.resource.TimeLine - Returns self for method chaining.

holidays

Setter for holidays settings.

Params:

NameTypeDescription
valueObjectValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

left

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

anychart.core.resource.TimeLine - Returns self for method chaining.

letterSpacing

Getter for text letter spacing settings.

Returns:

number - Letter spacing settings.
Example
var timeLine = chart.timeLine();
var letterSpacing = timeLine.letterSpacing();
Setter for text letter spacing settings.

Params:

NameTypeDescription
valuenumber | stringValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

levelHeight

Getter for the level height.

Returns:

number - The level height.
See listing
var currentTimeLine = chart.timeLine();
var currentHeight = currentTimeLine.levelHeight();
Setter for the level height.

Params:

NameTypeDescription
valuenumberLevel height.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

lineHeight

Getter for text line height settings.

Returns:

number | string - Line height settings.
Example
var timeLine = chart.timeLine();
var lineHeight = timeLine.lineHeight();
Setter for text line height settings.

Params:

NameTypeDefaultDescription
valuenumber | string
"normal"
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

maxFontSize

Getter for the maximum font size.

Returns:

number - Maximum font size.
See listing
var maxFontSize = timeLine.maxFontSize();
Setter for the maximum font size.

Params:

NameTypeDescription
valuenumber | stringValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

maxHeight

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.
Setter for maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

maxWidth

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.
Setter for maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

minFontSize

Getter for the minimum font size.

Returns:

number - Minimum font size.
See listing
var minFontSize = timeLine.minFontSize();
Setter for the minimum font size.

Params:

NameTypeDescription
valuenumber | stringValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

minHeight

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.
Setter for minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

minWidth

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.
Setter for minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

overlay

Getter for the overlay element.

Returns:

anychart.core.ui.Overlay - Overlay element.
See listing
var element = timeLine.overlay();
Setter for the overlay element.

Params:

NameTypeDescription
valueObject | null | booleanValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

padding

Getter for the padding.

Returns:

anychart.core.utils.Padding - Padding.
Setter for paddings in pixels using a single value.

Params:

NameTypeDescription
valuenull | Array.<(number|string)> | ObjectValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.
Examples for paddings
// all paddings 15px
timeLine.padding(15);
// all paddings 15px
timeLine.padding('15px');
// top and bottom 5px ,right and left 15px
timeLine.padding(anychart.utils.padding(5,15));
Setter for paddings in pixels using several numbers.

Params:

NameTypeDescription
value1string | numberTop or top-bottom space.
value2string | numberRight or right-left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.
Examples for paddings
// 1) top and bottom 10px, left and right 15px
timeLine.padding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
timeLine.padding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
timeLine.padding(10, '15px', '5px', 12);

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.
Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

anychart.core.resource.TimeLine - Returns self for method chaining.

selectable

Getter for the text selectable option.

Returns:

boolean - Text selectable value.
Example
var timeLine = chart.timeLine();
var selectable = timeLine.selectable();
Setter for the text selectable option.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

stroke

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke - The stroke.
See listing
var currentTimeLine = chart.timeLine();
var currentStroke = currentTimeLine.stroke();
Setter for the stroke. Learn more about stroke settings.

Params:

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

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

textDirection

Getter for the text direction settings.

Returns:

anychart.graphics.vector.Text.Direction - Text direction settings.
Example
var timeLine = chart.timeLine();
var textDirection = timeLine.textDirection();
Setter for text direction settings.

Params:

NameTypeDescription
valuestring | anychart.graphics.vector.Text.DirectionValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

textIndent

Getter for text-indent settings.

Returns:

number - Text indent settings.
Example
var timeLine = chart.timeLine();
var textIndent = timeLine.textIndent();
Setter for text-indent settings.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

textOverflow

Getter for text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow - Text overflow settings
Example
var timeLine = chart.timeLine();
var textOverflow = timeLine.textOverflow();
Setter for text overflow settings.

Params:

NameTypeDescription
valueanychart.graphics.vector.Text.TextOverflow | stringValue to set

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

textWrap

Getter for text wrap settings.

Returns:

anychart.graphics.vector.Text.TextWrap - Text wrap settings.
Example
var timeLine = chart.timeLine();
var textWrap = timeLine.textWrap();
Setter for text wrap settings.

Params:

NameTypeDescription
valuestring | anychart.graphics.vector.Text.TextWrapValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

top

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

anychart.core.resource.TimeLine - Returns self for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.

useHtml

Getter for the useHTML flag.

Returns:

boolean - UseHTML flag.
Example
var timeLine = chart.timeLine();
var useHtml = timeLine.useHtml();
Setter for the useHTML flag.

Params:

NameTypeDescription
valuebooleanValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

vAlign

Getter for text vertical align settings.

Returns:

anychart.graphics.vector.Text.VAlign - Vertical align.
Example
var timeLine = chart.timeLine();
var vAlign = timeLine.vAlign();
Setter for text vertical align settings.

Params:

NameTypeDescription
valuestring | anychart.graphics.vector.Text.VAlignValue to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.

width

Getter for element width setting.

Returns:

number | string | undefined - Current element's width setting.
Sets element width setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

anychart.core.resource.TimeLine - Returns self for method chaining.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.core.resource.TimeLine - Self instance for method chaining.