AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.stock.Grouping Improve this Doc

Extends: anychart.core.Base

Grouping settings class.

Methods Overview

Data
enabled()Grouping state.
forced()Forced grouping settings.
getCurrentDataInterval()Returns the grouping level.
isGrouped()Whether the data is grouped.
levels()Grouping levels.
maxVisiblePoints()Maximum visible points count.
minPixPerPoint()Minimum visible points count.

Methods Description

enabled

Getter for the grouping enabled state.

Returns:

boolean - Returns enabled state.
Setter for the grouping enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
If the grouping is enabled or disable.

Returns:

anychart.core.stock.Grouping - Self instance for method chaining.

forced

Getter for the forced grouping settings.

Returns:

boolean - The forced grouping settings.
Setter for the forced grouping settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

anychart.core.stock.Grouping - Self instance for method chaining.

getCurrentDataInterval

Returns the grouping level.

Returns:

anychart.core.stock.Grouping.Level - Object with unit and count.

isGrouped

Whether the data is grouped.

Returns:

boolean - Returns true if is data grouping.

levels

Getter for the data grouping levels.

Returns:

Array.<anychart.core.stock.Grouping.Level> - Data grouping levels.
Setter for the data grouping levels.

Params:

NameTypeDescription
levelsListArray.<(anychart.core.stock.Grouping.Level|string)>Grouping levels to set

Returns:

anychart.core.stock.Grouping - Self instance for method chaining.

maxVisiblePoints

Getter for the maximum visible points count.

Returns:

number - Maximum visible points count.
Setter for the maximum visible points count.

Params:

NameTypeDescription
countnumberMaximum visible points to set.

Returns:

anychart.core.stock.Grouping - Self instance for method chaining.

minPixPerPoint

Getter for the minimum pixels per point count.

Returns:

number - Minimum pixels per point count
Setter for minimum pixels per point count.

Params:

NameTypeDescription
countnumberMinimum pixels per point to set.

Returns:

anychart.core.stock.Grouping - Self instance for method chaining.