class anychart.scales.DateTime Improve this Doc
Extends: anychart.scales.ScatterBase
Define Datetime scale.
Note: To create instance use anychart.scales#dateTime method.
Methods Overview
| Specific settings | |
| finishAutoCalc() | Informs the scale that an auto range calculation started for the chart in past was ended. |
| getType() | Returns scale type. |
| inverseTransform() | Returns tick by its position ratio. |
| inverted() | Inversion state. |
| maximum() | Scale maximum. |
| maximumGap() | Maximum gap settings. |
| minimum() | Scale minimum. |
| minimumGap() | Minimum gap settings. |
| minorTicks() | Minor ticks settings. |
| softMaximum() | Soft maximum settings. |
| softMinimum() | Soft minimum settings. |
| startAutoCalc() | Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first |
| ticks() | Ticks 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. |
| Miscellaneous | |
| extendDataRange() | Extends the current input domain with the passed values (if such don't exist in the domain). |
| transform() | Returns tick position ratio by its name. |
Methods Description
extendDataRange
Extends the current input domain with the passed values (if such don't exist in the domain).
Note: Attention! anychart.scales.Base#finishAutoCalc drops all passed values.
Note: Attention! anychart.scales.Base#finishAutoCalc drops all passed values.
Params:
| Name | Type | Description |
|---|---|---|
| var_args | * | Values that are supposed to extend the input domain. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
finishAutoCalc
Informs the scale that an auto range calculation started for the chart in past was ended.
Params:
| Name | Type | Description |
|---|---|---|
| silently | boolean | If this flag is set, do not dispatch an event if reapplication needed. |
Returns:
boolean - If the calculation changed the scale and it needs to be reapplied.getType
inverseTransform
Returns tick by its position ratio.
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().
Params:
| Name | Type | Description |
|---|---|---|
| ratio | number | Value to transform in input scope. |
Returns:
* - Value transformed to output scope.Try it:
inverted
Getter for scale inversion.
Returns:
boolean - Current inversion state.Setter for scale inversion. If the scale is inverted, axes and series go upside-down or right-to-left
instead of bottom-to-top and left-to-right.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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 | 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.
Detailed description
After the event is called, its handler will be deleted.
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).
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 | 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 current scale maximum.
Returns:
number - Current scale maximum.Setter for scale maximum.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | null | Value to set. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
maximumGap
Getter for the current scale maximum gap.
Returns:
number - The current scale maximum gap.Try it:
Setter for the scale maximum gap.
Detailed description
Note: Gap works only if scale minimum is not set explicitly using anychart.scales.ScatterBase#maximum.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0.1 | Value from 0 to 1. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
minimum
Getter for the current scale minimum.
Returns:
number - Current scale minimum.Setter for scale minimum.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | null | Value to set. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
minimumGap
Getter for the current scale minimum gap.
Returns:
number - The current scale minimum gap.Try it:
Setter for the scale minimum gap.
Detailed description
Note: Gap works only if scale minimum is not set explicitly using anychart.scales.ScatterBase#minimum.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0.1 | Value from 0 to 1. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
minorTicks
Getter for set of scale ticks in terms of data values.
Returns:
anychart.scales.DateTimeTicks - Minor ticks.Try it:
Setter for set of scale ticks in terms of data values.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Array | An array of ticks to set. |
Returns:
anychart.scales.DateTime - 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
Setter for soft maximum.
Detailed description
If data range maximum is less than soft maximum, the soft maximum value will become the scale maximum.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | null | Value to set |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
softMinimum
Setter for soft minimum.
Detailed description
If data range minimum is greater than soft minimum, the soft minimum value will become the scale minimum.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | null | Value to set |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
startAutoCalc
Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first
call of this method if needed.
Returns:
anychart.scales.DateTime - Chaining.ticks
Getter for set of scale ticks in terms of data values.
Returns:
anychart.scales.DateTimeTicks - Ticks.Try it:
Setter for set of scale ticks in terms of data values.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Array | An array of ticks to set. |
Returns:
anychart.scales.DateTime - Self instance for method chaining.Try it:
transform
Returns tick position ratio by its name.
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().
Params:
| Name | Type | Description |
|---|---|---|
| value | * | Value to transform in input scope. |
Returns:
number - Value transformed to scope [0, 1].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: