Top
You are looking at an outdated 7.11.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.scales.DateTimeTicks Improve this Doc

Extends: anychart.core.Base

Scale ticks.

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.

Methods Description

count

Getter for ticks count value.

Returns:

number - Current ticks count value.
Setter for ticks count value.

Params:

Name Type Default Description
value 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()

Returns:

Array - Array of ticks.

Try it:

interval

Getter for ticks interval value. Note: you can get interval value only if it was set explicitly, otherwise its returns NaN.

Returns:

string - Current interval value in ISO 8601 interval string.
Setter for ticks interval value by 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 unit.

Params:

Name Type Description
unit anychart.enums.Interval 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:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
listenerScope scope 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.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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:

set

Setups ticks as an explicit array of fixed ticks.

Params:

Name Type Description
ticks Array Explicit ticks array.

Returns:

anychart.scales.DateTimeTicks - Returns itself for method chaining.

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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: