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 current grouping level. |
| isGrouped() | Whether the data is grouped. |
| levels() | Grouping levels. |
| maxVisiblePoints() | Maximum visible points count. |
| minPixPerPoint() | Minimum visible points count. |
| 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
enabled
Getter for the current grouping enabled state.
Returns:
boolean - The current value.Try it:
Setter for the grouping enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | 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 current forced grouping settings.
Returns:
boolean - The current forced grouping settings.Try it:
Setter for the forced grouping settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.Try it:
getCurrentDataInterval
Returns current 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 current data grouping levels.
Returns:
Array.<anychart.core.stock.Grouping.Level> - The current data grouping levels.Try it:
Setter for the data grouping levels.
Params:
| Name | Type | Description |
|---|---|---|
| value | Array.<(anychart.core.stock.Grouping.Level|string)> | Value to set |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | 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 | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| 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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
maxVisiblePoints
Getter for the current maximum visible points count.
Returns:
number - The current 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 |
|---|---|---|
| value | number | Value to set. |
Returns:
anychart.core.stock.Grouping - Self instance for method chaining.Try it:
minPixPerPoint
Getter for the current minimum pixels per point count.
Returns:
number - The current 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 |
|---|---|---|
| value | number | Value to set. |
Returns:
anychart.core.stock.Grouping - 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:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| 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: