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. |
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.
Whether to the allow fractional values in ticks.
Note: When anychart.scales.ScatterTicks#mode set to 'logarithmic', the allowFractional flag is always false.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Whether to allow fractional values in ticks. |
Returns:
anychart.scales.ScatterTicks - Self instance for method chaining.Try it:
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:
| Name | Type | Description |
|---|---|---|
| baseValue | number | Base value for ticks. |
Returns:
anychart.scales.ScatterTicks - Self instance for method chaining.Try it:
count
Getter for ticks count.
Returns:
number - Returns 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:
| Name | Type | Description |
|---|---|---|
| count | 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 | Minimum count to set. |
| maximumCount | number | 6 | Maximum count 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:
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:
| Name | Type | Description |
|---|---|---|
| mode | anychart.enums.ScatterTicksMode | string | Mode to set. |
Returns:
anychart.scales.ScatterTicks - Self instance for method chaining.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: