AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.Timeline Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Class for the Gantt chart timeline.

Methods Overview

Specific settings
header()Timeline header settings.
markers()Markers settings.
Axes and Scales
lineMarker()Line marker settings.
rangeMarker()Range marker settings.
scale()Scale settings.
textMarker()Text marker settings.
Coloring
backgroundFill()Background fill settings.
columnStroke()Column stroke settings.
rowEvenFill()Row even settings.
rowFill()Row fill settings.
rowHoverFill()Row settings on hover fill.
rowOddFill()Row odd fill settings.
rowSelectedFill()Row settings in selected mode.
Elements
baselines()Baselines settings.
connectors()Connectors settings.
elements()Elements settings.
groupingTasks()Grouping tasks settings.
milestones()Milestones settings.
periods()Periods settings.
tasks()Tasks 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
edit()Live edit settings.
enabled()Element state (enabled or disabled).
horizontalScrollBar()Horizontal scroll bar settings.
tooltip()Tooltip settings.
verticalScrollBar()Vertical scroll bar settings.
Labels
labels()Labels settings.
Size and Position
baselineBarAnchor()Baseline bar anchor.
baselineBarHeight()Baseline bar height.
baselineBarOffset()Baseline bar offset.
baselineBarPosition()Baseline bar position.
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height settings.
left()Left bound settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
right()Right bound settings.
top()Top bound settings.
width()Width settings.
zIndex()Z-index of the element.
Miscellaneous
baseBarOffset()Setter for the base bar offset.

Methods Description

backgroundFill

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill | string - Background fill.
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Fill color with opacity.

Params:

NameTypeDefaultDescription
colorstring
'none'
Color as a string.
opacitynumber
Color opacity.

Returns:

anychart.core.ui.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.ui.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.ui.Timeline - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

baseBarOffset

Setter for the base bar offset.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

baselineBarAnchor

Getter for the baseline bar anchor.

Returns:

string | anychart.enums.Anchor - Baseline bar anchor.
See listing
var baselineBarAnchor = timeLine.baselineBarAnchor();
Setter for the baseline bar anchor.

Params:

NameTypeDescription
valuestring | anychart.enums.AnchorValue to set.

Returns:

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

baselineBarHeight

Getter for the baseline bar height.

Returns:

string | number - Baseline bar height.
See listing
var baselineBarHeight = timeLine.baselineBarHeight();
Setter for the baseline bar height.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

baselineBarOffset

Getter for the baseline bar offset.

Returns:

string | number - Baseline bar offset.
See listing
var baselineBarOffset = timeLine.baselineBarOffset();
Setter for the baseline bar offset.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

baselineBarPosition

Getter for the baseline bar position.

Returns:

string | anychart.enums.Anchor - Base bar position.
See listing
var baselineBarPosition = timeLine.baselineBarPosition();
Setter for the baseline bar position.

Params:

NameTypeDescription
valuestring | anychart.enums.AnchorValue to set.

Returns:

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

baselines

Getter for baselines.

Returns:

anychart.core.gantt.elements.BaselinesElement - Baselines instance.
Setter for baselines.

Params:

NameTypeDescription
settingsObjectObject with settings from anychart.core.gantt.elements.BaselinesElement.

Returns:

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

bottom

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

anychart.core.ui.Timeline - Returns self for method chaining.

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

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

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Setter for 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.ui.Timeline - Self instance for method chaining.

columnStroke

Getter for the column stroke.

Returns:

string | anychart.graphics.vector.Stroke - Column stroke.
Setter for the column stroke.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string
{color: "#ccd7e1", thickness: 1}
Value to set.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Setter for the column stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

connectors

Getter for connectors.

Returns:

anychart.core.gantt.elements.ConnectorElement - Connectors instance.
Setter for connectors.

Params:

NameTypeDescription
settingsObjectObject with settings from anychart.core.gantt.elements.ConnectorElement.

Returns:

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

edit

Getter for live edit settings.

Returns:

anychart.core.gantt.edit.StructureEdit - The live edit settings.
Setter for live edit settings. Learn more about Live editing.

Params:

NameTypeDefaultDescription
settingsObject | boolean
false
Live edit settings to set.

Returns:

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

elements

Setter for elements.

Params:

NameTypeDescription
settingsObjectObject with settings from anychart.core.gantt.elements.TimelineElement.

Returns:

anychart.core.ui.Timeline - 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.ui.Timeline - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

getPixelBounds

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

Returns:

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

groupingTasks

Getter for grouping tasks.

Returns:

anychart.core.gantt.elements.GroupingTasksElement - Grouping tasks instance.
Setter for grouping tasks.

Params:

NameTypeDescription
settingsObjectObject with settings from anychart.core.gantt.elements.GroupingTasksElement.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Getter for the timeline header.

Returns:

anychart.core.gantt.TimeLineHeader - The timeline header.
Setter for the timeline header.

Params:

NameTypeDescription
valueObjectObject with settings.

Returns:

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

height

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.
Setter for element height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

anychart.core.ui.Timeline - Returns self for method chaining.

horizontalScrollBar

Getter for the horizontal scroll bar.

Returns:

anychart.core.ui.ScrollBar - Scroll bar.
Setter for the horizontal scroll bar.

Params:

NameTypeDescription
valueObjectObject with settings.

Returns:

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

labels

Getter for the labels factory.

Returns:

anychart.core.ui.LabelsFactory - Labels factory
Setter for the labels factory.

Params:

NameTypeDefaultDescription
valueObject
true
Value to be set.

Returns:

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

left

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

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

Returns:

anychart.core.ui.Timeline - Returns self for method chaining.

lineMarker

Getter for the line marker.

Params:

NameTypeDefaultDescription
indexnumber
0
Line marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.GanttLine - Line marker instance by index.
Setter for the line marker.

Params:

NameTypeDescription
valueObject | boolean | nullLine marker settings to set.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Setter for the line marker by index.

Params:

NameTypeDescription
indexnumberLine marker index.
valueObject | boolean | null | anychart.enums.GanttDateTimeMarkers | stringLine marker settings to set.

Returns:

anychart.core.ui.Timeline - 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.

markers

Getter for the markers factory.

Returns:

anychart.core.ui.MarkersFactory - Markers factory.
Setter for the markers factory.

Params:

NameTypeDescription
valueObjectValue to be set.

Returns:

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

maxHeight

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.
Setter for the maximum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

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

maxWidth

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.
Setter for the maximum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

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

milestones

Getter for milestones.

Returns:

anychart.core.gantt.elements.MilestonesElement - Milestones instance.
Setter for milestones.

Params:

NameTypeDescription
settingsObjectObject with settings from anychart.core.gantt.elements.MilestonesElement.

Returns:

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

minHeight

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.
Setter for the minimum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

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

minWidth

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.
Setter for the minimum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

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

periods

Setter for periods.

Params:

NameTypeDescription
settingsObjectObject with settings from anychart.core.gantt.elements.PeriodsElement.

Returns:

anychart.core.ui.Timeline - 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.

rangeMarker

Getter for the range marker.

Params:

NameTypeDescription
indexnumberRange marker index.

Returns:

anychart.core.axisMarkers.GanttRange - Range marker instance by index.
Setter for the range marker.

Params:

NameTypeDescription
valueObject | boolean | nullRange marker settings to set.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Setter for the range marker by index.

Params:

NameTypeDescription
indexnumberRange marker index.
valueObject | boolean | null | anychart.enums.GanttDateTimeMarkers | stringRange marker settings to set.

Returns:

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

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 settings.

Returns:

number | string | undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

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

Returns:

anychart.core.ui.Timeline - Returns self for method chaining.

rowEvenFill

Getter for the row even fill.

Returns:

anychart.graphics.vector.Fill | string - Row even fill.
Setter for row even fill settings using an object, an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
"#fff"
Color as an object, an object or a string.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.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.ui.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.ui.Timeline - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowFill

Getter for the row fill.

Returns:

anychart.graphics.vector.Fill | string - Row fill.
Setter for row fill settings using an array, an object or a string. Resets odd fill and even fill. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
"#fff"
Color as an array, an object or a string.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.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.ui.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.ui.Timeline - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowHoverFill

Getter for the row hover fill.

Returns:

anychart.graphics.vector.Fill | string - Row hover fill.
Setter for row hover fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
"#edf8ff"
Color as an object, an array or a string.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.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.ui.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.ui.Timeline - Self instance for method chaining.

rowOddFill

Getter for the row odd fill.

Returns:

anychart.graphics.vector.Fill | string - Row odd fill.
Setter for row odd fill settings using an object, an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
"#fff"
Color as an object, an array or a string.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.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.ui.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.ui.Timeline - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowSelectedFill

Getter for row fill in selected mode.

Returns:

anychart.graphics.vector.Fill | string - Row fill in selected mode.
Setter for row fill settings in selected mode using an array, an object or a string. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Fill color in selected mode with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Linear gradient fill in selected mode. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Radial gradient fill in selected mode. 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.ui.Timeline - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

scale

Getter for the timeline scale.

Returns:

anychart.scales.GanttDateTime - Default Gantt chart timeline scale value.
Setter for the timeline scale.

Params:

NameTypeDefaultDescription
valueObject
anychart.scales.GanttDateTime
Scale object.

Returns:

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

tasks

Setter for tasks.

Params:

NameTypeDescription
settingssObjectObject with settings from anychart.core.gantt.elements.TasksElement.

Returns:

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

textMarker

Getter for the text marker.

Params:

NameTypeDescription
indexnumberText marker index.

Returns:

anychart.core.axisMarkers.GanttText - Text marker instance by index.
Setter for the text marker.

Params:

NameTypeDescription
valueObject | boolean | nullText marker settings to set.

Returns:

anychart.core.ui.Timeline - Self instance for method chaining.
Setter for text marker by index.

Params:

NameTypeDescription
indexnumberText marker index.
valueObject | boolean | null | anychart.enums.GanttDateTimeMarkers | stringText marker settings to set.

Returns:

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

tooltip

Getter for tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for the tooltip.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Tooltip settings.

Returns:

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

top

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

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

Returns:

anychart.core.ui.Timeline - Returns self 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.

verticalScrollBar

Getter for the vertical scroll bar.

Returns:

anychart.core.ui.ScrollBar - Scroll bar.
Setter for the vertical scroll bar.

Params:

NameTypeDescription
valueObjectObject with settings.

Returns:

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

width

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.
Setter for element width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

anychart.core.ui.Timeline - Returns self for method chaining.

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.ui.Timeline - Self instance for method chaining.