class anychart.scales.DateTimeTicks Improve this Doc
Extends: anychart.core.Base
The DateTimeTicks class contains methods for configuring ticks on the DateTime scale.
Methods Overview
| Specific settings | |
| count() | Ticks count. |
| get() | Returns an array of ticks. Each tick is a value in terms of data, to make a tick on. |
| interval() | Ticks interval settings. |
| set() | Setups ticks as an explicit array of fixed ticks. |
| Miscellaneous | |
| getIntervalUnit() | Returns interval unit. |
| getIntervalUnitCount() | Returns interval unit count. |
Methods Description
count
Getter for ticks count value.
Returns:
number - Ticks count value.Setter for ticks count value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| count | number | 4 | Ticks count value. Note: If value is defined, but not a number or less than 2, it defaults to 5. |
Returns:
anychart.scales.DateTimeTicks - Self instance for method chaining.Try it:
get
Returns an array of ticks. Each tick is a value in terms of data, to make a tick on.
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or after chart.draw()
Note: returns correct values only after anychart.scales.Base#finishAutoCalc or after chart.draw()
Returns:
Array - Array of ticks.Try it:
getIntervalUnit
Returns interval unit.
Detailed description
This method returns the current interval unit that is used by the scale tick.
In case of manual-set mixed intervals like P1Y3M returns the biggest interval (year).
Returns:
anychart.enums.Interval - Return the current interval unit.Try it:
getIntervalUnitCount
Returns interval unit count.
Detailed description
This method returns the interval count in the unit.
In case of manual-set mixed intervals like P1Y3M returns the biggest interval count (1 year).
Returns:
number - Return the current interval unit count.Try it:
interval
Getter for ticks interval value.
Note: Interval value can get only if it was set explicitly, otherwise, it returns NaN.
Returns:
string - Interval value in ISO 8601 interval string.Setter for ticks interval value by a string representing date part or ISO 8601 interval string..
Params:
| Name | Type | Description |
|---|---|---|
| isoDate | string | Value to set. |
Returns:
anychart.scales.DateTimeTicks - Self instance for method chaining.Try it:
Setter for ticks interval value by the unit.
Params:
| Name | Type | Description |
|---|---|---|
| unit | anychart.enums.Interval | string | Set unit by first letter. "year" is "y", "month" is "m" etc. Note: 'minutes' is 'n'. |
| count | number | Any positive value. |
Returns:
anychart.scales.DateTimeTicks - Self instance for method chaining.Try it:
Setter for ticks interval value.
Note: If any passed value is defined but is not a number or less than 0, it defaults to NaN and count() resets to 5.
Params:
| Name | Type | Description |
|---|---|---|
| years | number | Any positive value. |
| months | number | Any positive value. |
| days | number | Any positive value. |
| hours | number | Any positive value. |
| minutes | number | Any positive value. |
| seconds | number | Any positive value. |
Returns:
anychart.scales.DateTimeTicks - Self instance for method chaining.Try it:
set
Setups ticks as an explicit array of fixed ticks.
Params:
| Name | Type | Description |
|---|---|---|
| ticks | Array | Explicit ticks array. |
Returns:
anychart.scales.DateTimeTicks - Self instance for method chaining.Try it: