@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.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +1 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +8 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +8 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +14 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +12 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +1 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/types.d.ts +364 -247
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +342 -241
- package/cjs/src/types.js.map +1 -1
- package/dist/src/embed/app.d.ts +1 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +8 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +14 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/types.d.ts +364 -247
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +356 -246
- package/dist/tsembed-react.js +355 -245
- package/dist/tsembed.es.js +364 -246
- package/dist/tsembed.js +363 -245
- package/dist/visual-embed-sdk-react-full.d.ts +387 -248
- package/dist/visual-embed-sdk-react.d.ts +387 -248
- package/dist/visual-embed-sdk.d.ts +387 -248
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +8 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -0
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/sage.d.ts +14 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +12 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +1 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/types.d.ts +364 -247
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +342 -241
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +387 -248
- package/package.json +1 -1
- package/src/embed/app.ts +1 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/sage.spec.ts +1 -1
- package/src/embed/sage.ts +24 -2
- package/src/types.ts +351 -247
package/dist/tsembed.es.js
CHANGED
|
@@ -848,6 +848,18 @@ var EmbedEvent;
|
|
|
848
848
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
849
849
|
*/
|
|
850
850
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
851
|
+
/**
|
|
852
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
853
|
+
*
|
|
854
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
855
|
+
*/
|
|
856
|
+
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
857
|
+
/**
|
|
858
|
+
* Emitten when a user select data source in Sage Embed
|
|
859
|
+
*
|
|
860
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
861
|
+
*/
|
|
862
|
+
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
851
863
|
})(EmbedEvent || (EmbedEvent = {}));
|
|
852
864
|
/**
|
|
853
865
|
* Event types that can be triggered by the host application
|
|
@@ -878,6 +890,7 @@ var HostEvent;
|
|
|
878
890
|
* Triggers a search query in AppEmbed and SearchEmbed
|
|
879
891
|
* deployments.
|
|
880
892
|
* Includes the following properties:
|
|
893
|
+
*
|
|
881
894
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
882
895
|
* - Although an array, only a single source
|
|
883
896
|
* is supported.
|
|
@@ -896,6 +909,7 @@ var HostEvent;
|
|
|
896
909
|
/**
|
|
897
910
|
* Triggers a drill on certain points of the specified column
|
|
898
911
|
* Includes the following properties:
|
|
912
|
+
*
|
|
899
913
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
900
914
|
* to drill to. For example, { selectedPoints: []}
|
|
901
915
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -960,18 +974,19 @@ var HostEvent;
|
|
|
960
974
|
*/
|
|
961
975
|
HostEvent["SetActiveTab"] = "SetActiveTab";
|
|
962
976
|
/**
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
977
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
978
|
+
* runtime filters passed here are appended to the existing runtime
|
|
979
|
+
* filters.
|
|
980
|
+
* Pass an array of runtime filters with the following attributes:
|
|
981
|
+
* `columnName`
|
|
982
|
+
* _String_. The name of the column to filter on.
|
|
983
|
+
* `operator`
|
|
984
|
+
* Runtime filter operator to apply. For information,
|
|
985
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
986
|
+
* `values`
|
|
987
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
988
|
+
* operators such as BW and IN accept multiple operands.
|
|
989
|
+
*
|
|
975
990
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
976
991
|
* @example
|
|
977
992
|
* ```js
|
|
@@ -987,6 +1002,7 @@ var HostEvent;
|
|
|
987
1002
|
/**
|
|
988
1003
|
* Navigate to a specific page in the embedded application without reloading the page.
|
|
989
1004
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1005
|
+
*
|
|
990
1006
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
991
1007
|
* @example
|
|
992
1008
|
* ```js
|
|
@@ -1310,6 +1326,7 @@ var HostEvent;
|
|
|
1310
1326
|
/**
|
|
1311
1327
|
* Triggers the **SpotIQ analyze** action on visualization
|
|
1312
1328
|
* or search.
|
|
1329
|
+
*
|
|
1313
1330
|
* @param - Liveboard embed takes `vizId` as a
|
|
1314
1331
|
* key. Can be left undefined when embedding Search or
|
|
1315
1332
|
* visualization.
|
|
@@ -1349,6 +1366,7 @@ var HostEvent;
|
|
|
1349
1366
|
/**
|
|
1350
1367
|
* Triggers the **Download** > **PNG** action on
|
|
1351
1368
|
* charts in the embedded view.
|
|
1369
|
+
*
|
|
1352
1370
|
* @example
|
|
1353
1371
|
* ```js
|
|
1354
1372
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -1382,6 +1400,7 @@ var HostEvent;
|
|
|
1382
1400
|
/**
|
|
1383
1401
|
* Triggers the **Download** > **XLSX** action on tables
|
|
1384
1402
|
* in the embedded view.
|
|
1403
|
+
*
|
|
1385
1404
|
* @example
|
|
1386
1405
|
* ```js
|
|
1387
1406
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -1413,6 +1432,7 @@ var HostEvent;
|
|
|
1413
1432
|
/**
|
|
1414
1433
|
* Triggers the **Save** action on a Liveboard or Answer.
|
|
1415
1434
|
* Saves the changes.
|
|
1435
|
+
*
|
|
1416
1436
|
* @example
|
|
1417
1437
|
* ```js
|
|
1418
1438
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -1426,6 +1446,7 @@ var HostEvent;
|
|
|
1426
1446
|
/**
|
|
1427
1447
|
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
1428
1448
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
1449
|
+
*
|
|
1429
1450
|
* @param - an object with `vizId` as a key
|
|
1430
1451
|
* @example
|
|
1431
1452
|
* ```js
|
|
@@ -1442,6 +1463,7 @@ var HostEvent;
|
|
|
1442
1463
|
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
1443
1464
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
1444
1465
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
1466
|
+
*
|
|
1445
1467
|
* @param - an object with vizId as a key
|
|
1446
1468
|
* @example
|
|
1447
1469
|
* ```js
|
|
@@ -1458,6 +1480,7 @@ var HostEvent;
|
|
|
1458
1480
|
* Triggers the **Manage pipelines** action on an embedded
|
|
1459
1481
|
* visualization or Answer.
|
|
1460
1482
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
1483
|
+
*
|
|
1461
1484
|
* @param - an object with `vizId` as a key
|
|
1462
1485
|
* @example
|
|
1463
1486
|
* ```js
|
|
@@ -1502,7 +1525,7 @@ var HostEvent;
|
|
|
1502
1525
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1503
1526
|
*/
|
|
1504
1527
|
HostEvent["UpdateFilters"] = "updateFilters";
|
|
1505
|
-
|
|
1528
|
+
/**
|
|
1506
1529
|
* Get Tab for the current Liveboard.
|
|
1507
1530
|
*
|
|
1508
1531
|
* @example
|
|
@@ -1513,7 +1536,7 @@ var HostEvent;
|
|
|
1513
1536
|
* );
|
|
1514
1537
|
* })
|
|
1515
1538
|
* ```
|
|
1516
|
-
* @version SDK: 1.
|
|
1539
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1517
1540
|
*/
|
|
1518
1541
|
HostEvent["GetTabs"] = "getTabs";
|
|
1519
1542
|
/**
|
|
@@ -1527,7 +1550,7 @@ var HostEvent;
|
|
|
1527
1550
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1528
1551
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
1529
1552
|
* ```
|
|
1530
|
-
* @version SDK: 1.
|
|
1553
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1531
1554
|
*/
|
|
1532
1555
|
HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
|
|
1533
1556
|
/**
|
|
@@ -1541,7 +1564,7 @@ var HostEvent;
|
|
|
1541
1564
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
1542
1565
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
1543
1566
|
* ```
|
|
1544
|
-
* @version SDK: 1.
|
|
1567
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1545
1568
|
*/
|
|
1546
1569
|
HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
|
|
1547
1570
|
})(HostEvent || (HostEvent = {}));
|
|
@@ -1629,6 +1652,9 @@ var Param;
|
|
|
1629
1652
|
Param["HiddenTabs"] = "hideTabs";
|
|
1630
1653
|
Param["VisibleTabs"] = "visibleTabs";
|
|
1631
1654
|
Param["HideTabPanel"] = "hideTabPanel";
|
|
1655
|
+
Param["HideSampleQuestions"] = "hideSampleQuestions";
|
|
1656
|
+
Param["WorksheetId"] = "worksheetId";
|
|
1657
|
+
Param["Query"] = "query,";
|
|
1632
1658
|
})(Param || (Param = {}));
|
|
1633
1659
|
/**
|
|
1634
1660
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -1637,6 +1663,7 @@ var Param;
|
|
|
1637
1663
|
* specific actions in the embedded view, define the Action
|
|
1638
1664
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
1639
1665
|
* or `hiddenActions` array.
|
|
1666
|
+
*
|
|
1640
1667
|
* @example
|
|
1641
1668
|
* ```js
|
|
1642
1669
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1655,7 +1682,6 @@ var Param;
|
|
|
1655
1682
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
1656
1683
|
* })
|
|
1657
1684
|
* ```
|
|
1658
|
-
|
|
1659
1685
|
*/
|
|
1660
1686
|
// eslint-disable-next-line no-shadow
|
|
1661
1687
|
var Action;
|
|
@@ -1663,6 +1689,7 @@ var Action;
|
|
|
1663
1689
|
/**
|
|
1664
1690
|
* The **Save** action on an Answer or Liveboard.
|
|
1665
1691
|
* Allows users to save the changes.
|
|
1692
|
+
*
|
|
1666
1693
|
* @example
|
|
1667
1694
|
* ```js
|
|
1668
1695
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -1678,136 +1705,146 @@ var Action;
|
|
|
1678
1705
|
*/
|
|
1679
1706
|
Action["SaveUntitled"] = "saveUntitled";
|
|
1680
1707
|
/**
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1708
|
+
* The **Save as View** action on the Answer
|
|
1709
|
+
* page. Saves an Answer as a View object.
|
|
1710
|
+
*
|
|
1711
|
+
* @example
|
|
1712
|
+
* ```js
|
|
1713
|
+
* disabledActions: [Action.SaveAsView]
|
|
1714
|
+
* ```
|
|
1715
|
+
*/
|
|
1689
1716
|
Action["SaveAsView"] = "saveAsView";
|
|
1690
1717
|
/**
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1718
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
1719
|
+
* page.
|
|
1720
|
+
* Creates a copy of the Liveboard, visualization,
|
|
1721
|
+
* or Answer.
|
|
1722
|
+
*
|
|
1723
|
+
* @example
|
|
1724
|
+
* ```js
|
|
1725
|
+
* disabledActions: [Action.MakeACopy]
|
|
1726
|
+
* ```
|
|
1727
|
+
*/
|
|
1701
1728
|
Action["MakeACopy"] = "makeACopy";
|
|
1702
1729
|
/**
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1730
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
1731
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
1732
|
+
*
|
|
1733
|
+
* @example
|
|
1734
|
+
* ```js
|
|
1735
|
+
* disabledActions: [Action.EditACopy]
|
|
1736
|
+
* ```
|
|
1737
|
+
*/
|
|
1711
1738
|
Action["EditACopy"] = "editACopy";
|
|
1712
1739
|
/**
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1740
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
1741
|
+
* Copies the visualization URL
|
|
1742
|
+
*
|
|
1743
|
+
* @example
|
|
1744
|
+
* ```js
|
|
1745
|
+
* disabledActions: [Action.CopyLink]
|
|
1746
|
+
* ```
|
|
1747
|
+
*/
|
|
1720
1748
|
Action["CopyLink"] = "embedDocument";
|
|
1721
1749
|
/**
|
|
1722
1750
|
* @hidden
|
|
1723
1751
|
*/
|
|
1724
1752
|
Action["ResetLayout"] = "resetLayout";
|
|
1725
1753
|
/**
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1754
|
+
* The **Schedule** menu action on a Liveboard.
|
|
1755
|
+
* Allows scheduling a Liveboard notification.
|
|
1756
|
+
*
|
|
1757
|
+
* @example
|
|
1758
|
+
* ```js
|
|
1759
|
+
* disabledActions: [Action.Schedule]
|
|
1760
|
+
* ```
|
|
1761
|
+
*/
|
|
1733
1762
|
Action["Schedule"] = "subscription";
|
|
1734
1763
|
/**
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1764
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
1765
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
1766
|
+
*
|
|
1767
|
+
* @example
|
|
1768
|
+
* ```js
|
|
1769
|
+
* disabledActions: [Action.SchedulesList]
|
|
1770
|
+
* ```
|
|
1771
|
+
*/
|
|
1742
1772
|
Action["SchedulesList"] = "schedule-list";
|
|
1743
1773
|
/**
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1774
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
1775
|
+
* Allows users to share an object with other users and groups.
|
|
1776
|
+
*
|
|
1777
|
+
* @example
|
|
1778
|
+
* ```js
|
|
1779
|
+
* disabledActions: [Action.Share]
|
|
1780
|
+
* ```
|
|
1781
|
+
*/
|
|
1751
1782
|
Action["Share"] = "share";
|
|
1752
1783
|
/**
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1784
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
1785
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
1786
|
+
*
|
|
1787
|
+
* @example
|
|
1788
|
+
* ```js
|
|
1789
|
+
* disabledActions: [Action.AddFilter]
|
|
1790
|
+
* ```
|
|
1791
|
+
*/
|
|
1760
1792
|
Action["AddFilter"] = "addFilter";
|
|
1761
1793
|
/**
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1794
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
1795
|
+
* Allows configuring filter options when adding filters to a
|
|
1796
|
+
* Liveboard or Answer.
|
|
1797
|
+
*
|
|
1798
|
+
* @example
|
|
1799
|
+
* ```js
|
|
1800
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
1801
|
+
* ```
|
|
1802
|
+
*/
|
|
1770
1803
|
Action["ConfigureFilter"] = "configureFilter";
|
|
1771
1804
|
Action["CollapseDataSources"] = "collapseDataSources";
|
|
1772
1805
|
/**
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1806
|
+
* The **Choose sources** button on Search page.
|
|
1807
|
+
* Allows selecting data sources for search queries.
|
|
1808
|
+
*
|
|
1809
|
+
* @example
|
|
1810
|
+
* ```js
|
|
1811
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
1812
|
+
* ```
|
|
1813
|
+
*/
|
|
1780
1814
|
Action["ChooseDataSources"] = "chooseDataSources";
|
|
1781
1815
|
/**
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1816
|
+
* The **Create formula** action on a Search or Answer page.
|
|
1817
|
+
* Allows adding formulas to an Answer.
|
|
1818
|
+
*
|
|
1819
|
+
* @example
|
|
1820
|
+
* ```js
|
|
1821
|
+
* disabledActions: [Action.AddFormula]
|
|
1822
|
+
* ```
|
|
1823
|
+
*/
|
|
1789
1824
|
Action["AddFormula"] = "addFormula";
|
|
1790
1825
|
/**
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1826
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
1827
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
1828
|
+
*
|
|
1829
|
+
* @example
|
|
1830
|
+
* ```js
|
|
1831
|
+
* disabledActions: [Action.AddParameter]
|
|
1832
|
+
* ```
|
|
1833
|
+
*/
|
|
1798
1834
|
Action["AddParameter"] = "addParameter";
|
|
1799
1835
|
/**
|
|
1800
1836
|
* @hidden
|
|
1801
1837
|
*/
|
|
1802
1838
|
Action["SearchOnTop"] = "searchOnTop";
|
|
1803
1839
|
/**
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1840
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
1841
|
+
* Answer page.
|
|
1842
|
+
*
|
|
1843
|
+
* @example
|
|
1844
|
+
* ```js
|
|
1845
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
1846
|
+
* ```
|
|
1847
|
+
*/
|
|
1811
1848
|
Action["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
1812
1849
|
/**
|
|
1813
1850
|
* @hidden
|
|
@@ -1823,89 +1860,98 @@ var Action;
|
|
|
1823
1860
|
*/
|
|
1824
1861
|
Action["ReplaySearch"] = "replaySearch";
|
|
1825
1862
|
/**
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1863
|
+
* The **Show underlying data** menu action on a visualization or
|
|
1864
|
+
* Answer page.
|
|
1865
|
+
*
|
|
1866
|
+
* @example
|
|
1867
|
+
* ```js
|
|
1868
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
1869
|
+
* ```
|
|
1870
|
+
*/
|
|
1833
1871
|
Action["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1834
1872
|
/**
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1873
|
+
* The **Download** menu action on Liveboard visualizations
|
|
1874
|
+
* and Answers.
|
|
1875
|
+
* Allows downloading a visualization or Answer.
|
|
1876
|
+
*
|
|
1877
|
+
* @example
|
|
1878
|
+
* ```js
|
|
1879
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
1880
|
+
* ```
|
|
1881
|
+
*/
|
|
1843
1882
|
Action["Download"] = "download";
|
|
1844
1883
|
/**
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1884
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
1885
|
+
* or Answer page.
|
|
1886
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
1887
|
+
*
|
|
1888
|
+
* @example
|
|
1889
|
+
* ```js
|
|
1890
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
1891
|
+
* ```
|
|
1892
|
+
*/
|
|
1853
1893
|
Action["DownloadAsPng"] = "downloadAsPng";
|
|
1854
1894
|
/**
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1895
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
1896
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
1897
|
+
*
|
|
1898
|
+
* @example
|
|
1899
|
+
* ```js
|
|
1900
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
1901
|
+
* ```
|
|
1902
|
+
*/
|
|
1862
1903
|
Action["DownloadAsPdf"] = "downloadAsPdf";
|
|
1863
1904
|
/**
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1905
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
1906
|
+
* or Answer page.
|
|
1907
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
1908
|
+
*
|
|
1909
|
+
* @example
|
|
1910
|
+
* ```js
|
|
1911
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
1912
|
+
* ```
|
|
1913
|
+
*/
|
|
1872
1914
|
Action["DownloadAsCsv"] = "downloadAsCSV";
|
|
1873
1915
|
/**
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1916
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
1917
|
+
* or Answer page.
|
|
1918
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
1919
|
+
*
|
|
1920
|
+
* @example
|
|
1921
|
+
* ```js
|
|
1922
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
1923
|
+
* ```
|
|
1924
|
+
*/
|
|
1882
1925
|
Action["DownloadAsXlsx"] = "downloadAsXLSX";
|
|
1883
1926
|
/**
|
|
1884
1927
|
* @hidden
|
|
1885
1928
|
*/
|
|
1886
1929
|
Action["DownloadTrace"] = "downloadTrace";
|
|
1887
1930
|
/**
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1931
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
1932
|
+
* Worksheets and Data Connections page.
|
|
1933
|
+
* Exports an object as a TML file.
|
|
1934
|
+
*
|
|
1935
|
+
* @example
|
|
1936
|
+
* ```js
|
|
1937
|
+
* disabledActions: [Action.ExportTML]
|
|
1938
|
+
* ```
|
|
1939
|
+
*/
|
|
1896
1940
|
Action["ExportTML"] = "exportTSL";
|
|
1897
1941
|
/**
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1942
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
1943
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
1944
|
+
*
|
|
1945
|
+
* @example
|
|
1946
|
+
* ```js
|
|
1947
|
+
* disabledActions: [Action.ImportTML]
|
|
1948
|
+
* ```
|
|
1949
|
+
*/
|
|
1905
1950
|
Action["ImportTML"] = "importTSL";
|
|
1906
1951
|
/**
|
|
1907
1952
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
1908
1953
|
* Update TML representation of ThoughtSpot objects.
|
|
1954
|
+
*
|
|
1909
1955
|
* @example
|
|
1910
1956
|
* ```js
|
|
1911
1957
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -1915,6 +1961,7 @@ var Action;
|
|
|
1915
1961
|
/**
|
|
1916
1962
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
1917
1963
|
* Opens the TML editor.
|
|
1964
|
+
*
|
|
1918
1965
|
* @example
|
|
1919
1966
|
* ```js
|
|
1920
1967
|
* disabledActions: [Action.EditTML]
|
|
@@ -1922,50 +1969,55 @@ var Action;
|
|
|
1922
1969
|
*/
|
|
1923
1970
|
Action["EditTML"] = "editTSL";
|
|
1924
1971
|
/**
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1972
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
1973
|
+
* Allows presenting a Liveboard or visualization in
|
|
1974
|
+
* slideshow mode.
|
|
1975
|
+
*
|
|
1976
|
+
* @example
|
|
1977
|
+
* ```js
|
|
1978
|
+
* disabledActions: [Action.Present]
|
|
1979
|
+
* ```
|
|
1980
|
+
*/
|
|
1933
1981
|
Action["Present"] = "present";
|
|
1934
1982
|
/**
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
1983
|
+
* The tile resize options in the visualization menu.
|
|
1984
|
+
* Allows switching between different preset layouts.
|
|
1985
|
+
*
|
|
1986
|
+
* @example
|
|
1987
|
+
* ```js
|
|
1988
|
+
* disabledActions: [Action.ToggleSize]
|
|
1989
|
+
* ```
|
|
1990
|
+
*/
|
|
1942
1991
|
Action["ToggleSize"] = "toggleSize";
|
|
1943
1992
|
/**
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
|
|
1993
|
+
* The *Edit* action on the Liveboard page and in the
|
|
1994
|
+
* visualization menu.
|
|
1995
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
1996
|
+
*
|
|
1997
|
+
* @example
|
|
1998
|
+
* ```js
|
|
1999
|
+
* disabledActions: [Action.Edit]
|
|
2000
|
+
* ```
|
|
2001
|
+
*/
|
|
1952
2002
|
Action["Edit"] = "edit";
|
|
1953
2003
|
/**
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
2004
|
+
* The text edit option for Liveboard and visualization titles.
|
|
2005
|
+
*
|
|
2006
|
+
* @example
|
|
2007
|
+
* ```js
|
|
2008
|
+
* disabledActions: [Action.EditTitle]
|
|
2009
|
+
* ```
|
|
2010
|
+
*/
|
|
1960
2011
|
Action["EditTitle"] = "editTitle";
|
|
1961
2012
|
/**
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
|
|
2013
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
2014
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
2015
|
+
*
|
|
2016
|
+
* @example
|
|
2017
|
+
* ```js
|
|
2018
|
+
* disabledActions: [Action.Remove]
|
|
2019
|
+
* ```
|
|
2020
|
+
*/
|
|
1969
2021
|
Action["Remove"] = "delete";
|
|
1970
2022
|
/**
|
|
1971
2023
|
* @hidden
|
|
@@ -1988,15 +2040,16 @@ var Action;
|
|
|
1988
2040
|
*/
|
|
1989
2041
|
Action["PinboardInfo"] = "pinboardInfo";
|
|
1990
2042
|
/**
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2043
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
2044
|
+
* Displays details such as the name, description, and
|
|
2045
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
2046
|
+
* and update.
|
|
2047
|
+
*
|
|
2048
|
+
* @example
|
|
2049
|
+
* ```js
|
|
2050
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
2051
|
+
* ```
|
|
2052
|
+
*/
|
|
2000
2053
|
Action["LiveboardInfo"] = "pinboardInfo";
|
|
2001
2054
|
/**
|
|
2002
2055
|
* @hidden
|
|
@@ -2007,13 +2060,14 @@ var Action;
|
|
|
2007
2060
|
*/
|
|
2008
2061
|
Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
|
|
2009
2062
|
/**
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2063
|
+
* The **Pin** menu action on an Answer or
|
|
2064
|
+
* Search results page.
|
|
2065
|
+
*
|
|
2066
|
+
* @example
|
|
2067
|
+
* ```js
|
|
2068
|
+
* disabledActions: [Action.Pin]
|
|
2069
|
+
* ```
|
|
2070
|
+
*/
|
|
2017
2071
|
Action["Pin"] = "pin";
|
|
2018
2072
|
/**
|
|
2019
2073
|
* @hidden
|
|
@@ -2021,6 +2075,7 @@ var Action;
|
|
|
2021
2075
|
Action["AnalysisInfo"] = "analysisInfo";
|
|
2022
2076
|
/**
|
|
2023
2077
|
* The **Schedule** menu action on a Liveboard.
|
|
2078
|
+
*
|
|
2024
2079
|
* @example
|
|
2025
2080
|
* ```js
|
|
2026
2081
|
* disabledActions: [Action.Subscription]
|
|
@@ -2028,25 +2083,28 @@ var Action;
|
|
|
2028
2083
|
*/
|
|
2029
2084
|
Action["Subscription"] = "subscription";
|
|
2030
2085
|
/**
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
|
|
2086
|
+
* The **Explore** action on Liveboard visualizations
|
|
2087
|
+
*
|
|
2088
|
+
* @example
|
|
2089
|
+
* ```js
|
|
2090
|
+
* disabledActions: [Action.Explore]
|
|
2091
|
+
* ```
|
|
2092
|
+
*/
|
|
2037
2093
|
Action["Explore"] = "explore";
|
|
2038
2094
|
/**
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
|
-
|
|
2045
|
-
|
|
2095
|
+
* The action to include data points on a drilled-down Answer
|
|
2096
|
+
* or visualization
|
|
2097
|
+
*
|
|
2098
|
+
* @example
|
|
2099
|
+
* ```js
|
|
2100
|
+
* disabledActions: [Action.DrillInclude]
|
|
2101
|
+
* ```
|
|
2102
|
+
*/
|
|
2046
2103
|
Action["DrillInclude"] = "context-menu-item-include";
|
|
2047
2104
|
/**
|
|
2048
2105
|
* The action to exclude data points on a drilled-down Answer
|
|
2049
2106
|
* or visualization
|
|
2107
|
+
*
|
|
2050
2108
|
* @example
|
|
2051
2109
|
* ```js
|
|
2052
2110
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -2057,6 +2115,7 @@ var Action;
|
|
|
2057
2115
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
2058
2116
|
* or Liveboard.
|
|
2059
2117
|
* Copies the selected data point.
|
|
2118
|
+
*
|
|
2060
2119
|
* @example
|
|
2061
2120
|
* ```js
|
|
2062
2121
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -2074,6 +2133,7 @@ var Action;
|
|
|
2074
2133
|
* The **Drill down** menu action on Answers and Liveboard
|
|
2075
2134
|
* visualizations.
|
|
2076
2135
|
* Allows drilling down to a specific data point on a chart or table.
|
|
2136
|
+
*
|
|
2077
2137
|
* @example
|
|
2078
2138
|
* ```js
|
|
2079
2139
|
* disabledActions: [Action.DrillDown]
|
|
@@ -2083,6 +2143,7 @@ var Action;
|
|
|
2083
2143
|
/**
|
|
2084
2144
|
* The request access action on Liveboards.
|
|
2085
2145
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
2146
|
+
*
|
|
2086
2147
|
* @example
|
|
2087
2148
|
* ```js
|
|
2088
2149
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -2092,6 +2153,7 @@ var Action;
|
|
|
2092
2153
|
/**
|
|
2093
2154
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
2094
2155
|
* of the Answer page
|
|
2156
|
+
*
|
|
2095
2157
|
* @example
|
|
2096
2158
|
* ```js
|
|
2097
2159
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -2100,6 +2162,7 @@ var Action;
|
|
|
2100
2162
|
Action["QueryDetailsButtons"] = "QueryDetailsButtons";
|
|
2101
2163
|
/**
|
|
2102
2164
|
* The **Delete** action for Answers.
|
|
2165
|
+
*
|
|
2103
2166
|
* @example
|
|
2104
2167
|
* ```js
|
|
2105
2168
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -2109,6 +2172,7 @@ var Action;
|
|
|
2109
2172
|
Action["AnswerDelete"] = "onDeleteAnswer";
|
|
2110
2173
|
/**
|
|
2111
2174
|
* The Chart switcher icon on Answer and visualization pages.
|
|
2175
|
+
*
|
|
2112
2176
|
* @example
|
|
2113
2177
|
* ```js
|
|
2114
2178
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -2118,6 +2182,7 @@ var Action;
|
|
|
2118
2182
|
Action["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
2119
2183
|
/**
|
|
2120
2184
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
2185
|
+
*
|
|
2121
2186
|
* @example
|
|
2122
2187
|
* ```js
|
|
2123
2188
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -2127,6 +2192,7 @@ var Action;
|
|
|
2127
2192
|
Action["AddToFavorites"] = "addToFavorites";
|
|
2128
2193
|
/**
|
|
2129
2194
|
* The edit icon on Liveboards (Classic experience).
|
|
2195
|
+
*
|
|
2130
2196
|
* @example
|
|
2131
2197
|
* ```js
|
|
2132
2198
|
* disabledActions: [Action.EditDetails]
|
|
@@ -2136,6 +2202,7 @@ var Action;
|
|
|
2136
2202
|
Action["EditDetails"] = "editDetails";
|
|
2137
2203
|
/**
|
|
2138
2204
|
* The Create alert action on KPI charts.
|
|
2205
|
+
*
|
|
2139
2206
|
* @example
|
|
2140
2207
|
* ```js
|
|
2141
2208
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -2154,6 +2221,7 @@ var Action;
|
|
|
2154
2221
|
/**
|
|
2155
2222
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
2156
2223
|
* Allows sending data to a Google Sheet.
|
|
2224
|
+
*
|
|
2157
2225
|
* @example
|
|
2158
2226
|
* ```js
|
|
2159
2227
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -2165,6 +2233,7 @@ var Action;
|
|
|
2165
2233
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
2166
2234
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
2167
2235
|
* Microsoft Teams, and so on.
|
|
2236
|
+
*
|
|
2168
2237
|
* @example
|
|
2169
2238
|
* ```js
|
|
2170
2239
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2175,6 +2244,7 @@ var Action;
|
|
|
2175
2244
|
/**
|
|
2176
2245
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
2177
2246
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
2247
|
+
*
|
|
2178
2248
|
* @example
|
|
2179
2249
|
* ```js
|
|
2180
2250
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2185,6 +2255,7 @@ var Action;
|
|
|
2185
2255
|
/**
|
|
2186
2256
|
* The **Filter** action on Liveboard visualizations.
|
|
2187
2257
|
* Allows users to apply cross-filters on a Liveboard.
|
|
2258
|
+
*
|
|
2188
2259
|
* @example
|
|
2189
2260
|
* ```js
|
|
2190
2261
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -2196,6 +2267,7 @@ var Action;
|
|
|
2196
2267
|
* The **Remove** action that appears when cross filters are applied
|
|
2197
2268
|
* on a Liveboard.
|
|
2198
2269
|
* Removes filters applied o a visualization.
|
|
2270
|
+
*
|
|
2199
2271
|
* @example
|
|
2200
2272
|
* ```js
|
|
2201
2273
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -2207,6 +2279,7 @@ var Action;
|
|
|
2207
2279
|
* The **Aggregate** option in the chart axis or the
|
|
2208
2280
|
* table column customization menu.
|
|
2209
2281
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
2282
|
+
*
|
|
2210
2283
|
* @example
|
|
2211
2284
|
* ```js
|
|
2212
2285
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -2218,6 +2291,7 @@ var Action;
|
|
|
2218
2291
|
* The **Time bucket** option in the chart axis or table column
|
|
2219
2292
|
* customization menu.
|
|
2220
2293
|
* Allows defining time metric for date comparison.
|
|
2294
|
+
*
|
|
2221
2295
|
* @example
|
|
2222
2296
|
* ```js
|
|
2223
2297
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -2228,6 +2302,7 @@ var Action;
|
|
|
2228
2302
|
/**
|
|
2229
2303
|
* The **Filter** action in the chart axis or table column
|
|
2230
2304
|
* customization menu.
|
|
2305
|
+
*
|
|
2231
2306
|
* @example
|
|
2232
2307
|
* ```js
|
|
2233
2308
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -2239,6 +2314,7 @@ var Action;
|
|
|
2239
2314
|
* The **Conditional formatting** action on chart or table.
|
|
2240
2315
|
* Allows adding rules for conditional formatting of data
|
|
2241
2316
|
* points on a chart or table.
|
|
2317
|
+
*
|
|
2242
2318
|
* @example
|
|
2243
2319
|
* ```js
|
|
2244
2320
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -2250,6 +2326,7 @@ var Action;
|
|
|
2250
2326
|
* The **Sort** menu action on a table or chart axis
|
|
2251
2327
|
* Sorts data in ascending or descending order.
|
|
2252
2328
|
* Allows adding, editing, or removing filters.
|
|
2329
|
+
*
|
|
2253
2330
|
* @example
|
|
2254
2331
|
* ```js
|
|
2255
2332
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -2262,6 +2339,7 @@ var Action;
|
|
|
2262
2339
|
* customization menu.
|
|
2263
2340
|
* Allows grouping data points if the axes use the same
|
|
2264
2341
|
* unit of measurement and a similar scale.
|
|
2342
|
+
*
|
|
2265
2343
|
* @example
|
|
2266
2344
|
* ```js
|
|
2267
2345
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -2273,6 +2351,7 @@ var Action;
|
|
|
2273
2351
|
* The **Position** option in the axis customization menu.
|
|
2274
2352
|
* Allows changing the position of the axis to the
|
|
2275
2353
|
* left or right side of the chart.
|
|
2354
|
+
*
|
|
2276
2355
|
* @example
|
|
2277
2356
|
* ```js
|
|
2278
2357
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -2283,6 +2362,7 @@ var Action;
|
|
|
2283
2362
|
/**
|
|
2284
2363
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
2285
2364
|
* Renames the axis label on a chart or the column header on a table.
|
|
2365
|
+
*
|
|
2286
2366
|
* @example
|
|
2287
2367
|
* ```js
|
|
2288
2368
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -2294,6 +2374,7 @@ var Action;
|
|
|
2294
2374
|
* The **Edit** action in the axis customization menu.
|
|
2295
2375
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
2296
2376
|
* and format of a column.
|
|
2377
|
+
*
|
|
2297
2378
|
* @example
|
|
2298
2379
|
* ```js
|
|
2299
2380
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -2304,6 +2385,7 @@ var Action;
|
|
|
2304
2385
|
/**
|
|
2305
2386
|
* The **Number format** action to customize the format of
|
|
2306
2387
|
* the data labels on a chart or table.
|
|
2388
|
+
*
|
|
2307
2389
|
* @example
|
|
2308
2390
|
* ```js
|
|
2309
2391
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -2314,6 +2396,7 @@ var Action;
|
|
|
2314
2396
|
/**
|
|
2315
2397
|
* The **Text wrapping** action on a table.
|
|
2316
2398
|
* Wraps or clips column text on a table.
|
|
2399
|
+
*
|
|
2317
2400
|
* @example
|
|
2318
2401
|
* ```js
|
|
2319
2402
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -2326,6 +2409,7 @@ var Action;
|
|
|
2326
2409
|
* customization menu.
|
|
2327
2410
|
* Removes the data labels from a chart or the column of a
|
|
2328
2411
|
* table visualization.
|
|
2412
|
+
*
|
|
2329
2413
|
* @example
|
|
2330
2414
|
* ```js
|
|
2331
2415
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -2340,6 +2424,7 @@ var Action;
|
|
|
2340
2424
|
/**
|
|
2341
2425
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
2342
2426
|
* Allows renaming a Liveboard or visualization.
|
|
2427
|
+
*
|
|
2343
2428
|
* @example
|
|
2344
2429
|
* ```js
|
|
2345
2430
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -2356,13 +2441,29 @@ var Action;
|
|
|
2356
2441
|
*/
|
|
2357
2442
|
Action["MarkAsVerified"] = "markAsVerified";
|
|
2358
2443
|
/**
|
|
2359
|
-
* @version SDK: 1.
|
|
2444
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2360
2445
|
*/
|
|
2361
2446
|
Action["AddTab"] = "addTab";
|
|
2362
2447
|
/**
|
|
2363
2448
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2364
2449
|
*/
|
|
2365
2450
|
Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
|
|
2451
|
+
/**
|
|
2452
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2453
|
+
*/
|
|
2454
|
+
Action["ShowSageQuery"] = "showSageQuery";
|
|
2455
|
+
/**
|
|
2456
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2457
|
+
*/
|
|
2458
|
+
Action["EditSageAnswer"] = "editSageAnswer";
|
|
2459
|
+
/**
|
|
2460
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2461
|
+
*/
|
|
2462
|
+
Action["SageAnswerFeedback"] = "sageAnswerFeedback";
|
|
2463
|
+
/**
|
|
2464
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2465
|
+
*/
|
|
2466
|
+
Action["ModifySageAnswer"] = "modifySageAnswer";
|
|
2366
2467
|
})(Action || (Action = {}));
|
|
2367
2468
|
// eslint-disable-next-line no-shadow
|
|
2368
2469
|
var OperationType;
|
|
@@ -27874,6 +27975,10 @@ const renderInQueue = (fn) => {
|
|
|
27874
27975
|
// Sending an empty function to keep it consistent with the above usage.
|
|
27875
27976
|
return fn(() => { }); // eslint-disable-line @typescript-eslint/no-empty-function
|
|
27876
27977
|
};
|
|
27978
|
+
/**
|
|
27979
|
+
* @param data
|
|
27980
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
27981
|
+
*/
|
|
27877
27982
|
const executeTML = async (data) => {
|
|
27878
27983
|
const { thoughtSpotHost, authType } = config;
|
|
27879
27984
|
try {
|
|
@@ -27914,6 +28019,10 @@ const executeTML = async (data) => {
|
|
|
27914
28019
|
throw error;
|
|
27915
28020
|
});
|
|
27916
28021
|
};
|
|
28022
|
+
/**
|
|
28023
|
+
* @param data
|
|
28024
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
28025
|
+
*/
|
|
27917
28026
|
const exportTML = async (data) => {
|
|
27918
28027
|
const { thoughtSpotHost, authType } = config;
|
|
27919
28028
|
try {
|
|
@@ -28172,7 +28281,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
|
|
|
28172
28281
|
});
|
|
28173
28282
|
}
|
|
28174
28283
|
|
|
28175
|
-
var name="@thoughtspot/visual-embed-sdk";var version="1.23.
|
|
28284
|
+
var name="@thoughtspot/visual-embed-sdk";var version="1.23.1";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","eslint-plugin-comment-length":"^0.9.2","eslint-plugin-jsdoc":"^40.1.0",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
|
|
28176
28285
|
|
|
28177
28286
|
/**
|
|
28178
28287
|
* Copyright (c) 2022
|
|
@@ -28955,7 +29064,7 @@ var Page;
|
|
|
28955
29064
|
/**
|
|
28956
29065
|
* SpotIQ listing page
|
|
28957
29066
|
*/
|
|
28958
|
-
Page["SpotIQ"] = "
|
|
29067
|
+
Page["SpotIQ"] = "insights";
|
|
28959
29068
|
})(Page || (Page = {}));
|
|
28960
29069
|
/**
|
|
28961
29070
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -29499,14 +29608,15 @@ class SageEmbed extends V1Embed {
|
|
|
29499
29608
|
*/
|
|
29500
29609
|
getEmbedParams() {
|
|
29501
29610
|
var _a;
|
|
29502
|
-
const { showObjectResults, disableWorksheetChange, hideWorksheetSelector, showObjectSuggestions, } = this.viewConfig;
|
|
29503
|
-
const params =
|
|
29611
|
+
const { showObjectResults, disableWorksheetChange, hideWorksheetSelector, showObjectSuggestions, hideSampleQuestions, } = this.viewConfig;
|
|
29612
|
+
const params = this.getBaseQueryParams();
|
|
29504
29613
|
params[Param.EmbedApp] = true;
|
|
29505
29614
|
params[Param.HideEurekaResults] = !showObjectResults;
|
|
29506
29615
|
params[Param.IsSageEmbed] = true;
|
|
29507
29616
|
params[Param.DisableWorksheetChange] = !!disableWorksheetChange;
|
|
29508
29617
|
params[Param.HideWorksheetSelector] = !!hideWorksheetSelector;
|
|
29509
29618
|
params[Param.HideEurekaSuggestions] = !showObjectSuggestions;
|
|
29619
|
+
params[Param.HideSampleQuestions] = !hideSampleQuestions;
|
|
29510
29620
|
params[Param.HideActions] = [
|
|
29511
29621
|
...((_a = params[Param.HideActions]) !== null && _a !== void 0 ? _a : []),
|
|
29512
29622
|
...HiddenActionItemByDefaultForSageEmbed,
|
|
@@ -29521,8 +29631,16 @@ class SageEmbed extends V1Embed {
|
|
|
29521
29631
|
*/
|
|
29522
29632
|
getIFrameSrc() {
|
|
29523
29633
|
const path = 'eureka';
|
|
29634
|
+
const postHashObj = {};
|
|
29524
29635
|
const tsPostHashParams = this.getThoughtSpotPostUrlParams();
|
|
29525
|
-
|
|
29636
|
+
if (this.viewConfig.searchQuery)
|
|
29637
|
+
postHashObj[Param.Query] = this.viewConfig.searchQuery;
|
|
29638
|
+
if (this.viewConfig.dataSource)
|
|
29639
|
+
postHashObj[Param.WorksheetId] = this.viewConfig.dataSource;
|
|
29640
|
+
let sagePostHashParams = new URLSearchParams(postHashObj).toString();
|
|
29641
|
+
if (sagePostHashParams)
|
|
29642
|
+
sagePostHashParams = `${tsPostHashParams ? '&' : '?'}${sagePostHashParams}`;
|
|
29643
|
+
return `${this.getRootIframeSrc()}/embed/${path}${tsPostHashParams}${sagePostHashParams}`;
|
|
29526
29644
|
}
|
|
29527
29645
|
/**
|
|
29528
29646
|
* Render the embedded ThoughtSpot Sage
|