AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.scales.Ordinal Improve this Doc

Extends: anychart.scales.Base

The Ordinal class contains methods for configuring 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.
getType()Returns scale type.
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.
weights()Scale weights.
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:

NameTypeDescription
var_args*Values that are supposed to extend the input domain.

Returns:

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

finishAutoCalc

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

Params:

NameTypeDescription
silentlybooleanIf 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.

getType

Returns scale type.

Returns:

string - Scale type.

inverseTransform

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

Params:

NameTypeDescription
rationumberValue to transform in input scope.

Returns:

* - Value transformed to output scope.

inverted

Getter for the scale inversion.

Returns:

boolean - The 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:

NameTypeDefaultDescription
enabledboolean
false
Inverted state to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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(e:Object)
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 scale ticks names.

Returns:

Array.<*> - Scale ticks names.
Setter for scale ticks names.

Params:

NameTypeDefaultDescription
namesArray.<*> | 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:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

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.Ordinal - Self instance for method chaining.

ticks

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

Returns:

anychart.scales.OrdinalTicks - The set of ordinal ticks.
Setter for set of scale ticks in terms of data values.

Params:

NameTypeDescription
ticksObject | ArrayAn array of indexes of ticks values.

Returns:

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

transform

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

Params:

NameTypeDescription
value*Value to transform in input scope.
subRangeRationumberSub range ratio.

Returns:

number - Value transformed to output scope.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
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.

values

Getter for the scale input domain.

Returns:

Array.<(number|string)> - Input domain.
Setter for the scale input domain.

Params:

NameTypeDefaultDescription
valuesArray.<*> | * | 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.

weights

Getter for scale weights.

Returns:

Array.<number> - Scale weights.
See listing
var weights = scale.weights();
Setter for scale weights.

Params:

NameTypeDescription
weightsArray.<number>An array of weights.

Returns:

anychart.scales.Ordinal - Scale weights or self for chaining.