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

class anychart.scales.Ordinal Improve this Doc

Extends: anychart.scales.Base

Define Ordinal scale. Note: To create instance use anychart.scales#ordinal method.

Methods Overview

Specific settings
extendDataRange()Extends the current input domain with the passed values (if such don't exist in the domain).
finishAutoCalc()Informs the scale that an auto range calculation started for the chart in past was ended.
inverseTransform()Returns tick name by its ratio position.
inverted()Inversion state.
names()Tics names.
startAutoCalc()Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first
ticks()Ticks settings.
transform()Returns tick position ratio by its name.
values()Input domain.
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

extendDataRange

Extends the current input domain with the passed values (if such don't exist in the domain). Note: Attention! anychart.scales.Base#finishAutoCalc drops all passed values.

Params:

Name Type Description
var_args * Values that are supposed to extend the input domain.

Returns:

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

Try it:

finishAutoCalc

Informs the scale that an auto range calculation started for the chart in past was ended.

Params:

Name Type Description
silently boolean If this flag is set, do not dispatch an event if reapplication needed.

Returns:

boolean - If the calculation changed the scale and it needs to be reapplied.

inverseTransform

Returns tick name by its ratio position. Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().

Params:

Name Type Description
ratio number Value to transform in input scope.

Returns:

* - Value transformed to output scope.

Try it:

inverted

Getter for scale inversion.

Returns:

boolean - Current inversion state.
Setter for scale inversion. If the scale is inverted, axes and series go upside-down or right-to-left instead of bottom-to-top and left-to-right.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

anychart.scales.Base - 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 scale ticks names.

Returns:

Array.<*> - Current scale ticks names.

Try it:

Setter for scale ticks names.

Params:

Name Type Default Description
value Array.<*> | string
[]
Array of names or attribute name for data set.

Returns:

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

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:

startAutoCalc

Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first call of this method if needed.

Returns:

anychart.scales.Base - Chaining.

ticks

Getter for set of scale ticks in terms of data values.

Returns:

anychart.scales.OrdinalTicks - An instance of the class for method chaining.

Try it:

Setter for set of scale ticks in terms of data values.

Params:

Name Type Description
value Object | Array An array of indexes of ticks values.

Returns:

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

Try it:

transform

Returns tick position ratio by its name. Note: returns correct values only after anychart.scales.Base#finishAutoCalc or chart.draw().

Params:

Name Type Description
value * Value to transform in input scope.
subRangeRatio number Sub range ratio.

Returns:

number - Value transformed to output scope.

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:

values

Getter for scale input domain.

Returns:

Array.<(number|string)> - Current input domain.

Try it:

Setter for scale input domain.

Params:

Name Type Default Description
values Array.<*> | * | null
[]
Array of values, or values, or null for autocalc.
var_args *
Other values, that should be contained in input domain.

Returns:

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

Try it: