Top

class anychart.scales.LinearColor Improve this Doc

Extends: anychart.scales.ScatterBase

Linear color scale. Note: To create instance use anychart.scales#linearColor method.

Methods Overview

Specific settings
colorToValue()Converts color to value. Returns number ratio by its color.
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 by its position ratio.
inverted()Inversion state.
maximum()Scale maximum.
minimum()Scale minimum.
minorTicks()Minor ticks settings.
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.
valueToColor()Converts value to color. Returns color ratio by its number.
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

Converts color to value. Returns number ratio by its color.

Params:

Name Type Description
value string Color name or hex color representation.

Returns:

number - Returns value relative passed color.

Try it:

colors

Gets the current linear gradient for the linear color scale.

Returns:

Array.<Object> - The current linear gradient.
Sets linear gradient for the linear color scale.

Returns:

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

Try it:

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.ScatterBase - 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.

getType

Returns scale type.

Returns:

string - Scale type.

Try it:

inverseTransform

Returns tick by its position ratio.
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 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:

listenOnce

Adds an event listener to an implementing object.

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:

maximum

Getter for the current scale maximum.

Returns:

number - Current scale maximum.
Setter for scale maximum.

Params:

Name Type Default Description
value number
null
Value to set.

Returns:

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

Try it:

minimum

Getter for the current scale minimum.

Returns:

number - Current scale minimum.
Setter for scale minimum.

Params:

Name Type Default Description
value number
null
Value to set.

Returns:

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

Try it:

minorTicks

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

Returns:

anychart.scales.ScatterTicks - The current set ticks.

Try it:

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

Params:

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

Returns:

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

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

Returns:

anychart.scales.ScatterTicks - The current set ticks.

Try it:

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

Params:

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

Returns:

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

Name Type Description
value * Value to transform in input scope.

Returns:

number - Value transformed to scope [0, 1].

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 ratio by its number.

Params:

Name Type Description
value number Value to convert.

Returns:

string - Returns color in hex representation relative passed value.

Try it: