ChartIQ SDK Documentation

Class: SymbolIdentifier

CIQ .ReferenceData. SymbolIdentifier (symbolObject)

The SymbolIdentifier class ensures that each Dataset adds the correct symbol to the chart and enables each Datasets to seamlessly share their unique chart symbol with other Datasets.

new SymbolIdentifier(symbolObject)

Parameters:

Name	Type	Description
`symbolObject`	object

Since:

10.1.0

Methods

getShortDisplayName(dataset, chartEngine)

Returns a shortened display name for tooltip/legend display. Format: "[symbol] - [metric name] ([period])" e.g., "AAPL - EBIT (Y)" If symbol matches chart's primary symbol, format: "[metric name] ([period])" e.g., "EBIT (Y)"

Uses dataset.baseName and dataset.frequency if available. Falls back to dataset.name if baseName is not defined.

Parameters:

Name	Type	Description
`dataset`	CIQ.ReferenceData.Dataset	The dataset
`chartEngine`	CIQ.ChartEngine	The chart engine instance

Since:

10.3.0

Returns:

Short display name

Type: string

getSymbol()

Gets the base symbol string (e.g., "AAPL")

Since:

10.2.0

Returns:

The base symbol string

Type: string

toSymbolObject(dataset)

Converts SymbolIdentifier into a symbol object using the provided dataset.

Parameters:

Name	Type	Description
`dataset`	object	Dataset

Since:

10.1.0

Returns:

Symbol object

Type: object

toSymbolString(dataset)

Converts SymbolIdentifier into a symbol string using the provided dataset.

Parameters:

Name	Type	Description
`dataset`	object	Dataset

Since:

10.1.0

Returns:

Symbol string

Type: string