Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.scales.ScatterTicks Improve this Doc

Extends: anychart.core.Base

Scale ticks.

Methods Overview

Specific settings
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

base

Getter for ticks base value.

Returns:

number - Current base value.
See listing.
var currentTicks = scale.ticks();
currentTicks.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:

Name Type Description
value number Base value for ticks.

Returns:

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

Try it:

count

Getter for ticks count.

Returns:

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

Params:

Name Type Description
value number Ticks 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.

Try it:

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:

Name Type Default Description
minimumCount number
4
Value to set.
maximumCount number
6
Value to set.

Returns:

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

Try it:

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.

Try it:

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:

Name Type Description
value number Ticks 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.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

mode

Getter for the current ticks mode.

Returns:

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

Params:

Name Type Description
value anychart.enums.ScatterTicksMode | string Value to set.

Returns:

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

set

Setups ticks as an explicit array of fixed ticks.

Params:

Name Type Description
ticks Array Explicit ticks array.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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: