AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.scales.ScatterTicks Improve this Doc

Extends: anychart.core.Base

The ScatterTicks class contains methods for configuring ticks on the Scatter scale.

Methods Overview

Specific settings
allowFractional()Allow showing fractional values in ticks
base()Ticks base value.
count()Ticks count.
get()Returns an array of ticks. Each tick is a value in terms of data, to make a tick on.
interval()Ticks interval.
mode()Ticks mode.
set()Setups ticks as an explicit array of fixed ticks.
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

allowFractional

Getter for the allowFractional flag.

Returns:

boolean - Allow fractional values or not.
Setter for the allowFractional flag.
Whether to the allow fractional values in ticks.
Note: When anychart.scales.ScatterTicks#mode set to 'logarithmic', the allowFractional flag is always false.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether to allow fractional values in ticks.

Returns:

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

base

Getter for ticks base value.

Returns:

number - Returns base value.
See listing.
var ticks = scale.ticks();
var base = ticks.base();
Setter for ticks base value. Note: it is a number that is guaranteed to set a tick if the number is located between minimum and maximum values of the scale.

Params:

NameTypeDescription
baseValuenumberBase value for ticks.

Returns:

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

count

Getter for ticks count.

Returns:

number - Current count value.
See listing
var ticks = scale.ticks();
var count = ticks.count();
Setter for ticks count value. Note: Final number of ticks can be greater (one more tick can be added).

Params:

NameTypeDescription
countnumberTicks count value.
Note: If value is defined, but not a number or less than 2, it defaults to 5.

Returns:

anychart.scales.ScatterTicks - Self instance for method chaining.
Setter for ticks count value using two parameters. Note: Final number of ticks can be greater than maximum (one more tick can be added).

Params:

NameTypeDefaultDescription
minimumCountnumber
4
Minimum count to set.
maximumCountnumber
6
Maximum count to set.

Returns:

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

get

Returns an array of ticks. Each tick is a value in terms of data, to make a tick on. Note: returns correct values only after anychart.scales.Base#finishAutoCalc or after chart.draw()

Returns:

Array - Array of ticks.

interval

Getter for ticks interval value. Note: You can get interval value only if it was set explicitly, otherwise its returns NaN.

Returns:

number - Current interval value.
Setter for ticks interval value.

Params:

NameTypeDescription
valuenumberTicks interval value.
Note: If value is defined but is not a number or less than 0, it defaults to NaN and count() resets to 5.

Returns:

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

mode

Getter for the ticks mode.

Returns:

anychart.enums.ScatterTicksMode | string - Returns ticks mode.
See listing
var ticks = scale.ticks();
var mode = ticks.mode();
Setter for the ticks mode. Note: Use only with logarithmic scales.

Params:

NameTypeDescription
modeanychart.enums.ScatterTicksMode | stringMode to set.

Returns:

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

set

Setups ticks as an explicit array of fixed ticks.

Params:

NameTypeDescription
ticksArrayExplicit ticks array.

Returns:

anychart.scales.ScatterTicks - Returns itself for method chaining.

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.