Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 7.13.0 version to see the up to date information.

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.

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.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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.

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 count

Try it:

Setter for minimum pixels per point count.

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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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: