[SCAL-211470] add support for measure names and values

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@thoughtspot/ts-chart-sdk",
     "private": false,
-    "version": "0.0.2-alpha.8",
+    "version": "0.0.2-alpha.9",
     "module": "lib/index",
     "main": "lib/index",
     "types": "lib/index",

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

@@ -107,6 +107,7 @@ describe('CustomChartContext', () => {
                 allowedConfigurations: {
                     allowColumnNumberFormatting: false,
                     allowColumnConditionalFormatting: false,
+                    allowMeasureNamesAndValues: false,
                 },
             });
             expect(mockPostMessageToHost).not.toHaveBeenCalled();

src/main/custom-chart-context.ts

@@ -7,7 +7,7 @@
  */
 
 import _ from 'lodash';
 import {
     AxisMenuActionHandler,
     ChartToTSEvent,
     ChartToTSEventsPayloadMap,
@@ -25,7 +25,7 @@
     ValidationResponse,
     VisualProps,
 } from '../types/common.types';
 import {
     ChartConfigEditorDefinition,
     ConfigEditorDefinitionSetter,
 } from '../types/configurator.types';
@@ -46,7 +46,7 @@
     VisualPropsUpdateEventPayload,
     VisualPropsValidateEventPayload,
 } from '../types/ts-to-chart-event.types';
 import {
     VisualEditorDefinitionSetter,
     VisualPropEditorDefinition,
 } from '../types/visual-prop.types';
@@ -59,6 +59,7 @@
 export type AllowedConfigurations = {
     allowColumnNumberFormatting: boolean;
     allowColumnConditionalFormatting: boolean;
+    allowMeasureNamesAndValues: boolean;
 };
 
 export type CustomChartContextProps = {
@@ -158,6 +159,7 @@
     allowedConfigurations: {
         allowColumnNumberFormatting: false,
         allowColumnConditionalFormatting: false,
+        allowMeasureNamesAndValues: false,
     },
 };
 
@@ -277,7 +279,7 @@
      * @version SDK: 0.1 | ThoughtSpot:
      */
     public initialize = (): Promise<void> => {
         console.log('Chart Context: initialization start');
         return this.hasInitializedPromise;
     };
 
@@ -309,7 +311,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;
         }
@@ -526,7 +528,7 @@
         ...eventPayload: ChartToTSEventsPayloadMap[T]
     ): Promise<any> {
         if (!globalThis.isInitialized) {
             console.log(
                 'Chart Context: not initialized the context, something went wrong',
             );
             return Promise.reject(new Error('Context not initialized'));
@@ -549,7 +551,7 @@
      */
     private registerEventProcessor = () => {
         if (globalThis.isInitialized) {
             console.error(
                 'The context is already initialized. you cannot have multiple contexts',
             );
             throw new Error(ErrorType.MultipleContextsNotSupported);
@@ -565,7 +567,7 @@
      * @param event : Message Event Object
      */
     private eventProcessor = (data: any) => {
         console.log('Chart Context: message received:', data.eventType, data);
 
         const messageResponse = this.executeEventListenerCBs(data);
 
@@ -726,7 +728,7 @@
                         isValid: true,
                     };
                 } catch (error: unknown) {
                     console.log(
                         'ContextMenuCustomAction: payload recieved:',
                         payload,
                         'CustomActionCallbackStore:',
@@ -769,7 +771,7 @@
                         isValid: true,
                     };
                 } catch (error: unknown) {
                     console.log(
                         'AxisMenuCustomAction: payload recieved:',
                         payload,
                         'CustomActionCallbackStore:',

src/types/answer-column.types.ts

@@ -4,6 +4,18 @@ export enum ColumnType {
     UNKNOWN,
     MEASURE,
     ATTRIBUTE,
+    // Virtual columns that are measure name/value columns
+    VIRTUAL,
+}
+
+/**
+ * When the column is generated for the chart for creating views,
+ * on top of measure columns from the worksheet which are part of answer query.
+ */
+export enum ChartSpecificColumnType {
+    UNKNOWN,
+    MEASURE_NAMES,
+    MEASURE_VALUES,
 }
 
 /**
@@ -249,4 +261,12 @@ export interface ChartColumn {
      * @version SDK: 0.1 | ThoughtSpot: sdcwdc
      */
     calenderGuid?: string;
+
+    /**
+     * Type of arbitrary column, can be measure names or measure values
+     * also, unknown if regular column
+     *
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    chartSpecificColumnType: ChartSpecificColumnType;
 }

src/types/configurator.types.ts

@@ -70,6 +70,20 @@ export interface ChartConfigSection {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     allowTimeSeriesColumns?: boolean;
+    /**
+     * Allow measure name Column on the Section
+     *
+     * @default true
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    allowMeasureNameColumn?: boolean;
+    /**
+     * Allow measure value Column on the Section
+     *
+     * @default true
+     * @version SDK: 0.1 | ThoughtSpot:
+     */
+    allowMeasureValueColumn?: boolean;
 }
 
 /**

src/utils/conditional-formatting/conditional-formatting.spec.ts

@@ -13,6 +13,7 @@ import {
 } from '../../test/test-conditional-formatting-utils';
 import {
     ChartColumn,
+    ChartSpecificColumnType,
     ColumnTimeBucket,
     ColumnType,
     DataType,
@@ -190,6 +191,7 @@ describe('getCfForColumn', () => {
             id: 'col3',
             name: '',
             type: ColumnType.MEASURE,
+            chartSpecificColumnType: ChartSpecificColumnType.UNKNOWN,
             timeBucket: ColumnTimeBucket.AUTO,
             dataType: DataType.UNKNOWN,
             columnProperties: {

src/utils/date-formatting.spec.ts

@@ -8,6 +8,7 @@
 
 import {
     ChartColumn,
+    ChartSpecificColumnType,
     ColumnTimeBucket,
     ColumnType,
     DataType,
@@ -33,6 +34,7 @@ describe('date-formatting', () => {
             id: 'testId',
             name: 'test',
             type: ColumnType.MEASURE,
+            chartSpecificColumnType: ChartSpecificColumnType.UNKNOWN,
             timeBucket: ColumnTimeBucket.AUTO,
             dataType: DataType.UNKNOWN,
             calenderGuid: '12345',