API Reference
Namespaces
Classes
Events
Global
Externals

Class: KeyDevelopmentsBase

KeyDevelopmentsBase ()

Abstract base class for all Key Developments datasets Contains shared functionality for transformQuote, addToChart, and other common methods


new KeyDevelopmentsBase()

Classes

KeyDevelopmentsBase

Members


categoryKey

Gets the category key from the static class property. Used to categorize the type of key development event.


keyDevFilterId

Gets the key development filter ID from the static class property. Allows subclasses to define their own filter ID.

Methods


addToChart(chartEngine, symbolIdentifier, params)

Add Key Developments markers to the given chart engine.

Parameters:
Name Type Description
chartEngine CIQ.ChartEngine

Chart engine instance to add markers to

symbolIdentifier SymbolIdentifier

Identifier of the symbol to add markers for

params any

Additional params passed through to marker creation

Returns:

Resolves when markers have been added

Type
Promise.<void>

buildQuery(baseQuery)

Builds a query for Key Developments datasets. Extends the base query with KEYDEV_DATA type and additional properties for filtering and subcription handling.

Parameters:
Name Type Description
baseQuery any

Base query object to extend

Returns:

Query object for Key Developments request

Type
any

getDefaultSeriesParams()

Gets the default series parameters for Key Developments datasets. Sets panel to undefined since key developments don't use a separate panel.

Returns:

Default series parameters

Type
DefaultSeriesParams

getSupportedParams()

Gets the supported parameters for Key Developments datasets. Disables color and panel customization for these datasets.

Returns:

Supported dataset parameters

Type
DatasetParams

transformQuote(response)

Transforms the API response into quote data for Key Developments. Extracts individual events from the KEY_DEV_DATA array and normalizes timestamp fields. Returns individual events as separate quotes - the markers API handles positioning and consolidation.

Parameters:
Name Type Description
response any

API response containing KEY_DEV_DATA array

Returns:

Array of transformed quote objects with DT and event data

Type
Array.<any>