Class: DataManager

StockChartX. DataManager


new DataManager()

Represents data manager that contains data series.

Members


<readonly> dateDataSeries :StockChartX.DataSeries

Returns date data series.
Type:
Example
var dateDataSeries = dataManager.dateDataSeries;

Methods


addBarDataSeries(symbol)

Creates bar data series (date, open, high, low, close, volume);
Parameters:
Name Type Argument Description
symbol String <optional>
The symbol name.
Returns:
Object that contains all data series.
Type
StockChartX.BarDataSeries
Example
var dataSeries = dataManager.addBarDataSeries();
or
var dataSeries = dataManager.addBarDataSeries('AAPL');

addDataSeries(dataSeries, replaceIfExists)

Adds data series into the data manager. If you specify data series name a new data series will be created and added.
Parameters:
Name Type Argument Default Description
dataSeries String | StockChartX.DataSeries The data series name or data series object.
replaceIfExists Boolean <optional>
false The flag that indicates whether data series with the same name should be replaced.
Throws:
Error if data series with the same name already exists and replaceIfExists set to false.
Returns:
The data series that has been added.
Type
StockChartX.DataSeries
Example
// Add new data series.
dataManager.addDataSeries(new StockChartX.DataSeries("OpenInterest"));

// Add new data series with a given name.
dataManager.addDataSeries("OpenInterest");

// Add/Replace data series with a given name.
dataManager.addDataSeries("Open Interest", true);

appendBars(bars)

Appends values from single bar or an array of bars into the corresponding data series.
Parameters:
Name Type Description
bars StockChartX.Bar | Array.<StockChartX.Bar> The single bar or an array of bars.
Example
// Add single bar
dataManager.appendBars({
 date: new Date(),
 open: 10,
 high: 11,
 low: 9,
 close: 9.5,
 volume: 1
});

// Add several bars
dataManager.appendBars([
 {
     date: new Date(),
     open: 10,
     high: 11,
     low: 8,
     close: 9,
     volume: 1
 },
 {
     date: new Date(),
     open: 20,
     high: 21,
     low: 18,
     close: 19,
     volume: 1
 }
]);

bar(index)

Returns bar at a given index.
Parameters:
Name Type Description
index Number The bar index.
Returns:
Type
StockChartX.Bar
Example
// Get first bar
var bar = dataManager.bar(0);

barDataSeries(prefix, createIfNotFound)

Returns bar data series.
Parameters:
Name Type Argument Default Description
prefix string <optional>
The data series prefix. It can be symbol (like 'aapl') or price style prefix (like '.kagi').
createIfNotFound boolean <optional>
false The flag that indicates whether data series should be created if it is not found.
Returns:
An object with bar data series.
Type
StockChartX.BarDataSeries
Example
var obj = dataManager.barDataSeries();
var dates = obj.date;
var opens = obj.open
var highs = obj.high;
var lows = obj.low;
var closes = obj.close;
var volumes = obj.volume;

clearDataSeries(dataSeries)

Removes all values from a given data series. Clears all values in all data series if parameter is omitted.
Parameters:
Name Type Argument Description
dataSeries String | StockChartX.DataSeries <optional>
The data series name or data series object.
Example
// clears all data series
dataManager.clearDataSeries();

// clears 'OpenInterest' data series.
dataManager.clearDataSeries("OpenInterest");

// clears date data series.
dataManager.clearDataSeries(dataManager.dateDataSeries);

findDataSeries(suffix)

Finds data series with a given suffix.
Parameters:
Name Type Description
suffix String The data series suffix.
Returns:
Type
StockChartX.DataSeries
Example
var dataSeries = dataManager.findDataSeries(StockChartX.DataSeriesSuffix.OPEN);

getDataSeries(name, addIfNotFound)

Returns data series with a given name.
Parameters:
Name Type Argument Default Description
name String The data series name.
addIfNotFound boolean <optional>
false
Returns:
Type
StockChartX.DataSeries
Example
var dataSeries = dataManager.getDataSeries("OpenInterest");

ohlcDataSeries(prefix, createIfNotFound)

Returns open, high, low, close data series.
Parameters:
Name Type Argument Default Description
prefix string <optional>
The data series prefix. It can be symbol (like 'aapl') or price style prefix (like '.kagi').
createIfNotFound boolean <optional>
false The flag that indicates whether data series should be created if it is not found.
Returns:
Type
StockChartX.OHLCDataSeries
Example
var obj = dataManager.ohlcDataSeries();
var opens = obj.open
var highs = obj.high;
var lows = obj.low;
var closes = obj.close;

removeDataSeries(dataSeries)

Removes specified data series. Or removes all data series if parameter is omitted.
Parameters:
Name Type Argument Description
dataSeries String | StockChartX.DataSeries <optional>
The data series object or data series name.
Example
// Remove all data series.
dataManager.removeDataSeries();

// Remove 'OpenInterest' data series.
dataManager.removeDataSeries('OpenInterest');

// Remove date data series.
dataManager.removeDataSeries(dataManager.dateDataSeries);

trimDataSeries(maxLength)

Trims all data series to a given maximum length.
Parameters:
Name Type Description
maxLength number The new maximum length of data series.
Example
// Trim all data series to contain 10 values maximum.
dataManager.trimDataSeries(10);