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.
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 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.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.