class anychart.standalones.ProjectTimeline Improve this Doc
Extends: anychart.core.ui.Timeline
The ProjectTimeline class contains methods for configuring standalones project 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. |
| Chart Coloring | |
| palette() | Palette 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. |
| rowStroke() | Row stroke settings. |
| Data | |
| data() | Data settings. |
| 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 |
| 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 | |
| bottom() | Bottom bound settings. |
| bounds() | Bounds settings. |
| defaultRowHeight() | Default row height settings. |
| getPixelBounds() | Returns pixel bounds. |
| headerHeight() | Header height. |
| 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 | |
| container() | Container for the elements. |
| draw() | Draws timeline. |
| parentBounds() | Getter for the parent bounds. |
Methods Description
backgroundFill
Getter for the background fill.
Returns:
anychart.graphics.vector.Fill | string - Background fill.Try it:
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | 'none' | Color as an array, an object or a string. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Fill color with opacity.
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 | Default | Description |
|---|---|---|---|
| color | string | 'none' | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
baselines
Getter for baselines.
Returns:
anychart.core.gantt.elements.BaselinesElement - Baselines instance.Try it:
Setter for baselines.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.BaselinesElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
bottom
Getter for element bottom bound settings.
Returns:
number | string | undefined - Element's bottom bound setting.Setter for element bottom bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.standalones.ProjectTimeline - Returns self for method chaining.Try it:
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:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
Setter for element bounds settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| x | number | string | null | X-coordinate. |
| y | number | string | null | Y-coordinate. |
| width | number | string | null | Width. |
| height | number | string | null | Height. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
columnStroke
Getter for the column stroke.
Returns:
string | anychart.graphics.vector.Stroke - Column stroke.Try it:
Setter for the column stroke.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | {color: "#ccd7e1", thickness: 1} | Value to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
Setter for the column stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
connectors
Getter for connectors.
Returns:
anychart.core.gantt.elements.ConnectorElement - Connectors instance.Try it:
Setter for connectors.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.ConnectorElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
container
Getter for the container.
Returns:
anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - An instance of the class for method chaining.Setter for the container.
Params:
| Name | Type | Description |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.data
Getter for the timeline data.
See listing
var data = timeLine.data();
Setter for the timeline data.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.Tree | anychart.data.TreeView | Data tree. |
| fillMethod | anychart.enums.TreeFillingMethod | string | Fill method. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
defaultRowHeight
Getter for the default row height.
Returns:
number - Default row height. See listing
var defaultRowHeight = timeLine.defaultRowHeight();
Setter for the default row height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | 20 | Default row height to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
draw
Draws timeline.
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
edit
Getter for live edit settings.
Returns:
anychart.core.gantt.edit.StructureEdit - The 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.standalones.ProjectTimeline - Self instance for method chaining.elements
Getter for elements.
Returns:
anychart.core.gantt.elements.TimelineElement - Elements instance.Try it:
Setter for elements.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.TimelineElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
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.Try it:
Setter for grouping tasks.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.GroupingTasksElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
header
Getter for the timeline header.
Returns:
anychart.core.gantt.TimeLineHeader - The timeline header.Try it:
Setter for the timeline header.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Object with settings. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
headerHeight
Getter for the header height.
Returns:
number - Returns the header height. See listing
var headerHeight = timeLine.headerHeight();
Setter for the header height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | Header height to be set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
height
Getter for element height settings.
Returns:
number | string | undefined - Element's height setting.Setter for element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the element. |
Returns:
anychart.standalones.ProjectTimeline - Returns self for method chaining.Try it:
horizontalScrollBar
Setter for the horizontal scroll bar.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Object with settings. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
labels
Setter for the labels factory.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | true | Value to be set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
left
Getter for element left bound settings.
Returns:
number | string | undefined - Element's left bound setting.Setter for element left bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.standalones.ProjectTimeline - Returns self for method chaining.Try it:
lineMarker
Getter for the line marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 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.Try it:
Setter for the line marker.
Detailed description
Sets line marker settings depending on parameter type:
- null/boolean - disable or enable line marker.
- object - sets line marker settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Line marker settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Setter for the line marker by index.
Detailed description
Sets line marker settings depending on parameter type:
- null/boolean - disable or enable line marker by index.
- object - sets line marker settings by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Line marker index. |
| value | Object | boolean | null | anychart.enums.GanttDateTimeMarkers | string | Line marker settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function(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
} | |
| 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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function(e:Object) | 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:
markers
Setter for the markers factory.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to be set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
maxHeight
Getter for the maximum height.
Returns:
number | string | null - Element's maximum height.Setter for the maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Maximum height to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
maxWidth
Getter for the maximum width.
Returns:
number | string | null - Element's maximum width.Setter for the maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Maximum width to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
milestones
Getter for milestones.
Returns:
anychart.core.gantt.elements.MilestonesElement - Milestones instance.Setter for milestones.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.MilestonesElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.minHeight
Getter for the minimum height.
Returns:
number | string | null - Element's minimum height.Setter for the minimum height.
Detailed description
The method sets a minimum height of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Minimum height to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
minWidth
Getter for the minimum width.
Returns:
number | string | null - Element's minimum width.Setter for the minimum width.
Detailed description
The method sets a minimum width of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Minimum width to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
palette
Getter for the palette.
See listing
var palette = timeline.palette();
Setter the for palette.
Detailed description
Note: You can use predefined palettes from anychart.palettes.
Params:
| Name | Type | Description |
|---|---|---|
| paletteSettings | anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> | Timeline colors palette settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.parentBounds
Getter for the parent bounds.
Bounds that would be used in case of percent size calculations. Expects pixel values only.
Bounds that would be used in case of percent size calculations. Expects pixel values only.
Returns:
anychart.math.Rect - The parent bounds of the element.Setter for the parent bounds using single value.
Bounds that would be used in case of percent size calculations. Expects pixel values only.
Bounds that would be used in case of percent size calculations. Expects pixel values only.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.math.Rect | Object | number | null | Bounds to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Setter for the parent bounds using several values.
Bounds that would be used in case of percent size calculations. Expects pixel values only.
Bounds that would be used in case of percent size calculations. Expects pixel values only.
Params:
| Name | Type | Description |
|---|---|---|
| left | number | Left space. |
| top | number | Top space. |
| width | number | Element width. |
| height | number | Element height. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.periods
Setter for periods.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.PeriodsElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
rangeMarker
Getter for the range marker.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Range marker index. |
Returns:
anychart.core.axisMarkers.GanttRange - Range marker instance by index.Try it:
Setter for the range marker.
Detailed description
Sets range marker settings depending on parameter type:
- null/boolean - disable or enable range marker.
- object - sets range marker settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Range marker settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Setter for the range marker by index.
Detailed description
Sets range marker settings depending on parameter type:
- null/boolean - disable or enable range marker by index.
- object - sets range marker settings by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Range marker index. |
| value | Object | boolean | null | anychart.enums.GanttDateTimeMarkers | string | Range marker settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.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:
right
Getter for element right bound settings.
Returns:
number | string | undefined - Element's right bound setting.Setter for element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.standalones.ProjectTimeline - Returns self for method chaining.Try it:
rowEvenFill
Setter for row even fill settings using an object, an array or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | "#fff" | Color as an object, an object or a string. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
rowFill
Setter for row fill settings using an array, an object or a string. Resets odd fill and even fill.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | "#fff" | Color as an array, an object or a string. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
Setter for the row fill using a function.
Params:
| Name | Type | Description |
|---|---|---|
| fillFunction | function | Function that returns fill settings.
Function that looks like: function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
} |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
rowHoverFill
Getter for the row hover fill.
Returns:
anychart.graphics.vector.Fill | string - Row hover fill.Try it:
Setter for row hover fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | "#edf8ff" | Color as an object, an array or a string. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
rowOddFill
Setter for row odd fill settings using an object, an array or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | "#fff" | Color as an object, an array or a string. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
rowSelectedFill
Getter for row fill in selected mode.
Returns:
anychart.graphics.vector.Fill | string - Row fill in selected mode.Try it:
Setter for row fill settings in selected mode using an array, 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.standalones.ProjectTimeline - Self instance for method chaining.Fill color in selected mode 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
Linear gradient fill in selected mode.
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. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
Radial gradient fill in selected mode.
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.standalones.ProjectTimeline - 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
rowStroke
Getter for the row stroke.
Returns:
string | anychart.graphics.vector.Stroke - Row stroke. See listing
var rowStroke = timeline.rowStroke();
Setter for the row stroke.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. |
| thickness | number | 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.standalones.ProjectTimeline - Self instance for method chaining.Try it:
Setter for the row stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
scale
Getter for the timeline scale.
Returns:
anychart.scales.GanttDateTime - Default Gantt chart timeline scale value.Try it:
Setter for the timeline scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | anychart.scales.GanttDateTime | Scale object. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
tasks
Setter for tasks.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings from anychart.core.gantt.elements.TasksElement. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
textMarker
Getter for the text marker.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Text marker index. |
Returns:
anychart.core.axisMarkers.GanttText - Text marker instance by index.Try it:
Setter for the text marker.
Detailed description
Sets text marker settings depending on parameter type:
- null/boolean - disable or enable text marker.
- object - sets text marker settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Text marker settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Setter for text marker by index.
Detailed description
Sets text marker settings depending on parameter type:
- null/boolean - disable or enable text marker by index.
- object - sets text marker settings by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Text marker index. |
| value | Object | boolean | null | anychart.enums.GanttDateTimeMarkers | string | Text marker settings to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.tooltip
Getter for tooltip settings.
timeline.tooltip() is an alias for timeline.elements().tooltip().
timeline.tooltip() is an alias for timeline.elements().tooltip().
Returns:
anychart.core.ui.Tooltip - Tooltip instance.Try it:
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.standalones.ProjectTimeline - 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:
| Name | Type | Default | Description |
|---|---|---|---|
| top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.standalones.ProjectTimeline - Returns self 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(e:Object):boolean|undefined | 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:
verticalScrollBar
Setter for the vertical scroll bar.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Object with settings. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it:
width
Getter for element width settings.
Returns:
number | string | undefined - Element's width setting.Setter for element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the element. |
Returns:
anychart.standalones.ProjectTimeline - Returns self for method chaining.Try it:
zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.standalones.ProjectTimeline - Self instance for method chaining.Try it: