class anychart.core.gantt.elements.TimelineElement Improve this Doc

Extends: anychart.core.Base

Settings class for all timeline elements:

anychart.core.gantt.elements.MilestonesElement

anychart.core.gantt.elements.MilestonesPreviewElement

anychart.core.gantt.elements.BaselinesElement

anychart.core.gantt.elements.TasksElement

anychart.core.gantt.elements.GroupingTasksElement

anychart.core.gantt.elements.ProgressElement

anychart.core.gantt.elements.PeriodsElement

Provides settings for all elements above if an element deosn't have own settings specified.

Methods Overview

Coloring
fill()	Fill elements settings.
stroke()	Element stroke settings.
Enabling/Disabling
enabled()	Gets element's 'enabled' state.
Interactivity
edit()	Live edit mode.
normal()	Normal state settings.
rendering()	Rendering settings.
selected()	Selected state settings.
tooltip()	Getter for the timeline elements' tooltip.
Labels
labels()	Element labels settings.
Markers
endMarker()	Getter for the end marker.
startMarker()	Getter for the start marker.
Size and Position
anchor()	Element anchor.
height()	Element height.
offset()	Element vertical offset.
position()	Element position.

Methods Description

anchor

anchor()Since version 8.2.0

Getter for the element anchor.

Returns:

string | anychart.enums.Anchor - Element anchor.

See listing

var elements = timeLine.elements();
var anchor = elements.anchor();

anchor(anchor)Since version 8.2.0

Setter for the element anchor.

Params:

Name	Type	Description
anchor	string \| anychart.enums.Anchor	Value to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

edit

edit()Since version 8.3.0

Getter for live edit settings.

Returns:

anychart.core.gantt.edit.ElementEdit - Live edit settings.

Try it:

Usage sample

edit(settings)Since version 8.3.0

Setter for live edit settings. Learn more about Live editing.

Detailed description

Sets live edit settings depending on parameter type:

boolean - disable or enable live edit.
object - sets live edit settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean	false	Live edit settings to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

enabled

enabled()Since version 8.6.0

Getter for element enabled state.

Returns:

boolean - Whether element is enabled.

Try it:

Usage sample

enabled(settings)Since version 8.6.0

Setter for element enabled state.

Params:

Name	Type	Default	Description
settings	boolean	true	Whether to enable element.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

endMarker

endMarker()

Getter for the end marker.

Returns:

anychart.core.gantt.elements.Marker - End marker instance.

Try it:

Complex demo.

endMarker(config)

Setter for the end marker.

Params:

Name	Type	Description
config	Object \| boolean	Marker config object or boolean value to enable/disable the marker.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Complex demo.

fill

fill()Since version 8.2.0

Getter for the element fill.

Returns:

anychart.graphics.vector.Fill | string - Element fill.

Try it:

Usage sample

fill(color)Since version 8.2.0

Setter for element fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an object, an array or a string.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

fill(fillFunction)Since version 8.2.0

Setter for fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	function():anychart.graphics.vector.Fill	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like: function(){ // this.sourceColor - Color with type anychart.graphics.vector.Fill (directly resolvable color). Type is anychart.graphics.vector.Fill, anychart.graphics.vector.PatternFill. The color is set from a theme or palette and is determined automatically for each colorized element. // this.item - the item of the visual element to which the coloring is applied. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem // this.itemIndex - the linear index of the item. Type is number // this.period - the period for anychart#ganttResource. Type is object. A period object with the index this.periodIndex at the data point this.item, corresponding to the visual display element. // this.periodIndex - the index of the period for anychart#ganttResource. return fillValue; // type anychart.graphics.vector.Fill }

Name

Type

Default

Description

fillFunction

function():anychart.graphics.vector.Fill

function() {
 return anychart.color.darken(this.sourceColor);
}

Function that looks like:

function(){
   // this.sourceColor - Color with type anychart.graphics.vector.Fill (directly resolvable color).
   Type is anychart.graphics.vector.Fill, anychart.graphics.vector.PatternFill. The color is set from a theme
   or palette and is determined automatically for each colorized element.
   // this.item - the item of the visual element to which the coloring is applied. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem
   // this.itemIndex - the linear index of the item. Type is number
   // this.period - the period for anychart#ganttResource. Type is object. A period object with the index
   this.periodIndex at the data point this.item, corresponding to the visual display element.
   // this.periodIndex - the index of the period for anychart#ganttResource.

   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

fill(color, opacity)Since version 8.2.0

Fill color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 8.2.0

Linear gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 8.2.0

Radial gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 8.2.0

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

height

height()Since version 8.2.0

Getter for the element height.

Returns:

string | number - Element height.

See listing

var elements = timeLine.elements();
var height = elements.height();

height(height)Since version 8.2.0

Setter for the element height.

Params:

Name	Type	Description
height	string \| number	Value to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

labels

labels()Since version 8.2.0

Getter for elements labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)Since version 8.2.0

Setter for element labels.

Detailed description

Sets labels settings depending on parameter type:

null/boolean - disable or enable base labels.
object - sets base labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Labels settings.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

normal

normal()Since version 8.2.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.2.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

offset

offset()Since version 8.2.0

Getter for the vertical offset.

Returns:

string | number - Element vertical offset.

See listing

var elements = timeLine.elements();
var offset = elements.offset();

offset(offset)Since version 8.2.0

Setter for the vertical offset.

Params:

Name	Type	Description
offset	string \| number	Value to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

position

position()Since version 8.2.0

Getter for the element position.

Returns:

string | anychart.enums.Anchor - The element position.

See listing

var elements = timeLine.elements();
var position = elements.position();

position(position)Since version 8.2.0

Setter for the element position.

Params:

Name	Type	Description
position	string \| anychart.enums.Anchor	Value to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

rendering

rendering()Since version 8.2.0

Getter for rendering settings.

Returns:

anychart.core.gantt.rendering.Settings - Rendering settings.

Try it:

Usage sample

rendering(settings)Since version 8.2.0

Setter for rendering settings.

Params:

Name	Type	Description
settings	Object	Rendering settings from anychart.core.gantt.rendering.Settings.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

selected

selected()Since version 8.2.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.2.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

startMarker

startMarker()

Getter for the start marker.

Returns:

anychart.core.gantt.elements.Marker - Start marker instance.

Try it:

Complex demo.

startMarker(config)

Setter for the start marker.

Params:

Name	Type	Description
config	Object \| boolean	Marker config object or boolean value to enable/disable the marker.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Complex demo.

stroke

stroke()Since version 8.2.0

Getter for element stroke settings.

Returns:

anychart.graphics.vector.Stroke | string - Element stroke settings.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.2.0

Setter for element stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

stroke(strokeFunction)Since version 8.2.0

Setter for element stroke settings using function.

Params:

Name	Type	Default	Description
strokeFunction	function():anychart.graphics.vector.Stroke\|anychart.graphics.vector.ColoredFill	function() { }	Function that looks like: function(){ // this.sourceColor - Color with type anychart.graphics.vector.Stroke (directly resolvable color). Type is anychart.graphics.vector.Stroke. The color is set from a theme or palette and is determined automatically for each colorized element. // this.item - the item of the visual element to which the coloring is applied. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem // this.itemIndex - the linear index of the item. Type is number // this.period - the period for anychart#ganttResource. Type is object. A period object with the index this.periodIndex at the data point this.item, corresponding to the visual display element. // this.periodIndex - the index of the period for anychart#ganttResource. return strokeValue; // type anychart.graphics.vector.Stroke }

Name

Type

Default

Description

strokeFunction

function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill

function() {
}

Function that looks like:

function(){
   // this.sourceColor - Color with type anychart.graphics.vector.Stroke (directly resolvable color).
   Type is anychart.graphics.vector.Stroke. The color is set from a theme or palette and is determined automatically for each colorized element.
   // this.item - the item of the visual element to which the coloring is applied. Type is anychart.data.Tree.DataItem or anychart.data.TreeView.DataItem
   // this.itemIndex - the linear index of the item. Type is number
   // this.period - the period for anychart#ganttResource. Type is object. A period object with the index
   this.periodIndex at the data point this.item, corresponding to the visual display element.
   // this.periodIndex - the index of the period for anychart#ganttResource.

   return strokeValue; // type anychart.graphics.vector.Stroke
}

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)Since version 8.2.0

Setter for the thumb stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.

Try it:

Usage sample

tooltip()Since version 8.6.0

tooltip(value)Since version 8.6.0

Setter for the tooltip.
timeline.tooltip() is an alias for timeline.elements().tooltip().

Detailed description

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Tooltip settings.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.