@thoughtspot/ts-chart-sdk 1.1.0 → 1.2.0

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

@@ -285,19 +285,29 @@ export enum AxisMenuActions {
     SORT = 'SORT',
 
     /**
-     * These 2 methods are disabled currently as they are not supported by the backend.
+     * This  method is disabled currently as it is not supported by the backend.
      * Following are the reasons for the same:
-     * 1. Remove is ambiguous as it can mean remove from the answer scope or remove from the chart.
-     * 2. Rename columns is not supported by the menu for now. If need be, this can be implemented.
+     * 1. Rename columns is not supported by the menu for now. If need be, this can be implemented.
      */
     // /**
     //  * Rename the column.
     //  * */
     // RENAME = 'RENAME',
-    // /**
-    //  * Remove the column from the answer scope.
-    //  * */
-    // REMOVE = 'REMOVE',
+
+    /**
+     * Remove the column from the answer scope.
+     * */
+    REMOVE = 'REMOVE',
+
+    /**
+     * Open configure settings.
+     */
+    EDIT = 'EDIT',
+
+    /**
+     * Open Conditional Formatting editor of the column.
+     */
+    CONDITIONAL_FORMAT = 'CONDITIONAL_FORMAT',
     /**
      * Defines a separator element between the actions.
      * Can be added multiple times.

package/src/types/common.types.ts

@@ -6,6 +6,7 @@
  * Copyright: ThoughtSpot Inc. 2023
  */
 
+import { Action } from './actions.types';
 import { ChartColumn } from './answer-column.types';
 import type { ChartConfigEditorDefinition } from './configurator.types';
 import type { VisualPropEditorDefinition } from './visual-prop.types';
@@ -358,3 +359,38 @@ export interface AppConfig {
      */
     chartAppAccessToken?: string;
 }
+
+/**
+ * @description Configuration interface for controlling the visibility and behavior of actions in a custom chart.
+ * This interface allows control over which actions are disabled, hidden, or visible
+ * in the Answer Actions(3dot menu)/ context menu actions.
+ *
+ * @export
+ * @interface VisualConfig
+ */
+export interface VisualConfig {
+    /**
+     * Array of actions that should be disabled (grayed out) in the custom chart.
+     * These actions will be visible but not interactive.
+     */
+    customChartDisabledActions?: Action[];
+
+    /**
+     * Tooltip message for why certain actions are disabled.
+     *
+     */
+    customChartDisabledActionReason?: string;
+
+    /**
+     * Array of actions that should be completely hidden from the custom chart's UI.
+     * These actions will not be visible to users. Define either this or visibleActions.
+     */
+    customChartHiddenActions?: Action[];
+
+    /**
+     * Array of actions that should be explicitly visible in the custom chart.
+     * Use this to specify which actions should be shown in the UI. Define either this or Hidden
+     * Actions
+     */
+    customChartVisibleActions?: Action[];
+}

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

@@ -12,6 +12,7 @@ import {
     DataPointsArray,
     QueryData,
     ValidationResponse,
+    VisualConfig,
     VisualProps,
 } from './common.types';
 import type { ChartConfigEditorDefinition } from './configurator.types';
@@ -234,6 +235,16 @@ export interface InitializeEventResponsePayload {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     chartConfigParameters?: ChartConfigParameters;
+
+    /**
+     * @description
+     * Optional parameter to control certain visual elements on the chart For example visibleAction
+     * array if Passed will only show those actions in context menu/Action menu of the chart on
+     * answer page. To be passed to TS via this payload
+     * @type {VisualConfig}
+     * @memberof InitializeEventResponsePayload
+     */
+    customChartVisualConfig?: VisualConfig;
 }
 
 /**