@thoughtspot/visual-embed-sdk 1.46.3 → 1.46.5-beta.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 +3 -3
- package/cjs/src/auth.d.ts +2 -1
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +2 -1
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/css-variables.d.ts +51 -17
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +1 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +46 -1
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +72 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +74 -3
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +7 -0
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +10 -0
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +46 -9
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +155 -0
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +1 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +11 -2
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +96 -2
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +41 -2
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +41 -2
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +58 -53
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/types.d.ts +730 -32
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +734 -3
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +4 -2
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/preview-service.d.ts.map +1 -1
- package/cjs/src/utils/graphql/preview-service.js.map +1 -1
- package/cjs/src/utils/processData.d.ts.map +1 -1
- package/cjs/src/utils/processData.js.map +1 -1
- package/dist/{index-DyX-x6uN.js → index-DW2wEHqy.js} +1 -1
- package/dist/src/auth.d.ts +2 -1
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +51 -17
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +1 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +74 -3
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +10 -0
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +1 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +41 -2
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +730 -32
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/graphql/preview-service.d.ts.map +1 -1
- package/dist/src/utils/processData.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +917 -77
- package/dist/tsembed-react.js +915 -75
- package/dist/tsembed.es.js +859 -24
- package/dist/tsembed.js +857 -22
- package/dist/visual-embed-sdk-react-full.d.ts +892 -54
- package/dist/visual-embed-sdk-react.d.ts +892 -54
- package/dist/visual-embed-sdk.d.ts +912 -56
- package/lib/package.json +3 -3
- package/lib/src/auth.d.ts +2 -1
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +2 -1
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/css-variables.d.ts +51 -17
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +1 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +10 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +46 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +73 -1
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +74 -3
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +7 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +10 -0
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +46 -9
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +155 -0
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +1 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +11 -2
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +96 -2
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +41 -2
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +42 -3
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +58 -53
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/types.d.ts +730 -32
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +734 -3
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +4 -2
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/preview-service.d.ts.map +1 -1
- package/lib/src/utils/graphql/preview-service.js.map +1 -1
- package/lib/src/utils/processData.d.ts.map +1 -1
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +973 -116
- package/package.json +3 -3
- package/src/auth.spec.ts +1 -1
- package/src/auth.ts +2 -1
- package/src/authToken.ts +0 -1
- package/src/css-variables.ts +51 -17
- package/src/embed/app.spec.ts +62 -3
- package/src/embed/app.ts +10 -1
- package/src/embed/base.spec.ts +1 -2
- package/src/embed/base.ts +1 -4
- package/src/embed/events.spec.ts +88 -0
- package/src/embed/hostEventClient/contracts.ts +74 -2
- package/src/embed/hostEventClient/host-event-client.spec.ts +257 -0
- package/src/embed/hostEventClient/host-event-client.ts +70 -15
- package/src/embed/liveboard.spec.ts +126 -2
- package/src/embed/liveboard.ts +11 -2
- package/src/embed/sage.ts +0 -1
- package/src/embed/search.spec.ts +0 -2
- package/src/embed/ts-embed.ts +43 -3
- package/src/react/index.tsx +76 -72
- package/src/types.ts +739 -31
- package/src/utils/graphql/answerService/answerService.ts +4 -5
- package/src/utils/graphql/preview-service.ts +0 -1
- package/src/utils/processData.ts +0 -5
package/lib/src/types.js
CHANGED
|
@@ -53,6 +53,7 @@ export var AuthType;
|
|
|
53
53
|
* @deprecated This option is deprecated.
|
|
54
54
|
* @hidden
|
|
55
55
|
*/
|
|
56
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
56
57
|
AuthType["SAML"] = "SSO_SAML";
|
|
57
58
|
/**
|
|
58
59
|
* SSO using SAML
|
|
@@ -98,6 +99,7 @@ export var AuthType;
|
|
|
98
99
|
* });
|
|
99
100
|
* ```
|
|
100
101
|
*/
|
|
102
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
101
103
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
102
104
|
/**
|
|
103
105
|
* SSO using OIDC
|
|
@@ -111,6 +113,7 @@ export var AuthType;
|
|
|
111
113
|
* Will make the host application redirect to the OIDC IdP.
|
|
112
114
|
* See code samples in {@link SAMLRedirect}.
|
|
113
115
|
*/
|
|
116
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
114
117
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
115
118
|
/**
|
|
116
119
|
* Trusted authentication server
|
|
@@ -136,6 +139,7 @@ export var AuthType;
|
|
|
136
139
|
* });
|
|
137
140
|
* ```
|
|
138
141
|
*/
|
|
142
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
139
143
|
AuthType["TrustedAuthToken"] = "AuthServer";
|
|
140
144
|
/**
|
|
141
145
|
* Trusted authentication server Cookieless, Use your own authentication
|
|
@@ -1275,22 +1279,45 @@ export var EmbedEvent;
|
|
|
1275
1279
|
/**
|
|
1276
1280
|
* Emitted when name, status (private or public) or filter values of a
|
|
1277
1281
|
* Personalised view is updated.
|
|
1282
|
+
* This event is deprecated. Use {@link EmbedEvent.UpdatePersonalizedView} instead.
|
|
1278
1283
|
* @returns viewName: string
|
|
1279
1284
|
* @returns viewId: string
|
|
1280
1285
|
* @returns liveboardId: string
|
|
1281
1286
|
* @returns isPublic: boolean
|
|
1282
1287
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1288
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1283
1289
|
*/
|
|
1284
1290
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1291
|
+
/**
|
|
1292
|
+
* Emitted when name, status (private or public) or filter values of a
|
|
1293
|
+
* Personalized view is updated.
|
|
1294
|
+
* @returns viewName: string
|
|
1295
|
+
* @returns viewId: string
|
|
1296
|
+
* @returns liveboardId: string
|
|
1297
|
+
* @returns isPublic: boolean
|
|
1298
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1299
|
+
*/
|
|
1300
|
+
EmbedEvent["UpdatePersonalizedView"] = "updatePersonalisedView";
|
|
1285
1301
|
/**
|
|
1286
1302
|
* Emitted when a Personalised view is saved.
|
|
1303
|
+
* This event is deprecated. Use {@link EmbedEvent.SavePersonalizedView} instead.
|
|
1287
1304
|
* @returns viewName: string
|
|
1288
1305
|
* @returns viewId: string
|
|
1289
1306
|
* @returns liveboardId: string
|
|
1290
1307
|
* @returns isPublic: boolean
|
|
1291
1308
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1309
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1292
1310
|
*/
|
|
1293
1311
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1312
|
+
/**
|
|
1313
|
+
* Emitted when a Personalized view is saved.
|
|
1314
|
+
* @returns viewName: string
|
|
1315
|
+
* @returns viewId: string
|
|
1316
|
+
* @returns liveboardId: string
|
|
1317
|
+
* @returns isPublic: boolean
|
|
1318
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1319
|
+
*/
|
|
1320
|
+
EmbedEvent["SavePersonalizedView"] = "savePersonalisedView";
|
|
1294
1321
|
/**
|
|
1295
1322
|
* Emitted when a Liveboard is reset.
|
|
1296
1323
|
* @returns viewName: string
|
|
@@ -1302,11 +1329,41 @@ export var EmbedEvent;
|
|
|
1302
1329
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1303
1330
|
/**
|
|
1304
1331
|
* Emitted when a PersonalisedView is deleted.
|
|
1332
|
+
* This event is deprecated. Use {@link EmbedEvent.DeletePersonalizedView} instead.
|
|
1305
1333
|
* @returns views: string[]
|
|
1306
1334
|
* @returns liveboardId: string
|
|
1307
1335
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1336
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1308
1337
|
*/
|
|
1309
1338
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1339
|
+
/**
|
|
1340
|
+
* Emitted when a PersonalizedView is deleted.
|
|
1341
|
+
* @returns views: string[]
|
|
1342
|
+
* @returns liveboardId: string
|
|
1343
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1344
|
+
*/
|
|
1345
|
+
EmbedEvent["DeletePersonalizedView"] = "deletePersonalisedView";
|
|
1346
|
+
/**
|
|
1347
|
+
* Emitted when a user selects a different Personalized View or
|
|
1348
|
+
* resets to the original/default view on a Liveboard.
|
|
1349
|
+
* @example
|
|
1350
|
+
* ```js
|
|
1351
|
+
* liveboardEmbed.on(EmbedEvent.ChangePersonalizedView, (data) => {
|
|
1352
|
+
* console.log(data.viewName); // 'Q4 Revenue' or 'Original View'
|
|
1353
|
+
* console.log(data.viewId); // '2a021a12-...' or null (default)
|
|
1354
|
+
* console.log(data.liveboardId); // 'abc123...'
|
|
1355
|
+
* console.log(data.isPublic); // true | false
|
|
1356
|
+
* })
|
|
1357
|
+
* ```
|
|
1358
|
+
* @returns viewName: string - Name of the selected view,
|
|
1359
|
+
* or 'Original View' when reset to default.
|
|
1360
|
+
* @returns viewId: string | null - GUID of the selected view,
|
|
1361
|
+
* or null when reset to default.
|
|
1362
|
+
* @returns liveboardId: string
|
|
1363
|
+
* @returns isPublic: boolean
|
|
1364
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
1365
|
+
*/
|
|
1366
|
+
EmbedEvent["ChangePersonalizedView"] = "changePersonalisedView";
|
|
1310
1367
|
/**
|
|
1311
1368
|
* Emitted when a user creates a Worksheet.
|
|
1312
1369
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
@@ -1340,7 +1397,8 @@ export var EmbedEvent;
|
|
|
1340
1397
|
* @param - Includes the following parameters:
|
|
1341
1398
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
1342
1399
|
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
1343
|
-
* will run or block the search operation, and if blocked, which error message to
|
|
1400
|
+
* will run or block the search operation, and if blocked, which error message to
|
|
1401
|
+
* provide.
|
|
1344
1402
|
* - `execute` - When `execute` returns `true`, the search is run.
|
|
1345
1403
|
* When `execute` returns `false`, the search is not executed.
|
|
1346
1404
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
@@ -1774,6 +1832,25 @@ export var EmbedEvent;
|
|
|
1774
1832
|
* );
|
|
1775
1833
|
* }
|
|
1776
1834
|
* ```
|
|
1835
|
+
*
|
|
1836
|
+
* **Context Parameter (SDK: 1.45.2+)**
|
|
1837
|
+
*
|
|
1838
|
+
* Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a
|
|
1839
|
+
* `ContextType` as the third parameter to the `trigger` method to specify the context
|
|
1840
|
+
* from which the event is triggered. This helps ThoughtSpot understand the current page
|
|
1841
|
+
* context (Search, Answer, Liveboard, or Spotter) for better event handling.
|
|
1842
|
+
*
|
|
1843
|
+
* @example
|
|
1844
|
+
* ```js
|
|
1845
|
+
* import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
1846
|
+
*
|
|
1847
|
+
* // Trigger Pin event with Search context
|
|
1848
|
+
* appEmbed.trigger(HostEvent.Pin, {
|
|
1849
|
+
* vizId: "123",
|
|
1850
|
+
* liveboardId: "456"
|
|
1851
|
+
* }, ContextType.Search);
|
|
1852
|
+
* ```
|
|
1853
|
+
*
|
|
1777
1854
|
* @group Events
|
|
1778
1855
|
*/
|
|
1779
1856
|
export var HostEvent;
|
|
@@ -1796,6 +1873,16 @@ export var HostEvent;
|
|
|
1796
1873
|
execute: true
|
|
1797
1874
|
});
|
|
1798
1875
|
* ```
|
|
1876
|
+
* @example
|
|
1877
|
+
* ```js
|
|
1878
|
+
* // Trigger search from search context
|
|
1879
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
1880
|
+
* appEmbed.trigger(HostEvent.Search, {
|
|
1881
|
+
* searchQuery: "[revenue] by [region]",
|
|
1882
|
+
* dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
1883
|
+
* execute: true
|
|
1884
|
+
* }, ContextType.Search);
|
|
1885
|
+
* ```
|
|
1799
1886
|
*/
|
|
1800
1887
|
HostEvent["Search"] = "search";
|
|
1801
1888
|
/**
|
|
@@ -1846,6 +1933,24 @@ export var HostEvent;
|
|
|
1846
1933
|
* });
|
|
1847
1934
|
* })
|
|
1848
1935
|
* ```
|
|
1936
|
+
* @example
|
|
1937
|
+
* ```js
|
|
1938
|
+
* // Drill down from answer context
|
|
1939
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
1940
|
+
* appEmbed.trigger(HostEvent.DrillDown, {
|
|
1941
|
+
* points: { clickedPoint, selectedPoints },
|
|
1942
|
+
* autoDrillDown: true
|
|
1943
|
+
* }, ContextType.Answer);
|
|
1944
|
+
* ```
|
|
1945
|
+
* @example
|
|
1946
|
+
* ```js
|
|
1947
|
+
* // Drill down from search context
|
|
1948
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
1949
|
+
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
1950
|
+
* points: { clickedPoint, selectedPoints },
|
|
1951
|
+
* columnGuid: "column-guid"
|
|
1952
|
+
* }, ContextType.Search);
|
|
1953
|
+
* ```
|
|
1849
1954
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1850
1955
|
*/
|
|
1851
1956
|
HostEvent["DrillDown"] = "triggerDrillDown";
|
|
@@ -1866,6 +1971,13 @@ export var HostEvent;
|
|
|
1866
1971
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
1867
1972
|
* console.log("iFrameURL",url);
|
|
1868
1973
|
* ```
|
|
1974
|
+
* @example
|
|
1975
|
+
* ```js
|
|
1976
|
+
* // Get iframe URL from specific context
|
|
1977
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
1978
|
+
* const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
|
|
1979
|
+
* console.log("iFrameURL", url);
|
|
1980
|
+
* ```
|
|
1869
1981
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
1870
1982
|
*/
|
|
1871
1983
|
HostEvent["GetIframeUrl"] = "GetIframeUrl";
|
|
@@ -1879,6 +1991,15 @@ export var HostEvent;
|
|
|
1879
1991
|
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
1880
1992
|
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
1881
1993
|
* ```
|
|
1994
|
+
* @example
|
|
1995
|
+
* ```js
|
|
1996
|
+
* // Set visible vizs from liveboard context
|
|
1997
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
1998
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
1999
|
+
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
2000
|
+
* 'd547ec54-2a37-4516-a222-2b06719af726'
|
|
2001
|
+
* ], ContextType.Liveboard);
|
|
2002
|
+
* ```
|
|
1882
2003
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1883
2004
|
*/
|
|
1884
2005
|
HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
|
|
@@ -1891,6 +2012,14 @@ export var HostEvent;
|
|
|
1891
2012
|
* tabId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
1892
2013
|
* })
|
|
1893
2014
|
* ```
|
|
2015
|
+
* @example
|
|
2016
|
+
* ```js
|
|
2017
|
+
* // Set active tab from liveboard context
|
|
2018
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2019
|
+
* liveboardEmbed.trigger(HostEvent.SetActiveTab, {
|
|
2020
|
+
* tabId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2021
|
+
* }, ContextType.Liveboard);
|
|
2022
|
+
* ```
|
|
1894
2023
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
|
|
1895
2024
|
*/
|
|
1896
2025
|
HostEvent["SetActiveTab"] = "SetActiveTab";
|
|
@@ -1924,6 +2053,15 @@ export var HostEvent;
|
|
|
1924
2053
|
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
|
|
1925
2054
|
* ])
|
|
1926
2055
|
* ```
|
|
2056
|
+
* @example
|
|
2057
|
+
* ```js
|
|
2058
|
+
* // Update runtime filters from liveboard context
|
|
2059
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2060
|
+
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
2061
|
+
* {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
|
|
2062
|
+
* {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
|
|
2063
|
+
* ], ContextType.Liveboard);
|
|
2064
|
+
* ```
|
|
1927
2065
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1928
2066
|
* @important
|
|
1929
2067
|
*/
|
|
@@ -1957,6 +2095,14 @@ export var HostEvent;
|
|
|
1957
2095
|
* LiveboardEmbed.trigger(HostEvent.OpenFilter,
|
|
1958
2096
|
* { column: {columnId: '<column-GUID>'}})
|
|
1959
2097
|
* ```
|
|
2098
|
+
* @example
|
|
2099
|
+
* ```js
|
|
2100
|
+
* // Open filter from search context
|
|
2101
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2102
|
+
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
2103
|
+
* column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
|
|
2104
|
+
* }, ContextType.Search);
|
|
2105
|
+
* ```
|
|
1960
2106
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1961
2107
|
*/
|
|
1962
2108
|
HostEvent["OpenFilter"] = "openFilter";
|
|
@@ -1967,6 +2113,14 @@ export var HostEvent;
|
|
|
1967
2113
|
* ```js
|
|
1968
2114
|
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
|
|
1969
2115
|
* ```
|
|
2116
|
+
* @example
|
|
2117
|
+
* ```js
|
|
2118
|
+
* // Add columns from search context
|
|
2119
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2120
|
+
* searchEmbed.trigger(HostEvent.AddColumns, {
|
|
2121
|
+
* columnIds: ['col-guid-1', 'col-guid-2']
|
|
2122
|
+
* }, ContextType.Search);
|
|
2123
|
+
* ```
|
|
1970
2124
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1971
2125
|
*/
|
|
1972
2126
|
HostEvent["AddColumns"] = "addColumns";
|
|
@@ -1977,6 +2131,14 @@ export var HostEvent;
|
|
|
1977
2131
|
* ```js
|
|
1978
2132
|
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
|
|
1979
2133
|
* ```
|
|
2134
|
+
* @example
|
|
2135
|
+
* ```js
|
|
2136
|
+
* // Remove column from search context
|
|
2137
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2138
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, {
|
|
2139
|
+
* columnId: 'column-guid'
|
|
2140
|
+
* }, ContextType.Search);
|
|
2141
|
+
* ```
|
|
1980
2142
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1981
2143
|
*/
|
|
1982
2144
|
HostEvent["RemoveColumn"] = "removeColumn";
|
|
@@ -2063,6 +2225,37 @@ export var HostEvent;
|
|
|
2063
2225
|
*
|
|
2064
2226
|
* spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
|
|
2065
2227
|
* ```
|
|
2228
|
+
* @example
|
|
2229
|
+
* ```js
|
|
2230
|
+
* // Using context parameter to specify the context type (SDK: 1.45.2+)
|
|
2231
|
+
* // Pin from a search answer context
|
|
2232
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2233
|
+
* appEmbed.trigger(HostEvent.Pin, {
|
|
2234
|
+
* vizId: "123",
|
|
2235
|
+
* newVizName: "Sales by region",
|
|
2236
|
+
* liveboardId: "456"
|
|
2237
|
+
* }, ContextType.Search);
|
|
2238
|
+
* ```
|
|
2239
|
+
* @example
|
|
2240
|
+
* ```js
|
|
2241
|
+
* // Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
|
|
2242
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2243
|
+
* appEmbed.trigger(HostEvent.Pin, {
|
|
2244
|
+
* vizId: "789",
|
|
2245
|
+
* newVizName: "Revenue trends",
|
|
2246
|
+
* liveboardId: "456"
|
|
2247
|
+
* }, ContextType.Answer);
|
|
2248
|
+
* ```
|
|
2249
|
+
* @example
|
|
2250
|
+
* ```js
|
|
2251
|
+
* // Pin from a spotter context (SDK: 1.45.2+)
|
|
2252
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2253
|
+
* appEmbed.trigger(HostEvent.Pin, {
|
|
2254
|
+
* vizId: latestSpotterVizId,
|
|
2255
|
+
* newVizName: "AI-generated insights",
|
|
2256
|
+
* liveboardId: "456"
|
|
2257
|
+
* }, ContextType.Spotter);
|
|
2258
|
+
* ```
|
|
2066
2259
|
*
|
|
2067
2260
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2068
2261
|
*/
|
|
@@ -2073,6 +2266,12 @@ export var HostEvent;
|
|
|
2073
2266
|
* @example
|
|
2074
2267
|
* ```js
|
|
2075
2268
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2269
|
+
*```
|
|
2270
|
+
* @example
|
|
2271
|
+
* ```js
|
|
2272
|
+
* // Show liveboard info from liveboard context
|
|
2273
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2274
|
+
* liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);
|
|
2076
2275
|
* ```
|
|
2077
2276
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2078
2277
|
*/
|
|
@@ -2083,6 +2282,12 @@ export var HostEvent;
|
|
|
2083
2282
|
* ```js
|
|
2084
2283
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
2085
2284
|
* ```
|
|
2285
|
+
* @example
|
|
2286
|
+
* ```js
|
|
2287
|
+
* // Schedule from liveboard context
|
|
2288
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2289
|
+
* liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);
|
|
2290
|
+
* ```
|
|
2086
2291
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2087
2292
|
*/
|
|
2088
2293
|
HostEvent["Schedule"] = "subscription";
|
|
@@ -2092,6 +2297,12 @@ export var HostEvent;
|
|
|
2092
2297
|
* ```js
|
|
2093
2298
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
2094
2299
|
* ```
|
|
2300
|
+
* @example
|
|
2301
|
+
* ```js
|
|
2302
|
+
* // Manage schedules from liveboard context
|
|
2303
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2304
|
+
* liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
|
|
2305
|
+
* ```
|
|
2095
2306
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2096
2307
|
*/
|
|
2097
2308
|
HostEvent["SchedulesList"] = "schedule-list";
|
|
@@ -2102,6 +2313,18 @@ export var HostEvent;
|
|
|
2102
2313
|
* ```js
|
|
2103
2314
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
2104
2315
|
* ```
|
|
2316
|
+
* @example
|
|
2317
|
+
* ```js
|
|
2318
|
+
* // Export TML from liveboard context
|
|
2319
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2320
|
+
* liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);
|
|
2321
|
+
* ```
|
|
2322
|
+
* @example
|
|
2323
|
+
* ```js
|
|
2324
|
+
* // Export TML from search-answer context
|
|
2325
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2326
|
+
* appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);
|
|
2327
|
+
* ```
|
|
2105
2328
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2106
2329
|
*/
|
|
2107
2330
|
HostEvent["ExportTML"] = "exportTSL";
|
|
@@ -2112,6 +2335,18 @@ export var HostEvent;
|
|
|
2112
2335
|
* ```js
|
|
2113
2336
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
2114
2337
|
* ```
|
|
2338
|
+
* @example
|
|
2339
|
+
* ```js
|
|
2340
|
+
* // Edit TML from liveboard context
|
|
2341
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2342
|
+
* liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);
|
|
2343
|
+
* ```
|
|
2344
|
+
* @example
|
|
2345
|
+
* ```js
|
|
2346
|
+
* // Edit TML from search-answer context
|
|
2347
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2348
|
+
* appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);
|
|
2349
|
+
* ```
|
|
2115
2350
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2116
2351
|
*/
|
|
2117
2352
|
HostEvent["EditTML"] = "editTSL";
|
|
@@ -2121,6 +2356,12 @@ export var HostEvent;
|
|
|
2121
2356
|
* ```js
|
|
2122
2357
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
2123
2358
|
* ```
|
|
2359
|
+
* @example
|
|
2360
|
+
* ```js
|
|
2361
|
+
* // Update TML from liveboard context
|
|
2362
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2363
|
+
* liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);
|
|
2364
|
+
* ```
|
|
2124
2365
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2125
2366
|
*/
|
|
2126
2367
|
HostEvent["UpdateTML"] = "updateTSL";
|
|
@@ -2147,6 +2388,18 @@ export var HostEvent;
|
|
|
2147
2388
|
*
|
|
2148
2389
|
* spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
|
|
2149
2390
|
* ```
|
|
2391
|
+
* @example
|
|
2392
|
+
* ```js
|
|
2393
|
+
* // Download as PDF from search-answer context
|
|
2394
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2395
|
+
* appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);
|
|
2396
|
+
* ```
|
|
2397
|
+
* @example
|
|
2398
|
+
* ```js
|
|
2399
|
+
* // Download as PDF from liveboard context
|
|
2400
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2401
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);
|
|
2402
|
+
* ```
|
|
2150
2403
|
*
|
|
2151
2404
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2152
2405
|
*/
|
|
@@ -2191,6 +2444,18 @@ export var HostEvent;
|
|
|
2191
2444
|
*
|
|
2192
2445
|
* spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
|
|
2193
2446
|
* ```
|
|
2447
|
+
* @example
|
|
2448
|
+
* ```js
|
|
2449
|
+
* // Make a copy from answer context
|
|
2450
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2451
|
+
* appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);
|
|
2452
|
+
* ```
|
|
2453
|
+
* @example
|
|
2454
|
+
* ```js
|
|
2455
|
+
* // Make a copy from search context
|
|
2456
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2457
|
+
* appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);
|
|
2458
|
+
* ```
|
|
2194
2459
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2195
2460
|
*/
|
|
2196
2461
|
HostEvent["MakeACopy"] = "makeACopy";
|
|
@@ -2215,6 +2480,14 @@ export var HostEvent;
|
|
|
2215
2480
|
* ```js
|
|
2216
2481
|
* liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2217
2482
|
* ```
|
|
2483
|
+
* @example
|
|
2484
|
+
* ```js
|
|
2485
|
+
* // Explore from liveboard context
|
|
2486
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2487
|
+
* liveboardEmbed.trigger(HostEvent.Explore, {
|
|
2488
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2489
|
+
* }, ContextType.Liveboard);
|
|
2490
|
+
* ```
|
|
2218
2491
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2219
2492
|
*/
|
|
2220
2493
|
HostEvent["Explore"] = "explore";
|
|
@@ -2232,6 +2505,20 @@ export var HostEvent;
|
|
|
2232
2505
|
* ```js
|
|
2233
2506
|
* searchEmbed.trigger(HostEvent.CreateMonitor)
|
|
2234
2507
|
* ```
|
|
2508
|
+
* @example
|
|
2509
|
+
* ```js
|
|
2510
|
+
* // Create monitor from answer context
|
|
2511
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2512
|
+
* appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);
|
|
2513
|
+
* ```
|
|
2514
|
+
* @example
|
|
2515
|
+
* ```js
|
|
2516
|
+
* // Create monitor from liveboard context
|
|
2517
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2518
|
+
* liveboardEmbed.trigger(HostEvent.CreateMonitor, {
|
|
2519
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2520
|
+
* }, ContextType.Liveboard);
|
|
2521
|
+
* ```
|
|
2235
2522
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2236
2523
|
*/
|
|
2237
2524
|
HostEvent["CreateMonitor"] = "createMonitor";
|
|
@@ -2253,6 +2540,20 @@ export var HostEvent;
|
|
|
2253
2540
|
* ```js
|
|
2254
2541
|
* vizEmbed.trigger(HostEvent.ManageMonitor)
|
|
2255
2542
|
* ```
|
|
2543
|
+
* @example
|
|
2544
|
+
* ```js
|
|
2545
|
+
* // Manage monitor from answer context
|
|
2546
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2547
|
+
* appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);
|
|
2548
|
+
* ```
|
|
2549
|
+
* @example
|
|
2550
|
+
* ```js
|
|
2551
|
+
* // Manage monitor from liveboard context
|
|
2552
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2553
|
+
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
2554
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2555
|
+
* }, ContextType.Liveboard);
|
|
2556
|
+
* ```
|
|
2256
2557
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2257
2558
|
*/
|
|
2258
2559
|
HostEvent["ManageMonitor"] = "manageMonitor";
|
|
@@ -2278,6 +2579,26 @@ export var HostEvent;
|
|
|
2278
2579
|
* ```js
|
|
2279
2580
|
* spotterEmbed.trigger(HostEvent.Edit);
|
|
2280
2581
|
* ```
|
|
2582
|
+
* @example
|
|
2583
|
+
* ```js
|
|
2584
|
+
* // Using context parameter to edit liveboard context
|
|
2585
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2586
|
+
* liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);
|
|
2587
|
+
* ```
|
|
2588
|
+
* @example
|
|
2589
|
+
* ```js
|
|
2590
|
+
* // Edit from search context
|
|
2591
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2592
|
+
* appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);
|
|
2593
|
+
* ```
|
|
2594
|
+
* * @example
|
|
2595
|
+
* ```js
|
|
2596
|
+
* // Edit from spotter context
|
|
2597
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2598
|
+
* appEmbed.trigger(HostEvent.Edit, {
|
|
2599
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2600
|
+
* }, ContextType.Spotter);
|
|
2601
|
+
* ```
|
|
2281
2602
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2282
2603
|
*/
|
|
2283
2604
|
HostEvent["Edit"] = "edit";
|
|
@@ -2295,6 +2616,20 @@ export var HostEvent;
|
|
|
2295
2616
|
* ```js
|
|
2296
2617
|
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
2297
2618
|
* ```
|
|
2619
|
+
* @example
|
|
2620
|
+
* ```js
|
|
2621
|
+
* // Copy link from liveboard context
|
|
2622
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2623
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
|
|
2624
|
+
* ```
|
|
2625
|
+
* @example
|
|
2626
|
+
* ```js
|
|
2627
|
+
* // Copy link from liveboard visualization context
|
|
2628
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2629
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
2630
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2631
|
+
* }, ContextType.Liveboard);
|
|
2632
|
+
* ```
|
|
2298
2633
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2299
2634
|
*/
|
|
2300
2635
|
HostEvent["CopyLink"] = "embedDocument";
|
|
@@ -2312,6 +2647,20 @@ export var HostEvent;
|
|
|
2312
2647
|
* ```js
|
|
2313
2648
|
* vizEmbed.trigger(HostEvent.Present)
|
|
2314
2649
|
* ```
|
|
2650
|
+
* @example
|
|
2651
|
+
* ```js
|
|
2652
|
+
* // Present from liveboard visualization context
|
|
2653
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2654
|
+
* liveboardEmbed.trigger(HostEvent.Present, {
|
|
2655
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2656
|
+
* }, ContextType.Liveboard);
|
|
2657
|
+
* ```
|
|
2658
|
+
* @example
|
|
2659
|
+
* ```js
|
|
2660
|
+
* // Present from liveboard context
|
|
2661
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2662
|
+
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
2663
|
+
* ```
|
|
2315
2664
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2316
2665
|
*/
|
|
2317
2666
|
HostEvent["Present"] = "present";
|
|
@@ -2340,6 +2689,22 @@ export var HostEvent;
|
|
|
2340
2689
|
* tml.answer.search_query // TML representation of the search query
|
|
2341
2690
|
* );
|
|
2342
2691
|
* })
|
|
2692
|
+
* ```
|
|
2693
|
+
* @example
|
|
2694
|
+
* ```js
|
|
2695
|
+
* // Get TML from search context
|
|
2696
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2697
|
+
* appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
|
|
2698
|
+
* console.log(tml.answer.search_query);
|
|
2699
|
+
* });
|
|
2700
|
+
* ```
|
|
2701
|
+
* @example
|
|
2702
|
+
* ```js
|
|
2703
|
+
* // Get TML from search-answer context
|
|
2704
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2705
|
+
* appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
|
|
2706
|
+
* console.log(tml.answer);
|
|
2707
|
+
* });
|
|
2343
2708
|
* ```
|
|
2344
2709
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2345
2710
|
* @important
|
|
@@ -2361,6 +2726,20 @@ export var HostEvent;
|
|
|
2361
2726
|
* ```js
|
|
2362
2727
|
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
2363
2728
|
* ```
|
|
2729
|
+
* @example
|
|
2730
|
+
* ```js
|
|
2731
|
+
* // Show underlying data from liveboard visualization context
|
|
2732
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2733
|
+
* appEmbed.trigger(HostEvent.ShowUnderlyingData, {
|
|
2734
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2735
|
+
* }, ContextType.Liveboard);
|
|
2736
|
+
* ```
|
|
2737
|
+
* @example
|
|
2738
|
+
* ```js
|
|
2739
|
+
* // Show underlying data from search context
|
|
2740
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2741
|
+
* appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);
|
|
2742
|
+
* ```
|
|
2364
2743
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2365
2744
|
*/
|
|
2366
2745
|
HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
@@ -2378,6 +2757,18 @@ export var HostEvent;
|
|
|
2378
2757
|
* ```js
|
|
2379
2758
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
2380
2759
|
* ```
|
|
2760
|
+
* @example
|
|
2761
|
+
* ```js
|
|
2762
|
+
* // Delete from liveboard context
|
|
2763
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2764
|
+
* liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);
|
|
2765
|
+
* ```
|
|
2766
|
+
* @example
|
|
2767
|
+
* ```js
|
|
2768
|
+
* // Delete from search context
|
|
2769
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2770
|
+
* appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);
|
|
2771
|
+
* ```
|
|
2381
2772
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2382
2773
|
*/
|
|
2383
2774
|
HostEvent["Delete"] = "onDeleteAnswer";
|
|
@@ -2398,6 +2789,20 @@ export var HostEvent;
|
|
|
2398
2789
|
* ```js
|
|
2399
2790
|
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
2400
2791
|
* ```
|
|
2792
|
+
* @example
|
|
2793
|
+
* ```js
|
|
2794
|
+
* // SpotIQ analyze from search-answer context
|
|
2795
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2796
|
+
* appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);
|
|
2797
|
+
* ```
|
|
2798
|
+
* @example
|
|
2799
|
+
* ```js
|
|
2800
|
+
* // SpotIQ analyze from search context
|
|
2801
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2802
|
+
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
|
|
2803
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2804
|
+
* }, ContextType.Liveboard);
|
|
2805
|
+
* ```
|
|
2401
2806
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2402
2807
|
*/
|
|
2403
2808
|
HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
@@ -2449,9 +2854,16 @@ export var HostEvent;
|
|
|
2449
2854
|
*
|
|
2450
2855
|
* spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
|
|
2451
2856
|
* ```
|
|
2857
|
+
* @example
|
|
2858
|
+
* ```js
|
|
2859
|
+
* // Download as PNG from search-answer context
|
|
2860
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2861
|
+
* appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);
|
|
2862
|
+
* ```
|
|
2452
2863
|
*
|
|
2453
2864
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
|
|
2454
2865
|
*/
|
|
2866
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
2455
2867
|
HostEvent["DownloadAsPng"] = "downloadAsPng";
|
|
2456
2868
|
/**
|
|
2457
2869
|
* Trigger the **Download** > **CSV** action on tables in
|
|
@@ -2477,6 +2889,18 @@ export var HostEvent;
|
|
|
2477
2889
|
*
|
|
2478
2890
|
* spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
|
|
2479
2891
|
* ```
|
|
2892
|
+
* @example
|
|
2893
|
+
* ```js
|
|
2894
|
+
* // Download as CSV from search-answer context
|
|
2895
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2896
|
+
* appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
|
|
2897
|
+
* ```
|
|
2898
|
+
* @example
|
|
2899
|
+
* ```js
|
|
2900
|
+
* // Download as CSV from search context
|
|
2901
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2902
|
+
* searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
|
|
2903
|
+
* ```
|
|
2480
2904
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2481
2905
|
*/
|
|
2482
2906
|
HostEvent["DownloadAsCsv"] = "downloadAsCSV";
|
|
@@ -2504,6 +2928,18 @@ export var HostEvent;
|
|
|
2504
2928
|
*
|
|
2505
2929
|
* spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
|
|
2506
2930
|
* ```
|
|
2931
|
+
* @example
|
|
2932
|
+
* ```js
|
|
2933
|
+
* // Download as XLSX from answer context
|
|
2934
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2935
|
+
* appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);
|
|
2936
|
+
* ```
|
|
2937
|
+
* @example
|
|
2938
|
+
* ```js
|
|
2939
|
+
* // Download as XLSX from search context
|
|
2940
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2941
|
+
* searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);
|
|
2942
|
+
* ```
|
|
2507
2943
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2508
2944
|
*/
|
|
2509
2945
|
HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
|
|
@@ -2517,6 +2953,18 @@ export var HostEvent;
|
|
|
2517
2953
|
* ```js
|
|
2518
2954
|
* searchEmbed.trigger(HostEvent.Share)
|
|
2519
2955
|
* ```
|
|
2956
|
+
* @example
|
|
2957
|
+
* ```js
|
|
2958
|
+
* // Share from Liveboard context
|
|
2959
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2960
|
+
* liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);
|
|
2961
|
+
* ```
|
|
2962
|
+
* @example
|
|
2963
|
+
* ```js
|
|
2964
|
+
* // Share from search-answer context
|
|
2965
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2966
|
+
* appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);
|
|
2967
|
+
* ```
|
|
2520
2968
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2521
2969
|
*/
|
|
2522
2970
|
HostEvent["Share"] = "share";
|
|
@@ -2556,6 +3004,18 @@ export var HostEvent;
|
|
|
2556
3004
|
*
|
|
2557
3005
|
* spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
|
|
2558
3006
|
* ```
|
|
3007
|
+
* @example
|
|
3008
|
+
* ```js
|
|
3009
|
+
* // Save from answer context
|
|
3010
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3011
|
+
* appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);
|
|
3012
|
+
* ```
|
|
3013
|
+
* @example
|
|
3014
|
+
* ```js
|
|
3015
|
+
* // Save from search context
|
|
3016
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3017
|
+
* searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);
|
|
3018
|
+
* ```
|
|
2559
3019
|
*
|
|
2560
3020
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2561
3021
|
*/
|
|
@@ -2572,6 +3032,20 @@ export var HostEvent;
|
|
|
2572
3032
|
* ```js
|
|
2573
3033
|
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
2574
3034
|
* ```
|
|
3035
|
+
* @example
|
|
3036
|
+
* ```js
|
|
3037
|
+
* // Sync to sheets from answer context
|
|
3038
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3039
|
+
* appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);
|
|
3040
|
+
* ```
|
|
3041
|
+
* @example
|
|
3042
|
+
* ```js
|
|
3043
|
+
* // Sync to sheets from liveboard context
|
|
3044
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3045
|
+
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {
|
|
3046
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3047
|
+
* }, ContextType.Liveboard);
|
|
3048
|
+
* ```
|
|
2575
3049
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2576
3050
|
*/
|
|
2577
3051
|
HostEvent["SyncToSheets"] = "sync-to-sheets";
|
|
@@ -2588,6 +3062,20 @@ export var HostEvent;
|
|
|
2588
3062
|
* ```js
|
|
2589
3063
|
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
2590
3064
|
* ```
|
|
3065
|
+
* @example
|
|
3066
|
+
* ```js
|
|
3067
|
+
* // Sync to other apps from answer context
|
|
3068
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3069
|
+
* appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);
|
|
3070
|
+
* ```
|
|
3071
|
+
* @example
|
|
3072
|
+
* ```js
|
|
3073
|
+
* // Sync to other apps from liveboard context
|
|
3074
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3075
|
+
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
|
|
3076
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3077
|
+
* }, ContextType.Liveboard);
|
|
3078
|
+
* ```
|
|
2591
3079
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2592
3080
|
*/
|
|
2593
3081
|
HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
|
|
@@ -2604,6 +3092,20 @@ export var HostEvent;
|
|
|
2604
3092
|
* ```js
|
|
2605
3093
|
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
2606
3094
|
* ```
|
|
3095
|
+
* @example
|
|
3096
|
+
* ```js
|
|
3097
|
+
* // Manage pipelines from answer context
|
|
3098
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3099
|
+
* appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);
|
|
3100
|
+
* ```
|
|
3101
|
+
* @example
|
|
3102
|
+
* ```js
|
|
3103
|
+
* // Manage pipelines from liveboard context
|
|
3104
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3105
|
+
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {
|
|
3106
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3107
|
+
* }, ContextType.Liveboard);
|
|
3108
|
+
* ```
|
|
2607
3109
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2608
3110
|
*/
|
|
2609
3111
|
HostEvent["ManagePipelines"] = "manage-pipeline";
|
|
@@ -2616,6 +3118,12 @@ export var HostEvent;
|
|
|
2616
3118
|
* ```js
|
|
2617
3119
|
* appEmbed.trigger(HostEvent.ResetSearch)
|
|
2618
3120
|
* ```
|
|
3121
|
+
* @example
|
|
3122
|
+
* ```js
|
|
3123
|
+
* // Reset search from search context
|
|
3124
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3125
|
+
* searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);
|
|
3126
|
+
* ```
|
|
2619
3127
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
2620
3128
|
*/
|
|
2621
3129
|
HostEvent["ResetSearch"] = "resetSearch";
|
|
@@ -2627,6 +3135,13 @@ export var HostEvent;
|
|
|
2627
3135
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
2628
3136
|
* console.log('data', data);
|
|
2629
3137
|
* ```
|
|
3138
|
+
* @example
|
|
3139
|
+
* ```js
|
|
3140
|
+
* // Get filters from liveboard context
|
|
3141
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3142
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
|
|
3143
|
+
* console.log('filters', data);
|
|
3144
|
+
* ```
|
|
2630
3145
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2631
3146
|
*/
|
|
2632
3147
|
HostEvent["GetFilters"] = "getFilters";
|
|
@@ -2634,7 +3149,8 @@ export var HostEvent;
|
|
|
2634
3149
|
* Update one or several filters applied on a Liveboard.
|
|
2635
3150
|
* @param - Includes the following keys:
|
|
2636
3151
|
* - `filter`: A single filter object containing column name, filter operator, and
|
|
2637
|
-
* values.
|
|
3152
|
+
* values.
|
|
3153
|
+
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
2638
3154
|
* and values for each.
|
|
2639
3155
|
*
|
|
2640
3156
|
* Each filter object must include the following attributes:
|
|
@@ -2717,6 +3233,18 @@ export var HostEvent;
|
|
|
2717
3233
|
* }]
|
|
2718
3234
|
* });
|
|
2719
3235
|
* ```
|
|
3236
|
+
* @example
|
|
3237
|
+
* ```js
|
|
3238
|
+
* // Update filters from liveboard context
|
|
3239
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3240
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
3241
|
+
* filter: {
|
|
3242
|
+
* column: "item type",
|
|
3243
|
+
* oper: "IN",
|
|
3244
|
+
* values: ["shoes", "boots"]
|
|
3245
|
+
* }
|
|
3246
|
+
* }, ContextType.Liveboard);
|
|
3247
|
+
* ```
|
|
2720
3248
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2721
3249
|
*/
|
|
2722
3250
|
HostEvent["UpdateFilters"] = "updateFilters";
|
|
@@ -2730,6 +3258,14 @@ export var HostEvent;
|
|
|
2730
3258
|
* );
|
|
2731
3259
|
* })
|
|
2732
3260
|
* ```
|
|
3261
|
+
* @example
|
|
3262
|
+
* ```js
|
|
3263
|
+
* // Get tabs from liveboard context
|
|
3264
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3265
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
|
|
3266
|
+
* console.log('tabs', tabDetails);
|
|
3267
|
+
* });
|
|
3268
|
+
* ```
|
|
2733
3269
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2734
3270
|
*/
|
|
2735
3271
|
HostEvent["GetTabs"] = "getTabs";
|
|
@@ -2743,6 +3279,15 @@ export var HostEvent;
|
|
|
2743
3279
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2744
3280
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2745
3281
|
* ```
|
|
3282
|
+
* @example
|
|
3283
|
+
* ```js
|
|
3284
|
+
* // Set visible tabs from liveboard context
|
|
3285
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3286
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
|
|
3287
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3288
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
3289
|
+
* ], ContextType.Liveboard);
|
|
3290
|
+
* ```
|
|
2746
3291
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2747
3292
|
*/
|
|
2748
3293
|
HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
|
|
@@ -2756,6 +3301,15 @@ export var HostEvent;
|
|
|
2756
3301
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2757
3302
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2758
3303
|
* ```
|
|
3304
|
+
* @example
|
|
3305
|
+
* ```js
|
|
3306
|
+
* // Set hidden tabs from liveboard context
|
|
3307
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3308
|
+
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
3309
|
+
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
3310
|
+
* 'i547ec54-2a37-4516-a222-2b06719af726'
|
|
3311
|
+
* ], ContextType.Liveboard);
|
|
3312
|
+
* ```
|
|
2759
3313
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2760
3314
|
*/
|
|
2761
3315
|
HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
|
|
@@ -2832,13 +3386,24 @@ export var HostEvent;
|
|
|
2832
3386
|
HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
|
|
2833
3387
|
/**
|
|
2834
3388
|
* Trigger reset action for a personalized Liveboard view.
|
|
3389
|
+
* This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
|
|
2835
3390
|
* @example
|
|
2836
3391
|
* ```js
|
|
2837
3392
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
2838
3393
|
* ```
|
|
2839
3394
|
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
3395
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
2840
3396
|
*/
|
|
2841
3397
|
HostEvent["ResetLiveboardPersonalisedView"] = "ResetLiveboardPersonalisedView";
|
|
3398
|
+
/**
|
|
3399
|
+
* Trigger reset action for a personalized Liveboard view.
|
|
3400
|
+
* @example
|
|
3401
|
+
* ```js
|
|
3402
|
+
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);
|
|
3403
|
+
* ```
|
|
3404
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
3405
|
+
*/
|
|
3406
|
+
HostEvent["ResetLiveboardPersonalizedView"] = "ResetLiveboardPersonalisedView";
|
|
2842
3407
|
/**
|
|
2843
3408
|
* Triggers an action to update Parameter values on embedded
|
|
2844
3409
|
* Answers, Liveboard, and Spotter answer in Edit mode.
|
|
@@ -2855,6 +3420,16 @@ export var HostEvent;
|
|
|
2855
3420
|
* isVisibleToUser: false
|
|
2856
3421
|
* }])
|
|
2857
3422
|
* ```
|
|
3423
|
+
* @example
|
|
3424
|
+
* ```js
|
|
3425
|
+
* // Update parameters from liveboard context
|
|
3426
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3427
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
3428
|
+
* name: "Region Param",
|
|
3429
|
+
* value: "West",
|
|
3430
|
+
* isVisibleToUser: true
|
|
3431
|
+
* }], ContextType.Liveboard);
|
|
3432
|
+
* ```
|
|
2858
3433
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2859
3434
|
*/
|
|
2860
3435
|
HostEvent["UpdateParameters"] = "UpdateParameters";
|
|
@@ -2874,18 +3449,77 @@ export var HostEvent;
|
|
|
2874
3449
|
* });
|
|
2875
3450
|
*
|
|
2876
3451
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
3452
|
+
*```
|
|
3453
|
+
* @example
|
|
3454
|
+
* ```js
|
|
3455
|
+
* // Get parameters from liveboard context
|
|
3456
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3457
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
|
|
3458
|
+
* console.log('parameters', parameters);
|
|
3459
|
+
* });
|
|
2877
3460
|
* ```
|
|
2878
3461
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2879
3462
|
*/
|
|
2880
3463
|
HostEvent["GetParameters"] = "GetParameters";
|
|
2881
3464
|
/**
|
|
2882
3465
|
* Triggers an event to update a personalized view of a Liveboard.
|
|
3466
|
+
* This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
|
|
2883
3467
|
* ```js
|
|
2884
3468
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
2885
3469
|
* ```
|
|
3470
|
+
* @example
|
|
3471
|
+
* ```js
|
|
3472
|
+
* // Update personalized view from liveboard context
|
|
3473
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3474
|
+
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
|
|
3475
|
+
* viewId: '1234'
|
|
3476
|
+
* }, ContextType.Liveboard);
|
|
3477
|
+
* ```
|
|
2886
3478
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3479
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
2887
3480
|
*/
|
|
2888
3481
|
HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
|
|
3482
|
+
/**
|
|
3483
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
3484
|
+
* ```js
|
|
3485
|
+
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
3486
|
+
* ```
|
|
3487
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
3488
|
+
*/
|
|
3489
|
+
HostEvent["UpdatePersonalizedView"] = "UpdatePersonalisedView";
|
|
3490
|
+
/**
|
|
3491
|
+
* Triggers selection of a specific Personalized View on a
|
|
3492
|
+
* Liveboard without reloading the embed. Pass either a
|
|
3493
|
+
* `viewId` (GUID) or `viewName`. If both are provided, `viewId` takes precedence.
|
|
3494
|
+
* If neither is provided, the Liveboard resets to the original/default view.
|
|
3495
|
+
* When a `viewName` is provided and multiple views share
|
|
3496
|
+
* the same name, the first match is selected.
|
|
3497
|
+
* @example
|
|
3498
|
+
* ```js
|
|
3499
|
+
* liveboardEmbed.trigger(
|
|
3500
|
+
* HostEvent.SelectPersonalizedView,
|
|
3501
|
+
* { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
|
|
3502
|
+
* )
|
|
3503
|
+
* ```
|
|
3504
|
+
* @example
|
|
3505
|
+
* ```js
|
|
3506
|
+
* // Select by name
|
|
3507
|
+
* liveboardEmbed.trigger(
|
|
3508
|
+
* HostEvent.SelectPersonalizedView,
|
|
3509
|
+
* { viewName: 'Dr Smith Cardiology' },
|
|
3510
|
+
* )
|
|
3511
|
+
* ```
|
|
3512
|
+
* @example
|
|
3513
|
+
* ```js
|
|
3514
|
+
* // Reset to default view
|
|
3515
|
+
* liveboardEmbed.trigger(
|
|
3516
|
+
* HostEvent.SelectPersonalizedView,
|
|
3517
|
+
* {},
|
|
3518
|
+
* )
|
|
3519
|
+
* ```
|
|
3520
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
3521
|
+
*/
|
|
3522
|
+
HostEvent["SelectPersonalizedView"] = "SelectPersonalisedView";
|
|
2889
3523
|
/**
|
|
2890
3524
|
* @hidden
|
|
2891
3525
|
* Notify when info call is completed successfully
|
|
@@ -2905,7 +3539,8 @@ export var HostEvent;
|
|
|
2905
3539
|
* add a name and description for the Answer.
|
|
2906
3540
|
* @param - Includes the following keys:
|
|
2907
3541
|
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
2908
|
-
* embed.
|
|
3542
|
+
* embed.
|
|
3543
|
+
* - `name`: Optional. Name string for the Answer.
|
|
2909
3544
|
* - `description`: Optional. Description text for the Answer.
|
|
2910
3545
|
* @example
|
|
2911
3546
|
* ```js
|
|
@@ -2924,6 +3559,34 @@ export var HostEvent;
|
|
|
2924
3559
|
*
|
|
2925
3560
|
* spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
|
|
2926
3561
|
* ```
|
|
3562
|
+
* @example
|
|
3563
|
+
* ```js
|
|
3564
|
+
* // Using context parameter to save answer from search context
|
|
3565
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3566
|
+
* const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
|
|
3567
|
+
* name: "Regional sales analysis",
|
|
3568
|
+
* description: "Sales breakdown by region"
|
|
3569
|
+
* }, ContextType.Search);
|
|
3570
|
+
* ```
|
|
3571
|
+
* @example
|
|
3572
|
+
* ```js
|
|
3573
|
+
* // Save answer from answer context (explore modal)
|
|
3574
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3575
|
+
* const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
|
|
3576
|
+
* name: "Modified analysis",
|
|
3577
|
+
* description: "Updated from explore view"
|
|
3578
|
+
* }, ContextType.Answer);
|
|
3579
|
+
* ```
|
|
3580
|
+
* @example
|
|
3581
|
+
* ```js
|
|
3582
|
+
* // Save answer from spotter context
|
|
3583
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3584
|
+
* const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
|
|
3585
|
+
* vizId: latestSpotterVizId,
|
|
3586
|
+
* name: "AI insights",
|
|
3587
|
+
* description: "Generated from Spotter"
|
|
3588
|
+
* }, ContextType.Spotter);
|
|
3589
|
+
* ```
|
|
2927
3590
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2928
3591
|
*/
|
|
2929
3592
|
HostEvent["SaveAnswer"] = "saveAnswer";
|
|
@@ -2965,6 +3628,15 @@ export var HostEvent;
|
|
|
2965
3628
|
* executeSearch: true,
|
|
2966
3629
|
* })
|
|
2967
3630
|
* ```
|
|
3631
|
+
* @example
|
|
3632
|
+
* ```js
|
|
3633
|
+
* // Spotter search from spotter context
|
|
3634
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3635
|
+
* spotterEmbed.trigger(HostEvent.SpotterSearch, {
|
|
3636
|
+
* query: 'sales by region',
|
|
3637
|
+
* executeSearch: true
|
|
3638
|
+
* }, ContextType.Spotter);
|
|
3639
|
+
* ```
|
|
2968
3640
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2969
3641
|
*/
|
|
2970
3642
|
HostEvent["SpotterSearch"] = "SpotterSearch";
|
|
@@ -2975,6 +3647,12 @@ export var HostEvent;
|
|
|
2975
3647
|
* ```js
|
|
2976
3648
|
* spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
|
|
2977
3649
|
* ```
|
|
3650
|
+
* @example
|
|
3651
|
+
* ```js
|
|
3652
|
+
* // Edit last prompt from spotter context
|
|
3653
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3654
|
+
* spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);
|
|
3655
|
+
* ```
|
|
2978
3656
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2979
3657
|
*/
|
|
2980
3658
|
HostEvent["EditLastPrompt"] = "EditLastPrompt";
|
|
@@ -2984,6 +3662,12 @@ export var HostEvent;
|
|
|
2984
3662
|
* ```js
|
|
2985
3663
|
* spotterEmbed.trigger(HostEvent.PreviewSpotterData);
|
|
2986
3664
|
* ```
|
|
3665
|
+
* @example
|
|
3666
|
+
* ```js
|
|
3667
|
+
* // Preview spotter data from spotter context
|
|
3668
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3669
|
+
* spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);
|
|
3670
|
+
* ```
|
|
2987
3671
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2988
3672
|
*/
|
|
2989
3673
|
HostEvent["PreviewSpotterData"] = "PreviewSpotterData";
|
|
@@ -3742,6 +4426,7 @@ export var Action;
|
|
|
3742
4426
|
* disabledActions: [Action.LiveboardInfo]
|
|
3743
4427
|
* ```
|
|
3744
4428
|
*/
|
|
4429
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
3745
4430
|
Action["LiveboardInfo"] = "pinboardInfo";
|
|
3746
4431
|
/**
|
|
3747
4432
|
* @hidden
|
|
@@ -3772,6 +4457,7 @@ export var Action;
|
|
|
3772
4457
|
* disabledActions: [Action.Subscription]
|
|
3773
4458
|
* ```
|
|
3774
4459
|
*/
|
|
4460
|
+
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
|
|
3775
4461
|
Action["Subscription"] = "subscription";
|
|
3776
4462
|
/**
|
|
3777
4463
|
* The **Explore** action on Liveboard visualizations
|
|
@@ -4251,13 +4937,25 @@ export var Action;
|
|
|
4251
4937
|
/**
|
|
4252
4938
|
* The Liveboard Personalised Views dropdown.
|
|
4253
4939
|
* Allows navigating to a personalized Liveboard View.
|
|
4940
|
+
* This action is deprecated. Use {@link Action.PersonalizedViewsDropdown} instead.
|
|
4254
4941
|
* @example
|
|
4255
4942
|
* ```js
|
|
4256
4943
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4257
4944
|
* ```
|
|
4258
4945
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4946
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
4259
4947
|
*/
|
|
4260
4948
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4949
|
+
/**
|
|
4950
|
+
* The Liveboard Personalized Views dropdown.
|
|
4951
|
+
* Allows navigating to a personalized Liveboard View.
|
|
4952
|
+
* @example
|
|
4953
|
+
* ```js
|
|
4954
|
+
* disabledActions: [Action.PersonalizedViewsDropdown]
|
|
4955
|
+
* ```
|
|
4956
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
4957
|
+
*/
|
|
4958
|
+
Action["PersonalizedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4261
4959
|
/**
|
|
4262
4960
|
* Action ID for show or hide the user details on a
|
|
4263
4961
|
* Liveboard (Recently visited / social proof)
|
|
@@ -4345,14 +5043,27 @@ export var Action;
|
|
|
4345
5043
|
/**
|
|
4346
5044
|
* The **Organize Favourites** action on Homepage
|
|
4347
5045
|
* *Favorites* module.
|
|
5046
|
+
* This action is deprecated. Use {@link Action.OrganizeFavorites} instead.
|
|
4348
5047
|
*
|
|
4349
5048
|
* @example
|
|
4350
5049
|
* ```js
|
|
4351
5050
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4352
5051
|
* ```
|
|
4353
5052
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
5053
|
+
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
4354
5054
|
*/
|
|
4355
5055
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
5056
|
+
/**
|
|
5057
|
+
* The **Organize Favorites** action on Homepage
|
|
5058
|
+
* *Favorites* module.
|
|
5059
|
+
*
|
|
5060
|
+
* @example
|
|
5061
|
+
* ```js
|
|
5062
|
+
* disabledActions: [Action.OrganizeFavorites]
|
|
5063
|
+
* ```
|
|
5064
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5065
|
+
*/
|
|
5066
|
+
Action["OrganizeFavorites"] = "organiseFavourites";
|
|
4356
5067
|
/**
|
|
4357
5068
|
* The **AI Highlights** action on a Liveboard.
|
|
4358
5069
|
*
|
|
@@ -5102,6 +5813,22 @@ export var EmbedErrorCodes;
|
|
|
5102
5813
|
/** Invalid URL provided in configuration */
|
|
5103
5814
|
EmbedErrorCodes["INVALID_URL"] = "INVALID_URL";
|
|
5104
5815
|
})(EmbedErrorCodes || (EmbedErrorCodes = {}));
|
|
5816
|
+
/**
|
|
5817
|
+
* Context types for specifying the page context when triggering host events.
|
|
5818
|
+
* Used as the third parameter in the `trigger` method to help ThoughtSpot
|
|
5819
|
+
* understand the current page context for better event handling.
|
|
5820
|
+
*
|
|
5821
|
+
* @example
|
|
5822
|
+
* ```js
|
|
5823
|
+
* import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5824
|
+
*
|
|
5825
|
+
* // Trigger an event with specific context
|
|
5826
|
+
* embed.trigger(HostEvent.Pin, { vizId: "123", liveboardId: "456" }, ContextType.Search);
|
|
5827
|
+
* ```
|
|
5828
|
+
*
|
|
5829
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
5830
|
+
* @group Events
|
|
5831
|
+
*/
|
|
5105
5832
|
export var ContextType;
|
|
5106
5833
|
(function (ContextType) {
|
|
5107
5834
|
/**
|
|
@@ -5120,6 +5847,10 @@ export var ContextType;
|
|
|
5120
5847
|
* Spotter context for spotter modal/page.
|
|
5121
5848
|
*/
|
|
5122
5849
|
ContextType["Spotter"] = "spotter";
|
|
5850
|
+
/**
|
|
5851
|
+
* Other context for any other generic page.
|
|
5852
|
+
*/
|
|
5853
|
+
ContextType["Other"] = "other";
|
|
5123
5854
|
})(ContextType || (ContextType = {}));
|
|
5124
5855
|
/**
|
|
5125
5856
|
* Enum for the type of API intercepted
|