class anychart.core.gantt.elements.TimelineElement Improve this Doc
Extends: anychart.core.Base
Settings class for all timeline elements:
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
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:
edit
Getter for live edit settings.
Returns:
anychart.core.gantt.edit.ElementEdit - Live edit settings.Try it:
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.enabled
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:
endMarker
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:
fill
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.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
} |
Returns:
anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.Try it:
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:
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:
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:
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
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.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.gantt.elements.TimelineElement - 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.gantt.elements.TimelineElement - Self instance for method chaining.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 settingsTry 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:
startMarker
Getter for the start marker.
Returns:
anychart.core.gantt.elements.Marker - Start marker instance.Try it:
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:
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():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:
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:
tooltip
Getter for the timeline elements' tooltip.
timeline.tooltip() is an alias for timeline.elements().tooltip().
This tooltip is never displayed visually, but provides settings to tooltips of another timeline's elements until they got own tooltip settings.
NOTE: Tooltip of any timeline element also provides its format and title format to data grid's tooltip if it doesn't have own formats.
timeline.tooltip() is an alias for timeline.elements().tooltip().
This tooltip is never displayed visually, but provides settings to tooltips of another timeline's elements until they got own tooltip settings.
NOTE: Tooltip of any timeline element also provides its format and title format to data grid's tooltip if it doesn't have own formats.
Returns:
anychart.core.ui.Tooltip - Tooltip settings. See listing.
var tooltip = timeline.elements().tooltip();
Setter for the tooltip.
timeline.tooltip() is an alias for timeline.elements().tooltip().
timeline.tooltip() is an alias for timeline.elements().tooltip().
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.gantt.elements.TimelineElement - Self instance for method chaining.