class anychart.scales.OrdinalColor Improve this Doc

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

Methods Overview

Specific settings
colorToValue()	Returns value for passed color. Value is a middle of its range.
finishAutoCalc()	Informs the scale that an auto range calculation started for the chart in past was ended.
getIndexByValue()	Returns range index relative passed value.
getProcessedRanges()	Returns processed ranges.
getRangeByValue()	Returns range for passed value.
getType()	Returns scale type.
inverseTransform()	Returns tick value by its ratio position.
inverted()	Scale inversion.
names()	Scale names settings.
ranges()	Scale ranges
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 value.
valueToColor()	Converts value to color. Returns color relative to passed value.
Coloring
colors()	Linear gradient settings.
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

colorToValue

colorToValue(value)Since version 7.6.0

Returns value for passed color. Value is a middle of its range.

Params:

Name	Type	Description
value	string	Color to search value.

Returns:

number - Middle of searched range.

Try it:

Usage sample

colors

colors()Since version 7.6.0

Gets the current linear gradient for linear color scale.

Returns:

Array.<string> - The current linear gradient.

colors(value)Since version 7.6.0

Sets linear gradient for linear color scale.

Detailed description

Can be set as single color or gradient as well as array or set of colors or gradients. Set ranges anychart.scales.OrdinalColor#ranges to see colors.

Params:

Name	Type	Description
value	Array.<string>	Colors set.

Returns:

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

Try it:

Usage sample

finishAutoCalc

finishAutoCalc(silently)

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.

getIndexByValue

getIndexByValue(value)Since version 7.6.0

Returns range index relative passed value.

Params:

Name	Type	Description
value	number	Value to search index.

Returns:

number - Range index.

Try it:

Usage sample

getProcessedRanges

getProcessedRanges()Since version 7.6.0

Returns processed ranges.

Returns:

Array.<Object> - Processed ranges.

Try it:

Usage sample

getRangeByValue

getRangeByValue(value)Since version 7.6.0

Returns range for passed value.

Params:

Name	Type	Description
value	number	Value to search its range.

Returns:

Object - Searched range or null.

Try it:

Usage sample

getType

getType()

Returns scale type.

Returns:

string - Scale type.

Try it:

Usage sample

inverseTransform

inverseTransform(ratio)Since version 7.6.0

Returns tick value by its ratio position.

Detailed description

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:

Usage sample

inverted

inverted()Since version 7.6.0

Getter for scale inversion.

Returns:

boolean - Current inversion state.

Try it:

Usage sample

inverted(value)Since version 7.6.0

Setter for scale inversion.

Detailed description

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.OrdinalColor - 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()Since version 7.6.0

Gets current scale names for data set.

Returns:

Array.<*> - Scale names.

Try it:

Usage sample

names(value)Since version 7.6.0

Sets scale names for data set.

Params:

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

Returns:

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

Try it:

Usage sample

ranges

ranges()Since version 7.6.0

Gets the current scale ranges.

Returns:

Array.<Object> - Current scale ranges.

ranges(value)Since version 7.6.0

Sets a set ranges.

Detailed description

Use "from" and "to" to set ranges.

Params:

Name	Type	Description
value	Array.<Object>	An array of the ranges.

Returns:

anychart.scales.OrdinalColor - 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

startAutoCalc

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.OrdinalColor - Chaining.

ticks

ticks()Since version 7.6.0

Gets the current set of scale ticks in terms of data values.

Returns:

anychart.scales.OrdinalTicks - Ordinal ticks instance.

Try it:

Usage sample

ticks(value)Since version 7.6.0

Sets a set of scale ticks in terms of data values.

Params:

Name	Type	Description
value	Object \| Array	An array or object of ticks to set.

Returns:

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

Try it:

Usage sample

transform

transform(value, subRangeRatio)Since version 7.6.0

Returns tick position ratio by its value.

Detailed description

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 [0, 1] scope.

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.