Class CustomChartContext

Hierarchy

CustomChartContext

Index

Constructors

Methods

destroy emitEvent getChartModel initialize on

Constructors

constructor

new CustomChartContext(chartContextProps): CustomChartContext
Constructor to only accept context props as payload
Parameters
- chartContextProps: CustomChartContextProps
Returns CustomChartContext
- Defined in main/custom-chart-context.ts:193

Methods

destroy

destroy(): void
Destroy the chart context object and stop listening to the parent post message events

Version
SDK: 0.1 | ThoughtSpot:

Returns void
- Defined in main/custom-chart-context.ts:260

emitEvent

emitEvent<T>(eventType, eventPayload): Promise<any>
Function to emit Chart to TS Events to the TS application.

Returns
Promise
Type Parameters
- T extends keyof ChartToTSEventsPayloadMap
Parameters
- eventType: T
  
  Type of the event
- eventPayload: ChartToTSEventsPayloadMap[T]
  
  Event payload bound to the type of the event
Returns Promise<any>
- Defined in main/custom-chart-context.ts:280

getChartModel

getChartModel(): ChartModel
Getter for the chart model object

Version
SDK: 0.1 | ThoughtSpot:

Returns ChartModel
- Defined in main/custom-chart-context.ts:270

initialize

initialize(): Promise<void>
Function to expose and wait on the initialize promise object. This will resolve immediately if the chart context is already initialized by TS App.

Version
SDK: 0.1 | ThoughtSpot:

Returns Promise<void>
- Defined in main/custom-chart-context.ts:211

on

on<T>(eventType, callbackFn): void
Add event listeners on the chart context with the required callback.

Returns
void

Version
SDK: 0.1 | ThoughtSpot:
Type Parameters
- T extends keyof TSToChartEventsPayloadMap
Parameters
- eventType: T
- callbackFn: TSToChartEventsPayloadMap[T]
Returns void
- Defined in main/custom-chart-context.ts:224