AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.scales.OrdinalColor Improve this Doc

Extends: anychart.scales.Base

The OrdinalColor class contains methods for configuring Ordinal color 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

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:

colors

Getter for the linear gradient for linear color scale.

Returns:

Array.<string> - The linear gradient.
Setter for the linear gradient for linear color scale.

Params:

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

Returns:

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

getIndexByValue

Returns range index relative passed value.

Params:

Name Type Description
value number Value to search index.

Returns:

number - Range index.

Try it:

getProcessedRanges

Returns processed ranges.

Returns:

Array.<Object> - Processed ranges.

Try it:

getRangeByValue

Returns range for passed value.

Params:

Name Type Description
value number Value to search its range.

Returns:

Object - Searched range or null.

Try it:

getType

Returns scale type.

Returns:

string - Scale type.

Try it:

inverseTransform

Returns tick value by its ratio position.

Params:

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

Returns:

* - Value transformed to output scope.

Try it:

inverted

Getter for the scale inversion.

Returns:

boolean - The inversion state.

Try it:

Setter for the scale inversion.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(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
}
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:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
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:

names

Getter for scale names for data set.

Returns:

Array.<*> - Scale names.

Try it:

Setter for 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:

ranges

Getter for the scale ranges.

Returns:

Array.<Object> - Scale ranges.
Setter for the scale ranges.

Params:

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

Returns:

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

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

ticks

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

Returns:

anychart.scales.OrdinalTicks - Ordinal ticks instance.

Try it:

Setter for the 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:

transform

Returns tick position ratio by its value.

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:

unlisten

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.

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:

valueToColor

Converts value to color. Returns color relative to passed value.

Params:

Name Type Description
value number Value to convert.

Returns:

string - Returns color in hex representation relative passed value.

Try it: