@thoughtspot/visual-embed-sdk 1.23.0 → 1.23.1

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 (60) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +1 -1
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +1 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/base.d.ts +8 -0
  7. package/cjs/src/embed/base.d.ts.map +1 -1
  8. package/cjs/src/embed/base.js +8 -0
  9. package/cjs/src/embed/base.js.map +1 -1
  10. package/cjs/src/embed/sage.d.ts +14 -0
  11. package/cjs/src/embed/sage.d.ts.map +1 -1
  12. package/cjs/src/embed/sage.js +12 -3
  13. package/cjs/src/embed/sage.js.map +1 -1
  14. package/cjs/src/embed/sage.spec.js +1 -1
  15. package/cjs/src/embed/sage.spec.js.map +1 -1
  16. package/cjs/src/types.d.ts +364 -247
  17. package/cjs/src/types.d.ts.map +1 -1
  18. package/cjs/src/types.js +342 -241
  19. package/cjs/src/types.js.map +1 -1
  20. package/dist/src/embed/app.d.ts +1 -1
  21. package/dist/src/embed/app.d.ts.map +1 -1
  22. package/dist/src/embed/base.d.ts +8 -0
  23. package/dist/src/embed/base.d.ts.map +1 -1
  24. package/dist/src/embed/sage.d.ts +14 -0
  25. package/dist/src/embed/sage.d.ts.map +1 -1
  26. package/dist/src/types.d.ts +364 -247
  27. package/dist/src/types.d.ts.map +1 -1
  28. package/dist/tsembed-react.es.js +356 -246
  29. package/dist/tsembed-react.js +355 -245
  30. package/dist/tsembed.es.js +364 -246
  31. package/dist/tsembed.js +363 -245
  32. package/dist/visual-embed-sdk-react-full.d.ts +387 -248
  33. package/dist/visual-embed-sdk-react.d.ts +387 -248
  34. package/dist/visual-embed-sdk.d.ts +387 -248
  35. package/lib/package.json +1 -1
  36. package/lib/src/embed/app.d.ts +1 -1
  37. package/lib/src/embed/app.d.ts.map +1 -1
  38. package/lib/src/embed/app.js +1 -1
  39. package/lib/src/embed/app.js.map +1 -1
  40. package/lib/src/embed/base.d.ts +8 -0
  41. package/lib/src/embed/base.d.ts.map +1 -1
  42. package/lib/src/embed/base.js +8 -0
  43. package/lib/src/embed/base.js.map +1 -1
  44. package/lib/src/embed/sage.d.ts +14 -0
  45. package/lib/src/embed/sage.d.ts.map +1 -1
  46. package/lib/src/embed/sage.js +12 -3
  47. package/lib/src/embed/sage.js.map +1 -1
  48. package/lib/src/embed/sage.spec.js +1 -1
  49. package/lib/src/embed/sage.spec.js.map +1 -1
  50. package/lib/src/types.d.ts +364 -247
  51. package/lib/src/types.d.ts.map +1 -1
  52. package/lib/src/types.js +342 -241
  53. package/lib/src/types.js.map +1 -1
  54. package/lib/src/visual-embed-sdk.d.ts +387 -248
  55. package/package.json +1 -1
  56. package/src/embed/app.ts +1 -1
  57. package/src/embed/base.ts +8 -0
  58. package/src/embed/sage.spec.ts +1 -1
  59. package/src/embed/sage.ts +24 -2
  60. package/src/types.ts +351 -247
package/lib/src/types.js CHANGED
@@ -669,6 +669,18 @@ export var EmbedEvent;
669
669
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
670
670
  */
671
671
  EmbedEvent["FilterChanged"] = "filterChanged";
672
+ /**
673
+ * Emitted when a user click on Go button in Sage Embed
674
+ *
675
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
676
+ */
677
+ EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
678
+ /**
679
+ * Emitten when a user select data source in Sage Embed
680
+ *
681
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
682
+ */
683
+ EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
672
684
  })(EmbedEvent || (EmbedEvent = {}));
673
685
  /**
674
686
  * Event types that can be triggered by the host application
@@ -699,6 +711,7 @@ export var HostEvent;
699
711
  * Triggers a search query in AppEmbed and SearchEmbed
700
712
  * deployments.
701
713
  * Includes the following properties:
714
+ *
702
715
  * @param - dataSourceIds - The data source GUID to Search on
703
716
  * - Although an array, only a single source
704
717
  * is supported.
@@ -717,6 +730,7 @@ export var HostEvent;
717
730
  /**
718
731
  * Triggers a drill on certain points of the specified column
719
732
  * Includes the following properties:
733
+ *
720
734
  * @param - points - an object containing selectedPoints/clickedPoints
721
735
  * to drill to. For example, { selectedPoints: []}
722
736
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -781,18 +795,19 @@ export var HostEvent;
781
795
  */
782
796
  HostEvent["SetActiveTab"] = "SetActiveTab";
783
797
  /**
784
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
785
- * runtime filters passed here are appended to the existing runtime
786
- * filters.
787
- * Pass an array of runtime filters with the following attributes:
788
- * `columnName`
789
- * _String_. The name of the column to filter on.
790
- * `operator`
791
- * Runtime filter operator to apply. For information,
792
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
793
- * `values`
794
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
795
- * such as BW and IN accept multiple operands.
798
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
799
+ * runtime filters passed here are appended to the existing runtime
800
+ * filters.
801
+ * Pass an array of runtime filters with the following attributes:
802
+ * `columnName`
803
+ * _String_. The name of the column to filter on.
804
+ * `operator`
805
+ * Runtime filter operator to apply. For information,
806
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
807
+ * `values`
808
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
809
+ * operators such as BW and IN accept multiple operands.
810
+ *
796
811
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
797
812
  * @example
798
813
  * ```js
@@ -808,6 +823,7 @@ export var HostEvent;
808
823
  /**
809
824
  * Navigate to a specific page in the embedded application without reloading the page.
810
825
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
826
+ *
811
827
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
812
828
  * @example
813
829
  * ```js
@@ -1131,6 +1147,7 @@ export var HostEvent;
1131
1147
  /**
1132
1148
  * Triggers the **SpotIQ analyze** action on visualization
1133
1149
  * or search.
1150
+ *
1134
1151
  * @param - Liveboard embed takes `vizId` as a
1135
1152
  * key. Can be left undefined when embedding Search or
1136
1153
  * visualization.
@@ -1170,6 +1187,7 @@ export var HostEvent;
1170
1187
  /**
1171
1188
  * Triggers the **Download** > **PNG** action on
1172
1189
  * charts in the embedded view.
1190
+ *
1173
1191
  * @example
1174
1192
  * ```js
1175
1193
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1203,6 +1221,7 @@ export var HostEvent;
1203
1221
  /**
1204
1222
  * Triggers the **Download** > **XLSX** action on tables
1205
1223
  * in the embedded view.
1224
+ *
1206
1225
  * @example
1207
1226
  * ```js
1208
1227
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -1234,6 +1253,7 @@ export var HostEvent;
1234
1253
  /**
1235
1254
  * Triggers the **Save** action on a Liveboard or Answer.
1236
1255
  * Saves the changes.
1256
+ *
1237
1257
  * @example
1238
1258
  * ```js
1239
1259
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -1247,6 +1267,7 @@ export var HostEvent;
1247
1267
  /**
1248
1268
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1249
1269
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
1270
+ *
1250
1271
  * @param - an object with `vizId` as a key
1251
1272
  * @example
1252
1273
  * ```js
@@ -1263,6 +1284,7 @@ export var HostEvent;
1263
1284
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1264
1285
  * Sends data from an Answer or Liveboard visualization to third-party apps such
1265
1286
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1287
+ *
1266
1288
  * @param - an object with vizId as a key
1267
1289
  * @example
1268
1290
  * ```js
@@ -1279,6 +1301,7 @@ export var HostEvent;
1279
1301
  * Triggers the **Manage pipelines** action on an embedded
1280
1302
  * visualization or Answer.
1281
1303
  * Allows users to manage ThoughtSpot Sync pipelines.
1304
+ *
1282
1305
  * @param - an object with `vizId` as a key
1283
1306
  * @example
1284
1307
  * ```js
@@ -1323,7 +1346,7 @@ export var HostEvent;
1323
1346
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1324
1347
  */
1325
1348
  HostEvent["UpdateFilters"] = "updateFilters";
1326
- /*
1349
+ /**
1327
1350
  * Get Tab for the current Liveboard.
1328
1351
  *
1329
1352
  * @example
@@ -1334,7 +1357,7 @@ export var HostEvent;
1334
1357
  * );
1335
1358
  * })
1336
1359
  * ```
1337
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1360
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1338
1361
  */
1339
1362
  HostEvent["GetTabs"] = "getTabs";
1340
1363
  /**
@@ -1348,7 +1371,7 @@ export var HostEvent;
1348
1371
  * '430496d6-6903-4601-937e-2c691821af3c',
1349
1372
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
1350
1373
  * ```
1351
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1374
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1352
1375
  */
1353
1376
  HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1354
1377
  /**
@@ -1362,7 +1385,7 @@ export var HostEvent;
1362
1385
  * '630496d6-6903-4601-937e-2c691821af3c',
1363
1386
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
1364
1387
  * ```
1365
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1388
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1366
1389
  */
1367
1390
  HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
1368
1391
  })(HostEvent || (HostEvent = {}));
@@ -1450,6 +1473,9 @@ export var Param;
1450
1473
  Param["HiddenTabs"] = "hideTabs";
1451
1474
  Param["VisibleTabs"] = "visibleTabs";
1452
1475
  Param["HideTabPanel"] = "hideTabPanel";
1476
+ Param["HideSampleQuestions"] = "hideSampleQuestions";
1477
+ Param["WorksheetId"] = "worksheetId";
1478
+ Param["Query"] = "query,";
1453
1479
  })(Param || (Param = {}));
1454
1480
  /**
1455
1481
  * ThoughtSpot application pages include actions and menu commands
@@ -1458,6 +1484,7 @@ export var Param;
1458
1484
  * specific actions in the embedded view, define the Action
1459
1485
  * enumeration members in the `disabledActions`, `visibleActions`,
1460
1486
  * or `hiddenActions` array.
1487
+ *
1461
1488
  * @example
1462
1489
  * ```js
1463
1490
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -1476,7 +1503,6 @@ export var Param;
1476
1503
  * hiddenActions: [Action.Edit, ActionAction.Explore],
1477
1504
  * })
1478
1505
  * ```
1479
-
1480
1506
  */
1481
1507
  // eslint-disable-next-line no-shadow
1482
1508
  export var Action;
@@ -1484,6 +1510,7 @@ export var Action;
1484
1510
  /**
1485
1511
  * The **Save** action on an Answer or Liveboard.
1486
1512
  * Allows users to save the changes.
1513
+ *
1487
1514
  * @example
1488
1515
  * ```js
1489
1516
  * disabledActions: [Action.SaveAsView]
@@ -1499,136 +1526,146 @@ export var Action;
1499
1526
  */
1500
1527
  Action["SaveUntitled"] = "saveUntitled";
1501
1528
  /**
1502
- * The **Save as View** action on the Answer
1503
- * page. Saves an Answer as a View object.
1504
- *
1505
- * @example
1506
- * ```js
1507
- * disabledActions: [Action.SaveAsView]
1508
- * ```
1509
- */
1529
+ * The **Save as View** action on the Answer
1530
+ * page. Saves an Answer as a View object.
1531
+ *
1532
+ * @example
1533
+ * ```js
1534
+ * disabledActions: [Action.SaveAsView]
1535
+ * ```
1536
+ */
1510
1537
  Action["SaveAsView"] = "saveAsView";
1511
1538
  /**
1512
- * The **Make a copy** action on a Liveboard or Answer
1513
- * page.
1514
- * Creates a copy of the Liveboard, visualization,
1515
- * or Answer.
1516
- *
1517
- * @example
1518
- * ```js
1519
- * disabledActions: [Action.MakeACopy]
1520
- * ```
1521
- */
1539
+ * The **Make a copy** action on a Liveboard or Answer
1540
+ * page.
1541
+ * Creates a copy of the Liveboard, visualization,
1542
+ * or Answer.
1543
+ *
1544
+ * @example
1545
+ * ```js
1546
+ * disabledActions: [Action.MakeACopy]
1547
+ * ```
1548
+ */
1522
1549
  Action["MakeACopy"] = "makeACopy";
1523
1550
  /**
1524
- * The **Copy and Edit** action on a Liveboard.
1525
- * This action is now replaced with `Action.MakeACopy`.
1526
- *
1527
- * @example
1528
- * ```js
1529
- * disabledActions: [Action.EditACopy]
1530
- * ```
1531
- */
1551
+ * The **Copy and Edit** action on a Liveboard.
1552
+ * This action is now replaced with `Action.MakeACopy`.
1553
+ *
1554
+ * @example
1555
+ * ```js
1556
+ * disabledActions: [Action.EditACopy]
1557
+ * ```
1558
+ */
1532
1559
  Action["EditACopy"] = "editACopy";
1533
1560
  /**
1534
- * The **Copy link** menu action on a Liveboard visualization.
1535
- * Copies the visualization URL
1536
- * @example
1537
- * ```js
1538
- * disabledActions: [Action.CopyLink]
1539
- * ```
1540
- */
1561
+ * The **Copy link** menu action on a Liveboard visualization.
1562
+ * Copies the visualization URL
1563
+ *
1564
+ * @example
1565
+ * ```js
1566
+ * disabledActions: [Action.CopyLink]
1567
+ * ```
1568
+ */
1541
1569
  Action["CopyLink"] = "embedDocument";
1542
1570
  /**
1543
1571
  * @hidden
1544
1572
  */
1545
1573
  Action["ResetLayout"] = "resetLayout";
1546
1574
  /**
1547
- * The **Schedule** menu action on a Liveboard.
1548
- * Allows scheduling a Liveboard notification.
1549
- * @example
1550
- * ```js
1551
- * disabledActions: [Action.Schedule]
1552
- * ```
1553
- */
1575
+ * The **Schedule** menu action on a Liveboard.
1576
+ * Allows scheduling a Liveboard notification.
1577
+ *
1578
+ * @example
1579
+ * ```js
1580
+ * disabledActions: [Action.Schedule]
1581
+ * ```
1582
+ */
1554
1583
  Action["Schedule"] = "subscription";
1555
1584
  /**
1556
- * The **Manage schedules** menu action on a Liveboard.
1557
- * Allows users to manage scheduled Liveboard jobs.
1558
- * @example
1559
- * ```js
1560
- * disabledActions: [Action.SchedulesList]
1561
- * ```
1562
- */
1585
+ * The **Manage schedules** menu action on a Liveboard.
1586
+ * Allows users to manage scheduled Liveboard jobs.
1587
+ *
1588
+ * @example
1589
+ * ```js
1590
+ * disabledActions: [Action.SchedulesList]
1591
+ * ```
1592
+ */
1563
1593
  Action["SchedulesList"] = "schedule-list";
1564
1594
  /**
1565
- * The **Share** action on a Liveboard, Answer, or Worksheet.
1566
- * Allows users to share an object with other users and groups.
1567
- * @example
1568
- * ```js
1569
- * disabledActions: [Action.Share]
1570
- * ```
1571
- */
1595
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
1596
+ * Allows users to share an object with other users and groups.
1597
+ *
1598
+ * @example
1599
+ * ```js
1600
+ * disabledActions: [Action.Share]
1601
+ * ```
1602
+ */
1572
1603
  Action["Share"] = "share";
1573
1604
  /**
1574
- * The **Add filter** action on a Liveboard and Search page.
1575
- * Allows adding filters to Answers and visualizations on a Liveboard.
1576
- * @example
1577
- * ```js
1578
- * disabledActions: [Action.AddFilter]
1579
- * ```
1580
- */
1605
+ * The **Add filter** action on a Liveboard and Search page.
1606
+ * Allows adding filters to Answers and visualizations on a Liveboard.
1607
+ *
1608
+ * @example
1609
+ * ```js
1610
+ * disabledActions: [Action.AddFilter]
1611
+ * ```
1612
+ */
1581
1613
  Action["AddFilter"] = "addFilter";
1582
1614
  /**
1583
- * Filter configuration options on a Liveboard and Search page.
1584
- * Allows configuring filter options when adding filters to a
1585
- * Liveboard or Answer.
1586
- * @example
1587
- * ```js
1588
- * disabledActions: [Action.ConfigureFilter]
1589
- * ```
1590
- */
1615
+ * Filter configuration options on a Liveboard and Search page.
1616
+ * Allows configuring filter options when adding filters to a
1617
+ * Liveboard or Answer.
1618
+ *
1619
+ * @example
1620
+ * ```js
1621
+ * disabledActions: [Action.ConfigureFilter]
1622
+ * ```
1623
+ */
1591
1624
  Action["ConfigureFilter"] = "configureFilter";
1592
1625
  Action["CollapseDataSources"] = "collapseDataSources";
1593
1626
  /**
1594
- * The **Choose sources** button on Search page.
1595
- * Allows selecting data sources for search queries.
1596
- * @example
1597
- * ```js
1598
- * disabledActions: [Action.ChooseDataSources]
1599
- * ```
1600
- */
1627
+ * The **Choose sources** button on Search page.
1628
+ * Allows selecting data sources for search queries.
1629
+ *
1630
+ * @example
1631
+ * ```js
1632
+ * disabledActions: [Action.ChooseDataSources]
1633
+ * ```
1634
+ */
1601
1635
  Action["ChooseDataSources"] = "chooseDataSources";
1602
1636
  /**
1603
- * The **Create formula** action on a Search or Answer page.
1604
- * Allows adding formulas to an Answer.
1605
- * @example
1606
- * ```js
1607
- * disabledActions: [Action.AddFormula]
1608
- * ```
1609
- */
1637
+ * The **Create formula** action on a Search or Answer page.
1638
+ * Allows adding formulas to an Answer.
1639
+ *
1640
+ * @example
1641
+ * ```js
1642
+ * disabledActions: [Action.AddFormula]
1643
+ * ```
1644
+ */
1610
1645
  Action["AddFormula"] = "addFormula";
1611
1646
  /**
1612
- * The **Add parameter** action on a Liveboard or Answer.
1613
- * Allows adding Parameters to a Liveboard or Answer.
1614
- * @example
1615
- * ```js
1616
- * disabledActions: [Action.AddParameter]
1617
- * ```
1618
- */
1647
+ * The **Add parameter** action on a Liveboard or Answer.
1648
+ * Allows adding Parameters to a Liveboard or Answer.
1649
+ *
1650
+ * @example
1651
+ * ```js
1652
+ * disabledActions: [Action.AddParameter]
1653
+ * ```
1654
+ */
1619
1655
  Action["AddParameter"] = "addParameter";
1620
1656
  /**
1621
1657
  * @hidden
1622
1658
  */
1623
1659
  Action["SearchOnTop"] = "searchOnTop";
1624
1660
  /**
1625
- * The **SpotIQ analyze** menu action on a visualization or
1626
- * Answer page.
1627
- * @example
1628
- * ```js
1629
- * disabledActions: [Action.SpotIQAnalyze]
1630
- * ```
1631
- */
1661
+ * The **SpotIQ analyze** menu action on a visualization or
1662
+ * Answer page.
1663
+ *
1664
+ * @example
1665
+ * ```js
1666
+ * disabledActions: [Action.SpotIQAnalyze]
1667
+ * ```
1668
+ */
1632
1669
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
1633
1670
  /**
1634
1671
  * @hidden
@@ -1644,89 +1681,98 @@ export var Action;
1644
1681
  */
1645
1682
  Action["ReplaySearch"] = "replaySearch";
1646
1683
  /**
1647
- * The **Show underlying data** menu action on a visualization or
1648
- * Answer page.
1649
- * @example
1650
- * ```js
1651
- * disabledActions: [Action.ShowUnderlyingData]
1652
- * ```
1653
- */
1684
+ * The **Show underlying data** menu action on a visualization or
1685
+ * Answer page.
1686
+ *
1687
+ * @example
1688
+ * ```js
1689
+ * disabledActions: [Action.ShowUnderlyingData]
1690
+ * ```
1691
+ */
1654
1692
  Action["ShowUnderlyingData"] = "showUnderlyingData";
1655
1693
  /**
1656
- * The **Download** menu action on Liveboard visualizations
1657
- * and Answers.
1658
- * Allows downloading a visualization or Answer.
1659
- * @example
1660
- * ```js
1661
- * disabledActions: [Action.DownloadAsPng]
1662
- * ```
1663
- */
1694
+ * The **Download** menu action on Liveboard visualizations
1695
+ * and Answers.
1696
+ * Allows downloading a visualization or Answer.
1697
+ *
1698
+ * @example
1699
+ * ```js
1700
+ * disabledActions: [Action.DownloadAsPng]
1701
+ * ```
1702
+ */
1664
1703
  Action["Download"] = "download";
