@thoughtspot/visual-embed-sdk 1.44.4 → 1.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +33 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +28 -7
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +10 -6
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +12 -2
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +3 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/embed.spec.js +1 -0
- package/cjs/src/embed/embed.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +32 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +10 -4
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +57 -33
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/pinboard.spec.js +1 -0
- package/cjs/src/embed/pinboard.spec.js.map +1 -1
- package/cjs/src/embed/search.d.ts +1 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +10 -2
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +12 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +7 -3
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +1 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +236 -158
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +198 -125
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +0 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +0 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.js +1 -1
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils/processTrigger.spec.js +12 -0
- package/cjs/src/utils/processTrigger.spec.js.map +1 -1
- package/dist/{index-C5FAW929.js → index-Dk-SLdNk.js} +1 -1
- package/dist/src/embed/app.d.ts +33 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +10 -6
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +32 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +1 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +236 -158
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +251 -145
- package/dist/tsembed-react.js +250 -144
- package/dist/tsembed.es.js +251 -145
- package/dist/tsembed.js +250 -144
- package/dist/visual-embed-sdk-react-full.d.ts +303 -146
- package/dist/visual-embed-sdk-react.d.ts +303 -146
- package/dist/visual-embed-sdk.d.ts +308 -163
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +33 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +10 -4
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +28 -7
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +10 -6
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +12 -2
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +3 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/embed.spec.js +1 -0
- package/lib/src/embed/embed.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +32 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +10 -4
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +57 -33
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +1 -0
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +1 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +10 -2
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +12 -0
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +7 -3
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +1 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +236 -158
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +198 -125
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +0 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +0 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.js +1 -1
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js +12 -0
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/package.json +1 -1
- package/src/embed/app.spec.ts +39 -7
- package/src/embed/app.ts +50 -6
- package/src/embed/conversation.spec.ts +3 -0
- package/src/embed/conversation.ts +22 -8
- package/src/embed/embed.spec.ts +1 -0
- package/src/embed/liveboard.spec.ts +77 -42
- package/src/embed/liveboard.ts +47 -5
- package/src/embed/pinboard.spec.ts +1 -0
- package/src/embed/search.spec.ts +16 -0
- package/src/embed/search.ts +12 -1
- package/src/embed/ts-embed.spec.ts +1 -0
- package/src/embed/ts-embed.ts +7 -3
- package/src/types.ts +263 -184
- package/src/utils/graphql/answerService/answer-queries.ts +0 -1
- package/src/utils/graphql/answerService/answerService.spec.ts +0 -1
- package/src/utils/processTrigger.spec.ts +18 -0
- package/src/utils/processTrigger.ts +1 -1
package/lib/src/types.js
CHANGED
|
@@ -343,7 +343,11 @@ export var HomepageModule;
|
|
|
343
343
|
export var ListPageColumns;
|
|
344
344
|
(function (ListPageColumns) {
|
|
345
345
|
/**
|
|
346
|
-
*
|
|
346
|
+
* Favorites
|
|
347
|
+
*/
|
|
348
|
+
ListPageColumns["Favorites"] = "FAVOURITE";
|
|
349
|
+
/**
|
|
350
|
+
* @deprecated Use {@link ListPageColumns.Favorites} instead.
|
|
347
351
|
*/
|
|
348
352
|
ListPageColumns["Favourite"] = "FAVOURITE";
|
|
349
353
|
/**
|
|
@@ -362,6 +366,10 @@ export var ListPageColumns;
|
|
|
362
366
|
* Share
|
|
363
367
|
*/
|
|
364
368
|
ListPageColumns["Share"] = "SHARE";
|
|
369
|
+
/**
|
|
370
|
+
* Verified badge/column
|
|
371
|
+
*/
|
|
372
|
+
ListPageColumns["Verified"] = "VERIFIED";
|
|
365
373
|
})(ListPageColumns || (ListPageColumns = {}));
|
|
366
374
|
/**
|
|
367
375
|
* Event types emitted by the embedded ThoughtSpot application.
|
|
@@ -578,7 +586,7 @@ export var EmbedEvent;
|
|
|
578
586
|
/**
|
|
579
587
|
* An error has occurred. This event is fired for the following error types:
|
|
580
588
|
*
|
|
581
|
-
* `API` - API call failure
|
|
589
|
+
* `API` - API call failure.
|
|
582
590
|
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
583
591
|
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
584
592
|
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
@@ -1309,20 +1317,20 @@ export var EmbedEvent;
|
|
|
1309
1317
|
/**
|
|
1310
1318
|
*
|
|
1311
1319
|
* This event can be emitted to intercept search execution initiated by
|
|
1312
|
-
*
|
|
1313
|
-
* You can
|
|
1320
|
+
* users and implement logic to allow or restrict search execution.
|
|
1321
|
+
* You can also show custom error text if the search query must be
|
|
1314
1322
|
* restricted due to your application or business requirements.
|
|
1315
1323
|
|
|
1316
1324
|
* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
1317
1325
|
* for this embed event to get emitted.
|
|
1318
|
-
* @param
|
|
1319
|
-
*
|
|
1320
|
-
* Contains elements that
|
|
1321
|
-
*
|
|
1322
|
-
*
|
|
1326
|
+
* @param - Includes the following event listener parameters:
|
|
1327
|
+
* - `payload`: The payload received from the embed related to the Data API call.
|
|
1328
|
+
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
1329
|
+
* should run the search, and if not, what error message
|
|
1330
|
+
* should be shown to the user.
|
|
1323
1331
|
*
|
|
1324
|
-
* `execute` - When execute returns `true`, the search will be run.
|
|
1325
|
-
* When execute returns `false`, the search will not be executed.
|
|
1332
|
+
* `execute` - When `execute` returns `true`, the search will be run.
|
|
1333
|
+
* When `execute` returns `false`, the search will not be executed.
|
|
1326
1334
|
*
|
|
1327
1335
|
* `error` - Developers can customize the error message text when `execute`
|
|
1328
1336
|
* is `false` using the `errorText` and `errorDescription` parameters in responder.
|
|
@@ -1494,7 +1502,7 @@ export var EmbedEvent;
|
|
|
1494
1502
|
* console.log('payload', payload);
|
|
1495
1503
|
* })
|
|
1496
1504
|
* ```
|
|
1497
|
-
* @version SDK: 1.
|
|
1505
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1498
1506
|
*/
|
|
1499
1507
|
EmbedEvent["DataModelInstructions"] = "DataModelInstructions";
|
|
1500
1508
|
/**
|
|
@@ -1713,14 +1721,14 @@ export var HostEvent;
|
|
|
1713
1721
|
* the search query string.
|
|
1714
1722
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
1715
1723
|
* Includes the following properties:
|
|
1716
|
-
* @param -
|
|
1717
|
-
*
|
|
1718
|
-
*
|
|
1719
|
-
*
|
|
1720
|
-
*
|
|
1724
|
+
* @param - Includes the following keys:
|
|
1725
|
+
* - `searchQuery`: Query string with search tokens.
|
|
1726
|
+
* - `dataSources`: Data source GUID to search on.
|
|
1727
|
+
* Although an array, only a single source is supported.
|
|
1728
|
+
* - `execute`: Executes search and updates the existing query.
|
|
1721
1729
|
* @example
|
|
1722
1730
|
* ```js
|
|
1723
|
-
*
|
|
1731
|
+
* searchEmbed.trigger(HostEvent.Search, {
|
|
1724
1732
|
searchQuery: "[sales] by [item type]",
|
|
1725
1733
|
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
1726
1734
|
execute: true
|
|
@@ -1731,16 +1739,15 @@ export var HostEvent;
|
|
|
1731
1739
|
/**
|
|
1732
1740
|
* Triggers a drill on certain points of the specified column
|
|
1733
1741
|
* Includes the following properties:
|
|
1734
|
-
* @param -
|
|
1735
|
-
*
|
|
1736
|
-
*
|
|
1737
|
-
*
|
|
1738
|
-
* column.
|
|
1739
|
-
*
|
|
1740
|
-
*
|
|
1741
|
-
*
|
|
1742
|
-
*
|
|
1743
|
-
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
1742
|
+
* @param - Includes the following keys:
|
|
1743
|
+
* - `points`: An object containing `selectedPoints` and/or `clickedPoint`
|
|
1744
|
+
* to drill to. For example, `{ selectedPoints: [] }`.
|
|
1745
|
+
* - `columnGuid`: Optional. GUID of the column to drill by. If not provided,
|
|
1746
|
+
* it will auto drill by the configured column.
|
|
1747
|
+
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
1748
|
+
* on the most popular column.
|
|
1749
|
+
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
1750
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
1744
1751
|
* @example
|
|
1745
1752
|
* ```js
|
|
1746
1753
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -1833,14 +1840,12 @@ export var HostEvent;
|
|
|
1833
1840
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
1834
1841
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
1835
1842
|
*
|
|
1836
|
-
* @param -
|
|
1837
|
-
* `columnName
|
|
1838
|
-
*
|
|
1839
|
-
*
|
|
1840
|
-
*
|
|
1841
|
-
*
|
|
1842
|
-
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
1843
|
-
* single value, whereas BW and IN accept multiple values.
|
|
1843
|
+
* @param - Array of {@link RuntimeFilter} objects. Each item includes:
|
|
1844
|
+
* - `columnName`: Name of the column to filter on.
|
|
1845
|
+
* - `operator`: {@link RuntimeFilterOp} to apply. For more information, see
|
|
1846
|
+
* link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
1847
|
+
* - `values`: List of operands. Some operators such as EQ and LE allow a single
|
|
1848
|
+
* value, whereas BW and IN accept multiple values.
|
|
1844
1849
|
*
|
|
1845
1850
|
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
1846
1851
|
* object to its original state and applies new filter conditions.
|
|
@@ -1863,7 +1868,7 @@ export var HostEvent;
|
|
|
1863
1868
|
/**
|
|
1864
1869
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
1865
1870
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
1866
|
-
* @param - `path` - the path to navigate to
|
|
1871
|
+
* @param - `path` - the path to navigate to go forward or back. The path value can
|
|
1867
1872
|
* be a number; for example, `1`, `-1`.
|
|
1868
1873
|
* @example
|
|
1869
1874
|
* ```js
|
|
@@ -1934,30 +1939,25 @@ export var HostEvent;
|
|
|
1934
1939
|
* for the Answer that the user is currently on
|
|
1935
1940
|
* and a modal opens for Liveboard selection.
|
|
1936
1941
|
* To add an Answer or visualization to a Liveboard programmatically without
|
|
1937
|
-
*
|
|
1942
|
+
* requiring additional user input via the *Pin to Liveboard* modal, define
|
|
1938
1943
|
* the following parameters:
|
|
1939
1944
|
*
|
|
1940
|
-
* @param
|
|
1941
|
-
* `vizId
|
|
1942
|
-
*
|
|
1943
|
-
*
|
|
1944
|
-
*
|
|
1945
|
-
* `
|
|
1946
|
-
*
|
|
1947
|
-
*
|
|
1948
|
-
*
|
|
1949
|
-
*
|
|
1950
|
-
*
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1953
|
-
*
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1956
|
-
* `newLiveboardName` - Name string for the Liveboard.
|
|
1957
|
-
* Creates a new Liveboard object with the specified name.
|
|
1958
|
-
* @param
|
|
1959
|
-
* `newTabName` - Name of the tab. Adds a new tab Liveboard specified
|
|
1960
|
-
* in the code.
|
|
1945
|
+
* @param - Includes the following keys:
|
|
1946
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
|
|
1947
|
+
* Optional when pinning a new chart or table generated from a Search query.
|
|
1948
|
+
* **Required** in Spotter Embed.
|
|
1949
|
+
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
1950
|
+
* specify the `newLiveboardName` parameter to create a new Liveboard.
|
|
1951
|
+
* - `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab
|
|
1952
|
+
* specified in the code.
|
|
1953
|
+
* - `newVizName`: Name string for the Answer or visualization. If defined,
|
|
1954
|
+
* this parameter adds a new visualization object or creates a copy of the
|
|
1955
|
+
* Answer or visualization specified in `vizId`.
|
|
1956
|
+
* Required.
|
|
1957
|
+
* - `newLiveboardName`: Name string for the Liveboard.
|
|
1958
|
+
* Creates a new Liveboard object with the specified name.
|
|
1959
|
+
* - `newTabName`: Name of the tab. Adds a new tab Liveboard specified
|
|
1960
|
+
* in the code.
|
|
1961
1961
|
*
|
|
1962
1962
|
* @example
|
|
1963
1963
|
* ```js
|
|
@@ -2197,9 +2197,9 @@ export var HostEvent;
|
|
|
2197
2197
|
* on a Liveboard.
|
|
2198
2198
|
*
|
|
2199
2199
|
* This event is not supported in visualization embed and search embed.
|
|
2200
|
-
* @param -
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2200
|
+
* @param - Object parameter. Includes the following keys:
|
|
2201
|
+
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
2202
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
|
|
2203
2203
|
*
|
|
2204
2204
|
* @example
|
|
2205
2205
|
* ```js
|
|
@@ -2566,10 +2566,9 @@ export var HostEvent;
|
|
|
2566
2566
|
HostEvent["GetFilters"] = "getFilters";
|
|
2567
2567
|
/**
|
|
2568
2568
|
* Update one or several filters applied on a Liveboard.
|
|
2569
|
-
* @param -
|
|
2570
|
-
* filter operator, and values.
|
|
2571
|
-
*
|
|
2572
|
-
* and values for each.
|
|
2569
|
+
* @param - Includes the following keys:
|
|
2570
|
+
* - `filter`: A single filter object containing column name, filter operator, and values.
|
|
2571
|
+
* - `filters`: Multiple filter objects with column name, filter operator, and values for each.
|
|
2573
2572
|
*
|
|
2574
2573
|
* Each filter object must include the following attributes:
|
|
2575
2574
|
*
|
|
@@ -2695,8 +2694,9 @@ export var HostEvent;
|
|
|
2695
2694
|
HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
|
|
2696
2695
|
/**
|
|
2697
2696
|
* Updates the search query string for Natural Language Search operations.
|
|
2698
|
-
* @param -
|
|
2699
|
-
*
|
|
2697
|
+
* @param - Includes the following keys:
|
|
2698
|
+
* - `queryString`: Text string in Natural Language format.
|
|
2699
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
2700
2700
|
* @example
|
|
2701
2701
|
* ```js
|
|
2702
2702
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -2775,11 +2775,10 @@ export var HostEvent;
|
|
|
2775
2775
|
/**
|
|
2776
2776
|
* Triggers an action to update Parameter values on embedded
|
|
2777
2777
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
2778
|
-
* @param -
|
|
2779
|
-
*
|
|
2780
|
-
*
|
|
2781
|
-
*
|
|
2782
|
-
* use the `isVisibleToUser` attribute when applying an override.
|
|
2778
|
+
* @param - Includes the following keys for each item:
|
|
2779
|
+
* - `name`: Name of the parameter.
|
|
2780
|
+
* - `value`: The value to set for the parameter.
|
|
2781
|
+
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
2783
2782
|
*
|
|
2784
2783
|
* @example
|
|
2785
2784
|
* ```js
|
|
@@ -2837,11 +2836,10 @@ export var HostEvent;
|
|
|
2837
2836
|
* If no parameters are specified, the save action is
|
|
2838
2837
|
* triggered with a modal to prompt users to
|
|
2839
2838
|
* add a name and description for the Answer.
|
|
2840
|
-
* @param -
|
|
2841
|
-
* and is required in Spotter embed.
|
|
2842
|
-
* Optional
|
|
2843
|
-
*
|
|
2844
|
-
* @param - `description` - Description text for the Answer.
|
|
2839
|
+
* @param - Includes the following keys:
|
|
2840
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
|
|
2841
|
+
* - `name`: Optional. Name string for the Answer.
|
|
2842
|
+
* - `description`: Optional. Description text for the Answer.
|
|
2845
2843
|
* @example
|
|
2846
2844
|
* ```js
|
|
2847
2845
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -2890,8 +2888,9 @@ export var HostEvent;
|
|
|
2890
2888
|
/**
|
|
2891
2889
|
* Triggers a search operation with the search tokens specified in
|
|
2892
2890
|
* the search query string in spotter embed.
|
|
2893
|
-
* @param -
|
|
2894
|
-
*
|
|
2891
|
+
* @param - Includes the following keys:
|
|
2892
|
+
* - `query`: Text string in Natural Language format.
|
|
2893
|
+
* - `executeSearch`: Boolean to execute search and update search query.
|
|
2895
2894
|
* @example
|
|
2896
2895
|
* ```js
|
|
2897
2896
|
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
@@ -2938,7 +2937,7 @@ export var HostEvent;
|
|
|
2938
2937
|
* ```js
|
|
2939
2938
|
* spotterEmbed.trigger(HostEvent.DataModelInstructions);
|
|
2940
2939
|
* ```
|
|
2941
|
-
* @version SDK: 1.
|
|
2940
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
2942
2941
|
*/
|
|
2943
2942
|
HostEvent["DataModelInstructions"] = "DataModelInstructions";
|
|
2944
2943
|
/**
|
|
@@ -3023,7 +3022,7 @@ export var HostEvent;
|
|
|
3023
3022
|
*/
|
|
3024
3023
|
HostEvent["UpdateEmbedParams"] = "updateEmbedParams";
|
|
3025
3024
|
/**
|
|
3026
|
-
* Triggered when the embed
|
|
3025
|
+
* Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.
|
|
3027
3026
|
* @example
|
|
3028
3027
|
* ```js
|
|
3029
3028
|
* liveboardEmbed.trigger(HostEvent.DestroyEmbed);
|
|
@@ -3031,11 +3030,12 @@ export var HostEvent;
|
|
|
3031
3030
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
3032
3031
|
*/
|
|
3033
3032
|
HostEvent["DestroyEmbed"] = "EmbedDestroyed";
|
|
3034
|
-
/**
|
|
3035
|
-
*
|
|
3036
|
-
*
|
|
3033
|
+
/**
|
|
3034
|
+
* Triggers a new conversation in Spotter embed.
|
|
3035
|
+
*
|
|
3037
3036
|
* This feature is available only when chat history is enabled on your ThoughtSpot instance.
|
|
3038
3037
|
* Contact your admin or ThoughtSpot Support to enable chat history on your instance.
|
|
3038
|
+
*
|
|
3039
3039
|
* @example
|
|
3040
3040
|
* ```js
|
|
3041
3041
|
* spotterEmbed.trigger(HostEvent.StartNewSpotterConversation);
|
|
@@ -3192,12 +3192,14 @@ export var Param;
|
|
|
3192
3192
|
Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
|
|
3193
3193
|
Param["IsLazyLoadingForEmbedEnabled"] = "isLazyLoadingForEmbedEnabled";
|
|
3194
3194
|
Param["RootMarginForLazyLoad"] = "rootMarginForLazyLoad";
|
|
3195
|
-
Param["LiveboardXLSXCSVDownload"] = "isLiveboardXLSXCSVDownloadEnabled";
|
|
3196
3195
|
Param["isPNGInScheduledEmailsEnabled"] = "isPNGInScheduledEmailsEnabled";
|
|
3196
|
+
Param["isLiveboardXLSXCSVDownloadEnabled"] = "isLiveboardXLSXCSVDownloadEnabled";
|
|
3197
|
+
Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
|
|
3197
3198
|
Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
|
|
3198
3199
|
Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
|
|
3199
3200
|
Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
|
|
3200
3201
|
Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
|
|
3202
|
+
Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
|
|
3201
3203
|
})(Param || (Param = {}));
|
|
3202
3204
|
/**
|
|
3203
3205
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3210,7 +3212,7 @@ export var Param;
|
|
|
3210
3212
|
* ```js
|
|
3211
3213
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
3212
3214
|
* ... //other embed view config
|
|
3213
|
-
* visibleActions: [Action.Save, Action.Edit, Action.Present,
|
|
3215
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
|
|
3214
3216
|
* disabledActions: [Action.Download],
|
|
3215
3217
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
3216
3218
|
* })
|
|
@@ -3221,10 +3223,10 @@ export var Param;
|
|
|
3221
3223
|
* ... //other embed view config
|
|
3222
3224
|
* //visibleActions: [],
|
|
3223
3225
|
* disabledActions: [Action.Download],
|
|
3224
|
-
* hiddenActions: [Action.Edit,
|
|
3226
|
+
* hiddenActions: [Action.Edit, Action.Explore],
|
|
3225
3227
|
* })
|
|
3226
3228
|
* ```
|
|
3227
|
-
* See also link:https://developers.thoughtspot.com/docs/actions[
|
|
3229
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].
|
|
3228
3230
|
*/
|
|
3229
3231
|
export var Action;
|
|
3230
3232
|
(function (Action) {
|
|
@@ -3512,6 +3514,16 @@ export var Action;
|
|
|
3512
3514
|
* ```
|
|
3513
3515
|
*/
|
|
3514
3516
|
Action["DownloadAsXlsx"] = "downloadAsXLSX";
|
|
3517
|
+
/**
|
|
3518
|
+
* The **Download Liveboard** menu action on a Liveboard.
|
|
3519
|
+
* Allows downloading the entire Liveboard.
|
|
3520
|
+
* @example
|
|
3521
|
+
* ```js
|
|
3522
|
+
* disabledActions: [Action.DownloadLiveboard]
|
|
3523
|
+
* ```
|
|
3524
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3525
|
+
*/
|
|
3526
|
+
Action["DownloadLiveboard"] = "downloadLiveboard";
|
|
3515
3527
|
/**
|
|
3516
3528
|
* @hidden
|
|
3517
3529
|
*/
|
|
@@ -3731,13 +3743,15 @@ export var Action;
|
|
|
3731
3743
|
*/
|
|
3732
3744
|
Action["RequestAccess"] = "requestAccess";
|
|
3733
3745
|
/**
|
|
3734
|
-
*
|
|
3735
|
-
* Query details panel
|
|
3746
|
+
* Controls the display and availability of the **Query visualizer** and
|
|
3747
|
+
* **Query SQL** buttons in the Query details panel on the Answer page.
|
|
3736
3748
|
*
|
|
3737
|
-
* **Query visualizer** - Displays the tables
|
|
3738
|
-
*
|
|
3739
|
-
*
|
|
3740
|
-
*
|
|
3749
|
+
* **Query visualizer** - Displays the tables and filters used in the search query.
|
|
3750
|
+
* **Query SQL** - Displays the SQL statements used to retrieve data for the query.
|
|
3751
|
+
*
|
|
3752
|
+
* Note: This action ID only affects the visibility of the buttons within the
|
|
3753
|
+
* Query details panel. It does not control the visibility
|
|
3754
|
+
* of the query details icon on the Answer page.
|
|
3741
3755
|
* @example
|
|
3742
3756
|
* ```js
|
|
3743
3757
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3851,28 +3865,28 @@ export var Action;
|
|
|
3851
3865
|
Action["CrossFilter"] = "context-menu-item-cross-filter";
|
|
3852
3866
|
/**
|
|
3853
3867
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
3854
|
-
* Allows sending data to third-party apps Slack
|
|
3868
|
+
* Allows sending data to third-party apps like Slack.
|
|
3855
3869
|
* @example
|
|
3856
3870
|
* ```js
|
|
3857
3871
|
* disabledActions: [Action.SyncToSlack]
|
|
3858
3872
|
* ```
|
|
3859
|
-
* @version
|
|
3873
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
3860
3874
|
*/
|
|
3861
3875
|
Action["SyncToSlack"] = "syncToSlack";
|
|
3862
3876
|
/**
|
|
3863
3877
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
3864
|
-
* Allows sending data to third-party apps
|
|
3878
|
+
* Allows sending data to third-party apps like Microsoft Teams.
|
|
3865
3879
|
* @example
|
|
3866
3880
|
* ```js
|
|
3867
3881
|
* disabledActions: [Action.SyncToTeams]
|
|
3868
3882
|
* ```
|
|
3869
|
-
* @version
|
|
3883
|
+
* @version SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
3870
3884
|
*/
|
|
3871
3885
|
Action["SyncToTeams"] = "syncToTeams";
|
|
3872
3886
|
/**
|
|
3873
3887
|
* The **Remove** action that appears when cross filters are applied
|
|
3874
3888
|
* on a Liveboard.
|
|
3875
|
-
* Removes filters applied
|
|
3889
|
+
* Removes filters applied to a visualization.
|
|
3876
3890
|
* @example
|
|
3877
3891
|
* ```js
|
|
3878
3892
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -4058,7 +4072,7 @@ export var Action;
|
|
|
4058
4072
|
Action["AddTab"] = "addTab";
|
|
4059
4073
|
/**
|
|
4060
4074
|
*
|
|
4061
|
-
*Initiates contextual change analysis on KPI charts.
|
|
4075
|
+
* Initiates contextual change analysis on KPI charts.
|
|
4062
4076
|
* @example
|
|
4063
4077
|
* ```js
|
|
4064
4078
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
@@ -4068,7 +4082,7 @@ export var Action;
|
|
|
4068
4082
|
Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
|
|
4069
4083
|
/**
|
|
4070
4084
|
* Action ID to hide or disable Iterative Change Analysis option
|
|
4071
|
-
*
|
|
4085
|
+
* in the contextual change analysis Insight charts context menu.
|
|
4072
4086
|
*
|
|
4073
4087
|
* @example
|
|
4074
4088
|
* ```js
|
|
@@ -4346,6 +4360,17 @@ export var Action;
|
|
|
4346
4360
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4347
4361
|
*/
|
|
4348
4362
|
Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
|
|
4363
|
+
/**
|
|
4364
|
+
* The **Data model instructions** button on the Spotter interface.
|
|
4365
|
+
* Allows opening the data model instructions modal.
|
|
4366
|
+
*
|
|
4367
|
+
* @example
|
|
4368
|
+
* ```js
|
|
4369
|
+
* hiddenAction: [Action.DataModelInstructions]
|
|
4370
|
+
* ```
|
|
4371
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
4372
|
+
*/
|
|
4373
|
+
Action["DataModelInstructions"] = "DataModelInstructions";
|
|
4349
4374
|
/**
|
|
4350
4375
|
* The **Preview data** button on the Spotter interface.
|
|
4351
4376
|
* Allows previewing the data used for Spotter queries.
|
|
@@ -4431,12 +4456,11 @@ export var Action;
|
|
|
4431
4456
|
*/
|
|
4432
4457
|
Action["CoverAndFilterOptionInPDF"] = "coverAndFilterOptionInPDF";
|
|
4433
4458
|
/**
|
|
4434
|
-
|
|
4435
|
-
|
|
4436
|
-
|
|
4437
|
-
|
|
4438
|
-
|
|
4439
|
-
* contact ThoughtSpot Support.
|
|
4459
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
4460
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
4461
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
4462
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
4463
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
4440
4464
|
* @example
|
|
4441
4465
|
* ```js
|
|
4442
4466
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -4512,6 +4536,55 @@ export var Action;
|
|
|
4512
4536
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
4513
4537
|
*/
|
|
4514
4538
|
Action["LiveboardStylePanel"] = "liveboardStylePanel";
|
|
4539
|
+
/**
|
|
4540
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
4541
|
+
* Opens the publishing modal. It's a parent action for the
|
|
4542
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
4543
|
+
* is already published, otherwise appears standalone.
|
|
4544
|
+
* @example
|
|
4545
|
+
* ```js
|
|
4546
|
+
* hiddenActions: [Action.Publish]
|
|
4547
|
+
* disabledActions: [Action.Publish]
|
|
4548
|
+
* ```
|
|
4549
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
4550
|
+
*/
|
|
4551
|
+
Action["Publish"] = "publish";
|
|
4552
|
+
/**
|
|
4553
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
4554
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
4555
|
+
* Appears as a child action to the **Publish** action if the
|
|
4556
|
+
* object is already published.
|
|
4557
|
+
* @example
|
|
4558
|
+
* ```js
|
|
4559
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
4560
|
+
* disabledActions: [Action.ManagePublishing]
|
|
4561
|
+
* ```
|
|
4562
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
4563
|
+
*/
|
|
4564
|
+
Action["ManagePublishing"] = "managePublishing";
|
|
4565
|
+
/**
|
|
4566
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
4567
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
4568
|
+
* the **Publish** action if the object is already published.
|
|
4569
|
+
* @example
|
|
4570
|
+
* ```js
|
|
4571
|
+
* hiddenActions: [Action.Unpublish]
|
|
4572
|
+
* disabledActions: [Action.Unpublish]
|
|
4573
|
+
* ```
|
|
4574
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
4575
|
+
*/
|
|
4576
|
+
Action["Unpublish"] = "unpublish";
|
|
4577
|
+
/**
|
|
4578
|
+
* The **Parameterize** action for Tables and Connections.
|
|
4579
|
+
* Opens the parameterization modal.
|
|
4580
|
+
* @example
|
|
4581
|
+
* ```js
|
|
4582
|
+
* hiddenActions: [Action.Parameterize]
|
|
4583
|
+
* disabledActions: [Action.Parameterize]
|
|
4584
|
+
* ```
|
|
4585
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
4586
|
+
*/
|
|
4587
|
+
Action["Parameterize"] = "parameterise";
|
|
4515
4588
|
/**
|
|
4516
4589
|
* The **Move to Group** menu action on a Liveboard.
|
|
4517
4590
|
* Allows moving a visualization to a different group.
|
|
@@ -4552,6 +4625,18 @@ export var Action;
|
|
|
4552
4625
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
4553
4626
|
*/
|
|
4554
4627
|
Action["UngroupLiveboardGroup"] = "ungroupLiveboardGroup";
|
|
4628
|
+
/**
|
|
4629
|
+
* The **Include current period** checkbox for date filters.
|
|
4630
|
+
* Controls the visibility and availability of the option to include
|
|
4631
|
+
* the current time period in filter results.
|
|
4632
|
+
* @example
|
|
4633
|
+
* ```js
|
|
4634
|
+
* hiddenActions: [Action.IncludeCurrentPeriod]
|
|
4635
|
+
* disabledActions: [Action.IncludeCurrentPeriod]
|
|
4636
|
+
* ```
|
|
4637
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
4638
|
+
*/
|
|
4639
|
+
Action["IncludeCurrentPeriod"] = "includeCurrentPeriod";
|
|
4555
4640
|
})(Action || (Action = {}));
|
|
4556
4641
|
export var PrefetchFeatures;
|
|
4557
4642
|
(function (PrefetchFeatures) {
|
|
@@ -4696,31 +4781,19 @@ export var ErrorDetailsTypes;
|
|
|
4696
4781
|
ErrorDetailsTypes["NETWORK"] = "NETWORK";
|
|
4697
4782
|
})(ErrorDetailsTypes || (ErrorDetailsTypes = {}));
|
|
4698
4783
|
/**
|
|
4699
|
-
*
|
|
4700
|
-
*
|
|
4701
|
-
* These codes provide granular identification of errors that occur in embedded components.
|
|
4702
|
-
* They are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for
|
|
4703
|
-
* precise error handling and debugging.
|
|
4784
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components.
|
|
4704
4785
|
*
|
|
4705
|
-
*
|
|
4706
|
-
*
|
|
4707
|
-
* - **Liveboard ID missing**: Errors related to missing liveboard ID
|
|
4708
|
-
* - **Conflicting actions configuration**: Errors related to conflicting actions configuration
|
|
4709
|
-
* - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
|
|
4710
|
-
* - **Initialization error**: Errors related to initialization error
|
|
4711
|
-
* - **Network error**: Errors related to network error
|
|
4712
|
-
* - **Custom action validation**: Errors related to custom action validation
|
|
4713
|
-
* - **Login failed**: Errors related to login failed
|
|
4714
|
-
* - **Render not called**: Errors related to render not called
|
|
4715
|
-
* - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
|
|
4786
|
+
* Use these codes for precise error handling and debugging. Each code maps to a
|
|
4787
|
+
* distinct failure scenario, enabling targeted recovery strategies.
|
|
4716
4788
|
*
|
|
4717
4789
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
4718
4790
|
* @group Error Handling
|
|
4791
|
+
*
|
|
4719
4792
|
* @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
|
|
4720
4793
|
* @see {@link ErrorDetailsTypes} - General error type categories
|
|
4721
4794
|
*
|
|
4722
4795
|
* @example
|
|
4723
|
-
* Handle specific error codes
|
|
4796
|
+
* Handle specific error codes in the error event handler
|
|
4724
4797
|
*
|
|
4725
4798
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
4726
4799
|
* if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
|