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
Setter for the grouping enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | If the grouping is enabled or disable. |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.Try it:
forced
Getter for the forced grouping settings.
Returns:
boolean - The forced grouping settings.Try it:
Setter for the forced grouping settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Value to set. |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.Try it:
getCurrentDataInterval
Returns the grouping level.
Returns:
anychart.core.stock.Grouping.Level - Object with unit and count.Try it:
isGrouped
Whether the data is grouped.
Detailed description
Returns true or false depending on current grouping state of the data.
Returns:
boolean - Returns true if is data grouping.Try it:
levels
Getter for the data grouping levels.
Returns:
Array.<anychart.core.stock.Grouping.Level> - Data grouping levels.Try it:
Setter for the data grouping levels.
Params:
| Name | Type | Description |
|---|---|---|
| levelsList | Array.<(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.Try it:
Setter for the maximum visible points count.
Detailed description
Mutually exclusive with anychart.core.stock.Grouping#minPixPerPoint settings.
Params:
| Name | Type | Description |
|---|---|---|
| count | number | Maximum visible points to set. |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.Try it:
minPixPerPoint
Getter for the minimum pixels per point count.
Returns:
number - Minimum pixels per point countTry it:
Setter for minimum pixels per point count.
Detailed description
Mutually exclusive with anychart.core.stock.Grouping#maxVisiblePoints settings.
Params:
| Name | Type | Description |
|---|---|---|
| count | number | Minimum pixels per point to set. |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.Try it: