Class: FinancialsBase

Members

---

dataIdentifier

Get the data identifier for this financial dataset

---

frequency

Get the frequency for this financial dataset

Since:

• 10.2.0

---

queryType

Get the query type for this financial dataset

Methods

---

addToChart(chartEngine, symbolIdentifier, params)

Add dataset series to the chart engine.

Parameters:

Name	Type	Description
chartEngine	CIQ.ChartEngine	Chart engine instance
symbolIdentifier	SymbolIdentifier	Symbol identifier for the series
params	object	Additional series parameters

Returns:

Promise that resolves when the series is added

Type

Promise.<any>

---

buildQuery(baseQuery)

Build query for API request

Parameters:

Name	Type	Description
baseQuery	object	Base Financials query object

Returns:

Query object for the API

Type

object

---

findSiblingDatasetByFrequency(chartEngine, targetFrequency)

Finds the dataset class for a different frequency of this same dataset. Filters the registry at runtime to find matching dataset constructor.

Parameters:

Name	Type	Description
chartEngine	CIQ.ChartEngine	Chart engine instance with registry
targetFrequency	string	The target frequency identifier

Since:

• 10.2.0

Returns:

The dataset class or null if not found

Type

DatasetConstructor.<FinancialsBase> | null

---

getAvailableIntervals(chartEngine)

Get all frequency variants for this dataset's dataIdentifier Filters the registry at runtime to find all datasets with matching dataIdentifier

Parameters:

Name	Type	Description
chartEngine	CIQ.ChartEngine	Chart engine instance with registry

Since:

• 10.2.0

Returns:

Map of frequency values to display labels for dropdown

Type

Record.<string, string>

---

getPanel()

Income Statement and Balance Sheet data go in "financials" panel, others in "chart"

Returns:

Panel name

Type

string

---

swapToVariant(chartEngine, seriesId, targetFrequency)

Swaps this financial dataset series to a different frequency variant (e.g., Yearly to Quarterly) while preserving other parameters.

Parameters:

Name	Type	Description
chartEngine	CIQ.ChartEngine	The chart engine instance
seriesId	string	The current series identifier
targetFrequency	string	The target frequency ("Yearly" or "Quarterly")

Since:

• 10.2.0

Returns:

True if the series was successfully swapped, false otherwise

Type

boolean

---

transformQuote(response, query)

Transform API response

Parameters:

Name	Type	Description
response	object	API Resposne
query	object	Query object

Returns:

Array of quote-like objects for the chart

Type

Array.<any>