API Reference
Namespaces
Classes
Events
Global
Externals

Class: Registry

CIQ.ReferenceData. Registry (datasets)

The reference data registry initializes and stores the provided datasets so that a reference data quotefeed can match an incoming request to a dataset.

new Registry(datasets)

Parameters:
Name Type Description
datasets Array.<CIQ.ReferenceData.Dataset>

Datasets
Since:

  • 10.1.0

Methods

addReferenceData(chartEngine, symbolString, datasetQuery, params)

Convenience method that matches a dataset using the provided datasetQuery string then calls Dataset.addToChart using the provided params.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

chart engine instance
symbolString string

string representing the symbol
datasetQuery string

string to match dataset
params object

addToChart params
Since:

  • 10.1.0

Returns:

Resolves once added

Type
Promise.<void>

filterByText(text)

Filters the registered datasets by matching the provided text query to the dataset name, categories, and description.

Parameters:
Name Type Description
text string

Text query
Since:

  • 10.1.0

Returns:

The matching dataset

Type
CIQ.ReferenceData.Dataset

findDataset(param)

Find a dataset using the provided string or Dataset constructor

Parameters:
Name Type Description
param string | CIQ.ReferenceData.Dataset

The query string or dataset constructor
Since:

  • 10.1.0

Returns:

The matching dataset

Type
CIQ.ReferenceData.Dataset