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
Returns:
Object.<string, number> - An object with min and max keys.Try it:
getTotalRange
Returns:
Object.<string, number> - An object with min and max keys.Try it:
inverseTransform
Params:
Name | Type | Description |
---|---|---|
ratio | number | Ratio to transform. |
Returns:
number - Ratio transformed to timestamp.Try it:
listen
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function(Object e) | 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
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function(Object e) | 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
Returns:
number - The scale maximum value.var scale = chart.xScale(); var maxValue = scale.maximum();
Params:
Name | Type | Description |
---|---|---|
value | number | Value to set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it:
maximumGap
Returns:
number - The maximum gap value.Params:
Name | Type | Description |
---|---|---|
value | number | Value to be set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it:
minimum
Returns:
number - The scale minimum value.var scale = chart.xScale(); var minValue = scale.minimum();
Params:
Name | Type | Description |
---|---|---|
value | number | Value to set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it:
minimumGap
Returns:
number - The minimum gap value.Params:
Name | Type | Description |
---|---|---|
value | number | Value to be set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it:
removeAllListeners
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
Returns:
number - The soft maximum value.var scale = chart.xScale(); var softMax = scale.softMaximum();
Params:
Name | Type | Description |
---|---|---|
value | number | Value to set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it:
softMinimum
Returns:
number - The soft minimum value.var scale = chart.xScale(); var softMin = scale.softMinimum();
Params:
Name | Type | Description |
---|---|---|
value | number | Value to set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it:
transform
Params:
Name | Type | Description |
---|---|---|
value | * | Value to transform. |
Returns:
number - Value to ratio.Try it:
unlisten
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
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
zoomLevels
Returns:
anychart.scales.GanttDateTime.ZoomLevelsSettings - Zoom levels settingsThe method sets the sets of labels by which the heder is built.
Params:
Name | Type | Description |
---|---|---|
settings | anychart.scales.GanttDateTime.ZoomLevelsSettings | Zoom levels settings to set. |
Returns:
anychart.scales.GanttDateTime - Self instance for method chaining.Try it: