Dynamic AllowedConfiguration

src/main/custom-chart-context.spec.ts

@@ -112,6 +112,10 @@ describe('CustomChartContext', () => {
                 defaultChartConfig: undefined,
                 chartConfigEditorDefinition: undefined,
                 visualPropEditorDefinition: undefined,
+                allowedConfigurations: {
+                    allowColumnNumberFormatting: false,
+                    allowColumnConditionalFormatting: false,
+                },
             });
             expect(mockPostMessage).toHaveBeenCalled();
             expect(mockPostMessageToHost).not.toHaveBeenCalled();

src/main/custom-chart-context.ts

@@ -7,7 +7,7 @@
  */
 
 import _ from 'lodash';
 import {
     AxisMenuActionHandler,
     ChartToTSEvent,
     ChartToTSEventsPayloadMap,
@@ -47,6 +47,11 @@
 
 let isInitialized = false;
 
+export type AllowedConfigurations = {
+    allowColumnNumberFormatting: boolean;
+    allowColumnConditionalFormatting: boolean;
+};
+
 export type CustomChartContextProps = {
     /**
      * Generate the default axis configuration for rendering the chart on first load.
@@ -121,6 +126,9 @@
      * @version SDK: 0.1 | ThoughtSpot:
      */
     visualPropEditorDefinition?: VisualPropEditorDefinition;
+
+    // Whether user wants thoughtspot default number and conditional formatting
+    allowedConfigurations?: AllowedConfigurations;
 };
 
 /**
@@ -130,6 +138,10 @@
     validateConfig: () => ({ isValid: true }),
     validateVisualProps: () => ({ isValid: true }),
     chartConfigEditorDefinition: undefined,
+    allowedConfigurations: {
+        allowColumnNumberFormatting: false,
+        allowColumnConditionalFormatting: false,
+    },
 };
 
 export class CustomChartContext {
@@ -244,7 +256,7 @@
      * @version SDK: 0.1 | ThoughtSpot:
      */
     public initialize = (): Promise<void> => {
         console.log('Chart Context: initialization start');
         return this.hasInitializedPromise;
     };
 
@@ -276,7 +288,7 @@
      */
     public off<T extends keyof TSToChartEventsPayloadMap>(eventType: T): void {
         if (_.isNil(this.eventListeners[eventType])) {
             console.log('No event listener found to remove');
             this.eventListeners[eventType] = [];
             return;
         }
@@ -433,7 +445,7 @@
         ...eventPayload: ChartToTSEventsPayloadMap[T]
     ): Promise<any> {
         if (!isInitialized) {
             console.log(
                 'Chart Context: not initialized the context, something went wrong',
             );
             return Promise.reject(new Error('Context not initialized'));
@@ -456,7 +468,7 @@
      */
     private registerEventProcessor = () => {
         if (isInitialized) {
             console.error(
                 'The context is already initialized. you cannot have multiple contexts',
             );
             throw new Error(ErrorType.MultipleContextsNotSupported);
@@ -476,7 +488,7 @@
             return;
         }
 
         console.log(
             'Chart Context: message received:',
             event.data.eventType,
             event.data,
@@ -619,7 +631,7 @@
                         isValid: true,
                     };
                 } catch (error: unknown) {
                     console.log(
                         'ContextMenuCustomAction: payload recieved:',
                         payload,
                         'CustomActionCallbackStore:',
@@ -662,7 +674,7 @@
                         isValid: true,
                     };
                 } catch (error: unknown) {
                     console.log(
                         'AxisMenuCustomAction: payload recieved:',
                         payload,
                         'CustomActionCallbackStore:',
@@ -787,6 +799,8 @@
                     this.chartContextProps.chartConfigEditorDefinition,
                 visualPropEditorDefinition:
                     this.chartContextProps.visualPropEditorDefinition,
+                allowedConfigurations:
+                    this.chartContextProps.allowedConfigurations,
             };
         };
 
@@ -814,7 +828,7 @@
             };
         }
 
         console.log(
             'ChartContext: Response:',
             event.data.eventType,
             response,

src/types/ts-to-chart-event.types.ts

@@ -1,3 +1,4 @@
+import { AllowedConfigurations } from '../main/custom-chart-context';
 import { ChartColumn } from './answer-column.types';
 import { Point } from './chart-to-ts-event.types';
 import {
@@ -191,6 +192,12 @@ export interface InitializeEventResponsePayload {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     visualPropEditorDefinition?: VisualPropEditorDefinition;
+    /**
+     * Toggle native configurations supported by TS UI. Ex: column level number and conditional formatting.
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    allowedConfigurations?: AllowedConfigurations;
 }
 
 /**