@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +1 -3
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/embed/app.d.ts +9 -1
  7. package/cjs/src/embed/app.d.ts.map +1 -1
  8. package/cjs/src/embed/app.js +3 -2
  9. package/cjs/src/embed/app.js.map +1 -1
  10. package/cjs/src/embed/app.spec.js +10 -0
  11. package/cjs/src/embed/app.spec.js.map +1 -1
  12. package/cjs/src/embed/base.d.ts +8 -0
  13. package/cjs/src/embed/base.d.ts.map +1 -1
  14. package/cjs/src/embed/base.js +8 -0
  15. package/cjs/src/embed/base.js.map +1 -1
  16. package/cjs/src/embed/sage.d.ts +39 -2
  17. package/cjs/src/embed/sage.d.ts.map +1 -1
  18. package/cjs/src/embed/sage.js +17 -3
  19. package/cjs/src/embed/sage.js.map +1 -1
  20. package/cjs/src/embed/sage.spec.js +27 -1
  21. package/cjs/src/embed/sage.spec.js.map +1 -1
  22. package/cjs/src/embed/search-bar.d.ts +1 -1
  23. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  24. package/cjs/src/embed/search.d.ts +8 -0
  25. package/cjs/src/embed/search.d.ts.map +1 -1
  26. package/cjs/src/embed/search.js +2 -1
  27. package/cjs/src/embed/search.js.map +1 -1
  28. package/cjs/src/embed/search.spec.js +11 -1
  29. package/cjs/src/embed/search.spec.js.map +1 -1
  30. package/cjs/src/react/index.spec.js +1 -1
  31. package/cjs/src/react/index.spec.js.map +1 -1
  32. package/cjs/src/types.d.ts +380 -248
  33. package/cjs/src/types.d.ts.map +1 -1
  34. package/cjs/src/types.js +357 -241
  35. package/cjs/src/types.js.map +1 -1
  36. package/dist/src/auth.d.ts.map +1 -1
  37. package/dist/src/embed/app.d.ts +9 -1
  38. package/dist/src/embed/app.d.ts.map +1 -1
  39. package/dist/src/embed/base.d.ts +8 -0
  40. package/dist/src/embed/base.d.ts.map +1 -1
  41. package/dist/src/embed/sage.d.ts +39 -2
  42. package/dist/src/embed/sage.d.ts.map +1 -1
  43. package/dist/src/embed/search-bar.d.ts +1 -1
  44. package/dist/src/embed/search-bar.d.ts.map +1 -1
  45. package/dist/src/embed/search.d.ts +8 -0
  46. package/dist/src/embed/search.d.ts.map +1 -1
  47. package/dist/src/types.d.ts +380 -248
  48. package/dist/src/types.d.ts.map +1 -1
  49. package/dist/tsembed-react.es.js +381 -17448
  50. package/dist/tsembed-react.js +380 -17447
  51. package/dist/tsembed.es.js +389 -17448
  52. package/dist/tsembed.js +388 -17447
  53. package/dist/visual-embed-sdk-react-full.d.ts +445 -252
  54. package/dist/visual-embed-sdk-react.d.ts +445 -252
  55. package/dist/visual-embed-sdk.d.ts +445 -252
  56. package/lib/package.json +1 -1
  57. package/lib/src/auth.d.ts.map +1 -1
  58. package/lib/src/auth.js +1 -2
  59. package/lib/src/auth.js.map +1 -1
  60. package/lib/src/embed/app.d.ts +9 -1
  61. package/lib/src/embed/app.d.ts.map +1 -1
  62. package/lib/src/embed/app.js +3 -2
  63. package/lib/src/embed/app.js.map +1 -1
  64. package/lib/src/embed/app.spec.js +10 -0
  65. package/lib/src/embed/app.spec.js.map +1 -1
  66. package/lib/src/embed/base.d.ts +8 -0
  67. package/lib/src/embed/base.d.ts.map +1 -1
  68. package/lib/src/embed/base.js +8 -0
  69. package/lib/src/embed/base.js.map +1 -1
  70. package/lib/src/embed/sage.d.ts +39 -2
  71. package/lib/src/embed/sage.d.ts.map +1 -1
  72. package/lib/src/embed/sage.js +17 -3
  73. package/lib/src/embed/sage.js.map +1 -1
  74. package/lib/src/embed/sage.spec.js +27 -1
  75. package/lib/src/embed/sage.spec.js.map +1 -1
  76. package/lib/src/embed/search-bar.d.ts +1 -1
  77. package/lib/src/embed/search-bar.d.ts.map +1 -1
  78. package/lib/src/embed/search.d.ts +8 -0
  79. package/lib/src/embed/search.d.ts.map +1 -1
  80. package/lib/src/embed/search.js +2 -1
  81. package/lib/src/embed/search.js.map +1 -1
  82. package/lib/src/embed/search.spec.js +11 -1
  83. package/lib/src/embed/search.spec.js.map +1 -1
  84. package/lib/src/react/index.spec.js +1 -1
  85. package/lib/src/react/index.spec.js.map +1 -1
  86. package/lib/src/types.d.ts +380 -248
  87. package/lib/src/types.d.ts.map +1 -1
  88. package/lib/src/types.js +357 -241
  89. package/lib/src/types.js.map +1 -1
  90. package/lib/src/visual-embed-sdk.d.ts +445 -252
  91. package/package.json +1 -1
  92. package/src/auth.ts +1 -2
  93. package/src/embed/app.spec.ts +15 -0
  94. package/src/embed/app.ts +11 -1
  95. package/src/embed/base.ts +8 -0
  96. package/src/embed/sage.spec.ts +33 -1
  97. package/src/embed/sage.ts +59 -4
  98. package/src/embed/search-bar.tsx +1 -1
  99. package/src/embed/search.spec.ts +15 -1
  100. package/src/embed/search.ts +10 -0
  101. package/src/react/index.spec.tsx +1 -1
  102. package/src/types.ts +366 -247
@@ -56,7 +56,7 @@ export enum Page {
56
56
  /**
57
57
  * SpotIQ listing page
58
58
  */
59
- SpotIQ = "spotiq"
59
+ SpotIQ = "insights"
60
60
  }
61
61
  /**
62
62
  * The view configuration for full app embedding.
@@ -126,6 +126,14 @@ export interface AppViewConfig extends ViewConfig {
126
126
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
127
127
  */
128
128
  fullHeight?: boolean;
129
+ /**
130
+ * Flag to control Data panel experience
131
+ *
132
+ * @default false
133
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
134
+ * @hidden
135
+ */
136
+ dataPanelV2?: boolean;
129
137
  }
130
138
  /**
131
139
  * Embeds full ThoughtSpot experience in a host application.
@@ -255,7 +263,15 @@ export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
255
263
  * @param fn The function being registered
256
264
  */
257
265
  export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
266
+ /**
267
+ * @param data
268
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
269
+ */
258
270
  export const executeTML: (data: executeTMLInput) => Promise<any>;
271
+ /**
272
+ * @param data
273
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
274
+ */
259
275
  export const exportTML: (data: exportTMLInput) => Promise<any>;
260
276
  /**
261
277
  *
@@ -494,6 +510,14 @@ export interface SearchViewConfig extends ViewConfig {
494
510
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
495
511
  */
496
512
  hideSearchBar?: boolean;
513
+ /**
514
+ * Flag to control Data panel experience
515
+ *
516
+ * @default false
517
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
518
+ * @hidden
519
+ */
520
+ dataPanelV2?: boolean;
497
521
  }
498
522
  export const HiddenActionItemByDefaultForSearchEmbed: Action[];
499
523
  /**
@@ -517,7 +541,7 @@ export class SearchEmbed extends TsEmbed {
517
541
  /**
518
542
  * @group Embed components
519
543
  */
520
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
544
+ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2'> {
521
545
  /**
522
546
  * The array of data source GUIDs to set on load.
523
547
  * Only a single dataSource supported currently.
@@ -991,6 +1015,9 @@ export interface CustomStyles {
991
1015
  export interface CustomisationsInterface {
992
1016
  style?: CustomStyles;
993
1017
  content?: {
1018
+ /**
1019
+ * @version SDK: 1.26.0 | 9.7.0.cl
1020
+ */
994
1021
  strings?: Record<string, any>;
995
1022
  [key: string]: any;
996
1023
  };
@@ -1398,21 +1425,21 @@ export interface ViewConfig {
1398
1425
  /**
1399
1426
  * Boolean to hide liveboard header
1400
1427
  *
1401
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1428
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1402
1429
  * @default false
1403
1430
  */
1404
1431
  hideLiveboardHeader?: boolean;
1405
1432
  /**
1406
1433
  * Boolean to show liveboard title
1407
1434
  *
1408
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1435
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1409
1436
  * @default false
1410
1437
  */
1411
1438
  showLiveboardTitle?: boolean;
1412
1439
  /**
1413
1440
  * Boolean to show liveboard description
1414
1441
  *
1415
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1442
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1416
1443
  * @default false
1417
1444
  */
1418
1445
  showLiveboardDescription?: boolean;
@@ -1430,7 +1457,7 @@ export interface ViewConfig {
1430
1457
  * 'f547ec54-2a37-4516-a222-2b06719af726']
1431
1458
  * });
1432
1459
  * ```
1433
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1460
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1434
1461
  */
1435
1462
  hiddenTabs?: string[];
1436
1463
  /**
@@ -1449,7 +1476,7 @@ export interface ViewConfig {
1449
1476
  * 'f547ec54-2a37-4516-a222-2b06719af726']
1450
1477
  * });
1451
1478
  * ```
1452
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1479
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1453
1480
  */
1454
1481
  visibleTabs?: string[];
1455
1482
  }
@@ -2011,7 +2038,19 @@ export enum EmbedEvent {
2011
2038
  *
2012
2039
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2013
2040
  */
2014
- FilterChanged = "filterChanged"
2041
+ FilterChanged = "filterChanged",
2042
+ /**
2043
+ * Emitted when a user click on Go button in Sage Embed
2044
+ *
2045
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2046
+ */
2047
+ SageEmbedQuery = "sageEmbedQuery",
2048
+ /**
2049
+ * Emitten when a user select data source in Sage Embed
2050
+ *
2051
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2052
+ */
2053
+ SageWorksheetUpdated = "sageWorksheetUpdated"
2015
2054
  }
2016
2055
  /**
2017
2056
  * Event types that can be triggered by the host application
@@ -2040,6 +2079,7 @@ export enum HostEvent {
2040
2079
  * Triggers a search query in AppEmbed and SearchEmbed
2041
2080
  * deployments.
2042
2081
  * Includes the following properties:
2082
+ *
2043
2083
  * @param - dataSourceIds - The data source GUID to Search on
2044
2084
  * - Although an array, only a single source
2045
2085
  * is supported.
@@ -2058,6 +2098,7 @@ export enum HostEvent {
2058
2098
  /**
2059
2099
  * Triggers a drill on certain points of the specified column
2060
2100
  * Includes the following properties:
2101
+ *
2061
2102
  * @param - points - an object containing selectedPoints/clickedPoints
2062
2103
  * to drill to. For example, { selectedPoints: []}
2063
2104
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -2122,18 +2163,19 @@ export enum HostEvent {
2122
2163
  */
2123
2164
  SetActiveTab = "SetActiveTab",
2124
2165
  /**
2125
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
2126
- * runtime filters passed here are appended to the existing runtime
2127
- * filters.
2128
- * Pass an array of runtime filters with the following attributes:
2129
- * `columnName`
2130
- * _String_. The name of the column to filter on.
2131
- * `operator`
2132
- * Runtime filter operator to apply. For information,
2133
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2134
- * `values`
2135
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2136
- * such as BW and IN accept multiple operands.
2166
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2167
+ * runtime filters passed here are appended to the existing runtime
2168
+ * filters.
2169
+ * Pass an array of runtime filters with the following attributes:
2170
+ * `columnName`
2171
+ * _String_. The name of the column to filter on.
2172
+ * `operator`
2173
+ * Runtime filter operator to apply. For information,
2174
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2175
+ * `values`
2176
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
2177
+ * operators such as BW and IN accept multiple operands.
2178
+ *
2137
2179
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2138
2180
  * @example
2139
2181
  * ```js
@@ -2149,6 +2191,7 @@ export enum HostEvent {
2149
2191
  /**
2150
2192
  * Navigate to a specific page in the embedded application without reloading the page.
2151
2193
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2194
+ *
2152
2195
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2153
2196
  * @example
2154
2197
  * ```js
@@ -2472,6 +2515,7 @@ export enum HostEvent {
2472
2515
  /**
2473
2516
  * Triggers the **SpotIQ analyze** action on visualization
2474
2517
  * or search.
2518
+ *
2475
2519
  * @param - Liveboard embed takes `vizId` as a
2476
2520
  * key. Can be left undefined when embedding Search or
2477
2521
  * visualization.
@@ -2511,6 +2555,7 @@ export enum HostEvent {
2511
2555
  /**
2512
2556
  * Triggers the **Download** > **PNG** action on
2513
2557
  * charts in the embedded view.
2558
+ *
2514
2559
  * @example
2515
2560
  * ```js
2516
2561
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2544,6 +2589,7 @@ export enum HostEvent {
2544
2589
  /**
2545
2590
  * Triggers the **Download** > **XLSX** action on tables
2546
2591
  * in the embedded view.
2592
+ *
2547
2593
  * @example
2548
2594
  * ```js
2549
2595
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -2575,6 +2621,7 @@ export enum HostEvent {
2575
2621
  /**
2576
2622
  * Triggers the **Save** action on a Liveboard or Answer.
2577
2623
  * Saves the changes.
2624
+ *
2578
2625
  * @example
2579
2626
  * ```js
2580
2627
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -2588,6 +2635,7 @@ export enum HostEvent {
2588
2635
  /**
2589
2636
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
2590
2637
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
2638
+ *
2591
2639
  * @param - an object with `vizId` as a key
2592
2640
  * @example
2593
2641
  * ```js
@@ -2604,6 +2652,7 @@ export enum HostEvent {
2604
2652
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
2605
2653
  * Sends data from an Answer or Liveboard visualization to third-party apps such
2606
2654
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2655
+ *
2607
2656
  * @param - an object with vizId as a key
2608
2657
  * @example
2609
2658
  * ```js
@@ -2620,6 +2669,7 @@ export enum HostEvent {
2620
2669
  * Triggers the **Manage pipelines** action on an embedded
2621
2670
  * visualization or Answer.
2622
2671
  * Allows users to manage ThoughtSpot Sync pipelines.
2672
+ *
2623
2673
  * @param - an object with `vizId` as a key
2624
2674
  * @example
2625
2675
  * ```js
@@ -2664,6 +2714,19 @@ export enum HostEvent {
2664
2714
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2665
2715
  */
