Top

class anychart.scales.GanttDateTime Improve this Doc

Extends: anychart.core.Base

The GanttDateTime class contains methods for configuring DateTime scale on the Gantt chart.

Methods Overview

Specific settings
getRange()Gets minimum and maximum visible dates set for a scale.
getTotalRange()Gets total minimum and maximum dates set for a scale.
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

getRange

Gets minimum and maximum visible dates set for a scale.

Returns:

Object.<string, number> - An object with min and max keys.

Try it:

getTotalRange

Gets total minimum and maximum dates set for a scale.

Returns:

Object.<string, number> - An object with min and max keys.

Try it:

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:

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:

Name Type Description
value number Value to set.

Returns:

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

Try it:

maximumGap

Getter for the maximum gap.

Returns:

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

Params:

Name Type Description
value number Value to be set.

Returns:

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

Try it:

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:

Name Type Description
value number Value to set.

Returns:

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

Try it:

minimumGap

Getter for the minimum gap.

Returns:

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

Params:

Name Type Description
value number Value to be set.

Returns:

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

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:

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:

Name Type Description
value number Value to set.

Returns:

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

Try it:

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:

Name Type Description
value number Value to set.

Returns:

anychart.scales.GanttDateTime - 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: