Merge pull request #83 from thoughtspot/feat/visible-hidden-disabled-…

…context-menu-actions SDK support to disable and hide context menu actions
thoughtspot · Jan 26, 2025 · e81a470 · e81a470
2 parents e34db7b + 327f231
commit e81a470
Show file tree

Hide file tree

Showing 6 changed files with 1,096 additions and 12 deletions.
diff --git a/example/custom-bar-chart/custom-chart.ts b/example/custom-bar-chart/custom-chart.ts
@@ -31,6 +31,7 @@ import {
     VisualPropEditorDefinition,
     VisualProps,
 } from '@thoughtspot/ts-chart-sdk';
+import { Action } from '@thoughtspot/ts-chart-sdk/lib/types/actions.types';
 import { ChartConfigEditorDefinition } from '@thoughtspot/ts-chart-sdk/src';
 import {
     generateMapOptions,
@@ -340,27 +341,36 @@ function render(ctx: CustomChartContext) {
                                     const currentVisualProps = JSON.parse(
                                         JSON.stringify({
                                             ...chartModel.visualProps!,
-                                            // Assign updated client state values as string.
+                                            // Assign updated client state
+                                            // values as string.
                                             clientState: JSON.stringify({
-                                                // JSON parse previous client state values from a string (if any, if not parse null object).
+                                                // JSON parse previous client
+                                                // state values from a string
+                                                // (if any, if not parse null
+                                                // object).
                                                 ...JSON.parse(
                                                     (
                                                         chartModel.visualProps as {
                                                             clientState: string;
                                                         }
                                                     ).clientState || '{}',
                                                 ),
-                                                // Used to store any local state specific to chart, only string allowed.
-                                                // This will be preserved when you update visual props with an event.
-                                                // Assign new values to a client state using object rest destruct.
+                                                // Used to store any local state
+                                                // specific to chart, only
+                                                // string allowed. This will be
+                                                // preserved when you update
+                                                // visual props with an event.
+                                                // Assign new values to a client
+                                                // state using object rest
+                                                // destruct.
                                                 ...exampleClientState,
-                                                // To assign, and update new value.
-                                                // id: 'new-chart-id',
+                                                // To assign, and update new
+                                                // value. id: 'new-chart-id',
                                             }),
-                                            // this will throw warning in console, as this must
-                                            // be stringified.
-                                            // clientStateChart2: {
-                                            //     ...chartModel.visualProps?.clientStateChart2,
+                                            // this will throw warning in
+                                            // console, as this must be
+                                            // stringified. clientStateChart2: {
+                                            // ...chartModel.visualProps?.clientStateChart2,
                                             //     ...exampleClientStatChart2,
                                             // },
                                             clientStateChart2: JSON.stringify({
@@ -618,6 +628,10 @@ const renderChart = async (ctx: CustomChartContext): Promise<void> => {
                 measureValueColumnAlias: 'Value',
             },
             batchSizeLimit: 20000,
+            customChartVisualConfig: {
+                customChartDisabledActions: [],
+                customChartHiddenActions: [Action.Download],
+            },
         },
     });
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@thoughtspot/ts-chart-sdk",
     "private": false,
-    "version": "1.1.1",
+    "version": "1.2.0",
     "module": "lib/index",
     "main": "lib/index",
     "types": "lib/index",

diff --git a/src/main/custom-chart-context.ts b/src/main/custom-chart-context.ts
@@ -23,6 +23,7 @@ import {
     ChartModel,
     SuccessValidationResponse,
     ValidationResponse,
+    VisualConfig,
     VisualProps,
 } from '../types/common.types';
 import {
@@ -173,6 +174,13 @@ export type ChartConfigParameters = {
      * @version SDK: 0.1 | ThoughtSpot:
      */
     batchSizeLimit?: number;
+    /**
+     * @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
+     * @type {VisualConfig}
+     */
+    customChartVisualConfig?: VisualConfig;
 };
 
 export type CustomChartContextProps = {