AnyChart
API Reference
Still have questions?
Contact support
Top

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 a 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:

NameTypeDescription
rawDataArray | stringAn array of arrays of data, array of objects or CSV string.
removeFromStartboolean | numberRemoves 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.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

createComputer

Creates new computer with given input fields.

Params:

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

Returns:

anychart.data.TableComputer - An instance of the class 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.

mapAs

Returns a new mapping for the table.
The fields can be added to table mappings after the mapping is created using its addField() method.

Params:

NameTypeDescription
fieldsObject.<({column: (number|string), type:anychart.enums.AggregationType, weights: (number|string)}|number|string)>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|string - 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 is determined from field name.

Returns:

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

remove

Removes all items between a start and end keys.

Params:

NameTypeDescription
startKeynumber | string | Date | nullStart key.
endKeynumber | string | Date | nullEnd key.

Returns:

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

removeFirst

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

Params:

NameTypeDescription
countnumberDefaults to 1.

Returns:

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

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.