AnyChart
API Reference
Still have questions?
Contact support
Top

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

Extends: anychart.core.gantt.elements.TimelineElement

Baselines element settings.

Methods Overview

Coloring
fill()Fill elements settings.
stroke()Element stroke 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.
Interactivity
normal()Normal state settings.
rendering()Rendering settings.
selected()Selected state settings.
Labels
labels()Element labels settings.
Size and Position
above()Displaying of the baseline bar above an time bar.
anchor()Element anchor.
height()Element height.
offset()Element vertical offset.
position()Element position.

Methods Description

above

Getter for the "above" flag.

Returns:

boolean - Boolean value.

Try it:

Setter for the "above" flag.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

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

Try it:

anchor

Getter for the element anchor.

Returns:

string anychart.enums.Anchor - Element anchor.
See listing
var elements = timeLine.elements();
var anchor = elements.anchor();
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:

fill

Getter for the element fill.

Returns:

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

Try it:

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

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.
Setter for fill settings using function.

Params:

Name Type Default Description
fillFunction function
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:

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

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:

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:

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:

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:

height

Getter for the element height.

Returns:

string number - Element height.
See listing
var elements = timeLine.elements();
var height = elements.height();
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:

labels

Getter for elements labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for element labels.

Params:

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

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
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 }.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

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:

offset

Getter for the vertical offset.

Returns:

string number - Element vertical offset.
See listing
var elements = timeLine.elements();
var offset = elements.offset();
Setter for the vertical offset.

Params:

Name Type Description
offset string | number Value to set.

Returns:

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

Try it:

position

Getter for the element position.

Returns:

string anychart.enums.Anchor - The element position.
See listing
var elements = timeLine.elements();
var position = elements.position();
Setter for the element position.

Params:

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

Returns:

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

Try it:

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

rendering

Getter for rendering settings.

Returns:

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

Try it:

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:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

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:

stroke

Getter for element stroke settings.

Returns:

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

Try it:

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:

Setter for element stroke settings using function.

Params:

Name Type Default Description
strokeFunction function
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:

unlisten

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

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it: