AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.scales.OrdinalTicks Improve this Doc

Extends: anychart.core.Base

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

Returns an array of ticks. Each tick can be:
  1. A value in terms of data, to make a tick on.
  2. 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.

interval

Getter for ticks interval value.

Returns:

number - Current interval value.
See listing
var currentTicks = scale.ticks();
currentTicks.interval();
Setter for ticks interval value. Passed value as rounded and defaults to 1 in case of incorrect settings.

Params:

NameTypeDefaultDescription
valuenumber
1
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

names

Getter for tick names.

Returns:

Array - Current ticks names.
Setter for tick names.

Params:

NameTypeDescription
valuesArrayAn array of tick aliases.

Returns:

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

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 tick indexes array.

Returns:

anychart.scales.OrdinalTicks - Returns itself for chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.