AnyChart
API Reference
Still have questions?
Contact support
Top

namespace anychart.data Improve this Doc

Classes for handling data structures/sources
The following data types/hierarchy is supported:

You can map any of these data sets to (anychart.data.View), and then work with it using anychart.data.Iterator iterator.

Functions Overview

buildMapping()Creates data mapping.
loadCsvFile()Loads the CSV file.
loadGoogleSpreadsheet()Loads the Google Spreadsheets.
loadJsonFile()Loads the JSON file.
loadXmlFile()Loads the XML file.
mapAsTable()Maps passed data as an array of mappings.
parseHtmlTable()Parses HTML table to table data.
parseText()Text parsing.
set()Return instance of class anychart.data.Set.
table()Creates and returns a new instance of a data table.
tree()Creates and returns a new instance of the data tree.

Typedefs Overview

anychart.data.DataSettingsType definition for table data.
anychart.data.TextParsingSettingsSettings for parsing text.

Classes Overview

anychart.data.Iteratoranychart.data.Iterator class is used to work with data in a View.
anychart.data.MappingThe special view which allows mapping anychart.data.Set storages.
anychart.data.SetLinear data storage.
anychart.data.TableStock data table constructor.
anychart.data.TableComputerStock table computer constructor.
anychart.data.TableComputer.RowProxyRow proxy for computational functions.
anychart.data.TableIteratorTable iterator class. Assumes iterator (if any) to return not fewer keys than the table has.
anychart.data.TableMappingTable mapping constructor.
anychart.data.TableSelectableTable mapping proxy that supports selection
anychart.data.TableSelectable.RowProxyRepresents table row with associated mapping. Allows fetching rows values.
anychart.data.TraverserTree data traverser.
anychart.data.TreeTree data model.
anychart.data.Tree.DataItemTree data item.
anychart.data.TreeViewTreeView. Class of mapped tree.
anychart.data.TreeView.DataItemMapped data item class.
anychart.data.ViewView is a representation of raw data.

Functions Description

buildMapping

Creates data mapping.
Creates object mapping if keys are set, otherwise - array mapping.

Params:

Name Type Description
dataSet anychart.data.Set Data set
fromIndex number "From" index
toIndex number "To" index
names Array.<string> Field names
keys Array.<string> Keys

Returns:

anychart.data.Mapping - Returns an object mapping.

Try it:

loadCsvFile

Loads the CSV file.

Params:

Name Type Description
url string URL of an CSV file or a script
onSuccess function(data:Array.<string>) The function that is launched after chart is successfully loaded. Takes resulting data object parsed from response string as an argument.
onError function Function that is called if loading fails. Takes an error code as first argument and exception object or error message as the second argument.
method string Send method
content ArrayBuffer | ArrayBufferView | Blob | Document | FormData | string Data
headers Object Headers to add to the request
timeoutInterval number Number of milliseconds after which an incomplete request is aborted
withCredentials boolean Whether to send credentials with the request
context * Context for handler function

Try it:

loadGoogleSpreadsheet

Loads the Google Spreadsheets. Learn more about loading Google Spreadsheet

Params:

Name Type Description
key string | Object Google Spreadsheet key.
onSuccess function The function that is launched after chart is successfully loaded. Takes resulting data object parsed from response string as an argument.
onError function The function that is launched if chart loading fails.
timeoutInterval number Number of milliseconds after which an incomplete request is aborted.
context * Context for handler function.

Try it:

loadJsonFile

Loads the JSON file.

Params:

Name Type Description
url string URL of a JSON file or a script.
onSuccess function(data:Array.<(Object|string|number|boolean|null)>) The function that is launched after chart is successfully loaded. Takes resulting data object parsed from response string as an argument.
onError function Function that is called if loading fails. Takes an error code as first argument and exception object or error message as the second argument.
method string Send method
content ArrayBuffer | ArrayBufferView | Blob | Document | FormData | string Data.
headers Object Headers to add to the request
timeoutInterval number Number of milliseconds after which an incomplete request is aborted
withCredentials boolean Whether to send credentials with the request
context * Context for handler function

Try it:

loadXmlFile

Loads the XML file.

Params:

Name Type Description
url string URL of an XML file or a script
onSuccess function The function that is launched after chart is successfully loaded. Takes resulting data object parsed from response string as an argument.
onError function Function that is called if loading fails. Takes an error code as first argument and exception object or error message as the second argument.
method string Send method
content ArrayBuffer | ArrayBufferView | Blob | Document | FormData | string Data
headers Object Headers to add to the request
timeoutInterval number Number of milliseconds after which an incomplete request is aborted.
withCredentials boolean Whether to send credentials with the request
context * Context for handler function

Try it:

mapAsTable

Maps passed data as an array of mappings.

Params:

Name Type Description
data Array.<Array.<*>> Source data table.
mode anychart.enums.MapAsTableMode | string Mapping mode.
seriesCount number Explicit number of series to make mapping for. If not set, auto-determination by the first table row is used.

Returns:

Array.<anychart.data.Mapping> - Returns an array of mappings, one per series.

parseHtmlTable

Parses HTML table to table data.

Params:

Name Type Description
tableSelector string CSS table selector
rowsSelector string Rows selector in the CSS table
cellsSelector string Cells selector in the CSS table
headersSelector string Header selector in the CSS table
captionSelector string Caption selector in the CSS table
valueProcessor function Function that converts values from a table

Returns:

anychart.data.DataSettings - Returns data settings.

Try it:

parseText

Text parsing.

Params:

Name Type Description
text string Text to parsing.
settings anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings Parsing settings.

Returns:

Array.<Array.<(string|number)>> - Array of arrays.

Try it:

set

Return instance of class anychart.data.Set.

Params:

Name Type Description
data Array | string Data set raw data can be set here.
csvSettings anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

Try it:

table

Creates and returns a new instance of a data table. Key column index defaults to zero column.

Params:

Name Type Description
keyColumnIndex number | string Index of the column in with the table key field or field name in the array.
dateTimePattern string Key column parsing pattern.
timeOffset number Shifts all input dates timeOffset hours forward. Defaults to zero.
baseDate number | Date Base date for the key column.
locale string | anychart.format.Locale Locale to be used.

Returns:

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

Try it:

tree

Creates and returns a new instance of the data tree.

Params:

Name Type Description
data Array.<Object> | string Raw data or CSV-string. If the string is passed, the second parameter is interpreted as fields mapping.
fillMethodOrCsvMapping anychart.enums.TreeFillingMethod | Object Fill method or CSV mapping object. This parameter is interpreted as mapping object if the first parameter is a string. Mapping object should have the structure like
   //'nameOfField': index_of_column
   mapping = {
     'id': 0,
     'name': 1,
     'value': 15
   };
 
csvSettings Object CSV settings object. Should be fields like
rowsSeparator - string or undefined, if it is undefined, it will not be set.
columnsSeparator - string or undefined, if it is undefined, it will not be set.
ignoreTrailingSpaces - boolean or undefined, if it is undefined, it will not be set.
ignoreFirstRow - boolean or undefined, if it is undefined, it will not be set.
fieldsMapping Object Field mapping object. Maps only first-level data.

Returns:

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

Try it: