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

class anychart.data.Table Improve this Doc

Extends: anychart.core.Base

Stock data table constructor.

Methods Overview

Data
addData()Adds data to the table. Replaces all rows with duplicating keys by the last seen row with that key.
createComputer()Creates new computer with given input fields.
mapAs()Returns a new mapping for the table.
remove()Removes all items between start and end keys.
removeFirst()Removes first opt_count rows from the storage also considering appended but not yet committed rows.
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

addData

Adds data to the table. Replaces all rows with duplicating keys by the last seen row with that key.

Params:

Name Type Description
rawData Array | string Array of arrays of data or CSV string.
removeFromStart boolean | number Removes passed count of rows from the beginning of the storage. If true is passed - removes N rows, where N is the number of rows, passed as rawData (doesn't count duplicates, so if you pass two rows with same key value - it will remove two rows, not one). Note that removing is made AFTER the adding, so it can remove some rows that were added by itself.
csvSettings Object CSV parser settings if the string is passed.

Returns:

anychart.data.Table - Self instance for method chaining.

Try it:

createComputer

Creates new computer with given input fields.

Params:

Name Type Description
mappingSettingsOrMapping anychart.data.TableMapping | Object.<({column: (number|string), type:anychart.enums.AggregationType, weights: (number|string)}|number|string)> Input mapping settings for the computer.

Returns:

null anychart.data.TableComputer - An instance of the class for method chaining.

Try it:

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:

mapAs

Returns a new mapping for the table. You can add fields to table mappings after the mapping is created using it's addField() method.

Params:

Name Type Description
fields Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be determined from field name.

Returns:

anychart.data.TableMapping - An instance of the class for method chaining.

Try it:

remove

Removes all items between start and end keys.

Params:

Name Type Description
startKey number | string | Date | null Start key.
endKey number | string | Date | null End key.

Returns:

anychart.data.Table - 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:

removeFirst

Removes first opt_count rows from the storage also considering appended but not yet committed rows.

Params:

Name Type Description
count number Defaults to 1.

Returns:

anychart.data.Table - Self instance for method chaining.

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: