@thoughtspot/visual-embed-sdk 1.23.0 → 1.24.0-alpha.0

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 (55) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -8
  3. package/cjs/src/embed/sage.d.ts +14 -0
  4. package/cjs/src/embed/sage.d.ts.map +1 -1
  5. package/cjs/src/embed/sage.js +12 -3
  6. package/cjs/src/embed/sage.js.map +1 -1
  7. package/cjs/src/embed/sage.spec.js +1 -1
  8. package/cjs/src/embed/sage.spec.js.map +1 -1
  9. package/cjs/src/embed/search.d.ts +0 -4
  10. package/cjs/src/embed/search.d.ts.map +1 -1
  11. package/cjs/src/embed/search.js +1 -1
  12. package/cjs/src/embed/search.js.map +1 -1
  13. package/cjs/src/react/index.spec.js +0 -12
  14. package/cjs/src/react/index.spec.js.map +1 -1
  15. package/cjs/src/types.d.ts +340 -239
  16. package/cjs/src/types.d.ts.map +1 -1
  17. package/cjs/src/types.js +337 -236
  18. package/cjs/src/types.js.map +1 -1
  19. package/dist/src/embed/sage.d.ts +14 -0
  20. package/dist/src/embed/sage.d.ts.map +1 -1
  21. package/dist/src/embed/search.d.ts +0 -4
  22. package/dist/src/embed/search.d.ts.map +1 -1
  23. package/dist/src/types.d.ts +340 -239
  24. package/dist/src/types.d.ts.map +1 -1
  25. package/dist/tsembed-react.es.js +351 -241
  26. package/dist/tsembed-react.js +350 -240
  27. package/dist/tsembed.es.js +351 -241
  28. package/dist/tsembed.js +350 -240
  29. package/dist/visual-embed-sdk-react-full.d.ts +354 -243
  30. package/dist/visual-embed-sdk-react.d.ts +354 -243
  31. package/dist/visual-embed-sdk.d.ts +354 -243
  32. package/lib/package.json +1 -8
  33. package/lib/src/embed/sage.d.ts +14 -0
  34. package/lib/src/embed/sage.d.ts.map +1 -1
  35. package/lib/src/embed/sage.js +12 -3
  36. package/lib/src/embed/sage.js.map +1 -1
  37. package/lib/src/embed/sage.spec.js +1 -1
  38. package/lib/src/embed/sage.spec.js.map +1 -1
  39. package/lib/src/embed/search.d.ts +0 -4
  40. package/lib/src/embed/search.d.ts.map +1 -1
  41. package/lib/src/embed/search.js +1 -1
  42. package/lib/src/embed/search.js.map +1 -1
  43. package/lib/src/react/index.spec.js +0 -12
  44. package/lib/src/react/index.spec.js.map +1 -1
  45. package/lib/src/types.d.ts +340 -239
  46. package/lib/src/types.d.ts.map +1 -1
  47. package/lib/src/types.js +337 -236
  48. package/lib/src/types.js.map +1 -1
  49. package/lib/src/visual-embed-sdk.d.ts +354 -243
  50. package/package.json +1 -8
  51. package/src/embed/sage.spec.ts +1 -1
  52. package/src/embed/sage.ts +24 -2
  53. package/src/embed/search.ts +0 -5
  54. package/src/react/index.spec.tsx +0 -29
  55. package/src/types.ts +338 -238
package/src/types.ts CHANGED
@@ -448,7 +448,6 @@ export interface EmbedConfig {
448
448
  * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
449
449
  */
450
450
  suppressSearchEmbedBetaWarning?: boolean;
451
-
452
451
  /**
453
452
  * Hide beta alert warning message for SageEmbed.
454
453
  *
@@ -1315,6 +1314,18 @@ export enum EmbedEvent {
1315
1314
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1316
1315
  */
1317
1316
  FilterChanged = 'filterChanged',
1317
+ /**
1318
+ * Emitted when a user click on Go button in Sage Embed
1319
+ *
1320
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
1321
+ */
1322
+ SageEmbedQuery = 'sageEmbedQuery',
1323
+ /**
1324
+ * Emitten when a user select data source in Sage Embed
1325
+ *
1326
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
1327
+ */
1328
+ SageWorksheetUpdated = 'sageWorksheetUpdated',
1318
1329
  }
1319
1330
 
1320
1331
  /**
@@ -1345,6 +1356,7 @@ export enum HostEvent {
1345
1356
  * Triggers a search query in AppEmbed and SearchEmbed
1346
1357
  * deployments.
1347
1358
  * Includes the following properties:
1359
+ *
1348
1360
  * @param - dataSourceIds - The data source GUID to Search on
1349
1361
  * - Although an array, only a single source
1350
1362
  * is supported.
@@ -1363,6 +1375,7 @@ export enum HostEvent {
1363
1375
  /**
1364
1376
  * Triggers a drill on certain points of the specified column
1365
1377
  * Includes the following properties:
1378
+ *
1366
1379
  * @param - points - an object containing selectedPoints/clickedPoints
1367
1380
  * to drill to. For example, { selectedPoints: []}
1368
1381
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -1427,18 +1440,19 @@ export enum HostEvent {
1427
1440
  */
1428
1441
  SetActiveTab = 'SetActiveTab',