2666
2716
  UpdateFilters = "updateFilters",
2717
+ /**
2718
+ * Get Tab for the current Liveboard.
2719
+ *
2720
+ * @example
2721
+ * ```js
2722
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
2723
+ * console.log(
2724
+ * tabDetails // TabDetails of current LB
2725
+ * );
2726
+ * })
2727
+ * ```
2728
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2729
+ */
2667
2730
  GetTabs = "getTabs",
2668
2731
  /**
2669
2732
  * Set the visible Tabs on a Liveboard.
@@ -2676,7 +2739,7 @@ export enum HostEvent {
2676
2739
  * '430496d6-6903-4601-937e-2c691821af3c',
2677
2740
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
2678
2741
  * ```
2679
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2742
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2680
2743
  */
2681
2744
  SetVisibleTabs = "SetPinboardVisibleTabs",
2682
2745
  /**
@@ -2690,9 +2753,23 @@ export enum HostEvent {
2690
2753
  * '630496d6-6903-4601-937e-2c691821af3c',
2691
2754
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
2692
2755
  * ```
2693
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2756
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2694
2757
  */
2695
- SetHiddenTabs = "SetPinboardHiddenTabs"
2758
+ SetHiddenTabs = "SetPinboardHiddenTabs",
2759
+ /**
2760
+ * Updates the search query for sage embed.
2761
+ *
2762
+ * @param - searchOptions: an object queryString and option to execute the query.
2763
+ * @example
2764
+ * ```js
2765
+ * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
2766
+ * queryString: 'revenue per year',
2767
+ * executeSearch: true,
2768
+ * })
2769
+ * ```
2770
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2771
+ */
2772
+ UpdateSageQuery = "updateSageQuery"
2696
2773
  }
2697
2774
  /**
2698
2775
  * The different visual modes that the data sources panel within
@@ -2747,6 +2824,7 @@ export enum Param {
2747
2824
  DisableLoginRedirect = "disableLoginRedirect",
2748
2825
  visibleVizs = "pinboardVisibleVizs",
2749
2826
  LiveboardV2Enabled = "isPinboardV2Enabled",
2827
+ DataPanelV2Enabled = "enableDataPanelV2",
2750
2828
  ShowAlerts = "showAlerts",
2751
2829
  Locale = "locale",
2752
2830
  CustomStyle = "customStyle",
@@ -2772,7 +2850,10 @@ export enum Param {
2772
2850
  ShowLiveboardTitle = "showLiveboardTitle",
2773
2851
  HiddenTabs = "hideTabs",
2774
2852
  VisibleTabs = "visibleTabs",
2775
- HideTabPanel = "hideTabPanel"
2853
+ HideTabPanel = "hideTabPanel",
2854
+ HideSampleQuestions = "hideSampleQuestions",
2855
+ WorksheetId = "worksheet",
2856
+ Query = "query"
2776
2857
  }
2777
2858
  /**
2778
2859
  * ThoughtSpot application pages include actions and menu commands
@@ -2781,6 +2862,7 @@ export enum Param {
2781
2862
  * specific actions in the embedded view, define the Action
2782
2863
  * enumeration members in the `disabledActions`, `visibleActions`,
2783
2864
  * or `hiddenActions` array.
2865
+ *
2784
2866
  * @example
2785
2867
  * ```js
2786
2868
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2799,12 +2881,12 @@ export enum Param {
2799
2881
  * hiddenActions: [Action.Edit, ActionAction.Explore],
2800
2882
  * })
2801
2883
  * ```
2802
-
2803
2884
  */
2804
2885
  export enum Action {
2805
2886
  /**
2806
2887
  * The **Save** action on an Answer or Liveboard.
2807
2888
  * Allows users to save the changes.
2889
+ *
2808
2890
  * @example
2809
2891
  * ```js
2810
2892
  * disabledActions: [Action.SaveAsView]
@@ -2820,136 +2902,146 @@ export enum Action {
2820
2902
  */
2821
2903
  SaveUntitled = "saveUntitled",
2822
2904
  /**
2823
- * The **Save as View** action on the Answer
2824
- * page. Saves an Answer as a View object.
2825
- *
2826
- * @example
2827
- * ```js
2828
- * disabledActions: [Action.SaveAsView]
2829
- * ```
2830
- */
2905
+ * The **Save as View** action on the Answer
2906
+ * page. Saves an Answer as a View object.
2907
+ *
2908
+ * @example
2909
+ * ```js
2910
+ * disabledActions: [Action.SaveAsView]
2911
+ * ```
2912
+ */
2831
2913
  SaveAsView = "saveAsView",
2832
2914
  /**
2833
- * The **Make a copy** action on a Liveboard or Answer
2834
- * page.
2835
- * Creates a copy of the Liveboard, visualization,
2836
- * or Answer.
2837
- *
2838
- * @example
2839
- * ```js
2840
- * disabledActions: [Action.MakeACopy]
2841
- * ```
2842
- */
2915
+ * The **Make a copy** action on a Liveboard or Answer
2916
+ * page.
2917
+ * Creates a copy of the Liveboard, visualization,
2918
+ * or Answer.
2919
+ *
2920
+ * @example
2921
+ * ```js
2922
+ * disabledActions: [Action.MakeACopy]
2923
+ * ```
2924
+ */
2843
2925
  MakeACopy = "makeACopy",
2844
2926
  /**
2845
- * The **Copy and Edit** action on a Liveboard.
2846
- * This action is now replaced with `Action.MakeACopy`.
2847
- *
2848
- * @example
2849
- * ```js
2850
- * disabledActions: [Action.EditACopy]
2851
- * ```
2852
- */
2927
+ * The **Copy and Edit** action on a Liveboard.
2928
+ * This action is now replaced with `Action.MakeACopy`.
2929
+ *
2930
+ * @example
2931
+ * ```js
2932
+ * disabledActions: [Action.EditACopy]
2933
+ * ```
2934
+ */
2853
2935
  EditACopy = "editACopy",
2854
2936
  /**
2855
- * The **Copy link** menu action on a Liveboard visualization.
2856
- * Copies the visualization URL
2857
- * @example
2858
- * ```js
2859
- * disabledActions: [Action.CopyLink]
2860
- * ```
2861
- */
2937
+ * The **Copy link** menu action on a Liveboard visualization.
2938
+ * Copies the visualization URL
2939
+ *
2940
+ * @example
2941
+ * ```js
2942
+ * disabledActions: [Action.CopyLink]
2943
+ * ```
2944
+ */
2862
2945
  CopyLink = "embedDocument",
2863
2946
  /**
2864
2947
  * @hidden
2865
2948
  */
2866
2949
  ResetLayout = "resetLayout",
2867
2950
  /**
2868
- * The **Schedule** menu action on a Liveboard.
2869
- * Allows scheduling a Liveboard notification.
2870
- * @example
2871
- * ```js
2872
- * disabledActions: [Action.Schedule]
2873
- * ```
2874
- */
2951
+ * The **Schedule** menu action on a Liveboard.
2952
+ * Allows scheduling a Liveboard notification.
2953
+ *
2954
+ * @example
2955
+ * ```js
2956
+ * disabledActions: [Action.Schedule]
2957
+ * ```
2958
+ */
2875
2959
  Schedule = "subscription",
2876
2960
  /**
2877
- * The **Manage schedules** menu action on a Liveboard.
2878
- * Allows users to manage scheduled Liveboard jobs.
2879
- * @example
2880
- * ```js
2881
- * disabledActions: [Action.SchedulesList]
2882
- * ```
2883
- */
2961
+ * The **Manage schedules** menu action on a Liveboard.
2962
+ * Allows users to manage scheduled Liveboard jobs.
2963
+ *
2964
+ * @example
2965
+ * ```js
2966
+ * disabledActions: [Action.SchedulesList]
2967
+ * ```
2968
+ */
2884
2969
  SchedulesList = "schedule-list",
2885
2970
  /**
2886
- * The **Share** action on a Liveboard, Answer, or Worksheet.
2887
- * Allows users to share an object with other users and groups.
2888
- * @example
2889
- * ```js
2890
- * disabledActions: [Action.Share]
2891
- * ```
2892
- */
2971
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
2972
+ * Allows users to share an object with other users and groups.
2973
+ *
2974
+ * @example
2975
+ * ```js
2976
+ * disabledActions: [Action.Share]
2977
+ * ```
2978
+ */
2893
2979
  Share = "share",
2894
2980
  /**
2895
- * The **Add filter** action on a Liveboard and Search page.
2896
- * Allows adding filters to Answers and visualizations on a Liveboard.
2897
- * @example
2898
- * ```js
2899
- * disabledActions: [Action.AddFilter]
2900
- * ```
2901
- */
2981
+ * The **Add filter** action on a Liveboard and Search page.
2982
+ * Allows adding filters to Answers and visualizations on a Liveboard.
2983
+ *
2984
+ * @example
2985
+ * ```js
2986
+ * disabledActions: [Action.AddFilter]
2987
+ * ```
2988
+ */
2902
2989
  AddFilter = "addFilter",
2903
2990
  /**
2904
- * Filter configuration options on a Liveboard and Search page.
2905
- * Allows configuring filter options when adding filters to a
2906
- * Liveboard or Answer.
2907
- * @example
2908
- * ```js
2909
- * disabledActions: [Action.ConfigureFilter]
2910
- * ```
2911
- */
2991
+ * Filter configuration options on a Liveboard and Search page.
2992
+ * Allows configuring filter options when adding filters to a
2993
+ * Liveboard or Answer.
2994
+ *
2995
+ * @example
2996
+ * ```js
2997
+ * disabledActions: [Action.ConfigureFilter]
2998
+ * ```
2999
+ */
2912
3000
  ConfigureFilter = "configureFilter",
2913
3001
  CollapseDataSources = "collapseDataSources",
2914
3002
  /**
2915
- * The **Choose sources** button on Search page.
2916
- * Allows selecting data sources for search queries.
2917
- * @example
2918
- * ```js
2919
- * disabledActions: [Action.ChooseDataSources]
2920
- * ```
2921
- */
3003
+ * The **Choose sources** button on Search page.
3004
+ * Allows selecting data sources for search queries.
3005
+ *
3006
+ * @example
3007
+ * ```js
3008
+ * disabledActions: [Action.ChooseDataSources]
3009
+ * ```
3010
+ */
2922
3011
  ChooseDataSources = "chooseDataSources",
2923
3012
  /**
2924
- * The **Create formula** action on a Search or Answer page.
2925
- * Allows adding formulas to an Answer.
2926
- * @example
2927
- * ```js
2928
- * disabledActions: [Action.AddFormula]
2929
- * ```
2930
- */
3013
+ * The **Create formula** action on a Search or Answer page.
3014
+ * Allows adding formulas to an Answer.
3015
+ *
3016
+ * @example
3017
+ * ```js
3018
+ * disabledActions: [Action.AddFormula]
3019
+ * ```
3020
+ */
2931
3021
  AddFormula = "addFormula",
2932
3022
  /**
2933
- * The **Add parameter** action on a Liveboard or Answer.
2934
- * Allows adding Parameters to a Liveboard or Answer.
2935
- * @example
2936
- * ```js
2937
- * disabledActions: [Action.AddParameter]
2938
- * ```
2939
- */
3023
+ * The **Add parameter** action on a Liveboard or Answer.
3024
+ * Allows adding Parameters to a Liveboard or Answer.
3025
+ *
3026
+ * @example
3027
+ * ```js
3028
+ * disabledActions: [Action.AddParameter]
3029
+ * ```
3030
+ */
2940
3031
  AddParameter = "addParameter",
2941
3032
  /**
2942
3033
  * @hidden
2943
3034
  */
2944
3035
  SearchOnTop = "searchOnTop",
2945
3036
  /**
2946
- * The **SpotIQ analyze** menu action on a visualization or
2947
- * Answer page.
2948
- * @example
2949
- * ```js
2950
- * disabledActions: [Action.SpotIQAnalyze]
2951
- * ```
2952
- */
3037
+ * The **SpotIQ analyze** menu action on a visualization or
3038
+ * Answer page.
3039
+ *
3040
+ * @example
3041
+ * ```js
3042
+ * disabledActions: [Action.SpotIQAnalyze]
3043
+ * ```
3044
+ */
2953
3045
  SpotIQAnalyze = "spotIQAnalyze",
2954
3046
  /**
2955
3047
  * @hidden
@@ -2965,89 +3057,98 @@ export enum Action {
2965
3057
  */
2966
3058
  ReplaySearch = "replaySearch",
2967
3059
  /**
2968
- * The **Show underlying data** menu action on a visualization or
2969
- * Answer page.
2970
- * @example
2971
- * ```js
2972
- * disabledActions: [Action.ShowUnderlyingData]
2973
- * ```
2974
- */
3060
+ * The **Show underlying data** menu action on a visualization or
3061
+ * Answer page.
3062
+ *
3063
+ * @example
3064
+ * ```js
3065
+ * disabledActions: [Action.ShowUnderlyingData]
3066
+ * ```
3067
+ */
2975
3068
  ShowUnderlyingData = "showUnderlyingData",
2976
3069
  /**
2977
- * The **Download** menu action on Liveboard visualizations
2978
- * and Answers.
2979
- * Allows downloading a visualization or Answer.
2980
- * @example
2981
- * ```js
2982
- * disabledActions: [Action.DownloadAsPng]
2983
- * ```
2984
- */
3070
+ * The **Download** menu action on Liveboard visualizations
3071
+ * and Answers.
3072
+ * Allows downloading a visualization or Answer.
3073
+ *
3074
+ * @example
3075
+ * ```js
3076
+ * disabledActions: [Action.DownloadAsPng]
3077
+ * ```
3078
+ */
2985
3079
  Download = "download",
2986
3080
  /**
2987
- * The **Download** > **PNG** menu action for charts on a Liveboard
2988
- * or Answer page.
2989
- * Downloads a visualization or Answer as a PNG file.
2990
- * @example
2991
- * ```js
2992
- * disabledActions: [Action.DownloadAsPng]
2993
- * ```
2994
- */
3081
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3082
+ * or Answer page.
3083
+ * Downloads a visualization or Answer as a PNG file.
3084
+ *
3085
+ * @example
3086
+ * ```js
3087
+ * disabledActions: [Action.DownloadAsPng]
3088
+ * ```
3089
+ */
2995
3090
  DownloadAsPng = "downloadAsPng",
2996
3091
  /**
2997
- * The **Download** > **PDF** menu action on a Liveboard.
2998
- * Downloads a visualization or Answer as a PDF file.
2999
- * @example
3000
- * ```js
3001
- * disabledActions: [Action.DownloadAsPdf]
3002
- * ```
3003
- */
3092
+ * The **Download** > **PDF** menu action on a Liveboard.
3093
+ * Downloads a visualization or Answer as a PDF file.
3094
+ *
3095
+ * @example
3096
+ * ```js
3097
+ * disabledActions: [Action.DownloadAsPdf]
3098
+ * ```
3099
+ */
3004
3100
  DownloadAsPdf = "downloadAsPdf",
3005
3101
  /**
3006
- * The **Download** > **CSV** menu action for tables on a Liveboard
3007
- * or Answer page.
3008
- * Downloads a visualization or Answer in the XLSX format.
3009
- * @example
3010
- * ```js
3011
- * disabledActions: [Action.DownloadAsCsv]
3012
- * ```
3013
- */
3102
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3103
+ * or Answer page.
3104
+ * Downloads a visualization or Answer in the XLSX format.
3105
+ *
3106
+ * @example
3107
+ * ```js
3108
+ * disabledActions: [Action.DownloadAsCsv]
3109
+ * ```
3110
+ */
3014
3111
  DownloadAsCsv = "downloadAsCSV",
3015
3112
  /**
3016
- * The **Download** > **XLSX** menu action for tables on a Liveboard
3017
- * or Answer page.
3018
- * Downloads a visualization or Answer in the XLSX format.
3019
- * @example
3020
- * ```js
3021
- * disabledActions: [Action.DownloadAsXlsx]
3022
- * ```
3023
- */
3113
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3114
+ * or Answer page.
3115
+ * Downloads a visualization or Answer in the XLSX format.
3116
+ *
3117
+ * @example
3118
+ * ```js
3119
+ * disabledActions: [Action.DownloadAsXlsx]
3120
+ * ```
3121
+ */
3024
3122
  DownloadAsXlsx = "downloadAsXLSX",
3025
3123
  /**
3026
3124
  * @hidden
3027
3125
  */
3028
3126
  DownloadTrace = "downloadTrace",
3029
3127
  /**
3030
- * The **Export TML** menu action on Liveboard, Answers
3031
- * Worksheets and Data Connections page.
3032
- * Exports an object as a TML file.
3033
- * @example
3034
- * ```js
3035
- * disabledActions: [Action.ExportTML]
3036
- * ```
3037
- */
3128
+ * The **Export TML** menu action on Liveboard, Answers
3129
+ * Worksheets and Data Connections page.
3130
+ * Exports an object as a TML file.
3131
+ *
3132
+ * @example
3133
+ * ```js
3134
+ * disabledActions: [Action.ExportTML]
3135
+ * ```
3136
+ */
3038
3137
  ExportTML = "exportTSL",
3039
3138
  /**
3040
- * The **Import TML** menu action for Liveboards and Answers.
3041
- * Imports TML representation of ThoughtSpot objects.
3042
- * @example
3043
- * ```js
3044
- * disabledActions: [Action.ImportTML]
3045
- * ```
3046
- */
3139
+ * The **Import TML** menu action for Liveboards and Answers.
3140
+ * Imports TML representation of ThoughtSpot objects.
3141
+ *
3142
+ * @example
3143
+ * ```js
3144
+ * disabledActions: [Action.ImportTML]
3145
+ * ```
3146
+ */
3047
3147
  ImportTML = "importTSL",
3048
3148
  /**
3049
3149
  * The **Update TML** menu action for Liveboards and Answers.
3050
3150
  * Update TML representation of ThoughtSpot objects.
3151
+ *
3051
3152
  * @example
3052
3153
  * ```js
3053
3154
  * disabledActions: [Action.UpdateTML]
@@ -3057,6 +3158,7 @@ export enum Action {
3057
3158
  /**
3058
3159
  * The **Edit TML** menu action for Liveboards and Answers.
3059
3160
  * Opens the TML editor.
3161
+ *
3060
3162
  * @example
3061
3163
  * ```js
3062
3164
  * disabledActions: [Action.EditTML]
@@ -3064,50 +3166,55 @@ export enum Action {
3064
3166
  */
3065
3167
  EditTML = "editTSL",
3066
3168
  /**
3067
- * The **Present** menu action for Liveboards and Answers.
3068
- * Allows presenting a Liveboard or visualization in
3069
- * slideshow mode.
3070
- * @example
3071
- * ```js
3072
- * disabledActions: [Action.Present]
3073
- * ```
3074
- */
3169
+ * The **Present** menu action for Liveboards and Answers.
3170
+ * Allows presenting a Liveboard or visualization in
3171
+ * slideshow mode.
3172
+ *
3173
+ * @example
3174
+ * ```js
3175
+ * disabledActions: [Action.Present]
3176
+ * ```
3177
+ */
3075
3178
  Present = "present",
3076
3179
  /**
3077
- * The tile resize options in the visualization menu.
3078
- * Allows switching between different preset layouts.
3079
- * @example
3080
- * ```js
3081
- * disabledActions: [Action.ToggleSize]
3082
- * ```
3083
- */
3180
+ * The tile resize options in the visualization menu.
3181
+ * Allows switching between different preset layouts.
3182
+ *
3183
+ * @example
3184
+ * ```js
3185
+ * disabledActions: [Action.ToggleSize]
3186
+ * ```
3187
+ */
3084
3188
  ToggleSize = "toggleSize",
3085
3189
  /**
3086
- * The *Edit* action on the Liveboard page and in the
3087
- * visualization menu.
3088
- * Opens a Liveboard or visualization in edit mode.
3089
- * @example
3090
- * ```js
3091
- * disabledActions: [Action.Edit]
3092
- * ```
3093
- */
3190
+ * The *Edit* action on the Liveboard page and in the
3191
+ * visualization menu.
3192
+ * Opens a Liveboard or visualization in edit mode.
3193
+ *
3194
+ * @example
3195
+ * ```js
3196
+ * disabledActions: [Action.Edit]
3197
+ * ```
3198
+ */
3094
3199
  Edit = "edit",
3095
3200
  /**
3096
- * The text edit option for Liveboard and visualization titles.
3097
- * @example
3098
- * ```js
3099
- * disabledActions: [Action.EditTitle]
3100
- * ```
3101
- */
3201
+ * The text edit option for Liveboard and visualization titles.
3202
+ *
3203
+ * @example
3204
+ * ```js
3205
+ * disabledActions: [Action.EditTitle]
3206
+ * ```
3207
+ */
3102
3208
  EditTitle = "editTitle",
3103
3209
  /**
3104
- * The **Delete** menu action on Liveboards and visualizations.
3105
- * Deletes a Liveboard or a visualization from a Liveboard.
3106
- * @example
3107
- * ```js
3108
- * disabledActions: [Action.Remove]
3109
- * ```
3110
- */
3210
+ * The **Delete** menu action on Liveboards and visualizations.
3211
+ * Deletes a Liveboard or a visualization from a Liveboard.
3212
+ *
3213
+ * @example
3214
+ * ```js
3215
+ * disabledActions: [Action.Remove]
3216
+ * ```
3217
+ */
3111
3218
  Remove = "delete",
3112
3219
  /**
3113
3220
  * @hidden
@@ -3130,15 +3237,16 @@ export enum Action {
3130
3237
  */
3131
3238
  PinboardInfo = "pinboardInfo",
3132
3239
  /**
3133
- * The **Show Liveboard details** menu action on a Liveboard.
3134
- * Displays details such as the name, description, and
3135
- * author of the Liveboard, and timestamp of Liveboard creation
3136
- * and update.
3137
- * @example
3138
- * ```js
3139
- * disabledActions: [Action.LiveboardInfo]
3140
- * ```
3141
- */
3240
+ * The **Show Liveboard details** menu action on a Liveboard.
3241
+ * Displays details such as the name, description, and
3242
+ * author of the Liveboard, and timestamp of Liveboard creation
3243
+ * and update.
3244
+ *
3245
+ * @example
3246
+ * ```js
3247
+ * disabledActions: [Action.LiveboardInfo]
3248
+ * ```
3249
+ */
3142
3250
  LiveboardInfo = "pinboardInfo",
3143
3251
  /**
3144
3252
  * @hidden
@@ -3149,13 +3257,14 @@ export enum Action {
3149
3257
  */
3150
3258
  DownloadEmbraceQueries = "downloadEmbraceQueries",
3151
3259
  /**
3152
- * The **Pin** menu action on an Answer or
3153
- * Search results page.
3154
- * @example
3155
- * ```js
3156
- * disabledActions: [Action.Pin]
3157
- * ```
3158
- */
3260
+ * The **Pin** menu action on an Answer or
3261
+ * Search results page.
3262
+ *
3263
+ * @example
3264
+ * ```js
3265
+ * disabledActions: [Action.Pin]
3266
+ * ```
3267
+ */
3159
3268
  Pin = "pin",
3160
3269
  /**
3161
3270
  * @hidden
@@ -3163,6 +3272,7 @@ export enum Action {
3163
3272
  AnalysisInfo = "analysisInfo",
3164
3273
  /**
3165
3274
  * The **Schedule** menu action on a Liveboard.
3275
+ *
3166
3276
  * @example
3167
3277
  * ```js
3168
3278
  * disabledActions: [Action.Subscription]
@@ -3170,25 +3280,28 @@ export enum Action {
3170
3280
  */
3171
3281
  Subscription = "subscription",
3172
3282
  /**
3173
- * The **Explore** action on Liveboard visualizations
3174
- * @example
3175
- * ```js
3176
- * disabledActions: [Action.Explore]
3177
- * ```
3178
- */
3283
+ * The **Explore** action on Liveboard visualizations
3284
+ *
3285
+ * @example
3286
+ * ```js
3287
+ * disabledActions: [Action.Explore]
3288
+ * ```
3289
+ */
3179
3290
  Explore = "explore",
3180
3291
  /**
3181
- * The action to include data points on a drilled-down Answer
3182
- * or visualization
3183
- * @example
3184
- * ```js
3185
- * disabledActions: [Action.DrillInclude]
3186
- * ```
3187
- */
3292
+ * The action to include data points on a drilled-down Answer
3293
+ * or visualization
3294
+ *
3295
+ * @example
3296
+ * ```js
3297
+ * disabledActions: [Action.DrillInclude]
3298
+ * ```
3299
+ */
3188
3300
  DrillInclude = "context-menu-item-include",
3189
3301
  /**
3190
3302
  * The action to exclude data points on a drilled-down Answer
3191
3303
  * or visualization
3304
+ *
3192
3305
  * @example
3193
3306
  * ```js
3194
3307
  * disabledActions: [Action.DrillInclude]
@@ -3199,6 +3312,7 @@ export enum Action {
3199
3312
  * The **Copy to clipboard** menu action on tables in an Answer
3200
3313
  * or Liveboard.
3201
3314
  * Copies the selected data point.
3315
+ *
3202
3316
  * @example
3203
3317
  * ```js
3204
3318
  * disabledActions: [Action.CopyToClipboard]
@@ -3216,6 +3330,7 @@ export enum Action {
3216
3330
  * The **Drill down** menu action on Answers and Liveboard
3217
3331
  * visualizations.
3218
3332
  * Allows drilling down to a specific data point on a chart or table.
3333
+ *
3219
3334
  * @example
3220
3335
  * ```js
3221
3336
  * disabledActions: [Action.DrillDown]
@@ -3225,6 +3340,7 @@ export enum Action {
3225
3340
  /**
3226
3341
  * The request access action on Liveboards.
3227
3342
  * Allows users with view permissions to request edit access to a Liveboard.
3343
+ *
3228
3344
  * @example
3229
3345
  * ```js
3230
3346
  * disabledActions: [Action.RequestAccess]
@@ -3234,6 +3350,7 @@ export enum Action {
3234
3350
  /**
3235
3351
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
3236
3352
  * of the Answer page
3353
+ *
3237
3354
  * @example
3238
3355
  * ```js
3239
3356
  * disabledActions: [Action.QueryDetailsButtons]
@@ -3242,6 +3359,7 @@ export enum Action {
3242
3359
  QueryDetailsButtons = "QueryDetailsButtons",
3243
3360
  /**
3244
3361
  * The **Delete** action for Answers.
3362
+ *
3245
3363
  * @example
3246
3364
  * ```js
3247
3365
  * disabledActions: [Action.AnswerDelete]
@@ -3251,6 +3369,7 @@ export enum Action {
3251
3369
  AnswerDelete = "onDeleteAnswer",
3252
3370
  /**
3253
3371
  * The Chart switcher icon on Answer and visualization pages.
3372
+ *
3254
3373
  * @example
3255
3374
  * ```js
3256
3375
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -3260,6 +3379,7 @@ export enum Action {
3260
3379
  AnswerChartSwitcher = "answerChartSwitcher",
3261
3380
  /**
3262
3381
  * Favorites icon (*) on Answers, Liveboard, and Data pages
3382
+ *
3263
3383
  * @example
3264
3384
  * ```js
3265
3385
  * disabledActions: [Action.AddToFavorites]
@@ -3269,6 +3389,7 @@ export enum Action {
3269
3389
  AddToFavorites = "addToFavorites",
3270
3390
  /**
3271
3391
  * The edit icon on Liveboards (Classic experience).
3392
+ *
3272
3393
  * @example
3273
3394
  * ```js
3274
3395
  * disabledActions: [Action.EditDetails]
@@ -3278,6 +3399,7 @@ export enum Action {
3278
3399
  EditDetails = "editDetails",
3279
3400
  /**
3280
3401
  * The Create alert action on KPI charts.
3402
+ *
3281
3403
  * @example
3282
3404
  * ```js
3283
3405
  * disabledActions: [Action.CreateMonitor ]
@@ -3296,6 +3418,7 @@ export enum Action {
3296
3418
  /**
3297
3419
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
3298
3420
  * Allows sending data to a Google Sheet.
3421
+ *
3299
3422
  * @example
3300
3423
  * ```js
3301
3424
  * disabledActions: [Action.SyncToSheets]
@@ -3307,6 +3430,7 @@ export enum Action {
3307
3430
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
3308
3431
  * Allows sending data to third-party apps like Slack, Salesforce,
3309
3432
  * Microsoft Teams, and so on.
3433
+ *
3310
3434
  * @example
3311
3435
  * ```js
3312
3436
  * disabledActions: [Action.SyncToOtherApps]
@@ -3317,6 +3441,7 @@ export enum Action {
3317
3441
  /**
3318
3442
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
3319
3443
  * Allows users to manage data sync pipelines to third-party apps.
3444
+ *
3320
3445
  * @example
3321
3446
  * ```js
3322
3447
  * disabledActions: [Action.SyncToOtherApps]
@@ -3327,6 +3452,7 @@ export enum Action {
3327
3452
  /**
3328
3453
  * The **Filter** action on Liveboard visualizations.
3329
3454
  * Allows users to apply cross-filters on a Liveboard.
3455
+ *
3330
3456
  * @example
3331
3457
  * ```js
3332
3458
  * disabledActions: [Action.CrossFilter]
@@ -3338,6 +3464,7 @@ export enum Action {
3338
3464
  * The **Remove** action that appears when cross filters are applied
3339
3465
  * on a Liveboard.
3340
3466
  * Removes filters applied o a visualization.
3467
+ *
3341
3468
  * @example
3342
3469
  * ```js
3343
3470
  * disabledActions: [Action.RemoveCrossFilter]
@@ -3349,6 +3476,7 @@ export enum Action {
3349
3476
  * The **Aggregate** option in the chart axis or the
3350
3477
  * table column customization menu.
3351
3478
  * Provides aggregation options to analyze the data on a chart or table.
3479
+ *
3352
3480
  * @example
3353
3481
  * ```js
3354
3482
  * disabledActions: [Action.AxisMenuAggregate]
@@ -3360,6 +3488,7 @@ export enum Action {
3360
3488
  * The **Time bucket** option in the chart axis or table column
3361
3489
  * customization menu.
3362
3490
  * Allows defining time metric for date comparison.
3491
+ *
3363
3492
  * @example
3364
3493
  * ```js
3365
3494
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -3370,6 +3499,7 @@ export enum Action {
3370
3499
  /**
3371
3500
  * The **Filter** action in the chart axis or table column
3372
3501
  * customization menu.
3502
+ *
3373
3503
  * @example
3374
3504
  * ```js
3375
3505
  * disabledActions: [Action.AxisMenuFilter]
@@ -3381,6 +3511,7 @@ export enum Action {
3381
3511
  * The **Conditional formatting** action on chart or table.
3382
3512
  * Allows adding rules for conditional formatting of data
3383
3513
  * points on a chart or table.
3514
+ *
3384
3515
  * @example
3385
3516
  * ```js
3386
3517
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3392,6 +3523,7 @@ export enum Action {
3392
3523
  * The **Sort** menu action on a table or chart axis
3393
3524
  * Sorts data in ascending or descending order.
3394
3525
  * Allows adding, editing, or removing filters.
3526
+ *
3395
3527
  * @example
3396
3528
  * ```js
3397
3529
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3404,6 +3536,7 @@ export enum Action {
3404
3536
  * customization menu.
3405
3537
  * Allows grouping data points if the axes use the same
3406
3538
  * unit of measurement and a similar scale.
3539
+ *
3407
3540
  * @example
3408
3541
  * ```js
3409
3542
  * disabledActions: [Action.AxisMenuGroup]
@@ -3415,6 +3548,7 @@ export enum Action {
3415
3548
  * The **Position** option in the axis customization menu.
3416
3549
  * Allows changing the position of the axis to the
3417
3550
  * left or right side of the chart.
3551
+ *
3418
3552
  * @example
3419
3553
  * ```js
3420
3554
  * disabledActions: [Action.AxisMenuPosition]
@@ -3425,6 +3559,7 @@ export enum Action {
3425
3559
  /**
3426
3560
  * The **Rename** option in the chart axis or table column customization menu.
3427
3561
  * Renames the axis label on a chart or the column header on a table.
3562
+ *
3428
3563
  * @example
3429
3564
  * ```js
3430
3565
  * disabledActions: [Action.AxisMenuRename]
@@ -3436,6 +3571,7 @@ export enum Action {
3436
3571
  * The **Edit** action in the axis customization menu.
3437
3572
  * Allows editing the axis name, position, minimum and maximum values,
3438
3573
  * and format of a column.
3574
+ *
3439
3575
  * @example
3440
3576
  * ```js
3441
3577
  * disabledActions: [Action.AxisMenuEdit]
@@ -3446,6 +3582,7 @@ export enum Action {
3446
3582
  /**
3447
3583
  * The **Number format** action to customize the format of
3448
3584
  * the data labels on a chart or table.
3585
+ *
3449
3586
  * @example
3450
3587
  * ```js
3451
3588
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -3456,6 +3593,7 @@ export enum Action {
3456
3593
  /**
3457
3594
  * The **Text wrapping** action on a table.
3458
3595
  * Wraps or clips column text on a table.
3596
+ *
3459
3597
  * @example
3460
3598
  * ```js
3461
3599
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -3468,6 +3606,7 @@ export enum Action {
3468
3606
  * customization menu.
3469
3607
  * Removes the data labels from a chart or the column of a
3470
3608
  * table visualization.
3609
+ *
3471
3610
  * @example
3472
3611
  * ```js
3473
3612
  * disabledActions: [Action.AxisMenuRemove]
@@ -3482,6 +3621,7 @@ export enum Action {
3482
3621
  /**
3483
3622
  * The **Rename** menu action on Liveboards and visualizations.
3484
3623
  * Allows renaming a Liveboard or visualization.
3624
+ *
3485
3625
  * @example
3486
3626
  * ```js
3487
3627
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -3498,13 +3638,29 @@ export enum Action {
3498
3638
  */
3499
3639
  MarkAsVerified = "markAsVerified",
3500
3640
  /**
3501
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3641
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3502
3642
  */
3503
3643
  AddTab = "addTab",
3504
3644
  /**
3505
3645
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3506
3646
  */
3507
- EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
3647
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
3648
+ /**
3649
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3650
+ */
3651
+ ShowSageQuery = "showSageQuery",
3652
+ /**
3653
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3654
+ */
3655
+ EditSageAnswer = "editSageAnswer",
3656
+ /**
3657
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3658
+ */
3659
+ SageAnswerFeedback = "sageAnswerFeedback",
3660
+ /**
3661
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3662
+ */
3663
+ ModifySageAnswer = "modifySageAnswer"
3508
3664
  }
3509
3665
  export interface SessionInterface {
3510
3666
  sessionId: string;
@@ -3846,15 +4002,34 @@ export interface CustomCssVariables {
3846
4002
  * @summary TS Sage embed
3847
4003
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
3848
4004
  */
4005
+ /**
4006
+ * Configuration for search options
4007
+ */
4008
+ export interface SearchOptions {
4009
+ /**
4010
+ * The tml string to load the answer
4011
+ */
4012
+ searchQuery: string;
4013
+ /**
4014
+ * Boolean to determine if the search should be executed or not.
4015
+ * if it is executed, put the focus on the results.
4016
+ * if it’s not executed, put the focus in the search bar - at the end of
4017
+ * the tokens
4018
+ */
4019
+ executeSearch?: boolean;
4020
+ }
3849
4021
  /**
3850
4022
  * The configuration attributes for the embedded Natural language search view. Based on
3851
4023
  * GPT and LLM.
3852
4024
  *
4025
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
3853
4026
  * @group Embed components
3854
4027
  */
3855
4028
  export interface SageViewConfig extends ViewConfig {
3856
4029
  /**
3857
- * If set to true, object results are shown.
4030
+ * If set to true, a list of liveboard and answers related
4031
+ * to the natural language search will be shown below the
4032
+ * AI generated answer.
3858
4033
  */
3859
4034
  showObjectResults?: boolean;
3860
4035
  /**
@@ -3866,10 +4041,28 @@ export interface SageViewConfig extends ViewConfig {
3866
4041
  */
3867
4042
  hideWorksheetSelector?: boolean;
3868
4043
  /**
3869
- * If set to true, the object search suggestions are not shown
4044
+ * If set to true, the search suggestions will contain existing
4045
+ * liveboards and answers in addition with the autocomplete
3870
4046
  *
3871
4047
  */
3872
4048
  showObjectSuggestions?: boolean;
4049
+ /**
4050
+ * The query string to pre-fill in natual language search bar
4051
+ */
4052
+ searchQuery?: string;
4053
+ /**
4054
+ * If set to true, sample questions would be hidden to user.
4055
+ * These sample questions are autogenerated based on selected datasource.
4056
+ */
4057
+ hideSampleQuestions?: boolean;
4058
+ /**
4059
+ * The data source GUID to set on load.
4060
+ */
4061
+ dataSource?: string;
4062
+ /**
4063
+ * Configuration for search options
4064
+ */
4065
+ searchOptions?: SearchOptions;
3873
4066
  }
3874
4067
  export const HiddenActionItemByDefaultForSageEmbed: Action[];
3875
4068
  /**