AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.scales.GanttDateTime Improve this Doc

Extends: anychart.core.Base

Gantt date time scale.

Methods Overview

Specific settings
maximum()Scale maximum.
maximumGap()Maximum gap settings.
minimum()Scale minimum.
minimumGap()Minimum gap settings.
softMaximum()Soft maximum settings.
softMinimum()Soft minimum 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.

Methods Description

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

maximum

Getter for the scale maximum.

Returns:

number - The scale maximum value.
See listing
var scale = chart.xScale();
var maxValue = scale.maximum();
Setter for the scale maximum.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

maximumGap

Getter for the maximum gap.

Returns:

number - The maximum gap value.
Setter for the maximum gap.

Params:

NameTypeDescription
valuenumberValue to be set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

minimum

Getter for the scale minimum.

Returns:

number - The scale minimum value.
See listing
var scale = chart.xScale();
var minValue = scale.minimum();
Setter for the scale minimum.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

minimumGap

Getter for the minimum gap.

Returns:

number - The minimum gap value.
Setter for the minimum gap.

Params:

NameTypeDescription
valuenumberValue to be set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

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.

softMaximum

Getter for the scale soft maximum.

Returns:

number - The soft maximum value.
See listing
var scale = chart.xScale();
var softMax = scale.softMaximum();
Setter for the scale soft maximum.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

softMinimum

Getter for the scale soft minimum.

Returns:

number - The soft minimum value.
See listing
var scale = chart.xScale();
var softMin = scale.softMinimum();
Setter for the scale soft minimum.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.scales.GanttDateTime - Self instance for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.