1429
1442
  /**
1430
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
1431
- * runtime filters passed here are appended to the existing runtime
1432
- * filters.
1433
- * Pass an array of runtime filters with the following attributes:
1434
- * `columnName`
1435
- * _String_. The name of the column to filter on.
1436
- * `operator`
1437
- * Runtime filter operator to apply. For information,
1438
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1439
- * `values`
1440
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
1441
- * such as BW and IN accept multiple operands.
1443
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
1444
+ * runtime filters passed here are appended to the existing runtime
1445
+ * filters.
1446
+ * Pass an array of runtime filters with the following attributes:
1447
+ * `columnName`
1448
+ * _String_. The name of the column to filter on.
1449
+ * `operator`
1450
+ * Runtime filter operator to apply. For information,
1451
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1452
+ * `values`
1453
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
1454
+ * operators such as BW and IN accept multiple operands.
1455
+ *
1442
1456
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1443
1457
  * @example
1444
1458
  * ```js
@@ -1454,6 +1468,7 @@ export enum HostEvent {
1454
1468
  /**
1455
1469
  * Navigate to a specific page in the embedded application without reloading the page.
1456
1470
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1471
+ *
1457
1472
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
1458
1473
  * @example
1459
1474
  * ```js
@@ -1777,6 +1792,7 @@ export enum HostEvent {
1777
1792
  /**
1778
1793
  * Triggers the **SpotIQ analyze** action on visualization
1779
1794
  * or search.
1795
+ *
1780
1796
  * @param - Liveboard embed takes `vizId` as a
1781
1797
  * key. Can be left undefined when embedding Search or
1782
1798
  * visualization.
@@ -1816,6 +1832,7 @@ export enum HostEvent {
1816
1832
  /**
1817
1833
  * Triggers the **Download** > **PNG** action on
1818
1834
  * charts in the embedded view.
1835
+ *
1819
1836
  * @example
1820
1837
  * ```js
1821
1838
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1849,6 +1866,7 @@ export enum HostEvent {
1849
1866
  /**
1850
1867
  * Triggers the **Download** > **XLSX** action on tables
1851
1868
  * in the embedded view.
1869
+ *
1852
1870
  * @example
1853
1871
  * ```js
1854
1872
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -1880,6 +1898,7 @@ export enum HostEvent {
1880
1898
  /**
1881
1899
  * Triggers the **Save** action on a Liveboard or Answer.
1882
1900
  * Saves the changes.
1901
+ *
1883
1902
  * @example
1884
1903
  * ```js
1885
1904
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -1893,6 +1912,7 @@ export enum HostEvent {
1893
1912
  /**
1894
1913
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1895
1914
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
1915
+ *
1896
1916
  * @param - an object with `vizId` as a key
1897
1917
  * @example
1898
1918
  * ```js
@@ -1909,6 +1929,7 @@ export enum HostEvent {
1909
1929
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1910
1930
  * Sends data from an Answer or Liveboard visualization to third-party apps such
1911
1931
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1932
+ *
1912
1933
  * @param - an object with vizId as a key
1913
1934
  * @example
1914
1935
  * ```js
@@ -1925,6 +1946,7 @@ export enum HostEvent {
1925
1946
  * Triggers the **Manage pipelines** action on an embedded
1926
1947
  * visualization or Answer.
1927
1948
  * Allows users to manage ThoughtSpot Sync pipelines.
1949
+ *
1928
1950
  * @param - an object with `vizId` as a key
1929
1951
  * @example
1930
1952
  * ```js
@@ -2095,7 +2117,10 @@ export enum Param {
2095
2117
  ShowLiveboardTitle = 'showLiveboardTitle',
2096
2118
  HiddenTabs = 'hideTabs',
2097
2119
  VisibleTabs = 'visibleTabs',
2098
- HideTabPanel = 'hideTabPanel'
2120
+ HideTabPanel = 'hideTabPanel',
2121
+ HideSampleQuestions = 'hideSampleQuestions',
2122
+ WorksheetId = 'worksheetId',
2123
+ Query = 'query,'
2099
2124
  }
2100
2125
 
2101
2126
  /**
@@ -2105,6 +2130,7 @@ export enum Param {
2105
2130
  * specific actions in the embedded view, define the Action
2106
2131
  * enumeration members in the `disabledActions`, `visibleActions`,
2107
2132
  * or `hiddenActions` array.
2133
+ *
2108
2134
  * @example
2109
2135
  * ```js
2110
2136
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2123,13 +2149,13 @@ export enum Param {
2123
2149
  * hiddenActions: [Action.Edit, ActionAction.Explore],
2124
2150
  * })
2125
2151
  * ```
2126
-
2127
2152
  */
2128
2153
  // eslint-disable-next-line no-shadow
2129
2154
  export enum Action {
2130
2155
  /**
2131
2156
  * The **Save** action on an Answer or Liveboard.
2132
2157
  * Allows users to save the changes.
2158
+ *
2133
2159
  * @example
2134
2160
  * ```js
2135
2161
  * disabledActions: [Action.SaveAsView]
@@ -2145,136 +2171,146 @@ export enum Action {
2145
2171
  */
2146
2172
  SaveUntitled = 'saveUntitled',
2147
2173
  /**
2148
- * The **Save as View** action on the Answer
2149
- * page. Saves an Answer as a View object.
2150
- *
2151
- * @example
2152
- * ```js
2153
- * disabledActions: [Action.SaveAsView]
2154
- * ```
2155
- */
2174
+ * The **Save as View** action on the Answer
2175
+ * page. Saves an Answer as a View object.
2176
+ *
2177
+ * @example
2178
+ * ```js
2179
+ * disabledActions: [Action.SaveAsView]
2180
+ * ```
2181
+ */
2156
2182
  SaveAsView = 'saveAsView',
2157
2183
  /**
2158
- * The **Make a copy** action on a Liveboard or Answer
2159
- * page.
2160
- * Creates a copy of the Liveboard, visualization,
2161
- * or Answer.
2162
- *
2163
- * @example
2164
- * ```js
2165
- * disabledActions: [Action.MakeACopy]
2166
- * ```
2167
- */
2184
+ * The **Make a copy** action on a Liveboard or Answer
2185
+ * page.
2186
+ * Creates a copy of the Liveboard, visualization,
2187
+ * or Answer.
2188
+ *
2189
+ * @example
2190
+ * ```js
2191
+ * disabledActions: [Action.MakeACopy]
2192
+ * ```
2193
+ */
2168
2194
  MakeACopy = 'makeACopy',
2169
2195
  /**
2170
- * The **Copy and Edit** action on a Liveboard.
2171
- * This action is now replaced with `Action.MakeACopy`.
2172
- *
2173
- * @example
2174
- * ```js
2175
- * disabledActions: [Action.EditACopy]
2176
- * ```
2177
- */
2196
+ * The **Copy and Edit** action on a Liveboard.
2197
+ * This action is now replaced with `Action.MakeACopy`.
2198
+ *
2199
+ * @example
2200
+ * ```js
2201
+ * disabledActions: [Action.EditACopy]
2202
+ * ```
2203
+ */
2178
2204
  EditACopy = 'editACopy',
2179
2205
  /**
2180
- * The **Copy link** menu action on a Liveboard visualization.
2181
- * Copies the visualization URL
2182
- * @example
2183
- * ```js
2184
- * disabledActions: [Action.CopyLink]
2185
- * ```
2186
- */
2206
+ * The **Copy link** menu action on a Liveboard visualization.
2207
+ * Copies the visualization URL
2208
+ *
2209
+ * @example
2210
+ * ```js
2211
+ * disabledActions: [Action.CopyLink]
2212
+ * ```
2213
+ */
2187
2214
  CopyLink = 'embedDocument',
2188
2215
  /**
2189
2216
  * @hidden
2190
2217
  */
2191
2218
  ResetLayout = 'resetLayout',
2192
2219
  /**
2193
- * The **Schedule** menu action on a Liveboard.
2194
- * Allows scheduling a Liveboard notification.
2195
- * @example
2196
- * ```js
2197
- * disabledActions: [Action.Schedule]
2198
- * ```
2199
- */
2220
+ * The **Schedule** menu action on a Liveboard.
2221
+ * Allows scheduling a Liveboard notification.
2222
+ *
2223
+ * @example
2224
+ * ```js
2225
+ * disabledActions: [Action.Schedule]
2226
+ * ```
2227
+ */
2200
2228
  Schedule = 'subscription',
2201
2229
  /**
2202
- * The **Manage schedules** menu action on a Liveboard.
2203
- * Allows users to manage scheduled Liveboard jobs.
2204
- * @example
2205
- * ```js
2206
- * disabledActions: [Action.SchedulesList]
2207
- * ```
2208
- */
2230
+ * The **Manage schedules** menu action on a Liveboard.
2231
+ * Allows users to manage scheduled Liveboard jobs.
2232
+ *
2233
+ * @example
2234
+ * ```js
2235
+ * disabledActions: [Action.SchedulesList]
2236
+ * ```
2237
+ */
2209
2238
  SchedulesList = 'schedule-list',
2210
2239
  /**
2211
- * The **Share** action on a Liveboard, Answer, or Worksheet.
2212
- * Allows users to share an object with other users and groups.
2213
- * @example
2214
- * ```js
2215
- * disabledActions: [Action.Share]
2216
- * ```
2217
- */
2240
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
2241
+ * Allows users to share an object with other users and groups.
2242
+ *
2243
+ * @example
2244
+ * ```js
2245
+ * disabledActions: [Action.Share]
2246
+ * ```
2247
+ */
2218
2248
  Share = 'share',
2219
2249
  /**
2220
- * The **Add filter** action on a Liveboard and Search page.
2221
- * Allows adding filters to Answers and visualizations on a Liveboard.
2222
- * @example
2223
- * ```js
2224
- * disabledActions: [Action.AddFilter]
2225
- * ```
2226
- */
2250
+ * The **Add filter** action on a Liveboard and Search page.
2251
+ * Allows adding filters to Answers and visualizations on a Liveboard.
2252
+ *
2253
+ * @example
2254
+ * ```js
2255
+ * disabledActions: [Action.AddFilter]
2256
+ * ```
2257
+ */
2227
2258
  AddFilter = 'addFilter',
2228
2259
  /**
2229
- * Filter configuration options on a Liveboard and Search page.
2230
- * Allows configuring filter options when adding filters to a
2231
- * Liveboard or Answer.
2232
- * @example
2233
- * ```js
2234
- * disabledActions: [Action.ConfigureFilter]
2235
- * ```
2236
- */
2260
+ * Filter configuration options on a Liveboard and Search page.
2261
+ * Allows configuring filter options when adding filters to a
2262
+ * Liveboard or Answer.
2263
+ *
2264
+ * @example
2265
+ * ```js
2266
+ * disabledActions: [Action.ConfigureFilter]
2267
+ * ```
2268
+ */
2237
2269
  ConfigureFilter = 'configureFilter',
2238
2270
  CollapseDataSources = 'collapseDataSources',
2239
2271
  /**
2240
- * The **Choose sources** button on Search page.
2241
- * Allows selecting data sources for search queries.
2242
- * @example
2243
- * ```js
2244
- * disabledActions: [Action.ChooseDataSources]
2245
- * ```
2246
- */
2272
+ * The **Choose sources** button on Search page.
2273
+ * Allows selecting data sources for search queries.
2274
+ *
2275
+ * @example
2276
+ * ```js
2277
+ * disabledActions: [Action.ChooseDataSources]
2278
+ * ```
2279
+ */
2247
2280
  ChooseDataSources = 'chooseDataSources',
2248
2281
  /**
2249
- * The **Create formula** action on a Search or Answer page.
2250
- * Allows adding formulas to an Answer.
2251
- * @example
2252
- * ```js
2253
- * disabledActions: [Action.AddFormula]
2254
- * ```
2255
- */
2282
+ * The **Create formula** action on a Search or Answer page.
2283
+ * Allows adding formulas to an Answer.
2284
+ *
2285
+ * @example
2286
+ * ```js
2287
+ * disabledActions: [Action.AddFormula]
2288
+ * ```
2289
+ */
2256
2290
  AddFormula = 'addFormula',
2257
2291
  /**
2258
- * The **Add parameter** action on a Liveboard or Answer.
2259
- * Allows adding Parameters to a Liveboard or Answer.
2260
- * @example
2261
- * ```js
2262
- * disabledActions: [Action.AddParameter]
2263
- * ```
2264
- */
2292
+ * The **Add parameter** action on a Liveboard or Answer.
2293
+ * Allows adding Parameters to a Liveboard or Answer.
2294
+ *
2295
+ * @example
2296
+ * ```js
2297
+ * disabledActions: [Action.AddParameter]
2298
+ * ```
2299
+ */
2265
2300
  AddParameter = 'addParameter',
2266
2301
  /**
2267
2302
  * @hidden
2268
2303
  */
2269
2304
  SearchOnTop = 'searchOnTop',
2270
2305
  /**
2271
- * The **SpotIQ analyze** menu action on a visualization or
2272
- * Answer page.
2273
- * @example
2274
- * ```js
2275
- * disabledActions: [Action.SpotIQAnalyze]
2276
- * ```
2277
- */
2306
+ * The **SpotIQ analyze** menu action on a visualization or
2307
+ * Answer page.
2308
+ *
2309
+ * @example
2310
+ * ```js
2311
+ * disabledActions: [Action.SpotIQAnalyze]
2312
+ * ```
2313
+ */
2278
2314
  SpotIQAnalyze = 'spotIQAnalyze',
2279
2315
  /**
2280
2316
  * @hidden
@@ -2290,89 +2326,98 @@ export enum Action {
2290
2326
  */
2291
2327
  ReplaySearch = 'replaySearch',
2292
2328
  /**
2293
- * The **Show underlying data** menu action on a visualization or
2294
- * Answer page.
2295
- * @example
2296
- * ```js
2297
- * disabledActions: [Action.ShowUnderlyingData]
2298
- * ```
2299
- */
2329
+ * The **Show underlying data** menu action on a visualization or
2330
+ * Answer page.
2331
+ *
2332
+ * @example
2333
+ * ```js
2334
+ * disabledActions: [Action.ShowUnderlyingData]
2335
+ * ```
2336
+ */
2300
2337
  ShowUnderlyingData = 'showUnderlyingData',
2301
2338
  /**
2302
- * The **Download** menu action on Liveboard visualizations
2303
- * and Answers.
2304
- * Allows downloading a visualization or Answer.
2305
- * @example
2306
- * ```js
2307
- * disabledActions: [Action.DownloadAsPng]
2308
- * ```
2309
- */
2339
+ * The **Download** menu action on Liveboard visualizations
2340
+ * and Answers.
2341
+ * Allows downloading a visualization or Answer.
2342
+ *
2343
+ * @example
2344
+ * ```js
2345
+ * disabledActions: [Action.DownloadAsPng]
2346
+ * ```
2347
+ */
2310
2348
  Download = 'download',
2311
2349
  /**
2312
- * The **Download** > **PNG** menu action for charts on a Liveboard
2313
- * or Answer page.
2314
- * Downloads a visualization or Answer as a PNG file.
2315
- * @example
2316
- * ```js
2317
- * disabledActions: [Action.DownloadAsPng]
2318
- * ```
2319
- */
2350
+ * The **Download** > **PNG** menu action for charts on a Liveboard
2351
+ * or Answer page.
2352
+ * Downloads a visualization or Answer as a PNG file.
2353
+ *
2354
+ * @example
2355
+ * ```js
2356
+ * disabledActions: [Action.DownloadAsPng]
2357
+ * ```
2358
+ */
2320
2359
  DownloadAsPng = 'downloadAsPng',
2321
2360
  /**
2322
- * The **Download** > **PDF** menu action on a Liveboard.
2323
- * Downloads a visualization or Answer as a PDF file.
2324
- * @example
2325
- * ```js
2326
- * disabledActions: [Action.DownloadAsPdf]
2327
- * ```
2328
- */
2361
+ * The **Download** > **PDF** menu action on a Liveboard.
2362
+ * Downloads a visualization or Answer as a PDF file.
2363
+ *
2364
+ * @example
2365
+ * ```js
2366
+ * disabledActions: [Action.DownloadAsPdf]
2367
+ * ```
2368
+ */
2329
2369
  DownloadAsPdf = 'downloadAsPdf',
2330
2370
  /**
2331
- * The **Download** > **CSV** menu action for tables on a Liveboard
2332
- * or Answer page.
2333
- * Downloads a visualization or Answer in the XLSX format.
2334
- * @example
2335
- * ```js
2336
- * disabledActions: [Action.DownloadAsCsv]
2337
- * ```
2338
- */
2371
+ * The **Download** > **CSV** menu action for tables on a Liveboard
2372
+ * or Answer page.
2373
+ * Downloads a visualization or Answer in the XLSX format.
2374
+ *
2375
+ * @example
2376
+ * ```js
2377
+ * disabledActions: [Action.DownloadAsCsv]
2378
+ * ```
2379
+ */
2339
2380
  DownloadAsCsv = 'downloadAsCSV',
2340
2381
  /**
2341
- * The **Download** > **XLSX** menu action for tables on a Liveboard
2342
- * or Answer page.
2343
- * Downloads a visualization or Answer in the XLSX format.
2344
- * @example
2345
- * ```js
2346
- * disabledActions: [Action.DownloadAsXlsx]
2347
- * ```
2348
- */
2382
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
2383
+ * or Answer page.
2384
+ * Downloads a visualization or Answer in the XLSX format.
2385
+ *
2386
+ * @example
2387
+ * ```js
2388
+ * disabledActions: [Action.DownloadAsXlsx]
2389
+ * ```
2390
+ */
2349
2391
  DownloadAsXlsx = 'downloadAsXLSX',
2350
2392
  /**
2351
2393
  * @hidden
2352
2394
  */
2353
2395
  DownloadTrace = 'downloadTrace',
2354
2396
  /**
2355
- * The **Export TML** menu action on Liveboard, Answers
2356
- * Worksheets and Data Connections page.
2357
- * Exports an object as a TML file.
2358
- * @example
2359
- * ```js
2360
- * disabledActions: [Action.ExportTML]
2361
- * ```
2362
- */
2397
+ * The **Export TML** menu action on Liveboard, Answers
2398
+ * Worksheets and Data Connections page.
2399
+ * Exports an object as a TML file.
2400
+ *
2401
+ * @example
2402
+ * ```js
2403
+ * disabledActions: [Action.ExportTML]
2404
+ * ```
2405
+ */
2363
2406
  ExportTML = 'exportTSL',
2364
2407
  /**
2365
- * The **Import TML** menu action for Liveboards and Answers.
2366
- * Imports TML representation of ThoughtSpot objects.
2367
- * @example
2368
- * ```js
2369
- * disabledActions: [Action.ImportTML]
2370
- * ```
2371
- */
2408
+ * The **Import TML** menu action for Liveboards and Answers.
2409
+ * Imports TML representation of ThoughtSpot objects.
2410
+ *
2411
+ * @example
2412
+ * ```js
2413
+ * disabledActions: [Action.ImportTML]
2414
+ * ```
2415
+ */
2372
2416
  ImportTML = 'importTSL',
2373
2417
  /**
2374
2418
  * The **Update TML** menu action for Liveboards and Answers.
2375
2419
  * Update TML representation of ThoughtSpot objects.
2420
+ *
2376
2421
  * @example
2377
2422
  * ```js
2378
2423
  * disabledActions: [Action.UpdateTML]
@@ -2382,6 +2427,7 @@ export enum Action {
2382
2427
  /**
2383
2428
  * The **Edit TML** menu action for Liveboards and Answers.
2384
2429
  * Opens the TML editor.
2430
+ *
2385
2431
  * @example
2386
2432
  * ```js
2387
2433
  * disabledActions: [Action.EditTML]
@@ -2389,50 +2435,55 @@ export enum Action {
2389
2435
  */
2390
2436
  EditTML = 'editTSL',
2391
2437
  /**
2392
- * The **Present** menu action for Liveboards and Answers.
2393
- * Allows presenting a Liveboard or visualization in
2394
- * slideshow mode.
2395
- * @example
2396
- * ```js
2397
- * disabledActions: [Action.Present]
2398
- * ```
2399
- */
2438
+ * The **Present** menu action for Liveboards and Answers.
2439
+ * Allows presenting a Liveboard or visualization in
2440
+ * slideshow mode.
2441
+ *
2442
+ * @example
2443
+ * ```js
2444
+ * disabledActions: [Action.Present]
2445
+ * ```
2446
+ */
2400
2447
  Present = 'present',
2401
2448
  /**
2402
- * The tile resize options in the visualization menu.
2403
- * Allows switching between different preset layouts.
2404
- * @example
2405
- * ```js
2406
- * disabledActions: [Action.ToggleSize]
2407
- * ```
2408
- */
2449
+ * The tile resize options in the visualization menu.
2450
+ * Allows switching between different preset layouts.
2451
+ *
2452
+ * @example
2453
+ * ```js
2454
+ * disabledActions: [Action.ToggleSize]
2455
+ * ```
2456
+ */
2409
2457
  ToggleSize = 'toggleSize',
2410
2458
  /**
2411
- * The *Edit* action on the Liveboard page and in the
2412
- * visualization menu.
2413
- * Opens a Liveboard or visualization in edit mode.
2414
- * @example
2415
- * ```js
2416
- * disabledActions: [Action.Edit]
2417
- * ```
2418
- */
2459
+ * The *Edit* action on the Liveboard page and in the
2460
+ * visualization menu.
2461
+ * Opens a Liveboard or visualization in edit mode.
2462
+ *
2463
+ * @example
2464
+ * ```js
2465
+ * disabledActions: [Action.Edit]
2466
+ * ```
2467
+ */
2419
2468
  Edit = 'edit',
2420
2469
  /**
2421
- * The text edit option for Liveboard and visualization titles.
2422
- * @example
2423
- * ```js
2424
- * disabledActions: [Action.EditTitle]
2425
- * ```
2426
- */
2470
+ * The text edit option for Liveboard and visualization titles.
2471
+ *
2472
+ * @example
2473
+ * ```js
2474
+ * disabledActions: [Action.EditTitle]
2475
+ * ```
2476
+ */
2427
2477
  EditTitle = 'editTitle',
2428
2478
  /**
2429
- * The **Delete** menu action on Liveboards and visualizations.
2430
- * Deletes a Liveboard or a visualization from a Liveboard.
2431
- * @example
2432
- * ```js
2433
- * disabledActions: [Action.Remove]
2434
- * ```
2435
- */
2479
+ * The **Delete** menu action on Liveboards and visualizations.
2480
+ * Deletes a Liveboard or a visualization from a Liveboard.
2481
+ *
2482
+ * @example
2483
+ * ```js
2484
+ * disabledActions: [Action.Remove]
2485
+ * ```
2486
+ */
2436
2487
  Remove = 'delete',
2437
2488
  /**
2438
2489
  * @hidden
@@ -2455,15 +2506,16 @@ export enum Action {
2455
2506
  */
2456
2507
  PinboardInfo = 'pinboardInfo',
2457
2508
  /**
2458
- * The **Show Liveboard details** menu action on a Liveboard.
2459
- * Displays details such as the name, description, and
2460
- * author of the Liveboard, and timestamp of Liveboard creation
2461
- * and update.
2462
- * @example
2463
- * ```js
2464
- * disabledActions: [Action.LiveboardInfo]
2465
- * ```
2466
- */
2509
+ * The **Show Liveboard details** menu action on a Liveboard.
2510
+ * Displays details such as the name, description, and
2511
+ * author of the Liveboard, and timestamp of Liveboard creation
2512
+ * and update.
2513
+ *
2514
+ * @example
2515
+ * ```js
2516
+ * disabledActions: [Action.LiveboardInfo]
2517
+ * ```
2518
+ */
2467
2519
  LiveboardInfo = 'pinboardInfo',
2468
2520
  /**
2469
2521
  * @hidden
@@ -2474,13 +2526,14 @@ export enum Action {
2474
2526
  */
2475
2527
  DownloadEmbraceQueries = 'downloadEmbraceQueries',
2476
2528
  /**
2477
- * The **Pin** menu action on an Answer or
2478
- * Search results page.
2479
- * @example
2480
- * ```js
2481
- * disabledActions: [Action.Pin]
2482
- * ```
2483
- */
2529
+ * The **Pin** menu action on an Answer or
2530
+ * Search results page.
2531
+ *
2532
+ * @example
2533
+ * ```js
2534
+ * disabledActions: [Action.Pin]
2535
+ * ```
2536
+ */
2484
2537
  Pin = 'pin',
2485
2538
  /**
2486
2539
  * @hidden
@@ -2488,6 +2541,7 @@ export enum Action {
2488
2541
  AnalysisInfo = 'analysisInfo',
2489
2542
  /**
2490
2543
  * The **Schedule** menu action on a Liveboard.
2544
+ *
2491
2545
  * @example
2492
2546
  * ```js
2493
2547
  * disabledActions: [Action.Subscription]
@@ -2495,26 +2549,29 @@ export enum Action {
2495
2549
  */
2496
2550
  Subscription = 'subscription',
2497
2551
  /**
2498
- * The **Explore** action on Liveboard visualizations
2499
- * @example
2500
- * ```js
2501
- * disabledActions: [Action.Explore]
2502
- * ```
2503
- */
2552
+ * The **Explore** action on Liveboard visualizations
2553
+ *
2554
+ * @example
2555
+ * ```js
2556
+ * disabledActions: [Action.Explore]
2557
+ * ```
2558
+ */
2504
2559
  Explore = 'explore',
2505
2560
  /**
2506
- * The action to include data points on a drilled-down Answer
2507
- * or visualization
2508
- * @example
2509
- * ```js
2510
- * disabledActions: [Action.DrillInclude]
2511
- * ```
2512
- */
2561
+ * The action to include data points on a drilled-down Answer
2562
+ * or visualization
2563
+ *
2564
+ * @example
2565
+ * ```js
2566
+ * disabledActions: [Action.DrillInclude]
2567
+ * ```
2568
+ */
2513
2569
 
2514
2570
  DrillInclude = 'context-menu-item-include',
2515
2571
  /**
2516
2572
  * The action to exclude data points on a drilled-down Answer
2517
2573
  * or visualization
2574
+ *
2518
2575
  * @example
2519
2576
  * ```js
2520
2577
  * disabledActions: [Action.DrillInclude]
@@ -2525,6 +2582,7 @@ export enum Action {
2525
2582
  * The **Copy to clipboard** menu action on tables in an Answer
2526
2583
  * or Liveboard.
2527
2584
  * Copies the selected data point.
2585
+ *
2528
2586
  * @example
2529
2587
  * ```js
2530
2588
  * disabledActions: [Action.CopyToClipboard]
@@ -2542,6 +2600,7 @@ export enum Action {
2542
2600
  * The **Drill down** menu action on Answers and Liveboard
2543
2601
  * visualizations.
2544
2602
  * Allows drilling down to a specific data point on a chart or table.
2603
+ *
2545
2604
  * @example
2546
2605
  * ```js
2547
2606
  * disabledActions: [Action.DrillDown]
@@ -2551,6 +2610,7 @@ export enum Action {
2551
2610
  /**
2552
2611
  * The request access action on Liveboards.
2553
2612
  * Allows users with view permissions to request edit access to a Liveboard.
2613
+ *
2554
2614
  * @example
2555
2615
  * ```js
2556
2616
  * disabledActions: [Action.RequestAccess]
@@ -2560,6 +2620,7 @@ export enum Action {
2560
2620
  /**
2561
2621
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
2562
2622
  * of the Answer page
2623
+ *
2563
2624
  * @example
2564
2625
  * ```js
2565
2626
  * disabledActions: [Action.QueryDetailsButtons]
@@ -2568,6 +2629,7 @@ export enum Action {
2568
2629
  QueryDetailsButtons = 'QueryDetailsButtons',
2569
2630
  /**
2570
2631
  * The **Delete** action for Answers.
2632
+ *
2571
2633
  * @example
2572
2634
  * ```js
2573
2635
  * disabledActions: [Action.AnswerDelete]
@@ -2577,6 +2639,7 @@ export enum Action {
2577
2639
  AnswerDelete = 'onDeleteAnswer',
2578
2640
  /**
2579
2641
  * The Chart switcher icon on Answer and visualization pages.
2642
+ *
2580
2643
  * @example
2581
2644
  * ```js
2582
2645
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -2586,6 +2649,7 @@ export enum Action {
2586
2649
  AnswerChartSwitcher = 'answerChartSwitcher',
2587
2650
  /**
2588
2651
  * Favorites icon (*) on Answers, Liveboard, and Data pages
2652
+ *
2589
2653
  * @example
2590
2654
  * ```js
2591
2655
  * disabledActions: [Action.AddToFavorites]
@@ -2595,6 +2659,7 @@ export enum Action {
2595
2659
  AddToFavorites = 'addToFavorites',
2596
2660
  /**
2597
2661
  * The edit icon on Liveboards (Classic experience).
2662
+ *
2598
2663
  * @example
2599
2664
  * ```js
2600
2665
  * disabledActions: [Action.EditDetails]
@@ -2604,6 +2669,7 @@ export enum Action {
2604
2669
  EditDetails = 'editDetails',
2605
2670
  /**
2606
2671
  * The Create alert action on KPI charts.
2672
+ *
2607
2673
  * @example
2608
2674
  * ```js
2609
2675
  * disabledActions: [Action.CreateMonitor ]
@@ -2622,6 +2688,7 @@ export enum Action {
2622
2688
  /**
2623
2689
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
2624
2690
  * Allows sending data to a Google Sheet.
2691
+ *
2625
2692
  * @example
2626
2693
  * ```js
2627
2694
  * disabledActions: [Action.SyncToSheets]
@@ -2633,6 +2700,7 @@ export enum Action {
2633
2700
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
2634
2701
  * Allows sending data to third-party apps like Slack, Salesforce,
2635
2702
  * Microsoft Teams, and so on.
2703
+ *
2636
2704
  * @example
2637
2705
  * ```js
2638
2706
  * disabledActions: [Action.SyncToOtherApps]
@@ -2643,6 +2711,7 @@ export enum Action {
2643
2711
  /**
2644
2712
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
2645
2713
  * Allows users to manage data sync pipelines to third-party apps.
2714
+ *
2646
2715
  * @example
2647
2716
  * ```js
2648
2717
  * disabledActions: [Action.SyncToOtherApps]
@@ -2653,6 +2722,7 @@ export enum Action {
2653
2722
  /**
2654
2723
  * The **Filter** action on Liveboard visualizations.
2655
2724
  * Allows users to apply cross-filters on a Liveboard.
2725
+ *
2656
2726
  * @example
2657
2727
  * ```js
2658
2728
  * disabledActions: [Action.CrossFilter]
@@ -2664,6 +2734,7 @@ export enum Action {
2664
2734
  * The **Remove** action that appears when cross filters are applied
2665
2735
  * on a Liveboard.
2666
2736
  * Removes filters applied o a visualization.
2737
+ *
2667
2738
  * @example
2668
2739
  * ```js
2669
2740
  * disabledActions: [Action.RemoveCrossFilter]
@@ -2675,6 +2746,7 @@ export enum Action {
2675
2746
  * The **Aggregate** option in the chart axis or the
2676
2747
  * table column customization menu.
2677
2748
  * Provides aggregation options to analyze the data on a chart or table.
2749
+ *
2678
2750
  * @example
2679
2751
  * ```js
2680
2752
  * disabledActions: [Action.AxisMenuAggregate]
@@ -2686,6 +2758,7 @@ export enum Action {
2686
2758
  * The **Time bucket** option in the chart axis or table column
2687
2759
  * customization menu.
2688
2760
  * Allows defining time metric for date comparison.
2761
+ *
2689
2762
  * @example
2690
2763
  * ```js
2691
2764
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -2696,6 +2769,7 @@ export enum Action {
2696
2769
  /**
2697
2770
  * The **Filter** action in the chart axis or table column
2698
2771
  * customization menu.
2772
+ *
2699
2773
  * @example
2700
2774
  * ```js
2701
2775
  * disabledActions: [Action.AxisMenuFilter]
@@ -2707,6 +2781,7 @@ export enum Action {
2707
2781
  * The **Conditional formatting** action on chart or table.
2708
2782
  * Allows adding rules for conditional formatting of data
2709
2783
  * points on a chart or table.
2784
+ *
2710
2785
  * @example
2711
2786
  * ```js
2712
2787
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2718,6 +2793,7 @@ export enum Action {
2718
2793
  * The **Sort** menu action on a table or chart axis
2719
2794
  * Sorts data in ascending or descending order.
2720
2795
  * Allows adding, editing, or removing filters.
2796
+ *
2721
2797
  * @example
2722
2798
  * ```js
2723
2799
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2730,6 +2806,7 @@ export enum Action {
2730
2806
  * customization menu.
2731
2807
  * Allows grouping data points if the axes use the same
2732
2808
  * unit of measurement and a similar scale.
2809
+ *
2733
2810
  * @example
2734
2811
  * ```js
2735
2812
  * disabledActions: [Action.AxisMenuGroup]
@@ -2741,6 +2818,7 @@ export enum Action {
2741
2818
  * The **Position** option in the axis customization menu.
2742
2819
  * Allows changing the position of the axis to the
2743
2820
  * left or right side of the chart.
2821
+ *
2744
2822
  * @example
2745
2823
  * ```js
2746
2824
  * disabledActions: [Action.AxisMenuPosition]
@@ -2751,6 +2829,7 @@ export enum Action {
2751
2829
  /**
2752
2830
  * The **Rename** option in the chart axis or table column customization menu.
2753
2831
  * Renames the axis label on a chart or the column header on a table.
2832
+ *
2754
2833
  * @example
2755
2834
  * ```js
2756
2835
  * disabledActions: [Action.AxisMenuRename]
@@ -2762,6 +2841,7 @@ export enum Action {
2762
2841
  * The **Edit** action in the axis customization menu.
2763
2842
  * Allows editing the axis name, position, minimum and maximum values,
2764
2843
  * and format of a column.
2844
+ *
2765
2845
  * @example
2766
2846
  * ```js
2767
2847
  * disabledActions: [Action.AxisMenuEdit]
@@ -2772,6 +2852,7 @@ export enum Action {
2772
2852
  /**
2773
2853
  * The **Number format** action to customize the format of
2774
2854
  * the data labels on a chart or table.
2855
+ *
2775
2856
  * @example
2776
2857
  * ```js
2777
2858
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -2782,6 +2863,7 @@ export enum Action {
2782
2863
  /**
2783
2864
  * The **Text wrapping** action on a table.
2784
2865
  * Wraps or clips column text on a table.
2866
+ *
2785
2867
  * @example
2786
2868
  * ```js
2787
2869
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -2794,6 +2876,7 @@ export enum Action {
2794
2876
  * customization menu.
2795
2877
  * Removes the data labels from a chart or the column of a
2796
2878
  * table visualization.
2879
+ *
2797
2880
  * @example
2798
2881
  * ```js
2799
2882
  * disabledActions: [Action.AxisMenuRemove]
@@ -2808,6 +2891,7 @@ export enum Action {
2808
2891
  /**
2809
2892
  * The **Rename** menu action on Liveboards and visualizations.
2810
2893
  * Allows renaming a Liveboard or visualization.
2894
+ *
2811
2895
  * @example
2812
2896
  * ```js
2813
2897
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -2831,6 +2915,22 @@ export enum Action {
2831
2915
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2832
2916
  */
2833
2917
  EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
2918
+ /**
2919
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2920
+ */
2921
+ ShowSageQuery = 'showSageQuery',
2922
+ /**
2923
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2924
+ */
2925
+ EditSageAnswer = 'editSageAnswer',
2926
+ /**
2927
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2928
+ */
2929
+ SageAnswerFeedback = 'sageAnswerFeedback',
2930
+ /**
2931
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2932
+ */
2933
+ ModifySageAnswer = 'modifySageAnswer',
2834
2934
  }
2835
2935
 
2836
2936
  export interface SessionInterface {