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

class anychart.core.axisMarkers.GanttRange Improve this Doc

Extends: anychart.core.VisualBase

Gantt range marker.

Methods Overview

Specific settings
from()Starting marker value.
to()Ending marker value.
Axes and Scales
scale()Scale settings.
Coloring
fill()Fill 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 range 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:

fill

Getter for the range marker fill.

Returns:

anychart.graphics.vector.Fill - Range marker settings.
See listing
var customRangeMarker = currentTimeLine.rangeMarker();
customRangeMarker.from("2000-02-25 00:00:00");
customRangeMarker.to("2000-02-26 00:00:00");
var fillSettings = customRangeMarker.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
{color: "#c1c1c1", opacity: 0.4}
Color as an object or a string.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.
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.axisMarkers.GanttRange - 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.axisMarkers.GanttRange - 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.axisMarkers.GanttRange - Self instance for method chaining.

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.

Try it:

from

Getter for the starting marker value.

Returns:

number anychart.enums.GanttDateTimeMarkers string - The starting marker value.
See listing
var currentTimeLine = chart.getTimeline();
var customRangeMarker = currentTimeLine.rangeMarker();
var startingValue = customRangeMarker.from();
Setter for the starting marker value.

Params:

Name Type Description
value number | anychart.enums.GanttDateTimeMarkers | string RangeMarker value settings.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.

isHorizontal

Whether a range 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 range marker layout.

Returns:

anychart.enums.Layout string - Layout settings.
See listing
var currentTimeLine = chart.getTimeline();
var customRangeMarker = currentTimeLine.rangeMarker();
customRangeMarker.from("2000-02-25 00:00:00");
customRangeMarker.to("2000-02-26 00:00:00");
var layoutSettings = customRangeMarker.layout();
Setter for the Gantt chart range 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"
Range marker layout.

Returns:

anychart.core.axisMarkers.GanttRange - 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 range marker scale.

Returns:

anychart.scales.GanttDateTime - The Gantt chart range marker scale.
See listing
var currentTimeLine = chart.getTimeline();
var customLineMarker = currentTimeLine.lineMarker();
customLineMarker.value("2000-02-29 00:00:00");
var scaleSettings = customLineMarker.scale();
Setter for the Gantt chart range 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.GanttRange - Self instance for method chaining.

to

Getter for the ending marker value.

Returns:

number anychart.enums.GanttDateTimeMarkers string - The ending marker value.
See listing
var currentTimeLine = chart.getTimeline();
var customRangeMarker = currentTimeLine.rangeMarker();
var endingValue = customRangeMarker.to();
Setter for the ending marker value.

Params:

Name Type Description
value number | anychart.enums.GanttDateTimeMarkers | string Range marker value settings.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.

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:

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: