API Reference
Namespaces
Classes
Events
Global
Externals

Class: ReferenceData

CIQ. ReferenceData ()

Reference Data Plugin

Note: Reference Data plugin constructor will be called automatically when the chart is created.


new ReferenceData()

Classes

Dataset
QuoteFeed
Registry
Study
SymbolIdentifier

Methods


configure(chartConfig, pluginConfig)

Adds the plugin to the provided chart config object using the provided plugin config object.

Parameters:
Name Type Description
chartConfig object

Chart configuration

pluginConfig object

Plugin Configuration

Properties
Name Type Argument Description
registry CIQ.ReferenceData.Registry <optional>

Dataset registry

attachQuoteFeed boolean

If true, attach the provided quote feed using the provided params

quoteFeed CIQ.ReferenceData.QuoteFeed

The quote feed to use

quoteFeedParams object

The quote feed params

toggle boolean

If true, registers the Reference Data toggle button on the chart menu

dialog boolean

If true, registers the Reference Data dialog

postInstall function

Callback when the plugin is loaded

container string <optional>

DOM object where toggle used to enable dialog will be located

toggleMarkup string

DOM markup for the toggle

Since:
  • 10.1.0