Top
You are looking at an outdated 7.14.3 version of this document. Switch to the 8.0.1 version to see the up to date information.

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.
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.
Export
print()Prints all elements.
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 current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - 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.

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 currentTimeLine = chart.getTimeline();
var customLineMarker = currentTimeLine.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.

Params:

Name Type Default Description
value anychart.enums.Layout | string
"vertical"
Line marker layout.

Returns:

anychart.core.axisMarkers.GanttLine - 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
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
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:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

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:

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.

Params:

Name Type Description
value 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 currentTimeLine = chart.getTimeline();
var customLineMarker = currentTimeLine.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
value 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 anychart.graphics.vector.StrokeLineJoin
"miter"
Line joint style.
lineCap anychart.graphics.vector.StrokeLineCap
"square"
Line cap style.

Returns:

anychart.core.axisMarkers.GanttLine - 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:

value

Getter for the Gantt chart line marker value.

Returns:

number anychart.enums.GanttDateTimeMarkers - The Gantt chart line marker value.
See listing
var currentTimeLine = chart.getTimeline();
var customLineMarker = currentTimeLine.lineMarker();
var currentValue = 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

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: