class anychart.core.axisMarkers.GanttLine Improve this Doc
Extends: anychart.core.VisualBase
Gantt line marker.
Methods Overview
| Specific settings | |
| value() | Value settings. |
| Axes and Scales | |
| scale() | Scale settings. |
| Coloring | |
| stroke() | Stroke settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| Size and Position | |
| isHorizontal() | Whether a line marker has horizontal layout. |
| layout() | Layout settings. |
| zIndex() | Z-index of the element. |
Methods Description
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.core.axisMarkers.GanttLine - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
isHorizontal
Whether a line marker has horizontal layout.
Note: Any type of Gantt diagram will return "false", because markers in Gantt charts can be only vertical.
Layout is defined by anychart.core.axisMarkers.GanttLine#layout method.
Note: Any type of Gantt diagram will return "false", because markers in Gantt charts can be only vertical.
Layout is defined by anychart.core.axisMarkers.GanttLine#layout method.
Returns:
boolean - Returns false, because markers in Gantt charts can be only vertical.layout
Getter for the Gantt chart line marker layout.
Returns:
anychart.enums.Layout | string - The Gantt chart line marker layout. See listing
var timeLine = chart.getTimeline();
var customLineMarker = timeLine.lineMarker();
customLineMarker.value("2000-02-29 00:00:00");
var layoutSettings = customLineMarker.layout();Setter for the Gantt chart line marker layout.
Note: The layout method will not work here, only 'vertical' layout are available in Gantt Chart.
Note: The layout method will not work here, only 'vertical' layout are available in Gantt Chart.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| layout | anychart.enums.Layout | string | 'vertical' | Line marker layout. |
Returns:
anychart.core.axisMarkers.GanttLine - Self instance for method chaining.scale
Getter for the Gantt chart line marker scale.
Returns:
anychart.scales.GanttDateTime - The Gantt chart line marker scale.Try it:
Setter for the Gantt chart line marker scale.
Note: The scale() method will not work here, only 'dateTime' scale are available in Gantt Chart. Learn more about scale.
Note: The scale() method will not work here, only 'dateTime' scale are available in Gantt Chart. Learn more about scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| scale | anychart.scales.GanttDateTime | anychart.scales.GanttDateTime | Scale. |
Returns:
anychart.core.axisMarkers.GanttLine - Self instance for method chaining.stroke
Getter for the Gantt chart line marker stroke.
Returns:
anychart.graphics.vector.Stroke - Gantt line marker stroke settings. See listing
var timeLine = chart.getTimeline();
var customLineMarker = timeLine.lineMarker();
customLineMarker.value('2000-02-29 00:00:00');
var strokeSettings = customLineMarker.stroke();Setter for the Gantt chart line marker stroke.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | '#7c868e 1' | Stroke settings. |
| thickness | number | 2 | Line thickness. |
| dashpattern | string | 'none' | Controls the pattern of dashes and gaps used to stroke paths. |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | 'miter' | Line joint style. |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | 'square' | Line cap style. |
Returns:
anychart.core.axisMarkers.GanttLine - Self instance for method chaining.Try it:
Setter for price indicator stroke settings using an object.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | {color: "#7c868e", dash: "none" , lineCap: "square", lineJoin: "miter", opacity: 1, thickness: 2} | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.core.axisMarkers.GanttLine - Self instance for method chaining.Try it:
value
Getter for the Gantt chart line marker value.
Returns:
number | anychart.enums.GanttDateTimeMarkers | string - The Gantt chart line marker value. See listing
var timeLine = chart.getTimeline(); var customLineMarker = timeLine.lineMarker(); var value = customLineMarker.value();
Setter for the Gantt chart line marker value.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | anychart.enums.GanttDateTimeMarkers | string | Line marker value settings. |
Returns:
anychart.core.axisMarkers.GanttLine - Self instance 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.core.axisMarkers.GanttLine - Self instance for method chaining.Try it: