AnyChart
API Reference
Still have questions?
Contact support
Top

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.
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
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:

NameTypeDefaultDescription
countnumber
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.

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()

Returns:

Array - Array of ticks.

getIntervalUnit

Returns interval unit.

Returns:

anychart.enums.Interval - Return the current interval unit.

getIntervalUnitCount

Returns interval unit count.

Returns:

number - Return the current interval unit count.

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:

NameTypeDescription
isoDatestringValue to set.

Returns:

anychart.scales.DateTimeTicks - Self instance for method chaining.
Setter for ticks interval value by the unit.

Params:

NameTypeDescription
unitanychart.enums.Interval | stringSet unit by first letter. "year" is "y", "month" is "m" etc.
Note: 'minutes' is 'n'.
countnumberAny positive value.

Returns:

anychart.scales.DateTimeTicks - Self instance for method chaining.
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:

NameTypeDescription
yearsnumberAny positive value.
monthsnumberAny positive value.
daysnumberAny positive value.
hoursnumberAny positive value.
minutesnumberAny positive value.
secondsnumberAny positive value.

Returns:

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

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.

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.

set

Setups ticks as an explicit array of fixed ticks.

Params:

NameTypeDescription
ticksArrayExplicit ticks array.

Returns:

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

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.