class anychart.scales.OrdinalTicks Improve this Doc

Scale ticks settings.

Methods Overview

Specific settings
get()	Returns an array of ticks. Each tick can be:
interval()	Ticks interval.
names()	Tick names 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

get

get()

Returns an array of ticks. Each tick can be:

A value in terms of data, to make a tick on.
An array of two values to make the tick from the first one to the second one.

Note: returns correct values only after anychart.scales.Base#finishAutoCalc or after chart.draw().

Returns:

Array - Array of ticks.

Try it:

Usage sample

interval

interval()

Getter for ticks interval value.

Returns:

number - Current interval value.

See listing

var currentTicks = scale.ticks();
currentTicks.interval();

interval(value)

Setter for ticks interval value. Passed value as rounded and defaults to 1 in case of incorrect settings.

Params:

Name	Type	Default	Description
value	number	1	Value to set.

Returns:

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

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.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

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

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:

Usage sample

names

names()

Getter for tick names.

Returns:

Array - Current ticks names.

Try it:

Usage sample

names(values)

Setter for tick names.

Params:

Name	Type	Description
values	Array	An array of tick aliases.

Returns:

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

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

set

set(ticks)

Setups ticks as an explicit array of fixed ticks.

Params:

Name	Type	Description
ticks	Array	Explicit tick indexes array.

Returns:

anychart.scales.OrdinalTicks - Returns itself for chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample