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