AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.scales.GeoTicks Improve this Doc

Extends: anychart.core.Base

The GeoTicks class contains methods for configuring ticks on the Geo scale.

Methods Overview

Specific settings
count()Ticks count.
get()Returns an array of ticks.
interval()Ticks interval.
set()Setups ticks as an explicit array of fixed ticks.

Methods Description

count

Getter for ticks count.

Returns:

number - Ticks count value.
See listing
var ticks = australiaMap.scale().xTicks();
var ticksCount = 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.
Note: If value is defined, but not a number or less than 2, it defaults to 5.

Returns:

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

NameTypeDescription
minimumCountnumberMinimum count to set.
maximumCountnumberMaximum count to set.

Returns:

anychart.scales.GeoTicks - 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, it returns NaN otherwise

Returns:

number - Returns interval value.
See listing
var ticks = australiaMap.scale().xTicks();
var interval = ticks.interval();
Setter for ticks interval value.

Params:

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

set

Setups ticks as an explicit array of fixed ticks.

Params:

NameTypeDescription
ticksArrayExplicit ticks array.

Returns:

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