AnyChart
API Reference
Still have questions?
Contact support
Top

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 element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fill

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 fillSettings = customRangeMarker.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.axisMarkers.GanttRange - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

from

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();
Setter for the starting marker value.

Params:

NameTypeDescription
fromValuenumber | anychart.enums.GanttDateTimeMarkers | stringRange marker 'from' 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 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();
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:

NameTypeDefaultDescription
layoutanychart.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:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

scale

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();
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:

NameTypeDefaultDescription
scaleanychart.scales.GanttDateTime
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 getTimeline = chart.getTimeline();
var customRangeMarker = getTimeline.rangeMarker();
var endingValue = customRangeMarker.to();
Setter for the ending marker value.

Params:

NameTypeDescription
toValuenumber | anychart.enums.GanttDateTimeMarkers | stringRange marker 'to' value settings.

Returns:

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

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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