AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.scales.Base Improve this Doc

Extends: anychart.core.Base

Basic methods for scales.

Methods Overview

Specific settings
finishAutoCalc()Informs the scale that an auto range calculation started for the chart in past was ended.
getType()Returns scale type.
inverted()Inversion state.
startAutoCalc()Informs scale that an auto range calculation started for the chart, so it should reset its data range on the first
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

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.

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:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.