DataSet

Type class

DataSet is objects which holds all information about data.

Sources

This information about DataSet is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

DataSet does not extend any other symbol.

DataSet is not extended by any other symbol.

Properties

#categoryField

Type string

Category field name in your dataProvider. It needs to contains a date/time value.

Note: we recommend using JavaScript timestamps to specify date/time. If you are specifying dates as strings in your data, i.e. "2015-01-05", we strongly recommend setting dataDateFormat as well.

#color

Type string

Color of the data set. One of colors from AmStockChart.colors array will be used if not set.

#compared

Type booleanDefault false

Whether this data set is selected for comparing. If you change this property, you should call stockChart.validateData() method in order the changes to be applied.

#fieldMappings

Type object[]

Array of field mappings. Field mapping is an object with fromField and toField properties. fromField is a name of your value field in dataProvider. toField might be chosen freely, it will be used to set value/open/close/high/low fields for the StockGraph. Example: {fromField:"val1", toField:"value"}.

#showInCompare

Type booleanDefault true

Specifies whether this data set should be visible in "compare to" list.

#showInSelect

Type booleanDefault true

Specifies whether this data set should be visible in "select" dropdown.

#stockEvents

Type StockEvent[]

Array of StockEvent objects.

#title

Type string

DataSet title.

Methods

DataSet does not have any methods.

Events

DataSet does not have any events.