1665
1704
  /**
1666
- * The **Download** > **PNG** menu action for charts on a Liveboard
1667
- * or Answer page.
1668
- * Downloads a visualization or Answer as a PNG file.
1669
- * @example
1670
- * ```js
1671
- * disabledActions: [Action.DownloadAsPng]
1672
- * ```
1673
- */
1705
+ * The **Download** > **PNG** menu action for charts on a Liveboard
1706
+ * or Answer page.
1707
+ * Downloads a visualization or Answer as a PNG file.
1708
+ *
1709
+ * @example
1710
+ * ```js
1711
+ * disabledActions: [Action.DownloadAsPng]
1712
+ * ```
1713
+ */
1674
1714
  Action["DownloadAsPng"] = "downloadAsPng";
1675
1715
  /**
1676
- * The **Download** > **PDF** menu action on a Liveboard.
1677
- * Downloads a visualization or Answer as a PDF file.
1678
- * @example
1679
- * ```js
1680
- * disabledActions: [Action.DownloadAsPdf]
1681
- * ```
1682
- */
1716
+ * The **Download** > **PDF** menu action on a Liveboard.
1717
+ * Downloads a visualization or Answer as a PDF file.
1718
+ *
1719
+ * @example
1720
+ * ```js
1721
+ * disabledActions: [Action.DownloadAsPdf]
1722
+ * ```
1723
+ */
1683
1724
  Action["DownloadAsPdf"] = "downloadAsPdf";
1684
1725
  /**
1685
- * The **Download** > **CSV** menu action for tables on a Liveboard
1686
- * or Answer page.
1687
- * Downloads a visualization or Answer in the XLSX format.
1688
- * @example
1689
- * ```js
1690
- * disabledActions: [Action.DownloadAsCsv]
1691
- * ```
1692
- */
1726
+ * The **Download** > **CSV** menu action for tables on a Liveboard
1727
+ * or Answer page.
1728
+ * Downloads a visualization or Answer in the XLSX format.
1729
+ *
1730
+ * @example
1731
+ * ```js
1732
+ * disabledActions: [Action.DownloadAsCsv]
1733
+ * ```
1734
+ */
1693
1735
  Action["DownloadAsCsv"] = "downloadAsCSV";
1694
1736
  /**
1695
- * The **Download** > **XLSX** menu action for tables on a Liveboard
1696
- * or Answer page.
1697
- * Downloads a visualization or Answer in the XLSX format.
1698
- * @example
1699
- * ```js
1700
- * disabledActions: [Action.DownloadAsXlsx]
1701
- * ```
1702
- */
1737
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
1738
+ * or Answer page.
1739
+ * Downloads a visualization or Answer in the XLSX format.
1740
+ *
1741
+ * @example
1742
+ * ```js
1743
+ * disabledActions: [Action.DownloadAsXlsx]
1744
+ * ```
1745
+ */
1703
1746
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
1704
1747
  /**
1705
1748
  * @hidden
1706
1749
  */
1707
1750
  Action["DownloadTrace"] = "downloadTrace";
1708
1751
  /**
1709
- * The **Export TML** menu action on Liveboard, Answers
1710
- * Worksheets and Data Connections page.
1711
- * Exports an object as a TML file.
1712
- * @example
1713
- * ```js
1714
- * disabledActions: [Action.ExportTML]
1715
- * ```
1716
- */
1752
+ * The **Export TML** menu action on Liveboard, Answers
1753
+ * Worksheets and Data Connections page.
1754
+ * Exports an object as a TML file.
1755
+ *
1756
+ * @example
1757
+ * ```js
1758
+ * disabledActions: [Action.ExportTML]
1759
+ * ```
1760
+ */
1717
1761
  Action["ExportTML"] = "exportTSL";
1718
1762
  /**
1719
- * The **Import TML** menu action for Liveboards and Answers.
1720
- * Imports TML representation of ThoughtSpot objects.
1721
- * @example
1722
- * ```js
1723
- * disabledActions: [Action.ImportTML]
1724
- * ```
1725
- */
1763
+ * The **Import TML** menu action for Liveboards and Answers.
1764
+ * Imports TML representation of ThoughtSpot objects.
1765
+ *
1766
+ * @example
1767
+ * ```js
1768
+ * disabledActions: [Action.ImportTML]
1769
+ * ```
1770
+ */
1726
1771
  Action["ImportTML"] = "importTSL";
1727
1772
  /**
1728
1773
  * The **Update TML** menu action for Liveboards and Answers.
1729
1774
  * Update TML representation of ThoughtSpot objects.
1775
+ *
1730
1776
  * @example
1731
1777
  * ```js
1732
1778
  * disabledActions: [Action.UpdateTML]
@@ -1736,6 +1782,7 @@ export var Action;
1736
1782
  /**
1737
1783
  * The **Edit TML** menu action for Liveboards and Answers.
1738
1784
  * Opens the TML editor.
1785
+ *
1739
1786
  * @example
1740
1787
  * ```js
1741
1788
  * disabledActions: [Action.EditTML]
@@ -1743,50 +1790,55 @@ export var Action;
1743
1790
  */
1744
1791
  Action["EditTML"] = "editTSL";
1745
1792
  /**
1746
- * The **Present** menu action for Liveboards and Answers.
1747
- * Allows presenting a Liveboard or visualization in
1748
- * slideshow mode.
1749
- * @example
1750
- * ```js
1751
- * disabledActions: [Action.Present]
1752
- * ```
1753
- */
1793
+ * The **Present** menu action for Liveboards and Answers.
1794
+ * Allows presenting a Liveboard or visualization in
1795
+ * slideshow mode.
1796
+ *
1797
+ * @example
1798
+ * ```js
1799
+ * disabledActions: [Action.Present]
1800
+ * ```
1801
+ */
1754
1802
  Action["Present"] = "present";
1755
1803
  /**
1756
- * The tile resize options in the visualization menu.
1757
- * Allows switching between different preset layouts.
1758
- * @example
1759
- * ```js
1760
- * disabledActions: [Action.ToggleSize]
1761
- * ```
1762
- */
1804
+ * The tile resize options in the visualization menu.
1805
+ * Allows switching between different preset layouts.
1806
+ *
1807
+ * @example
1808
+ * ```js
1809
+ * disabledActions: [Action.ToggleSize]
1810
+ * ```
1811
+ */
1763
1812
  Action["ToggleSize"] = "toggleSize";
1764
1813
  /**
1765
- * The *Edit* action on the Liveboard page and in the
1766
- * visualization menu.
1767
- * Opens a Liveboard or visualization in edit mode.
1768
- * @example
1769
- * ```js
1770
- * disabledActions: [Action.Edit]
1771
- * ```
1772
- */
1814
+ * The *Edit* action on the Liveboard page and in the
1815
+ * visualization menu.
1816
+ * Opens a Liveboard or visualization in edit mode.
1817
+ *
1818
+ * @example
1819
+ * ```js
1820
+ * disabledActions: [Action.Edit]
1821
+ * ```
1822
+ */
1773
1823
  Action["Edit"] = "edit";
1774
1824
  /**
1775
- * The text edit option for Liveboard and visualization titles.
1776
- * @example
1777
- * ```js
1778
- * disabledActions: [Action.EditTitle]
1779
- * ```
1780
- */
1825
+ * The text edit option for Liveboard and visualization titles.
1826
+ *
1827
+ * @example
1828
+ * ```js
1829
+ * disabledActions: [Action.EditTitle]
1830
+ * ```
1831
+ */
1781
1832
  Action["EditTitle"] = "editTitle";
1782
1833
  /**
1783
- * The **Delete** menu action on Liveboards and visualizations.
1784
- * Deletes a Liveboard or a visualization from a Liveboard.
1785
- * @example
1786
- * ```js
1787
- * disabledActions: [Action.Remove]
1788
- * ```
1789
- */
1834
+ * The **Delete** menu action on Liveboards and visualizations.
1835
+ * Deletes a Liveboard or a visualization from a Liveboard.
1836
+ *
1837
+ * @example
1838
+ * ```js
1839
+ * disabledActions: [Action.Remove]
1840
+ * ```
1841
+ */
1790
1842
  Action["Remove"] = "delete";
1791
1843
  /**
1792
1844
  * @hidden
@@ -1809,15 +1861,16 @@ export var Action;
1809
1861
  */
1810
1862
  Action["PinboardInfo"] = "pinboardInfo";
1811
1863
  /**
1812
- * The **Show Liveboard details** menu action on a Liveboard.
1813
- * Displays details such as the name, description, and
1814
- * author of the Liveboard, and timestamp of Liveboard creation
1815
- * and update.
1816
- * @example
1817
- * ```js
1818
- * disabledActions: [Action.LiveboardInfo]
1819
- * ```
1820
- */
1864
+ * The **Show Liveboard details** menu action on a Liveboard.
1865
+ * Displays details such as the name, description, and
1866
+ * author of the Liveboard, and timestamp of Liveboard creation
1867
+ * and update.
1868
+ *
1869
+ * @example
1870
+ * ```js
1871
+ * disabledActions: [Action.LiveboardInfo]
1872
+ * ```
1873
+ */
1821
1874
  Action["LiveboardInfo"] = "pinboardInfo";
1822
1875
  /**
1823
1876
  * @hidden
@@ -1828,13 +1881,14 @@ export var Action;
1828
1881
  */
1829
1882
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
1830
1883
  /**
1831
- * The **Pin** menu action on an Answer or
1832
- * Search results page.
1833
- * @example
1834
- * ```js
1835
- * disabledActions: [Action.Pin]
1836
- * ```
1837
- */
1884
+ * The **Pin** menu action on an Answer or
1885
+ * Search results page.
1886
+ *
1887
+ * @example
1888
+ * ```js
1889
+ * disabledActions: [Action.Pin]
1890
+ * ```
1891
+ */
1838
1892
  Action["Pin"] = "pin";
1839
1893
  /**
1840
1894
  * @hidden
@@ -1842,6 +1896,7 @@ export var Action;
1842
1896
  Action["AnalysisInfo"] = "analysisInfo";
1843
1897
  /**
1844
1898
  * The **Schedule** menu action on a Liveboard.
1899
+ *
1845
1900
  * @example
1846
1901
  * ```js
1847
1902
  * disabledActions: [Action.Subscription]
@@ -1849,25 +1904,28 @@ export var Action;
1849
1904
  */
1850
1905
  Action["Subscription"] = "subscription";
1851
1906
  /**
1852
- * The **Explore** action on Liveboard visualizations
1853
- * @example
1854
- * ```js
1855
- * disabledActions: [Action.Explore]
1856
- * ```
1857
- */
1907
+ * The **Explore** action on Liveboard visualizations
1908
+ *
1909
+ * @example
1910
+ * ```js
1911
+ * disabledActions: [Action.Explore]
1912
+ * ```
1913
+ */
1858
1914
  Action["Explore"] = "explore";
1859
1915
  /**
1860
- * The action to include data points on a drilled-down Answer
1861
- * or visualization
1862
- * @example
1863
- * ```js
1864
- * disabledActions: [Action.DrillInclude]
1865
- * ```
1866
- */
1916
+ * The action to include data points on a drilled-down Answer
1917
+ * or visualization
1918
+ *
1919
+ * @example
1920
+ * ```js
1921
+ * disabledActions: [Action.DrillInclude]
1922
+ * ```
1923
+ */
1867
1924
  Action["DrillInclude"] = "context-menu-item-include";
1868
1925
  /**
1869
1926
  * The action to exclude data points on a drilled-down Answer
1870
1927
  * or visualization
1928
+ *
1871
1929
  * @example
1872
1930
  * ```js
1873
1931
  * disabledActions: [Action.DrillInclude]
@@ -1878,6 +1936,7 @@ export var Action;
1878
1936
  * The **Copy to clipboard** menu action on tables in an Answer
1879
1937
  * or Liveboard.
1880
1938
  * Copies the selected data point.
1939
+ *
1881
1940
  * @example
1882
1941
  * ```js
1883
1942
  * disabledActions: [Action.CopyToClipboard]
@@ -1895,6 +1954,7 @@ export var Action;
1895
1954
  * The **Drill down** menu action on Answers and Liveboard
1896
1955
  * visualizations.
1897
1956
  * Allows drilling down to a specific data point on a chart or table.
1957
+ *
1898
1958
  * @example
1899
1959
  * ```js
1900
1960
  * disabledActions: [Action.DrillDown]
@@ -1904,6 +1964,7 @@ export var Action;
1904
1964
  /**
1905
1965
  * The request access action on Liveboards.
1906
1966
  * Allows users with view permissions to request edit access to a Liveboard.
1967
+ *
1907
1968
  * @example
1908
1969
  * ```js
1909
1970
  * disabledActions: [Action.RequestAccess]
@@ -1913,6 +1974,7 @@ export var Action;
1913
1974
  /**
1914
1975
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
1915
1976
  * of the Answer page
1977
+ *
1916
1978
  * @example
1917
1979
  * ```js
1918
1980
  * disabledActions: [Action.QueryDetailsButtons]
@@ -1921,6 +1983,7 @@ export var Action;
1921
1983
  Action["QueryDetailsButtons"] = "QueryDetailsButtons";
1922
1984
  /**
1923
1985
  * The **Delete** action for Answers.
1986
+ *
1924
1987
  * @example
1925
1988
  * ```js
1926
1989
  * disabledActions: [Action.AnswerDelete]
@@ -1930,6 +1993,7 @@ export var Action;
1930
1993
  Action["AnswerDelete"] = "onDeleteAnswer";
1931
1994
  /**
1932
1995
  * The Chart switcher icon on Answer and visualization pages.
1996
+ *
1933
1997
  * @example
1934
1998
  * ```js
1935
1999
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -1939,6 +2003,7 @@ export var Action;
1939
2003
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
1940
2004
  /**
1941
2005
  * Favorites icon (*) on Answers, Liveboard, and Data pages
2006
+ *
1942
2007
  * @example
1943
2008
  * ```js
1944
2009
  * disabledActions: [Action.AddToFavorites]
@@ -1948,6 +2013,7 @@ export var Action;
1948
2013
  Action["AddToFavorites"] = "addToFavorites";
1949
2014
  /**
1950
2015
  * The edit icon on Liveboards (Classic experience).
2016
+ *
1951
2017
  * @example
1952
2018
  * ```js
1953
2019
  * disabledActions: [Action.EditDetails]
@@ -1957,6 +2023,7 @@ export var Action;
1957
2023
  Action["EditDetails"] = "editDetails";
1958
2024
  /**
1959
2025
  * The Create alert action on KPI charts.
2026
+ *
1960
2027
  * @example
1961
2028
  * ```js
1962
2029
  * disabledActions: [Action.CreateMonitor ]
@@ -1975,6 +2042,7 @@ export var Action;
1975
2042
  /**
1976
2043
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
1977
2044
  * Allows sending data to a Google Sheet.
2045
+ *
1978
2046
  * @example
1979
2047
  * ```js
1980
2048
  * disabledActions: [Action.SyncToSheets]
@@ -1986,6 +2054,7 @@ export var Action;
1986
2054
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
1987
2055
  * Allows sending data to third-party apps like Slack, Salesforce,
1988
2056
  * Microsoft Teams, and so on.
2057
+ *
1989
2058
  * @example
1990
2059
  * ```js
1991
2060
  * disabledActions: [Action.SyncToOtherApps]
@@ -1996,6 +2065,7 @@ export var Action;
1996
2065
  /**
1997
2066
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
1998
2067
  * Allows users to manage data sync pipelines to third-party apps.
2068
+ *
1999
2069
  * @example
2000
2070
  * ```js
2001
2071
  * disabledActions: [Action.SyncToOtherApps]
@@ -2006,6 +2076,7 @@ export var Action;
2006
2076
  /**
2007
2077
  * The **Filter** action on Liveboard visualizations.
2008
2078
  * Allows users to apply cross-filters on a Liveboard.
2079
+ *
2009
2080
  * @example
2010
2081
  * ```js
2011
2082
  * disabledActions: [Action.CrossFilter]
@@ -2017,6 +2088,7 @@ export var Action;
2017
2088
  * The **Remove** action that appears when cross filters are applied
2018
2089
  * on a Liveboard.
2019
2090
  * Removes filters applied o a visualization.
2091
+ *
2020
2092
  * @example
2021
2093
  * ```js
2022
2094
  * disabledActions: [Action.RemoveCrossFilter]
@@ -2028,6 +2100,7 @@ export var Action;
2028
2100
  * The **Aggregate** option in the chart axis or the
2029
2101
  * table column customization menu.
2030
2102
  * Provides aggregation options to analyze the data on a chart or table.
2103
+ *
2031
2104
  * @example
2032
2105
  * ```js
2033
2106
  * disabledActions: [Action.AxisMenuAggregate]
@@ -2039,6 +2112,7 @@ export var Action;
2039
2112
  * The **Time bucket** option in the chart axis or table column
2040
2113
  * customization menu.
2041
2114
  * Allows defining time metric for date comparison.
2115
+ *
2042
2116
  * @example
2043
2117
  * ```js
2044
2118
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -2049,6 +2123,7 @@ export var Action;
2049
2123
  /**
2050
2124
  * The **Filter** action in the chart axis or table column
2051
2125
  * customization menu.
2126
+ *
2052
2127
  * @example
2053
2128
  * ```js
2054
2129
  * disabledActions: [Action.AxisMenuFilter]
@@ -2060,6 +2135,7 @@ export var Action;
2060
2135
  * The **Conditional formatting** action on chart or table.
2061
2136
  * Allows adding rules for conditional formatting of data
2062
2137
  * points on a chart or table.
2138
+ *
2063
2139
  * @example
2064
2140
  * ```js
2065
2141
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2071,6 +2147,7 @@ export var Action;
2071
2147
  * The **Sort** menu action on a table or chart axis
2072
2148
  * Sorts data in ascending or descending order.
2073
2149
  * Allows adding, editing, or removing filters.
2150
+ *
2074
2151
  * @example
2075
2152
  * ```js
2076
2153
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2083,6 +2160,7 @@ export var Action;
2083
2160
  * customization menu.
2084
2161
  * Allows grouping data points if the axes use the same
2085
2162
  * unit of measurement and a similar scale.
2163
+ *
2086
2164
  * @example
2087
2165
  * ```js
2088
2166
  * disabledActions: [Action.AxisMenuGroup]
@@ -2094,6 +2172,7 @@ export var Action;
2094
2172
  * The **Position** option in the axis customization menu.
2095
2173
  * Allows changing the position of the axis to the
2096
2174
  * left or right side of the chart.
2175
+ *
2097
2176
  * @example
2098
2177
  * ```js
2099
2178
  * disabledActions: [Action.AxisMenuPosition]
@@ -2104,6 +2183,7 @@ export var Action;
2104
2183
  /**
2105
2184
  * The **Rename** option in the chart axis or table column customization menu.
2106
2185
  * Renames the axis label on a chart or the column header on a table.
2186
+ *
2107
2187
  * @example
2108
2188
  * ```js
2109
2189
  * disabledActions: [Action.AxisMenuRename]
@@ -2115,6 +2195,7 @@ export var Action;
2115
2195
  * The **Edit** action in the axis customization menu.
2116
2196
  * Allows editing the axis name, position, minimum and maximum values,
2117
2197
  * and format of a column.
2198
+ *
2118
2199
  * @example
2119
2200
  * ```js
2120
2201
  * disabledActions: [Action.AxisMenuEdit]
@@ -2125,6 +2206,7 @@ export var Action;
2125
2206
  /**
2126
2207
  * The **Number format** action to customize the format of
2127
2208
  * the data labels on a chart or table.
2209
+ *
2128
2210
  * @example
2129
2211
  * ```js
2130
2212
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -2135,6 +2217,7 @@ export var Action;
2135
2217
  /**
2136
2218
  * The **Text wrapping** action on a table.
2137
2219
  * Wraps or clips column text on a table.
2220
+ *
2138
2221
  * @example
2139
2222
  * ```js
2140
2223
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -2147,6 +2230,7 @@ export var Action;
2147
2230
  * customization menu.
2148
2231
  * Removes the data labels from a chart or the column of a
2149
2232
  * table visualization.
2233
+ *
2150
2234
  * @example
2151
2235
  * ```js
2152
2236
  * disabledActions: [Action.AxisMenuRemove]
@@ -2161,6 +2245,7 @@ export var Action;
2161
2245
  /**
2162
2246
  * The **Rename** menu action on Liveboards and visualizations.
2163
2247
  * Allows renaming a Liveboard or visualization.
2248
+ *
2164
2249
  * @example
2165
2250
  * ```js
2166
2251
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -2177,13 +2262,29 @@ export var Action;
2177
2262
  */
2178
2263
  Action["MarkAsVerified"] = "markAsVerified";
2179
2264
  /**
2180
- * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2265
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2181
2266
  */
2182
2267
  Action["AddTab"] = "addTab";
2183
2268
  /**
2184
2269
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2185
2270
  */
2186
2271
  Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
2272
+ /**
2273
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2274
+ */
2275
+ Action["ShowSageQuery"] = "showSageQuery";
2276
+ /**
2277
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2278
+ */
2279
+ Action["EditSageAnswer"] = "editSageAnswer";
2280
+ /**
2281
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2282
+ */
2283
+ Action["SageAnswerFeedback"] = "sageAnswerFeedback";
2284
+ /**
2285
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2286
+ */
2287
+ Action["ModifySageAnswer"] = "modifySageAnswer";
2187
2288
  })(Action || (Action = {}));
2188
2289
  // eslint-disable-next-line no-shadow
2189
2290
  export var OperationType;