class anychart.core.axisMarkers.GanttRange Improve this Doc

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.
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

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

fill

fill()Since version 7.9.0

Getter for the range marker fill.

Returns:

anychart.graphics.vector.Fill - Range marker settings.

See listing

var customRangeMarker = timeLine.rangeMarker();
customRangeMarker.from('2000-02-25 00:00:00');
customRangeMarker.to('2000-02-26 00:00:00');
var fill = customRangeMarker.fill();

fill(color)Since version 7.9.0

Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	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.

Try it:

fill(color, opacity)Since version 7.9.0

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 7.9.0

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:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.9.0

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:

Usage sample

fill(imageSettings)Since version 7.9.0

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

from

from()Since version 7.9.0

Getter for the starting marker value.

Returns:

number | anychart.enums.GanttDateTimeMarkers | string - The starting marker value.

See listing

var getTimeline = chart.getTimeline();
var customRangeMarker = getTimeline.rangeMarker();
var startingValue = customRangeMarker.from();

from(fromValue)Since version 7.9.0

Setter for the starting marker value.

Params:

Name	Type	Description
fromValue	number \| anychart.enums.GanttDateTimeMarkers \| string	Range marker 'from' value settings.

Returns:

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

Try it:

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

layout()Since version 7.9.0

Getter for the Gantt chart range marker layout.

Returns:

anychart.enums.Layout | string - Layout settings.

See listing

var getTimeline = chart.getTimeline();
var customRangeMarker = getTimeline.rangeMarker();
customRangeMarker.from('2000-02-25 00:00:00');
customRangeMarker.to('2000-02-26 00:00:00');
var layoutSettings = customRangeMarker.layout();

layout(layout)Since version 7.9.0

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
layout	anychart.enums.Layout \| string	'vertical'	Range marker layout.

Returns:

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

scale

scale()Since version 7.9.0

Getter for the Gantt chart range marker scale.

Returns:

anychart.scales.GanttDateTime - The Gantt chart range marker scale.

See listing

var getTimeline = chart.getTimeline();
var customLineMarker = getTimeline.lineMarker();
customLineMarker.value("2000-02-29 00:00:00");
var scaleSettings = customLineMarker.scale();

scale(scale)Since version 7.9.0

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	Default	Description
scale	anychart.scales.GanttDateTime	anychart.scales.GanttDateTime	Scale.

Returns:

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

to

to()Since version 7.9.0

Getter for the ending marker value.

Returns:

number | anychart.enums.GanttDateTimeMarkers | string - The ending marker value.

See listing

var getTimeline = chart.getTimeline();
var customRangeMarker = getTimeline.rangeMarker();
var endingValue = customRangeMarker.to();

to(toValue)Since version 7.9.0

Setter for the ending marker value.

Params:

Name	Type	Description
toValue	number \| anychart.enums.GanttDateTimeMarkers \| string	Range marker 'to' value settings.

Returns:

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

Try it:

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(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.GanttRange - Self instance for method chaining.

Try it:

Usage sample