AnyChart
API Reference
Still have questions?
Contact support
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.
inverseTransform()Processes reverse transformation of the ratio backward to value.
maximum()Scale maximum.
maximumGap()Maximum gap settings.
minimum()Scale minimum.
minimumGap()Minimum gap settings.
softMaximum()Soft maximum settings.
softMinimum()Soft minimum settings.
transform()Transforms values to ratio.
zoomLevels()Zoom level 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.

getTotalRange

Gets total minimum and maximum dates set for a scale.

Returns:

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

inverseTransform

Processes reverse transformation of the ratio backward to value.

Params:

NameTypeDescription
rationumberRatio to transform.

Returns:

number - Ratio transformed to timestamp.

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.

maximum

Getter for the scale maximum.

Returns:

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

Params:

NameTypeDescription
maximumnumberScale maximum value 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
gapnumberGap value 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 minimum = scale.minimum();
Setter for the scale minimum.

Params:

NameTypeDescription
minimumnumberScale minimum value 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
gapnumberGap value 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
maximumnumberSoft maximum value 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
minimumnumberSoft minimum value to set.

Returns:

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

transform

Transforms values to ratio.

Params:

NameTypeDescription
value*Value to transform.

Returns:

number - Value to ratio.

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.

zoomLevels

Getter for zoom levels settings.
Setter for zoom levels settings.
The method sets the sets of labels by which the heder is built.

Params:

NameTypeDescription
settingsanychart.scales.GanttDateTime.ZoomLevelsSettingsZoom levels settings to set.

Returns:

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