Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.3 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.

Try it:

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:

Name Type Default Description
value number
1
Value to set.

Returns:

anychart.scales.OrdinalTicks - 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 Object 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 Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

names

Getter for tick names.

Returns:

Array - Current ticks names.

Try it:

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:

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

Returns:

anychart.scales.OrdinalTicks - Returns itself for 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 Object 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: