API Reference
Namespaces
Classes
Events
Global
Externals

Class: Dataset

CIQ.ReferenceData. Dataset ()

Dataset base class that can be extended to create your own datasets

new Dataset()

Since:

  • 10.1.0

Members

<abstract> categories :Array.<string>

The categories for the dataset

Type:
  • Array.<string>
Since:

  • 10.1.0

<abstract> description :string

The description of the dataset

Type:
  • string
Since:

  • 10.1.0

<abstract> name :string

The name of the dataset

Type:
  • string
Since:

  • 10.1.0

<static> Dataset.All

An array of all datasets that are based on this dataset

Since:

  • 10.1.0

<static> this.dependencies

Allow Datasets to specify any dependencies on other datasets, which signals to the ReferenceData Registry that those dependencies should be registered but remain hidden from the Reference Data UI unless explicitly registered by the user.

Since:

  • 10.1.0

Methods

addChartEngineMarkers(chartEngine, symbolIdentifier, params)

Add an event series to the chart using CIQ.ChartEngine.addEvent

This method is used for datasets that display as event markers. It resolves with the transformed API response data.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

The chart engine instance
symbolIdentifier CIQ.ReferenceData.SymbolIdentifier

The SymbolIdentifier instance
params object

Event series params including processResults callback
Since:

  • 10.1.0

Returns:

Promise resolves with the transformed API response data

Type
Promise.<object>

addChartEngineSeries(chartEngine, symbolIdentifier, params)

Add a series to the chart using CIQ.ChartEngine.addSeries

Checks that the series was added using CIQ.ReferenceData.checkSeriesAdded before resolving.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

The chart engine instance
symbolIdentifier CIQ.ReferenceData.SymbolIdentifier

The SymbolIdentifier instance
params object

Series params
Since:

  • 10.1.0

Returns:
Type
Promise.<object>

addSeriesManagerSeries(chartEngine, symbolIdentifier, params)

Add a series to the chart using the Series Manager class provided by the low frequency plugin.

Checks that the series was added using CIQ.ReferenceData.checkSeriesAdded before resolving.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

The chart engine instance
symbolIdentifier CIQ.ReferenceData.SymbolIdentifier

The SymbolIdentifier instance
params object

Series params
Since:

  • 10.1.0

Returns:

Promise resolves once the series has been added

Type
Promise.<object>

<abstract> addToChart(chartEngine, symbolIdentifier, params)

Determines how the dataset should be added to the chart when a dataset is added from the UI.

Override this method to change how a Dataset is added to the chart.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

The ChartEngine instance
symbolIdentifier CIQ.ReferenceData.SymbolIdentifier

The SymbolIdentifier instance
params object

Params provided by the Datasets UI, such as color
Since:

  • 10.1.0

Returns:

Return a promise that resolves when the dataset is added to the chart

Type
Promise.<object>

checkSeriesAdded(chartEngine, symbolString [, error])

Checks that a series was added successfully.

Resolves when the series is loaded otherwise rejects if the series was not added.

Parameters:
Name Type Argument Description
chartEngine CIQ.ChartEngine

The ChartEngine instance
symbolString string

The symbol string related to the series
error object <optional>

Any errors while adding the series
Since:

  • 10.1.0

Returns:

Promise resolves once the series has been added

Type
Promise.<object>

getSeriesQuotes(chartEngine, series)

Get the quotes for a series by filtering the chart's masterData.

Returns an array of quotes.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

The ChartEngine instance
series object

The series object
Since:

  • 10.1.0

Returns:

Array of quote objects with series data

Type
Array.<object>