@thoughtspot/visual-embed-sdk 1.46.0 → 1.46.2
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/README.md +1 -1
- package/cjs/package.json +2 -2
- package/cjs/src/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +30 -5
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +61 -33
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +11 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +34 -1
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +2 -2
- package/cjs/src/embed/base.js +2 -2
- package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
- package/cjs/src/embed/bodyless-conversation.js +4 -4
- package/cjs/src/embed/conversation.d.ts +43 -30
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +10 -11
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +27 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +42 -36
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +3 -3
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +1 -1
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +5 -5
- package/cjs/src/embed/sage.js +1 -1
- package/cjs/src/embed/search-bar.d.ts +7 -7
- package/cjs/src/embed/search-bar.js +1 -1
- package/cjs/src/embed/search.d.ts +16 -14
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +3 -2
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +4 -4
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +13 -7
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +35 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -12
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +653 -276
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +274 -208
- 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 +6 -4
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +10 -1
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-BQvLEoxp.js → index-DkizS4xM.js} +1 -1
- package/dist/src/auth.d.ts +29 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +17 -17
- package/dist/src/embed/app.d.ts +61 -33
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +2 -2
- package/dist/src/embed/bodyless-conversation.d.ts +5 -5
- package/dist/src/embed/conversation.d.ts +43 -30
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +42 -36
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +5 -5
- package/dist/src/embed/search-bar.d.ts +7 -7
- package/dist/src/embed/search.d.ts +16 -14
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +4 -4
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +15 -15
- package/dist/src/tokenizedFetch.d.ts +1 -1
- package/dist/src/types.d.ts +653 -276
- 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.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +383 -290
- package/dist/tsembed-react.js +382 -289
- package/dist/tsembed.es.js +375 -282
- package/dist/tsembed.js +374 -281
- package/dist/visual-embed-sdk-react-full.d.ts +880 -431
- package/dist/visual-embed-sdk-react.d.ts +873 -427
- package/dist/visual-embed-sdk.d.ts +879 -430
- package/lib/package.json +2 -2
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +30 -5
- package/lib/src/auth.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +61 -33
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +12 -5
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +34 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +2 -2
- package/lib/src/embed/base.js +2 -2
- package/lib/src/embed/bodyless-conversation.d.ts +5 -5
- package/lib/src/embed/bodyless-conversation.js +4 -4
- package/lib/src/embed/conversation.d.ts +43 -30
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -11
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +27 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +42 -36
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +3 -3
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +1 -1
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +5 -5
- package/lib/src/embed/sage.js +1 -1
- package/lib/src/embed/search-bar.d.ts +7 -7
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search.d.ts +16 -14
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +3 -2
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +4 -4
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +13 -7
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +35 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -12
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +653 -276
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +274 -208
- 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 +5 -3
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +8 -0
- package/lib/src/utils.js.map +1 -1
- package/package.json +2 -2
- package/src/auth.ts +30 -5
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +73 -36
- package/src/embed/base.ts +2 -2
- package/src/embed/bodyless-conversation.ts +5 -5
- package/src/embed/conversation.spec.ts +37 -0
- package/src/embed/conversation.ts +55 -38
- package/src/embed/liveboard.spec.ts +1 -1
- package/src/embed/liveboard.ts +42 -36
- package/src/embed/sage.ts +5 -5
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.ts +16 -14
- package/src/embed/ts-embed.spec.ts +42 -0
- package/src/embed/ts-embed.ts +12 -7
- package/src/react/index.tsx +15 -15
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +652 -275
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +6 -3
- package/src/utils.ts +14 -0
package/dist/tsembed-react.es.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* @thoughtspot/visual-embed-sdk version 1.46.
|
|
1
|
+
/* @thoughtspot/visual-embed-sdk version 1.46.2 */
|
|
2
2
|
'use client';
|
|
3
3
|
import * as React from 'react';
|
|
4
4
|
import React__default, { useRef, useCallback } from 'react';
|
|
@@ -191,7 +191,7 @@ merge.withOptions = (options, ...objects) => {
|
|
|
191
191
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
192
192
|
*/
|
|
193
193
|
/**
|
|
194
|
-
* The authentication mechanism for allowing access to
|
|
194
|
+
* The authentication mechanism for allowing access to
|
|
195
195
|
* the embedded app
|
|
196
196
|
* @group Authentication / Init
|
|
197
197
|
*/
|
|
@@ -217,6 +217,7 @@ var AuthType;
|
|
|
217
217
|
* To use this:
|
|
218
218
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
219
219
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
220
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
220
221
|
* @example
|
|
221
222
|
* ```js
|
|
222
223
|
* init({
|
|
@@ -224,18 +225,17 @@ var AuthType;
|
|
|
224
225
|
* authType: AuthType.EmbeddedSSO,
|
|
225
226
|
* });
|
|
226
227
|
* ```
|
|
227
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
228
228
|
*/
|
|
229
229
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
230
230
|
/**
|
|
231
|
-
* SSO using SAML
|
|
232
|
-
* @deprecated
|
|
231
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
232
|
+
* @deprecated This option is deprecated.
|
|
233
233
|
* @hidden
|
|
234
234
|
*/
|
|
235
235
|
AuthType["SSO"] = "SSO_SAML";
|
|
236
236
|
/**
|
|
237
|
-
* SSO using SAML
|
|
238
|
-
* @deprecated
|
|
237
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
238
|
+
* @deprecated This option is deprecated.
|
|
239
239
|
* @hidden
|
|
240
240
|
*/
|
|
241
241
|
AuthType["SAML"] = "SSO_SAML";
|
|
@@ -286,8 +286,9 @@ var AuthType;
|
|
|
286
286
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
287
287
|
/**
|
|
288
288
|
* SSO using OIDC
|
|
289
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
290
|
+
* @deprecated This option is deprecated.
|
|
289
291
|
* @hidden
|
|
290
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
291
292
|
*/
|
|
292
293
|
AuthType["OIDC"] = "SSO_OIDC";
|
|
293
294
|
/**
|
|
@@ -298,8 +299,9 @@ var AuthType;
|
|
|
298
299
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
299
300
|
/**
|
|
300
301
|
* Trusted authentication server
|
|
302
|
+
* Use {@link TrustedAuth} instead
|
|
303
|
+
* @deprecated This option is deprecated.
|
|
301
304
|
* @hidden
|
|
302
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
303
305
|
*/
|
|
304
306
|
AuthType["AuthServer"] = "AuthServer";
|
|
305
307
|
/**
|
|
@@ -326,6 +328,7 @@ var AuthType;
|
|
|
326
328
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
327
329
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
328
330
|
* implemented by some browsers.
|
|
331
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
329
332
|
* @example
|
|
330
333
|
* ```js
|
|
331
334
|
* init({
|
|
@@ -336,8 +339,8 @@ var AuthType;
|
|
|
336
339
|
* .then((response) => response.json())
|
|
337
340
|
* .then((data) => data.token);
|
|
338
341
|
* }
|
|
342
|
+
* });
|
|
339
343
|
* ```
|
|
340
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
341
344
|
*/
|
|
342
345
|
AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
|
|
343
346
|
/**
|
|
@@ -358,43 +361,43 @@ var HomeLeftNavItem;
|
|
|
358
361
|
/**
|
|
359
362
|
* The *Search data* option in
|
|
360
363
|
* the *Insights* left navigation panel.
|
|
361
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
364
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
362
365
|
*/
|
|
363
366
|
HomeLeftNavItem["SearchData"] = "search-data";
|
|
364
367
|
/**
|
|
365
368
|
* The *Home* menu option in
|
|
366
369
|
* the *Insights* left navigation panel.
|
|
367
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
370
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
368
371
|
*/
|
|
369
372
|
HomeLeftNavItem["Home"] = "insights-home";
|
|
370
373
|
/**
|
|
371
374
|
* The *Liveboards* menu option in
|
|
372
375
|
* the *Insights* left navigation panel.
|
|
373
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
376
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
374
377
|
*/
|
|
375
378
|
HomeLeftNavItem["Liveboards"] = "liveboards";
|
|
376
379
|
/**
|
|
377
380
|
* The *Answers* menu option in
|
|
378
381
|
* the *Insights* left navigation panel.
|
|
379
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
382
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
380
383
|
*/
|
|
381
384
|
HomeLeftNavItem["Answers"] = "answers";
|
|
382
385
|
/**
|
|
383
386
|
* The *Monitor subscriptions* menu option in
|
|
384
387
|
* the *Insights* left navigation panel.
|
|
385
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
388
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
386
389
|
*/
|
|
387
390
|
HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
|
|
388
391
|
/**
|
|
389
392
|
* The *SpotIQ analysis* menu option in
|
|
390
393
|
* the *Insights* left navigation panel.
|
|
391
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
394
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
392
395
|
*/
|
|
393
396
|
HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
|
|
394
397
|
/**
|
|
395
398
|
* The *Liveboard schedules* menu option in
|
|
396
399
|
* the *Insights* left navigation panel.
|
|
397
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
400
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
398
401
|
*/
|
|
399
402
|
HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
|
|
400
403
|
/**
|
|
@@ -500,7 +503,7 @@ var HomepageModule;
|
|
|
500
503
|
*/
|
|
501
504
|
HomepageModule["Search"] = "SEARCH";
|
|
502
505
|
/**
|
|
503
|
-
*
|
|
506
|
+
* KPI watchlist module
|
|
504
507
|
*/
|
|
505
508
|
HomepageModule["Watchlist"] = "WATCHLIST";
|
|
506
509
|
/**
|
|
@@ -532,7 +535,8 @@ var ListPageColumns;
|
|
|
532
535
|
*/
|
|
533
536
|
ListPageColumns["Favorites"] = "FAVOURITE";
|
|
534
537
|
/**
|
|
535
|
-
*
|
|
538
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
539
|
+
* @deprecated This option is deprecated.
|
|
536
540
|
*/
|
|
537
541
|
ListPageColumns["Favourite"] = "FAVOURITE";
|
|
538
542
|
/**
|
|
@@ -600,13 +604,13 @@ var EmbedEvent;
|
|
|
600
604
|
/**
|
|
601
605
|
* Rendering has initialized.
|
|
602
606
|
* @example
|
|
603
|
-
|
|
607
|
+
* ```js
|
|
604
608
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
605
609
|
* //show a loader
|
|
606
610
|
* function showLoader() {
|
|
607
611
|
* document.getElementById("loader");
|
|
608
612
|
* }
|
|
609
|
-
|
|
613
|
+
* ```
|
|
610
614
|
* @returns timestamp - The timestamp when the event was generated.
|
|
611
615
|
*/
|
|
612
616
|
EmbedEvent["Init"] = "init";
|
|
@@ -614,11 +618,11 @@ var EmbedEvent;
|
|
|
614
618
|
* Authentication has either succeeded or failed.
|
|
615
619
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
616
620
|
* @example
|
|
617
|
-
|
|
621
|
+
* ```js
|
|
618
622
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
619
623
|
* console.log('AuthInit', payload);
|
|
620
624
|
* })
|
|
621
|
-
|
|
625
|
+
* ```
|
|
622
626
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
623
627
|
*/
|
|
624
628
|
EmbedEvent["AuthInit"] = "authInit";
|
|
@@ -627,13 +631,13 @@ var EmbedEvent;
|
|
|
627
631
|
* @returns timestamp - The timestamp when the event was generated.
|
|
628
632
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
629
633
|
* @example
|
|
630
|
-
|
|
634
|
+
* ```js
|
|
631
635
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
632
636
|
* //hide loader
|
|
633
637
|
* function hideLoader() {
|
|
634
638
|
* document.getElementById("loader");
|
|
635
639
|
* }
|
|
636
|
-
|
|
640
|
+
* ```
|
|
637
641
|
*/
|
|
638
642
|
EmbedEvent["Load"] = "load";
|
|
639
643
|
/**
|
|
@@ -642,11 +646,11 @@ var EmbedEvent;
|
|
|
642
646
|
* @return data - Answer of Liveboard data
|
|
643
647
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
644
648
|
* @example
|
|
645
|
-
|
|
649
|
+
* ```js
|
|
646
650
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
647
651
|
* console.log('data', payload);
|
|
648
652
|
* })
|
|
649
|
-
|
|
653
|
+
* ```
|
|
650
654
|
* @important
|
|
651
655
|
*/
|
|
652
656
|
EmbedEvent["Data"] = "data";
|
|
@@ -654,9 +658,9 @@ var EmbedEvent;
|
|
|
654
658
|
* Search query has been updated by the user.
|
|
655
659
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
656
660
|
* @example
|
|
657
|
-
|
|
661
|
+
* ```js
|
|
658
662
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
659
|
-
|
|
663
|
+
* ```
|
|
660
664
|
*/
|
|
661
665
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
662
666
|
/**
|
|
@@ -666,7 +670,7 @@ var EmbedEvent;
|
|
|
666
670
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
667
671
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
668
672
|
* @example
|
|
669
|
-
|
|
673
|
+
* ```js
|
|
670
674
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
671
675
|
* points: {
|
|
672
676
|
* clickedPoint,
|
|
@@ -674,12 +678,12 @@ var EmbedEvent;
|
|
|
674
678
|
* },
|
|
675
679
|
* autoDrillDown: true,
|
|
676
680
|
* })
|
|
677
|
-
|
|
681
|
+
* ```
|
|
678
682
|
* In this example, `VizPointDoubleClick` event is used for
|
|
679
683
|
* triggering the `DrillDown` event when an area or specific
|
|
680
684
|
* data point on a table or chart is double-clicked.
|
|
681
685
|
* @example
|
|
682
|
-
|
|
686
|
+
* ```js
|
|
683
687
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
684
688
|
* console.log(payload);
|
|
685
689
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -693,7 +697,7 @@ var EmbedEvent;
|
|
|
693
697
|
* autoDrillDown: true,
|
|
694
698
|
* })
|
|
695
699
|
* })
|
|
696
|
-
|
|
700
|
+
* ```
|
|
697
701
|
*/
|
|
698
702
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
699
703
|
/**
|
|
@@ -818,13 +822,13 @@ var EmbedEvent;
|
|
|
818
822
|
* The ThoughtSpot authentication session has expired.
|
|
819
823
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
820
824
|
* @example
|
|
821
|
-
|
|
825
|
+
* ```js
|
|
822
826
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
823
827
|
* //show auth expired banner
|
|
824
828
|
* function showAuthExpired() {
|
|
825
829
|
* document.getElementById("authExpiredBanner");
|
|
826
830
|
* }
|
|
827
|
-
|
|
831
|
+
* ```
|
|
828
832
|
*/
|
|
829
833
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
830
834
|
/**
|
|
@@ -859,22 +863,22 @@ var EmbedEvent;
|
|
|
859
863
|
* Applicable to `SearchBarEmbed` only.
|
|
860
864
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
861
865
|
* @example
|
|
862
|
-
|
|
866
|
+
* ```js
|
|
863
867
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
864
868
|
* .then(data => {
|
|
865
869
|
* console.log('Answer Data:', data);
|
|
866
870
|
* })
|
|
867
|
-
|
|
871
|
+
* ```
|
|
868
872
|
*/
|
|
869
873
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
870
874
|
/**
|
|
871
875
|
* Detects the route change.
|
|
872
876
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
873
877
|
* @example
|
|
874
|
-
|
|
878
|
+
* ```js
|
|
875
879
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
876
880
|
* console.log('data', payload))
|
|
877
|
-
|
|
881
|
+
* ```
|
|
878
882
|
*/
|
|
879
883
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
880
884
|
/**
|
|
@@ -884,12 +888,12 @@ var EmbedEvent;
|
|
|
884
888
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
885
889
|
/**
|
|
886
890
|
* Emitted when the embed does not have cookie access. This happens
|
|
887
|
-
* when
|
|
888
|
-
*
|
|
891
|
+
* when third-party cookies are blocked by Safari or other
|
|
892
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
889
893
|
* @example
|
|
890
|
-
|
|
894
|
+
* ```js
|
|
891
895
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
892
|
-
|
|
896
|
+
* ```
|
|
893
897
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
894
898
|
*/
|
|
895
899
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
@@ -903,22 +907,22 @@ var EmbedEvent;
|
|
|
903
907
|
* Emitted when any modal is opened in the app
|
|
904
908
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
905
909
|
* @example
|
|
906
|
-
|
|
910
|
+
* ```js
|
|
907
911
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
908
912
|
* console.log('dialog open', payload);
|
|
909
913
|
* })
|
|
910
|
-
|
|
914
|
+
* ```
|
|
911
915
|
*/
|
|
912
916
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
913
917
|
/**
|
|
914
918
|
* Emitted when any modal is closed in the app
|
|
915
919
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
916
920
|
* @example
|
|
917
|
-
|
|
921
|
+
* ```js
|
|
918
922
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
919
923
|
* console.log('dialog close', payload);
|
|
920
924
|
* })
|
|
921
|
-
|
|
925
|
+
* ```
|
|
922
926
|
*/
|
|
923
927
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
924
928
|
/**
|
|
@@ -927,39 +931,39 @@ var EmbedEvent;
|
|
|
927
931
|
* other events on the rendered Liveboard.
|
|
928
932
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
929
933
|
* @example
|
|
930
|
-
|
|
934
|
+
* ```js
|
|
931
935
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
932
936
|
console.log('Liveboard is rendered', payload);
|
|
933
937
|
})
|
|
934
|
-
|
|
938
|
+
* ```
|
|
935
939
|
* The following example shows how to trigger
|
|
936
940
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
937
941
|
* @example
|
|
938
|
-
|
|
942
|
+
* ```js
|
|
939
943
|
* const embedRef = useEmbedRef();
|
|
940
944
|
* const onLiveboardRendered = () => {
|
|
941
945
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
942
946
|
* };
|
|
943
|
-
|
|
947
|
+
* ```
|
|
944
948
|
*/
|
|
945
949
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
946
950
|
/**
|
|
947
951
|
* Emits all events.
|
|
948
|
-
* @
|
|
952
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
949
953
|
* @example
|
|
950
|
-
|
|
954
|
+
* ```js
|
|
951
955
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
952
956
|
* console.log('Embed Events', payload)
|
|
953
957
|
* })
|
|
954
|
-
|
|
958
|
+
* ```
|
|
955
959
|
*/
|
|
956
960
|
EmbedEvent["ALL"] = "*";
|
|
957
961
|
/**
|
|
958
962
|
* Emitted when an Answer is saved in the app.
|
|
959
963
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
960
|
-
* @
|
|
964
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
961
965
|
* @example
|
|
962
|
-
|
|
966
|
+
* ```js
|
|
963
967
|
* //Emit when action starts
|
|
964
968
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
965
969
|
* console.log('Save', payload)
|
|
@@ -970,7 +974,7 @@ var EmbedEvent;
|
|
|
970
974
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
971
975
|
* console.log('Save', payload)
|
|
972
976
|
* })
|
|
973
|
-
|
|
977
|
+
* ```
|
|
974
978
|
*/
|
|
975
979
|
EmbedEvent["Save"] = "save";
|
|
976
980
|
/**
|
|
@@ -982,11 +986,11 @@ var EmbedEvent;
|
|
|
982
986
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
983
987
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
984
988
|
* @example
|
|
985
|
-
|
|
989
|
+
* ```js
|
|
986
990
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
987
991
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
988
992
|
* })
|
|
989
|
-
|
|
993
|
+
* ```
|
|
990
994
|
*/
|
|
991
995
|
EmbedEvent["Download"] = "download";
|
|
992
996
|
/**
|
|
@@ -994,14 +998,14 @@ var EmbedEvent;
|
|
|
994
998
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
995
999
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
996
1000
|
* @example
|
|
997
|
-
|
|
1001
|
+
* ```js
|
|
998
1002
|
* //emit when action starts
|
|
999
1003
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1000
1004
|
* console.log('download PNG', payload)}, {start: true })
|
|
1001
1005
|
* //emit when action ends
|
|
1002
1006
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1003
1007
|
* console.log('download PNG', payload)})
|
|
1004
|
-
|
|
1008
|
+
* ```
|
|
1005
1009
|
*/
|
|
1006
1010
|
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
1007
1011
|
/**
|
|
@@ -1009,14 +1013,14 @@ var EmbedEvent;
|
|
|
1009
1013
|
* Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
|
|
1010
1014
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1011
1015
|
* @example
|
|
1012
|
-
|
|
1016
|
+
* ```js
|
|
1013
1017
|
* //emit when action starts
|
|
1014
1018
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1015
1019
|
* console.log('download PDF', payload)}, {start: true })
|
|
1016
1020
|
* //emit when action ends
|
|
1017
1021
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1018
1022
|
* console.log('download PDF', payload)})
|
|
1019
|
-
|
|
1023
|
+
* ```
|
|
1020
1024
|
*/
|
|
1021
1025
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
1022
1026
|
/**
|
|
@@ -1024,14 +1028,14 @@ var EmbedEvent;
|
|
|
1024
1028
|
* Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
|
|
1025
1029
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1026
1030
|
* @example
|
|
1027
|
-
|
|
1031
|
+
* ```js
|
|
1028
1032
|
* //emit when action starts
|
|
1029
1033
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1030
1034
|
* console.log('download CSV', payload)}, {start: true })
|
|
1031
1035
|
* //emit when action ends
|
|
1032
1036
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1033
1037
|
* console.log('download CSV', payload)})
|
|
1034
|
-
|
|
1038
|
+
* ```
|
|
1035
1039
|
*/
|
|
1036
1040
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
1037
1041
|
/**
|
|
@@ -1039,14 +1043,14 @@ var EmbedEvent;
|
|
|
1039
1043
|
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
|
|
1040
1044
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1041
1045
|
* @example
|
|
1042
|
-
|
|
1046
|
+
* ```js
|
|
1043
1047
|
* //emit when action starts
|
|
1044
1048
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1045
1049
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
1046
1050
|
* //emit when action ends
|
|
1047
1051
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1048
1052
|
* console.log('download Xlsx', payload)})
|
|
1049
|
-
|
|
1053
|
+
* ```
|
|
1050
1054
|
*/
|
|
1051
1055
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
1052
1056
|
/**
|
|
@@ -1054,25 +1058,25 @@ var EmbedEvent;
|
|
|
1054
1058
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
1055
1059
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1056
1060
|
* @example
|
|
1057
|
-
|
|
1061
|
+
* ```js
|
|
1058
1062
|
* //emit when action starts
|
|
1059
1063
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1060
1064
|
* console.log('delete answer', payload)}, {start: true })
|
|
1061
1065
|
* //trigger when action is completed
|
|
1062
1066
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1063
1067
|
* console.log('delete answer', payload)})
|
|
1064
|
-
|
|
1068
|
+
* ```
|
|
1065
1069
|
*/
|
|
1066
1070
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
1067
1071
|
/**
|
|
1068
1072
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
1069
1073
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
1070
1074
|
* @example
|
|
1071
|
-
|
|
1075
|
+
* ```js
|
|
1072
1076
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
1073
1077
|
* console.log('AI Highlights', payload);
|
|
1074
1078
|
* })
|
|
1075
|
-
|
|
1079
|
+
* ```
|
|
1076
1080
|
*/
|
|
1077
1081
|
EmbedEvent["AIHighlights"] = "AIHighlights";
|
|
1078
1082
|
/**
|
|
@@ -1081,7 +1085,7 @@ var EmbedEvent;
|
|
|
1081
1085
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
1082
1086
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1083
1087
|
* @example
|
|
1084
|
-
|
|
1088
|
+
* ```js
|
|
1085
1089
|
* //emit when action starts
|
|
1086
1090
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1087
1091
|
* console.log('pin', payload)
|
|
@@ -1092,14 +1096,14 @@ var EmbedEvent;
|
|
|
1092
1096
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1093
1097
|
* console.log('pin', payload)
|
|
1094
1098
|
* })
|
|
1095
|
-
|
|
1099
|
+
* ```
|
|
1096
1100
|
*/
|
|
1097
1101
|
EmbedEvent["Pin"] = "pin";
|
|
1098
1102
|
/**
|
|
1099
1103
|
* Emitted when SpotIQ analysis is triggered
|
|
1100
1104
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1101
1105
|
* @example
|
|
1102
|
-
|
|
1106
|
+
* ```js
|
|
1103
1107
|
* //emit when action starts
|
|
1104
1108
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1105
1109
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -1110,14 +1114,14 @@ var EmbedEvent;
|
|
|
1110
1114
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1111
1115
|
* console.log('SpotIQ analyze', payload)
|
|
1112
1116
|
* })
|
|
1113
|
-
|
|
1117
|
+
* ```
|
|
1114
1118
|
*/
|
|
1115
1119
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
1116
1120
|
/**
|
|
1117
1121
|
* Emitted when a user shares an object with another user or group
|
|
1118
1122
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1119
1123
|
* @example
|
|
1120
|
-
|
|
1124
|
+
* ```js
|
|
1121
1125
|
* //emit when action starts
|
|
1122
1126
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1123
1127
|
* console.log('Share', payload)
|
|
@@ -1128,7 +1132,7 @@ var EmbedEvent;
|
|
|
1128
1132
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1129
1133
|
* console.log('Share', payload)
|
|
1130
1134
|
* })
|
|
1131
|
-
|
|
1135
|
+
* ```
|
|
1132
1136
|
*/
|
|
1133
1137
|
EmbedEvent["Share"] = "share";
|
|
1134
1138
|
/**
|
|
@@ -1136,11 +1140,11 @@ var EmbedEvent;
|
|
|
1136
1140
|
* data on a chart or table.
|
|
1137
1141
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1138
1142
|
* @example
|
|
1139
|
-
|
|
1143
|
+
* ```js
|
|
1140
1144
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
1141
1145
|
* console.log('Drill include', payload);
|
|
1142
1146
|
* })
|
|
1143
|
-
|
|
1147
|
+
* ```
|
|
1144
1148
|
*/
|
|
1145
1149
|
EmbedEvent["DrillInclude"] = "context-menu-item-include";
|
|
1146
1150
|
/**
|
|
@@ -1148,22 +1152,22 @@ var EmbedEvent;
|
|
|
1148
1152
|
* data on a chart or table
|
|
1149
1153
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1150
1154
|
* @example
|
|
1151
|
-
|
|
1155
|
+
* ```js
|
|
1152
1156
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
1153
1157
|
* console.log('Drill exclude', payload);
|
|
1154
1158
|
* })
|
|
1155
|
-
|
|
1159
|
+
* ```
|
|
1156
1160
|
*/
|
|
1157
1161
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
1158
1162
|
/**
|
|
1159
1163
|
* Emitted when a column value is copied in the embedded app.
|
|
1160
1164
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1161
1165
|
* @example
|
|
1162
|
-
|
|
1163
|
-
*
|
|
1166
|
+
* ```js
|
|
1167
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
1164
1168
|
* console.log('copy to clipboard', payload);
|
|
1165
1169
|
* })
|
|
1166
|
-
|
|
1170
|
+
* ```
|
|
1167
1171
|
*/
|
|
1168
1172
|
EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
|
|
1169
1173
|
/**
|
|
@@ -1171,10 +1175,10 @@ var EmbedEvent;
|
|
|
1171
1175
|
* embedded Liveboard.
|
|
1172
1176
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1173
1177
|
* @example
|
|
1174
|
-
|
|
1178
|
+
* ```js
|
|
1175
1179
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
1176
1180
|
* })
|
|
1177
|
-
|
|
1181
|
+
* ```
|
|
1178
1182
|
*/
|
|
1179
1183
|
EmbedEvent["UpdateTML"] = "updateTSL";
|
|
1180
1184
|
/**
|
|
@@ -1182,11 +1186,11 @@ var EmbedEvent;
|
|
|
1182
1186
|
* on an embedded Liveboard.
|
|
1183
1187
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1184
1188
|
* @example
|
|
1185
|
-
|
|
1189
|
+
* ```js
|
|
1186
1190
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
1187
1191
|
* console.log('Edit TML', payload);
|
|
1188
1192
|
* })
|
|
1189
|
-
|
|
1193
|
+
* ```
|
|
1190
1194
|
*/
|
|
1191
1195
|
EmbedEvent["EditTML"] = "editTSL";
|
|
1192
1196
|
/**
|
|
@@ -1195,25 +1199,25 @@ var EmbedEvent;
|
|
|
1195
1199
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
1196
1200
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1197
1201
|
* @example
|
|
1198
|
-
|
|
1202
|
+
* ```js
|
|
1199
1203
|
* //emit when action starts
|
|
1200
1204
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1201
1205
|
* console.log('Export TML', payload)}, { start: true })
|
|
1202
1206
|
* //emit when action ends
|
|
1203
1207
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1204
1208
|
* console.log('Export TML', payload)})
|
|
1205
|
-
|
|
1209
|
+
* ```
|
|
1206
1210
|
*/
|
|
1207
1211
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
1208
1212
|
/**
|
|
1209
1213
|
* Emitted when an Answer is saved as a View.
|
|
1210
1214
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1211
1215
|
* @example
|
|
1212
|
-
|
|
1216
|
+
* ```js
|
|
1213
1217
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
1214
1218
|
* console.log('View', payload);
|
|
1215
1219
|
* })
|
|
1216
|
-
|
|
1220
|
+
* ```
|
|
1217
1221
|
*/
|
|
1218
1222
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
1219
1223
|
/**
|
|
@@ -1221,36 +1225,36 @@ var EmbedEvent;
|
|
|
1221
1225
|
* Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
|
|
1222
1226
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1223
1227
|
* @example
|
|
1224
|
-
|
|
1228
|
+
* ```js
|
|
1225
1229
|
* //emit when action starts
|
|
1226
1230
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1227
1231
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1228
1232
|
* //emit when action ends
|
|
1229
1233
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1230
1234
|
* console.log('Copy and edit', payload)})
|
|
1231
|
-
|
|
1235
|
+
* ```
|
|
1232
1236
|
*/
|
|
1233
1237
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
1234
1238
|
/**
|
|
1235
1239
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
1236
1240
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1237
1241
|
* @example
|
|
1238
|
-
|
|
1242
|
+
* ```js
|
|
1239
1243
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
1240
1244
|
* console.log('show data', payload);
|
|
1241
1245
|
* })
|
|
1242
|
-
|
|
1246
|
+
* ```
|
|
1243
1247
|
*/
|
|
1244
1248
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1245
1249
|
/**
|
|
1246
1250
|
* Emitted when an Answer is switched to a chart or table view.
|
|
1247
1251
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1248
1252
|
* @example
|
|
1249
|
-
|
|
1253
|
+
* ```js
|
|
1250
1254
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1251
1255
|
* console.log('switch view', payload);
|
|
1252
1256
|
* })
|
|
1253
|
-
|
|
1257
|
+
* ```
|
|
1254
1258
|
*/
|
|
1255
1259
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
1256
1260
|
/**
|
|
@@ -1267,118 +1271,118 @@ var EmbedEvent;
|
|
|
1267
1271
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1268
1272
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1269
1273
|
* @example
|
|
1270
|
-
|
|
1274
|
+
* ```js
|
|
1271
1275
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
1272
1276
|
* console.log('Liveboard details', payload);
|
|
1273
1277
|
* })
|
|
1274
|
-
|
|
1278
|
+
* ```
|
|
1275
1279
|
*/
|
|
1276
1280
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1277
1281
|
/**
|
|
1278
1282
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1279
1283
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1280
1284
|
* @example
|
|
1281
|
-
|
|
1285
|
+
* ```js
|
|
1282
1286
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
1283
1287
|
* console.log('favorites', payload);
|
|
1284
1288
|
* })
|
|
1285
|
-
|
|
1289
|
+
* ```
|
|
1286
1290
|
*/
|
|
1287
1291
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
1288
1292
|
/**
|
|
1289
1293
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1290
1294
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1291
1295
|
* @example
|
|
1292
|
-
|
|
1296
|
+
* ```js
|
|
1293
1297
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
1294
|
-
* console.log(
|
|
1298
|
+
* console.log('Liveboard schedule', payload);
|
|
1295
1299
|
* })
|
|
1296
|
-
|
|
1300
|
+
* ```
|
|
1297
1301
|
*/
|
|
1298
1302
|
EmbedEvent["Schedule"] = "subscription";
|
|
1299
1303
|
/**
|
|
1300
1304
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1301
1305
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1302
1306
|
* @example
|
|
1303
|
-
|
|
1307
|
+
* ```js
|
|
1304
1308
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
1305
|
-
* console.log(
|
|
1309
|
+
* console.log('Liveboard edit', payload);
|
|
1306
1310
|
* })
|
|
1307
|
-
|
|
1311
|
+
* ```
|
|
1308
1312
|
*/
|
|
1309
1313
|
EmbedEvent["Edit"] = "edit";
|
|
1310
1314
|
/**
|
|
1311
1315
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1312
1316
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1313
1317
|
* @example
|
|
1314
|
-
|
|
1318
|
+
* ```js
|
|
1315
1319
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
1316
|
-
* console.log(
|
|
1320
|
+
* console.log('Copy', payload);
|
|
1317
1321
|
* })
|
|
1318
|
-
|
|
1322
|
+
* ```
|
|
1319
1323
|
*/
|
|
1320
1324
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
1321
1325
|
/**
|
|
1322
1326
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1323
1327
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1324
1328
|
* @example
|
|
1325
|
-
|
|
1329
|
+
* ```js
|
|
1326
1330
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1327
|
-
|
|
1331
|
+
* ```
|
|
1328
1332
|
* @example
|
|
1329
|
-
|
|
1333
|
+
* ```js
|
|
1330
1334
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
1331
1335
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1332
1336
|
* })
|
|
1333
|
-
|
|
1337
|
+
* ```
|
|
1334
1338
|
*/
|
|
1335
1339
|
EmbedEvent["Present"] = "present";
|
|
1336
1340
|
/**
|
|
1337
1341
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1338
1342
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1339
1343
|
* @example
|
|
1340
|
-
|
|
1344
|
+
* ```js
|
|
1341
1345
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1342
1346
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1343
|
-
|
|
1347
|
+
* ```
|
|
1344
1348
|
*/
|
|
1345
1349
|
EmbedEvent["Delete"] = "delete";
|
|
1346
1350
|
/**
|
|
1347
1351
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1348
1352
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1349
1353
|
* @example
|
|
1350
|
-
|
|
1354
|
+
* ```js
|
|
1351
1355
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1352
|
-
|
|
1356
|
+
* ```
|
|
1353
1357
|
*/
|
|
1354
1358
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
1355
1359
|
/**
|
|
1356
1360
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1357
1361
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1358
1362
|
* @example
|
|
1359
|
-
|
|
1363
|
+
* ```js
|
|
1360
1364
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1361
|
-
|
|
1365
|
+
* ```
|
|
1362
1366
|
*/
|
|
1363
1367
|
EmbedEvent["Cancel"] = "cancel";
|
|
1364
1368
|
/**
|
|
1365
1369
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1366
1370
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1367
1371
|
* @example
|
|
1368
|
-
|
|
1372
|
+
* ```js
|
|
1369
1373
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1370
1374
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1371
|
-
|
|
1375
|
+
* ```
|
|
1372
1376
|
*/
|
|
1373
1377
|
EmbedEvent["Explore"] = "explore";
|
|
1374
1378
|
/**
|
|
1375
1379
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
1376
1380
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1377
1381
|
* @example
|
|
1378
|
-
|
|
1382
|
+
* ```js
|
|
1379
1383
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
1380
1384
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1381
|
-
|
|
1385
|
+
* ```
|
|
1382
1386
|
*/
|
|
1383
1387
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
1384
1388
|
/**
|
|
@@ -1386,21 +1390,21 @@ var EmbedEvent;
|
|
|
1386
1390
|
* visualization or Liveboard.
|
|
1387
1391
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1388
1392
|
* @example
|
|
1389
|
-
|
|
1393
|
+
* ```js
|
|
1390
1394
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
1391
1395
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1392
|
-
|
|
1396
|
+
* ```
|
|
1393
1397
|
*/
|
|
1394
1398
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
1395
1399
|
/**
|
|
1396
1400
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
1397
1401
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1398
1402
|
* @example
|
|
1399
|
-
|
|
1403
|
+
* ```js
|
|
1400
1404
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
1401
1405
|
* console.log('VizPointClick', payload)
|
|
1402
1406
|
* })
|
|
1403
|
-
|
|
1407
|
+
* ```
|
|
1404
1408
|
*/
|
|
1405
1409
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
1406
1410
|
/**
|
|
@@ -1414,35 +1418,35 @@ var EmbedEvent;
|
|
|
1414
1418
|
* filter details.
|
|
1415
1419
|
* @example
|
|
1416
1420
|
*
|
|
1417
|
-
|
|
1421
|
+
* ```js
|
|
1418
1422
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1419
1423
|
* console.log('payload', payload);
|
|
1420
1424
|
* })
|
|
1421
|
-
*
|
|
1425
|
+
* ```
|
|
1422
1426
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1423
1427
|
*/
|
|
1424
1428
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
1425
1429
|
/**
|
|
1426
1430
|
* Emitted when a user clicks the **Go** button to initiate
|
|
1427
1431
|
* a Natural Language Search query
|
|
1428
|
-
* @version SDK
|
|
1432
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1429
1433
|
*/
|
|
1430
1434
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
1431
1435
|
/**
|
|
1432
1436
|
* Emitted when a user selects a data source on the embedded
|
|
1433
1437
|
* Natural Language Search interface.
|
|
1434
1438
|
*
|
|
1435
|
-
* @version SDK
|
|
1439
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1436
1440
|
*/
|
|
1437
1441
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
1438
1442
|
/**
|
|
1439
1443
|
* Emitted when a user updates a connection on the **Data** page
|
|
1440
|
-
* @version SDK
|
|
1444
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1441
1445
|
*/
|
|
1442
1446
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
1443
1447
|
/**
|
|
1444
1448
|
* Emitted when a user updates a connection on the **Data** page
|
|
1445
|
-
* @version SDK
|
|
1449
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1446
1450
|
*/
|
|
1447
1451
|
EmbedEvent["CreateConnection"] = "createConnection";
|
|
1448
1452
|
/**
|
|
@@ -1452,7 +1456,7 @@ var EmbedEvent;
|
|
|
1452
1456
|
* @returns viewId: string
|
|
1453
1457
|
* @returns liveboardId: string
|
|
1454
1458
|
* @returns isPublic: boolean
|
|
1455
|
-
* @version SDK
|
|
1459
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1456
1460
|
*/
|
|
1457
1461
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1458
1462
|
/**
|
|
@@ -1461,7 +1465,7 @@ var EmbedEvent;
|
|
|
1461
1465
|
* @returns viewId: string
|
|
1462
1466
|
* @returns liveboardId: string
|
|
1463
1467
|
* @returns isPublic: boolean
|
|
1464
|
-
* @version SDK
|
|
1468
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1465
1469
|
*/
|
|
1466
1470
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1467
1471
|
/**
|
|
@@ -1470,19 +1474,19 @@ var EmbedEvent;
|
|
|
1470
1474
|
* @returns viewId: string
|
|
1471
1475
|
* @returns liveboardId: string
|
|
1472
1476
|
* @returns isPublic: boolean
|
|
1473
|
-
* @version SDK
|
|
1477
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1474
1478
|
*/
|
|
1475
1479
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1476
1480
|
/**
|
|
1477
1481
|
* Emitted when a PersonalisedView is deleted.
|
|
1478
1482
|
* @returns views: string[]
|
|
1479
1483
|
* @returns liveboardId: string
|
|
1480
|
-
* @version SDK
|
|
1484
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1481
1485
|
*/
|
|
1482
1486
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1483
1487
|
/**
|
|
1484
1488
|
* Emitted when a user creates a Worksheet.
|
|
1485
|
-
* @version SDK
|
|
1489
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1486
1490
|
*/
|
|
1487
1491
|
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
1488
1492
|
/**
|
|
@@ -1491,12 +1495,12 @@ var EmbedEvent;
|
|
|
1491
1495
|
* @returns viewId: string
|
|
1492
1496
|
* @returns liveboardId: string
|
|
1493
1497
|
* @returns isPublic: boolean
|
|
1494
|
-
* @version SDK
|
|
1498
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
1495
1499
|
*/
|
|
1496
1500
|
EmbedEvent["AskSageInit"] = "AskSageInit";
|
|
1497
1501
|
/**
|
|
1498
1502
|
* Emitted when a Liveboard or visualization is renamed.
|
|
1499
|
-
* @version SDK
|
|
1503
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
1500
1504
|
*/
|
|
1501
1505
|
EmbedEvent["Rename"] = "rename";
|
|
1502
1506
|
/**
|
|
@@ -1514,14 +1518,12 @@ var EmbedEvent;
|
|
|
1514
1518
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
1515
1519
|
* - `responder`: Contains elements that let developers define whether ThoughtSpot
|
|
1516
1520
|
* will run or block the search operation, and if blocked, which error message to provide.
|
|
1517
|
-
*
|
|
1518
|
-
* `execute` - When `execute` returns `true`, the search is run.
|
|
1521
|
+
* - `execute` - When `execute` returns `true`, the search is run.
|
|
1519
1522
|
* When `execute` returns `false`, the search is not executed.
|
|
1520
|
-
*
|
|
1521
|
-
* `error` - Developers can customize the user-facing error message when `execute`
|
|
1523
|
+
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
1522
1524
|
* is `false` by using the `error` parameters in `responder`.
|
|
1523
|
-
* `errorText` - The error message text shown to the user.
|
|
1524
|
-
* @version SDK
|
|
1525
|
+
* - `errorText` - The error message text shown to the user.
|
|
1526
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1525
1527
|
* @example
|
|
1526
1528
|
*
|
|
1527
1529
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -1536,7 +1538,7 @@ var EmbedEvent;
|
|
|
1536
1538
|
* },
|
|
1537
1539
|
* },
|
|
1538
1540
|
* });
|
|
1539
|
-
* })
|
|
1541
|
+
* })
|
|
1540
1542
|
* ```
|
|
1541
1543
|
* @example
|
|
1542
1544
|
*
|
|
@@ -1562,7 +1564,7 @@ var EmbedEvent;
|
|
|
1562
1564
|
* },
|
|
1563
1565
|
* },
|
|
1564
1566
|
* });
|
|
1565
|
-
* })
|
|
1567
|
+
* })
|
|
1566
1568
|
* ```
|
|
1567
1569
|
*/
|
|
1568
1570
|
EmbedEvent["OnBeforeGetVizDataIntercept"] = "onBeforeGetVizDataIntercept";
|
|
@@ -1573,8 +1575,8 @@ var EmbedEvent;
|
|
|
1573
1575
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1574
1576
|
* console.log('payload', payload);
|
|
1575
1577
|
* })
|
|
1576
|
-
|
|
1577
|
-
* @version SDK
|
|
1578
|
+
* ```
|
|
1579
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1578
1580
|
*/
|
|
1579
1581
|
EmbedEvent["ParameterChanged"] = "parameterChanged";
|
|
1580
1582
|
/**
|
|
@@ -1629,24 +1631,24 @@ var EmbedEvent;
|
|
|
1629
1631
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
1630
1632
|
* console.log('payload', payload);
|
|
1631
1633
|
* })
|
|
1632
|
-
|
|
1633
|
-
* @version SDK
|
|
1634
|
+
* ```
|
|
1635
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1634
1636
|
*/
|
|
1635
1637
|
EmbedEvent["CreateLiveboard"] = "createLiveboard";
|
|
1636
1638
|
/**
|
|
1637
1639
|
* Emitted when a user creates a Model.
|
|
1638
|
-
* @version SDK
|
|
1640
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1639
1641
|
*/
|
|
1640
1642
|
EmbedEvent["CreateModel"] = "createModel";
|
|
1641
1643
|
/**
|
|
1642
1644
|
* @hidden
|
|
1643
1645
|
* Emitted when a user exits present mode.
|
|
1644
|
-
* @version SDK
|
|
1646
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1645
1647
|
*/
|
|
1646
1648
|
EmbedEvent["ExitPresentMode"] = "exitPresentMode";
|
|
1647
1649
|
/**
|
|
1648
1650
|
* Emitted when a user requests the full height lazy load data.
|
|
1649
|
-
* @version SDK
|
|
1651
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1650
1652
|
* @hidden
|
|
1651
1653
|
*/
|
|
1652
1654
|
EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
|
|
@@ -1657,7 +1659,7 @@ var EmbedEvent;
|
|
|
1657
1659
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
1658
1660
|
* console.log('payload', payload);
|
|
1659
1661
|
* })
|
|
1660
|
-
|
|
1662
|
+
* ```
|
|
1661
1663
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1662
1664
|
*/
|
|
1663
1665
|
EmbedEvent["SpotterData"] = "SpotterData";
|
|
@@ -1668,7 +1670,7 @@ var EmbedEvent;
|
|
|
1668
1670
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
1669
1671
|
* console.log('payload', payload);
|
|
1670
1672
|
* })
|
|
1671
|
-
|
|
1673
|
+
* ```
|
|
1672
1674
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1673
1675
|
*/
|
|
1674
1676
|
EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
|
|
@@ -1679,7 +1681,7 @@ var EmbedEvent;
|
|
|
1679
1681
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
1680
1682
|
* console.log('payload', payload);
|
|
1681
1683
|
* })
|
|
1682
|
-
|
|
1684
|
+
* ```
|
|
1683
1685
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1684
1686
|
*/
|
|
1685
1687
|
EmbedEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -1701,7 +1703,7 @@ var EmbedEvent;
|
|
|
1701
1703
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
1702
1704
|
* console.log('payload', payload);
|
|
1703
1705
|
* })
|
|
1704
|
-
|
|
1706
|
+
* ```
|
|
1705
1707
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1706
1708
|
*/
|
|
1707
1709
|
EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
|
|
@@ -1712,7 +1714,7 @@ var EmbedEvent;
|
|
|
1712
1714
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
1713
1715
|
* console.log('payload', payload);
|
|
1714
1716
|
* })
|
|
1715
|
-
|
|
1717
|
+
* ```
|
|
1716
1718
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1717
1719
|
*/
|
|
1718
1720
|
EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
|
|
@@ -1723,18 +1725,18 @@ var EmbedEvent;
|
|
|
1723
1725
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
1724
1726
|
* console.log('payload', payload);
|
|
1725
1727
|
* })
|
|
1726
|
-
|
|
1728
|
+
* ```
|
|
1727
1729
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1728
1730
|
*/
|
|
1729
1731
|
EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
|
|
1730
1732
|
/**
|
|
1731
|
-
* Emitted when the
|
|
1733
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
1732
1734
|
* @example
|
|
1733
1735
|
* ```js
|
|
1734
1736
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
1735
1737
|
* console.log('payload', payload);
|
|
1736
1738
|
* })
|
|
1737
|
-
|
|
1739
|
+
* ```
|
|
1738
1740
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1739
1741
|
*/
|
|
1740
1742
|
EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
@@ -1745,7 +1747,7 @@ var EmbedEvent;
|
|
|
1745
1747
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
1746
1748
|
* console.log('payload', payload);
|
|
1747
1749
|
* })
|
|
1748
|
-
|
|
1750
|
+
* ```
|
|
1749
1751
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1750
1752
|
*/
|
|
1751
1753
|
EmbedEvent["SpotterInit"] = "spotterInit";
|
|
@@ -1756,7 +1758,7 @@ var EmbedEvent;
|
|
|
1756
1758
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
1757
1759
|
* console.log('payload', payload);
|
|
1758
1760
|
* })
|
|
1759
|
-
|
|
1761
|
+
* ```
|
|
1760
1762
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
1761
1763
|
*/
|
|
1762
1764
|
EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
|
|
@@ -2111,7 +2113,7 @@ var HostEvent;
|
|
|
2111
2113
|
* ```js
|
|
2112
2114
|
* appEmbed.navigateToPage(-1)
|
|
2113
2115
|
* ```
|
|
2114
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
2116
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
2115
2117
|
*/
|
|
2116
2118
|
HostEvent["Navigate"] = "Navigate";
|
|
2117
2119
|
/**
|
|
@@ -2244,9 +2246,9 @@ var HostEvent;
|
|
|
2244
2246
|
* Trigger the **Show Liveboard details** action
|
|
2245
2247
|
* on an embedded Liveboard.
|
|
2246
2248
|
* @example
|
|
2247
|
-
|
|
2249
|
+
* ```js
|
|
2248
2250
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2249
|
-
|
|
2251
|
+
* ```
|
|
2250
2252
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2251
2253
|
*/
|
|
2252
2254
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
@@ -2374,7 +2376,7 @@ var HostEvent;
|
|
|
2374
2376
|
* appEmbed.trigger(HostEvent.Remove)
|
|
2375
2377
|
* ```
|
|
2376
2378
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2377
|
-
*
|
|
2379
|
+
* @example
|
|
2378
2380
|
* ```js
|
|
2379
2381
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
2380
2382
|
* ```
|
|
@@ -2465,7 +2467,7 @@ var HostEvent;
|
|
|
2465
2467
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2466
2468
|
* ```
|
|
2467
2469
|
* ```js
|
|
2468
|
-
* vizEmbed.trigger(
|
|
2470
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
2469
2471
|
* ```
|
|
2470
2472
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2471
2473
|
*/
|
|
@@ -2482,7 +2484,7 @@ var HostEvent;
|
|
|
2482
2484
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2483
2485
|
* ```
|
|
2484
2486
|
* ```js
|
|
2485
|
-
* vizEmbed.trigger(
|
|
2487
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
2486
2488
|
* ```
|
|
2487
2489
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2488
2490
|
*/
|
|
@@ -2497,23 +2499,22 @@ var HostEvent;
|
|
|
2497
2499
|
* );
|
|
2498
2500
|
* })
|
|
2499
2501
|
* ```
|
|
2500
|
-
*
|
|
2502
|
+
* @example
|
|
2501
2503
|
* ```js
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2504
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
2505
|
+
* let latestSpotterVizId = '';
|
|
2506
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
2507
|
+
* latestSpotterVizId = payload.data.id;
|
|
2508
|
+
* });
|
|
2509
|
+
*
|
|
2510
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2510
2511
|
* vizId: latestSpotterVizId
|
|
2511
2512
|
* }).then((tml) => {
|
|
2512
2513
|
* console.log(
|
|
2513
2514
|
* tml.answer.search_query // TML representation of the search query
|
|
2514
2515
|
* );
|
|
2515
2516
|
* })
|
|
2516
|
-
|
|
2517
|
+
* ```
|
|
2517
2518
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2518
2519
|
* @important
|
|
2519
2520
|
*/
|
|
@@ -2577,6 +2578,11 @@ var HostEvent;
|
|
|
2577
2578
|
/**
|
|
2578
2579
|
* Trigger the **Download** action on charts in
|
|
2579
2580
|
* the embedded view.
|
|
2581
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
2582
|
+
*
|
|
2583
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2584
|
+
*
|
|
2585
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2580
2586
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
2581
2587
|
* @example
|
|
2582
2588
|
* ```js
|
|
@@ -2595,9 +2601,6 @@ var HostEvent;
|
|
|
2595
2601
|
*
|
|
2596
2602
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
2597
2603
|
* ```
|
|
2598
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2599
|
-
* Use {@link DownloadAsPng}
|
|
2600
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2601
2604
|
*/
|
|
2602
2605
|
HostEvent["Download"] = "downloadAsPng";
|
|
2603
2606
|
/**
|
|
@@ -3035,8 +3038,8 @@ var HostEvent;
|
|
|
3035
3038
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
3036
3039
|
* console.log('parameters', parameter);
|
|
3037
3040
|
* });
|
|
3038
|
-
|
|
3039
|
-
|
|
3041
|
+
* ```
|
|
3042
|
+
* ```js
|
|
3040
3043
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
3041
3044
|
* let latestSpotterVizId = '';
|
|
3042
3045
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -3044,7 +3047,7 @@ var HostEvent;
|
|
|
3044
3047
|
* });
|
|
3045
3048
|
*
|
|
3046
3049
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
3047
|
-
|
|
3050
|
+
* ```
|
|
3048
3051
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3049
3052
|
*/
|
|
3050
3053
|
HostEvent["GetParameters"] = "GetParameters";
|
|
@@ -3061,7 +3064,7 @@ var HostEvent;
|
|
|
3061
3064
|
* Notify when info call is completed successfully
|
|
3062
3065
|
* ```js
|
|
3063
3066
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
3064
|
-
|
|
3067
|
+
* ```
|
|
3065
3068
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3066
3069
|
*/
|
|
3067
3070
|
HostEvent["InfoSuccess"] = "InfoSuccess";
|
|
@@ -3164,7 +3167,7 @@ var HostEvent;
|
|
|
3164
3167
|
* ```js
|
|
3165
3168
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
3166
3169
|
*
|
|
3167
|
-
|
|
3170
|
+
* ```
|
|
3168
3171
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
3169
3172
|
*/
|
|
3170
3173
|
HostEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -3206,7 +3209,7 @@ var HostEvent;
|
|
|
3206
3209
|
* });
|
|
3207
3210
|
*
|
|
3208
3211
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
3209
|
-
|
|
3212
|
+
* ```
|
|
3210
3213
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3211
3214
|
*/
|
|
3212
3215
|
HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
@@ -3216,7 +3219,7 @@ var HostEvent;
|
|
|
3216
3219
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
3217
3220
|
* ```js
|
|
3218
3221
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
3219
|
-
|
|
3222
|
+
* ```
|
|
3220
3223
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3221
3224
|
*/
|
|
3222
3225
|
HostEvent["ExitPresentMode"] = "exitPresentMode";
|
|
@@ -3366,6 +3369,7 @@ var Param;
|
|
|
3366
3369
|
// 'both' clicks in `contextMenuTrigger` configuration.
|
|
3367
3370
|
Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
|
|
3368
3371
|
Param["LinkOverride"] = "linkOverride";
|
|
3372
|
+
Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
|
|
3369
3373
|
Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
|
|
3370
3374
|
Param["ShowInsertToSlide"] = "insertInToSlide";
|
|
3371
3375
|
Param["PrimaryNavHidden"] = "primaryNavHidden";
|
|
@@ -3460,6 +3464,7 @@ var Param;
|
|
|
3460
3464
|
Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
|
|
3461
3465
|
Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
|
|
3462
3466
|
Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
|
|
3467
|
+
Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
|
|
3463
3468
|
})(Param || (Param = {}));
|
|
3464
3469
|
/**
|
|
3465
3470
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3619,14 +3624,14 @@ var Action;
|
|
|
3619
3624
|
* ```js
|
|
3620
3625
|
* disabledActions: [Action.CollapseDataPanel]
|
|
3621
3626
|
* ```
|
|
3622
|
-
* @version
|
|
3627
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3623
3628
|
*/
|
|
3624
3629
|
Action["CollapseDataSources"] = "collapseDataSources";
|
|
3625
3630
|
/**
|
|
3626
3631
|
* The **Collapse data panel** icon on the Search page.
|
|
3627
3632
|
* Collapses the data panel view.
|
|
3628
3633
|
*
|
|
3629
|
-
* @version
|
|
3634
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3630
3635
|
*
|
|
3631
3636
|
* @example
|
|
3632
3637
|
* ```js
|
|
@@ -4073,13 +4078,12 @@ var Action;
|
|
|
4073
4078
|
*/
|
|
4074
4079
|
Action["CreateMonitor"] = "createMonitor";
|
|
4075
4080
|
/**
|
|
4076
|
-
* @
|
|
4077
|
-
*
|
|
4081
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
4082
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
4078
4083
|
* @example
|
|
4079
4084
|
* ```js
|
|
4080
4085
|
* disabledActions: [Action.ReportError]
|
|
4081
4086
|
* ```
|
|
4082
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
4083
4087
|
*/
|
|
4084
4088
|
Action["ReportError"] = "reportError";
|
|
4085
4089
|
/**
|
|
@@ -4089,7 +4093,7 @@ var Action;
|
|
|
4089
4093
|
* ```js
|
|
4090
4094
|
* disabledActions: [Action.SyncToSheets]
|
|
4091
4095
|
* ```
|
|
4092
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4096
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4093
4097
|
*/
|
|
4094
4098
|
Action["SyncToSheets"] = "sync-to-sheets";
|
|
4095
4099
|
/**
|
|
@@ -4100,7 +4104,7 @@ var Action;
|
|
|
4100
4104
|
* ```js
|
|
4101
4105
|
* disabledActions: [Action.SyncToOtherApps]
|
|
4102
4106
|
* ```
|
|
4103
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4107
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4104
4108
|
*/
|
|
4105
4109
|
Action["SyncToOtherApps"] = "sync-to-other-apps";
|
|
4106
4110
|
/**
|
|
@@ -4110,7 +4114,7 @@ var Action;
|
|
|
4110
4114
|
* ```js
|
|
4111
4115
|
* disabledActions: [Action.ManagePipelines]
|
|
4112
4116
|
* ```
|
|
4113
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4117
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4114
4118
|
*/
|
|
4115
4119
|
Action["ManagePipelines"] = "manage-pipeline";
|
|
4116
4120
|
/**
|
|
@@ -4422,7 +4426,7 @@ var Action;
|
|
|
4422
4426
|
* ```js
|
|
4423
4427
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4424
4428
|
* ```
|
|
4425
|
-
* @version SDK
|
|
4429
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4426
4430
|
*/
|
|
4427
4431
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4428
4432
|
/**
|
|
@@ -4432,7 +4436,7 @@ var Action;
|
|
|
4432
4436
|
* ```js
|
|
4433
4437
|
* disabledActions: [Action.LiveboardUsers]
|
|
4434
4438
|
* ```
|
|
4435
|
-
* @version SDK
|
|
4439
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4436
4440
|
*/
|
|
4437
4441
|
Action["LiveboardUsers"] = "liveboardUsers";
|
|
4438
4442
|
/**
|
|
@@ -4450,7 +4454,7 @@ var Action;
|
|
|
4450
4454
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4451
4455
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4452
4456
|
* ```
|
|
4453
|
-
* @version SDK
|
|
4457
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4454
4458
|
*/
|
|
4455
4459
|
Action["TML"] = "tml";
|
|
4456
4460
|
/**
|
|
@@ -4496,7 +4500,7 @@ var Action;
|
|
|
4496
4500
|
* ```js
|
|
4497
4501
|
* disabledActions: [Action.AddToWatchlist]
|
|
4498
4502
|
* ```
|
|
4499
|
-
* @version SDK
|
|
4503
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4500
4504
|
*/
|
|
4501
4505
|
Action["AddToWatchlist"] = "addToWatchlist";
|
|
4502
4506
|
/**
|
|
@@ -4506,7 +4510,7 @@ var Action;
|
|
|
4506
4510
|
* ```js
|
|
4507
4511
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4508
4512
|
* ```
|
|
4509
|
-
* @version SDK
|
|
4513
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4510
4514
|
*/
|
|
4511
4515
|
Action["RemoveFromWatchlist"] = "removeFromWatchlist";
|
|
4512
4516
|
/**
|
|
@@ -4517,7 +4521,7 @@ var Action;
|
|
|
4517
4521
|
* ```js
|
|
4518
4522
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4519
4523
|
* ```
|
|
4520
|
-
* @version SDK
|
|
4524
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4521
4525
|
*/
|
|
4522
4526
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
4523
4527
|
/**
|
|
@@ -4578,7 +4582,7 @@ var Action;
|
|
|
4578
4582
|
* ```js
|
|
4579
4583
|
* disabledActions: [Action.ManageTags]
|
|
4580
4584
|
* ```
|
|
4581
|
-
* @version SDK
|
|
4585
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4582
4586
|
*/
|
|
4583
4587
|
Action["ManageTags"] = "manageTags";
|
|
4584
4588
|
/**
|
|
@@ -5011,18 +5015,80 @@ var ContextMenuTriggerOptions;
|
|
|
5011
5015
|
*/
|
|
5012
5016
|
var CustomActionsPosition;
|
|
5013
5017
|
(function (CustomActionsPosition) {
|
|
5018
|
+
/**
|
|
5019
|
+
* Shows the action as a primary button
|
|
5020
|
+
* in the toolbar area of the embed.
|
|
5021
|
+
*/
|
|
5014
5022
|
CustomActionsPosition["PRIMARY"] = "PRIMARY";
|
|
5023
|
+
/**
|
|
5024
|
+
* Shows the action inside the "More" menu
|
|
5025
|
+
* (three-dot overflow menu).
|
|
5026
|
+
*/
|
|
5015
5027
|
CustomActionsPosition["MENU"] = "MENU";
|
|
5028
|
+
/**
|
|
5029
|
+
* Shows the action in the right-click
|
|
5030
|
+
* context menu. Only supported for
|
|
5031
|
+
* {@link CustomActionTarget.VIZ},
|
|
5032
|
+
* {@link CustomActionTarget.ANSWER}, and
|
|
5033
|
+
* {@link CustomActionTarget.SPOTTER} targets.
|
|
5034
|
+
*/
|
|
5016
5035
|
CustomActionsPosition["CONTEXTMENU"] = "CONTEXTMENU";
|
|
5017
5036
|
})(CustomActionsPosition || (CustomActionsPosition = {}));
|
|
5018
5037
|
/**
|
|
5019
|
-
* Enum options to mention the target of the custom action.
|
|
5038
|
+
* Enum options to mention the target of the code-based custom action.
|
|
5039
|
+
* The target determines which type of ThoughtSpot object the action is
|
|
5040
|
+
* associated with, and also controls which positions and scoping options
|
|
5041
|
+
* are available.
|
|
5020
5042
|
*/
|
|
5021
5043
|
var CustomActionTarget;
|
|
5022
5044
|
(function (CustomActionTarget) {
|
|
5045
|
+
/**
|
|
5046
|
+
* Action applies at the Liveboard level.
|
|
5047
|
+
* Supported positions:
|
|
5048
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
5049
|
+
* {@link CustomActionsPosition.MENU}.
|
|
5050
|
+
* Can be scoped with
|
|
5051
|
+
* `metadataIds.liveboardIds`,
|
|
5052
|
+
* `orgIds`, and `groupIds`.
|
|
5053
|
+
*/
|
|
5023
5054
|
CustomActionTarget["LIVEBOARD"] = "LIVEBOARD";
|
|
5055
|
+
/**
|
|
5056
|
+
* Action applies to individual
|
|
5057
|
+
* visualizations (charts/tables).
|
|
5058
|
+
* Supported positions:
|
|
5059
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
5060
|
+
* {@link CustomActionsPosition.MENU},
|
|
5061
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
5062
|
+
* Can be scoped with `metadataIds`
|
|
5063
|
+
* (answerIds, liveboardIds, vizIds),
|
|
5064
|
+
* `dataModelIds` (modelIds,
|
|
5065
|
+
* modelColumnNames), `orgIds`,
|
|
5066
|
+
* and `groupIds`.
|
|
5067
|
+
*/
|
|
5024
5068
|
CustomActionTarget["VIZ"] = "VIZ";
|
|
5069
|
+
/**
|
|
5070
|
+
* Action applies to saved or unsaved
|
|
5071
|
+
* Answers. Supported positions:
|
|
5072
|
+
* {@link CustomActionsPosition.PRIMARY},
|
|
5073
|
+
* {@link CustomActionsPosition.MENU},
|
|
5074
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
5075
|
+
* Can be scoped with
|
|
5076
|
+
* `metadataIds.answerIds`,
|
|
5077
|
+
* `dataModelIds` (modelIds,
|
|
5078
|
+
* modelColumnNames), `orgIds`,
|
|
5079
|
+
* and `groupIds`.
|
|
5080
|
+
*/
|
|
5025
5081
|
CustomActionTarget["ANSWER"] = "ANSWER";
|
|
5082
|
+
/**
|
|
5083
|
+
* Action applies to Spotter
|
|
5084
|
+
* (AI-powered search).
|
|
5085
|
+
* Supported positions:
|
|
5086
|
+
* {@link CustomActionsPosition.MENU},
|
|
5087
|
+
* {@link CustomActionsPosition.CONTEXTMENU}.
|
|
5088
|
+
* Can be scoped with
|
|
5089
|
+
* `dataModelIds.modelIds`,
|
|
5090
|
+
* `orgIds`, and `groupIds`.
|
|
5091
|
+
*/
|
|
5026
5092
|
CustomActionTarget["SPOTTER"] = "SPOTTER";
|
|
5027
5093
|
})(CustomActionTarget || (CustomActionTarget = {}));
|
|
5028
5094
|
/**
|
|
@@ -5463,7 +5529,7 @@ const getCssDimension = (value) => {
|
|
|
5463
5529
|
* @returns true if the value is a valid CSS margin value, false otherwise
|
|
5464
5530
|
*/
|
|
5465
5531
|
const isValidCssMargin = (value) => {
|
|
5466
|
-
if (isUndefined
|
|
5532
|
+
if (isUndefined(value)) {
|
|
5467
5533
|
return false;
|
|
5468
5534
|
}
|
|
5469
5535
|
if (typeof value !== 'string') {
|
|
@@ -5651,7 +5717,7 @@ const removeStyleProperties = (element, styleProperties) => {
|
|
|
5651
5717
|
element.style.removeProperty(styleProperty);
|
|
5652
5718
|
});
|
|
5653
5719
|
};
|
|
5654
|
-
const isUndefined
|
|
5720
|
+
const isUndefined = (value) => value === undefined;
|
|
5655
5721
|
// Return if the value is a string, double or boolean.
|
|
5656
5722
|
const getTypeFromValue = (value) => {
|
|
5657
5723
|
if (typeof value === 'string') {
|
|
@@ -5848,6 +5914,14 @@ const validateHttpUrl = (url) => {
|
|
|
5848
5914
|
return [false, error instanceof Error ? error : new Error(String(error))];
|
|
5849
5915
|
}
|
|
5850
5916
|
};
|
|
5917
|
+
/**
|
|
5918
|
+
* Resolves enablePastConversationsSidebar with
|
|
5919
|
+
* spotterSidebarConfig taking precedence over the
|
|
5920
|
+
* standalone flag.
|
|
5921
|
+
*/
|
|
5922
|
+
const resolveEnablePastConversationsSidebar = (params) => (params.spotterSidebarConfigValue !== undefined
|
|
5923
|
+
? params.spotterSidebarConfigValue
|
|
5924
|
+
: params.standaloneValue);
|
|
5851
5925
|
/**
|
|
5852
5926
|
* Sets a query parameter if the value is defined.
|
|
5853
5927
|
* @param queryParams - The query params object to modify
|
|
@@ -8428,7 +8502,7 @@ const setEmbedConfig = (newConfig) => {
|
|
|
8428
8502
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
8429
8503
|
* // .. fetch options ..
|
|
8430
8504
|
* });
|
|
8431
|
-
|
|
8505
|
+
* ```
|
|
8432
8506
|
* @version SDK: 1.28.0
|
|
8433
8507
|
* @group Global methods
|
|
8434
8508
|
*/
|
|
@@ -8768,6 +8842,7 @@ var OperationType;
|
|
|
8768
8842
|
OperationType["GetChartWithData"] = "GetChartWithData";
|
|
8769
8843
|
OperationType["GetTableWithHeadlineData"] = "GetTableWithHeadlineData";
|
|
8770
8844
|
})(OperationType || (OperationType = {}));
|
|
8845
|
+
const DATA_TYPES = ['DATE', 'DATE_TIME', 'TIME'];
|
|
8771
8846
|
/**
|
|
8772
8847
|
* AnswerService provides a simple way to work with ThoughtSpot Answers.
|
|
8773
8848
|
*
|
|
@@ -8813,7 +8888,7 @@ var OperationType;
|
|
|
8813
8888
|
* });
|
|
8814
8889
|
* ```
|
|
8815
8890
|
*
|
|
8816
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
8891
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
8817
8892
|
* @group Events
|
|
8818
8893
|
*/
|
|
8819
8894
|
class AnswerService {
|
|
@@ -8874,6 +8949,7 @@ class AnswerService {
|
|
|
8874
8949
|
* ]);
|
|
8875
8950
|
* console.log(await service.fetchData());
|
|
8876
8951
|
* });
|
|
8952
|
+
* ```
|
|
8877
8953
|
*/
|
|
8878
8954
|
async addColumnsByName(columnNames) {
|
|
8879
8955
|
const sourceDetail = await this.getSourceDetail();
|
|
@@ -9004,7 +9080,7 @@ class AnswerService {
|
|
|
9004
9080
|
* const data = await underlying.fetchData(0, 100);
|
|
9005
9081
|
* })
|
|
9006
9082
|
* ```
|
|
9007
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
9083
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
9008
9084
|
*/
|
|
9009
9085
|
async getUnderlyingDataForPoint(outputColumnNames, selectedPoints) {
|
|
9010
9086
|
if (!selectedPoints && !this.selectedPoints) {
|
|
@@ -9072,7 +9148,7 @@ class AnswerService {
|
|
|
9072
9148
|
async getTML() {
|
|
9073
9149
|
const { object } = await this.executeQuery(getAnswerTML, {});
|
|
9074
9150
|
const edoc = object[0].edoc;
|
|
9075
|
-
const YAML = await import('./index-
|
|
9151
|
+
const YAML = await import('./index-DkizS4xM.js');
|
|
9076
9152
|
const parsedDoc = YAML.parse(edoc);
|
|
9077
9153
|
return {
|
|
9078
9154
|
answer: {
|
|
@@ -9123,7 +9199,7 @@ function getSelectedPointsForUnderlyingDataQuery(selectedPoints) {
|
|
|
9123
9199
|
const dataType = colVal.column.dataType;
|
|
9124
9200
|
colVal.column.id;
|
|
9125
9201
|
let dataValue;
|
|
9126
|
-
if (dataType
|
|
9202
|
+
if (DATA_TYPES.includes(dataType)) {
|
|
9127
9203
|
if (Number.isFinite(colVal.value)) {
|
|
9128
9204
|
dataValue = [{
|
|
9129
9205
|
epochRange: {
|
|
@@ -17563,20 +17639,45 @@ var AuthFailureType;
|
|
|
17563
17639
|
var AuthStatus;
|
|
17564
17640
|
(function (AuthStatus) {
|
|
17565
17641
|
/**
|
|
17566
|
-
* Emits when the SDK fails to authenticate
|
|
17642
|
+
* Emits when the SDK fails to authenticate.
|
|
17567
17643
|
*/
|
|
17568
17644
|
AuthStatus["FAILURE"] = "FAILURE";
|
|
17569
17645
|
/**
|
|
17570
|
-
* Emits when the SDK
|
|
17646
|
+
* Emits when the SDK authentication step completes
|
|
17647
|
+
* successfully (e.g., token exchange, cookie set).
|
|
17648
|
+
* This fires before any iframe is rendered. Use
|
|
17649
|
+
* this to know that auth passed and it is safe to
|
|
17650
|
+
* proceed with rendering. The callback receives no
|
|
17651
|
+
* arguments.
|
|
17652
|
+
* @example
|
|
17653
|
+
* ```js
|
|
17654
|
+
* const authEE = init({ ... });
|
|
17655
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
17656
|
+
* // Auth done, iframe not loaded yet
|
|
17657
|
+
* });
|
|
17658
|
+
* ```
|
|
17571
17659
|
*/
|
|
17572
17660
|
AuthStatus["SDK_SUCCESS"] = "SDK_SUCCESS";
|
|
17573
17661
|
/**
|
|
17574
17662
|
* @hidden
|
|
17575
|
-
* Emits when iframe is loaded and session
|
|
17663
|
+
* Emits when iframe is loaded and session
|
|
17664
|
+
* information is available.
|
|
17576
17665
|
*/
|
|
17577
17666
|
AuthStatus["SESSION_INFO_SUCCESS"] = "SESSION_INFO_SUCCESS";
|
|
17578
17667
|
/**
|
|
17579
|
-
* Emits when the app
|
|
17668
|
+
* Emits when the ThoughtSpot app inside the
|
|
17669
|
+
* embedded iframe confirms its session is active.
|
|
17670
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
17671
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
17672
|
+
* @see EmbedEvent.AuthInit
|
|
17673
|
+
* @example
|
|
17674
|
+
* ```js
|
|
17675
|
+
* const authEE = init({ ... });
|
|
17676
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
17677
|
+
* // App is loaded and authenticated
|
|
17678
|
+
* console.log(sessionInfo.userGUID);
|
|
17679
|
+
* });
|
|
17680
|
+
* ```
|
|
17580
17681
|
*/
|
|
17581
17682
|
AuthStatus["SUCCESS"] = "SUCCESS";
|
|
17582
17683
|
/**
|
|
@@ -17722,7 +17823,7 @@ function removeSSORedirectUrlMarker() {
|
|
|
17722
17823
|
// reload the page which we don't want. We'll live with adding an
|
|
17723
17824
|
// unnecessary hash to the parent page URL until we find any use case where
|
|
17724
17825
|
// that creates an issue.
|
|
17725
|
-
// Replace any
|
|
17826
|
+
// Replace any occurrences of ?ssoMarker=guid or &ssoMarker=guid.
|
|
17726
17827
|
let updatedHash = window.location.hash.replace(`?${getSSOMarker(SSO_REDIRECTION_MARKER_GUID)}`, '');
|
|
17727
17828
|
updatedHash = updatedHash.replace(`&${getSSOMarker(SSO_REDIRECTION_MARKER_GUID)}`, '');
|
|
17728
17829
|
window.location.hash = updatedHash;
|
|
@@ -18364,7 +18465,7 @@ function processEventData(type, eventData, thoughtSpotHost, containerEl) {
|
|
|
18364
18465
|
return eventData;
|
|
18365
18466
|
}
|
|
18366
18467
|
|
|
18367
|
-
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.
|
|
18468
|
+
var name="@thoughtspot/visual-embed-sdk";var version$1="1.46.2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p tsconfig.build.json --incremental false; tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle-generator --config ./dts-config/dts-bundle-file.config.js","bundle-dts":"dts-bundle-generator --config ./dts-config/dts-bundle.config.js","bundle-dts-react":"dts-bundle-generator --config ./dts-config/dts-bundle-react.config.js","bundle-dts-react-full":"dts-bundle-generator --config ./dts-config/dts-bundle-react-full.config.js",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.build.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck","test-sdk":"jest -c jest.config.sdk.js --runInBand",test:"npm run test-sdk",posttest:"cat ./coverage/sdk/lcov.info | npx coveralls-next || echo 'Warning: Coveralls upload failed but not breaking the build.'","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest",dev:"vite -c vite.local.config.ts"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={classnames:"^2.3.1",eventemitter3:"^4.0.7",lodash:"^4.17.23","mixpanel-browser":"2.47.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1",yaml:"^2.5.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^11.2.0","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^30.0.0","@types/lodash":"^4.17.0","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^8.28.0","@typescript-eslint/parser":"^8.28.0",ajv:"^8.17.1",asciidoctor:"^2.2.1","babel-jest":"^30.2.0","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1","coveralls-next":"^5.0.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle-generator":"^9.5.1",eslint:"^9.23.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^10.1.1","eslint-import-resolver-typescript":"^4.2.5","eslint-plugin-comment-length":"2.2.1","eslint-plugin-import":"^2.31.0","eslint-plugin-jsdoc":"^50.6.9","eslint-plugin-prettier":"^5.2.5","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^5.2.0","fs-extra":"^10.0.0","gh-pages":"6.3.0",globals:"^16.0.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^2.0.0",jest:"^30.2.0","jest-environment-jsdom":"^29.7.0","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"4.24.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^29.4.6","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","typescript-eslint":"^8.29.1","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^6.3.5"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embedded","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version$1,description:description,module:module,main:main,types:types,files:files,exports:exports,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.es.js",limit:"32 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
|
|
18368
18469
|
|
|
18369
18470
|
class HostEventClient {
|
|
18370
18471
|
constructor(iFrame) {
|
|
@@ -18638,7 +18739,7 @@ const processLegacyInterceptResponse = (payload) => {
|
|
|
18638
18739
|
*/
|
|
18639
18740
|
const { version } = pkgInfo;
|
|
18640
18741
|
/**
|
|
18641
|
-
* Global prefix for all
|
|
18742
|
+
* Global prefix for all ThoughtSpot postHash Params.
|
|
18642
18743
|
*/
|
|
18643
18744
|
const THOUGHTSPOT_PARAM_PREFIX = 'ts-';
|
|
18644
18745
|
const TS_EMBED_ID = '_thoughtspot-embed';
|
|
@@ -18670,9 +18771,9 @@ class TsEmbed {
|
|
|
18670
18771
|
this.embedNodeKey = '__tsEmbed';
|
|
18671
18772
|
this.isAppInitialized = false;
|
|
18672
18773
|
/**
|
|
18673
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
18774
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
18674
18775
|
* will generate for embedding. This provides additional security to
|
|
18675
|
-
*
|
|
18776
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
18676
18777
|
* @default false
|
|
18677
18778
|
*/
|
|
18678
18779
|
this.shouldEncodeUrlQueryParams = false;
|
|
@@ -18848,7 +18949,7 @@ class TsEmbed {
|
|
|
18848
18949
|
if (viewConfig.preRenderId) {
|
|
18849
18950
|
const allOtherKeys = Object.keys(viewConfig).filter((key) => !preRenderAllowedKeys.includes(key) && !key.startsWith('on'));
|
|
18850
18951
|
allOtherKeys.forEach((key) => {
|
|
18851
|
-
if (!isUndefined
|
|
18952
|
+
if (!isUndefined(viewConfig[key])
|
|
18852
18953
|
&& !isEqual_1(viewConfig[key], preRenderedObject.viewConfig[key])) {
|
|
18853
18954
|
logger$3.warn(`${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
|
|
18854
18955
|
+ `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
|
|
@@ -19184,7 +19285,7 @@ class TsEmbed {
|
|
|
19184
19285
|
if (this.embedConfig.currencyFormat) {
|
|
19185
19286
|
queryParams[Param.CurrencyFormat] = this.embedConfig.currencyFormat;
|
|
19186
19287
|
}
|
|
19187
|
-
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19288
|
+
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags: additionalFlagsFromView, locale, customizations, contextMenuTrigger, linkOverride, enableLinkOverridesV2, insertInToSlide, disableRedirectionLinksInNewTab, overrideOrgId, exposeTranslationIDs, primaryAction, } = this.viewConfig;
|
|
19188
19289
|
const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
|
|
19189
19290
|
const additionalFlags = {
|
|
19190
19291
|
...additionalFlagsFromInit,
|
|
@@ -19260,7 +19361,13 @@ class TsEmbed {
|
|
|
19260
19361
|
if (locale !== undefined) {
|
|
19261
19362
|
queryParams[Param.Locale] = locale;
|
|
19262
19363
|
}
|
|
19263
|
-
|
|
19364
|
+
// TODO: Once V2 is stable, send both flags when
|
|
19365
|
+
// linkOverride is true (remove the else-if).
|
|
19366
|
+
if (enableLinkOverridesV2) {
|
|
19367
|
+
queryParams[Param.EnableLinkOverridesV2] = true;
|
|
19368
|
+
queryParams[Param.LinkOverride] = true;
|
|
19369
|
+
}
|
|
19370
|
+
else if (linkOverride) {
|
|
19264
19371
|
queryParams[Param.LinkOverride] = linkOverride;
|
|
19265
19372
|
}
|
|
19266
19373
|
if (insertInToSlide) {
|
|
@@ -19328,7 +19435,7 @@ class TsEmbed {
|
|
|
19328
19435
|
iFrame.mozallowfullscreen = true;
|
|
19329
19436
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
19330
19437
|
// @ts-ignore
|
|
19331
|
-
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
|
|
19438
|
+
iFrame.allow = 'clipboard-read; clipboard-write; fullscreen; local-network-access;';
|
|
19332
19439
|
const frameParams = this.viewConfig.frameParams;
|
|
19333
19440
|
const { height: frameHeight, width: frameWidth, ...restParams } = frameParams || {};
|
|
19334
19441
|
const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
|
|
@@ -20030,7 +20137,7 @@ class TsEmbed {
|
|
|
20030
20137
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
20031
20138
|
* session.
|
|
20032
20139
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
20033
|
-
* @version SDK: 1.25.0
|
|
20140
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
20034
20141
|
*/
|
|
20035
20142
|
async getAnswerService(vizId) {
|
|
20036
20143
|
const { session } = await this.trigger(HostEvent.GetAnswerSession, vizId ? { vizId } : {});
|
|
@@ -20145,7 +20252,7 @@ class V1Embed extends TsEmbed {
|
|
|
20145
20252
|
|
|
20146
20253
|
/**
|
|
20147
20254
|
* Embed ThoughtSpot search bar
|
|
20148
|
-
* @version
|
|
20255
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
20149
20256
|
* @group Embed components
|
|
20150
20257
|
*/
|
|
20151
20258
|
let SearchBarEmbed$1 = class SearchBarEmbed extends TsEmbed {
|
|
@@ -20227,7 +20334,7 @@ let SearchBarEmbed$1 = class SearchBarEmbed extends TsEmbed {
|
|
|
20227
20334
|
*/
|
|
20228
20335
|
/**
|
|
20229
20336
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
20230
|
-
* @version
|
|
20337
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
20231
20338
|
*
|
|
20232
20339
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
20233
20340
|
* @group Embed components
|
|
@@ -20303,12 +20410,13 @@ let SageEmbed$1 = class SageEmbed extends V1Embed {
|
|
|
20303
20410
|
/**
|
|
20304
20411
|
* Copyright (c) 2022
|
|
20305
20412
|
*
|
|
20306
|
-
* Embed ThoughtSpot search or a saved answer
|
|
20413
|
+
* Embed ThoughtSpot search or a saved answer.
|
|
20414
|
+
* https://developers.thoughtspot.com/docs/search-embed
|
|
20307
20415
|
* @summary Search embed
|
|
20308
20416
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
20309
20417
|
*/
|
|
20310
20418
|
/**
|
|
20311
|
-
* Define the initial state
|
|
20419
|
+
* Define the initial state of column custom group accordions
|
|
20312
20420
|
* in data panel v2.
|
|
20313
20421
|
*/
|
|
20314
20422
|
var DataPanelCustomColumnGroupsAccordionState$1;
|
|
@@ -20531,7 +20639,7 @@ var Page;
|
|
|
20531
20639
|
Page["Monitor"] = "monitor";
|
|
20532
20640
|
})(Page || (Page = {}));
|
|
20533
20641
|
/**
|
|
20534
|
-
* Define the initial state
|
|
20642
|
+
* Define the initial state of column custom group accordions
|
|
20535
20643
|
* in data panel v2.
|
|
20536
20644
|
*/
|
|
20537
20645
|
var DataPanelCustomColumnGroupsAccordionState;
|
|
@@ -20670,7 +20778,7 @@ let AppEmbed$1 = class AppEmbed extends V1Embed {
|
|
|
20670
20778
|
* embedded Liveboard or visualization.
|
|
20671
20779
|
*/
|
|
20672
20780
|
getEmbedParams() {
|
|
20673
|
-
const { tag, hideTagFilterChips, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = true, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, isEnhancedFilterInteractivityEnabled = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, minimumHeight, isThisPeriodInDateFiltersEnabled, } = this.viewConfig;
|
|
20781
|
+
const { tag, hideTagFilterChips, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = true, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, showMaskedFilterChip = false, isLiveboardMasterpiecesEnabled = false, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, isEnhancedFilterInteractivityEnabled = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, isPNGInScheduledEmailsEnabled = false, isLiveboardXLSXCSVDownloadEnabled = false, isGranularXLSXCSVSchedulesEnabled = false, isCentralizedLiveboardFilterUXEnabled = false, isLinkParametersEnabled, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, minimumHeight, isThisPeriodInDateFiltersEnabled, enableHomepageAnnouncement, } = this.viewConfig;
|
|
20674
20782
|
let params = {};
|
|
20675
20783
|
params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
|
|
20676
20784
|
params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
|
|
@@ -20691,13 +20799,17 @@ let AppEmbed$1 = class AppEmbed extends V1Embed {
|
|
|
20691
20799
|
params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
|
|
20692
20800
|
params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
|
|
20693
20801
|
params = this.getBaseQueryParams(params);
|
|
20694
|
-
if (!isUndefined
|
|
20802
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
20695
20803
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
20696
20804
|
}
|
|
20805
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
20806
|
+
spotterSidebarConfigValue: spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar,
|
|
20807
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
20808
|
+
});
|
|
20809
|
+
setParamIfDefined(params, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
20697
20810
|
// Handle spotterSidebarConfig params
|
|
20698
20811
|
if (spotterSidebarConfig) {
|
|
20699
|
-
const {
|
|
20700
|
-
setParamIfDefined(params, Param.EnablePastConversationsSidebar, enablePastConversationsSidebar, true);
|
|
20812
|
+
const { spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig;
|
|
20701
20813
|
setParamIfDefined(params, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
20702
20814
|
setParamIfDefined(params, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
20703
20815
|
setParamIfDefined(params, Param.SpotterChatRenameLabel, spotterChatRenameLabel);
|
|
@@ -20795,6 +20907,9 @@ let AppEmbed$1 = class AppEmbed extends V1Embed {
|
|
|
20795
20907
|
if (isThisPeriodInDateFiltersEnabled !== undefined) {
|
|
20796
20908
|
params[Param.IsThisPeriodInDateFiltersEnabled] = isThisPeriodInDateFiltersEnabled;
|
|
20797
20909
|
}
|
|
20910
|
+
if (enableHomepageAnnouncement !== undefined) {
|
|
20911
|
+
params[Param.EnableHomepageAnnouncement] = enableHomepageAnnouncement;
|
|
20912
|
+
}
|
|
20798
20913
|
this.defaultHeight = minimumHeight || this.defaultHeight;
|
|
20799
20914
|
params[Param.DataPanelV2Enabled] = dataPanelV2;
|
|
20800
20915
|
params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
|
|
@@ -21044,8 +21159,8 @@ const addPreviewStylesIfNotPresent = () => {
|
|
|
21044
21159
|
* Copyright (c) 2022
|
|
21045
21160
|
*
|
|
21046
21161
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
21047
|
-
* https://developers.thoughtspot.com/docs
|
|
21048
|
-
* https://developers.thoughtspot.com/docs
|
|
21162
|
+
* https://developers.thoughtspot.com/docs/embed-liveboard
|
|
21163
|
+
* https://developers.thoughtspot.com/docs/embed-a-viz
|
|
21049
21164
|
* @summary Liveboard & visualization embed
|
|
21050
21165
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
21051
21166
|
*/
|
|
@@ -21053,6 +21168,7 @@ const addPreviewStylesIfNotPresent = () => {
|
|
|
21053
21168
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
21054
21169
|
* waits for the authentication to complete, so you need not wait for
|
|
21055
21170
|
* `AuthStatus.SUCCESS`.
|
|
21171
|
+
* @group Embed components
|
|
21056
21172
|
* @example
|
|
21057
21173
|
* ```js
|
|
21058
21174
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -21062,7 +21178,6 @@ const addPreviewStylesIfNotPresent = () => {
|
|
|
21062
21178
|
* // .. other params here.
|
|
21063
21179
|
* })
|
|
21064
21180
|
* ```
|
|
21065
|
-
* @group Embed components
|
|
21066
21181
|
*/
|
|
21067
21182
|
let LiveboardEmbed$1 = class LiveboardEmbed extends V1Embed {
|
|
21068
21183
|
constructor(domSelector, viewConfig) {
|
|
@@ -21170,7 +21285,7 @@ let LiveboardEmbed$1 = class LiveboardEmbed extends V1Embed {
|
|
|
21170
21285
|
if (preventLiveboardFilterRemoval) {
|
|
21171
21286
|
params[Param.preventLiveboardFilterRemoval] = true;
|
|
21172
21287
|
}
|
|
21173
|
-
if (!isUndefined
|
|
21288
|
+
if (!isUndefined(updatedSpotterChatPrompt)) {
|
|
21174
21289
|
params[Param.UpdatedSpotterChatPrompt] = !!updatedSpotterChatPrompt;
|
|
21175
21290
|
}
|
|
21176
21291
|
if (visibleVizs) {
|
|
@@ -21349,7 +21464,7 @@ let LiveboardEmbed$1 = class LiveboardEmbed extends V1Embed {
|
|
|
21349
21464
|
});
|
|
21350
21465
|
}
|
|
21351
21466
|
async handleRenderForPrerender() {
|
|
21352
|
-
if (isUndefined
|
|
21467
|
+
if (isUndefined(this.viewConfig.liveboardId)) {
|
|
21353
21468
|
return this.prerenderGeneric();
|
|
21354
21469
|
}
|
|
21355
21470
|
return super.handleRenderForPrerender();
|
|
@@ -21872,6 +21987,8 @@ let ConversationMessage$1 = class ConversationMessage extends TsEmbed {
|
|
|
21872
21987
|
/**
|
|
21873
21988
|
* Create a conversation embed, which can be integrated inside
|
|
21874
21989
|
* chatbots or other conversational interfaces.
|
|
21990
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21991
|
+
* @group Embed components
|
|
21875
21992
|
* @example
|
|
21876
21993
|
* ```js
|
|
21877
21994
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -21885,8 +22002,6 @@ let ConversationMessage$1 = class ConversationMessage extends TsEmbed {
|
|
|
21885
22002
|
* // append the container to the DOM
|
|
21886
22003
|
* document.body.appendChild(container); // or to any other element
|
|
21887
22004
|
* ```
|
|
21888
|
-
* @group Embed components
|
|
21889
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21890
22005
|
*/
|
|
21891
22006
|
class SpotterAgentEmbed {
|
|
21892
22007
|
constructor(viewConfig) {
|
|
@@ -21958,31 +22073,9 @@ function getViewPropsAndListeners(props) {
|
|
|
21958
22073
|
});
|
|
21959
22074
|
}
|
|
21960
22075
|
|
|
21961
|
-
/**
|
|
21962
|
-
* Checks if `value` is `undefined`.
|
|
21963
|
-
*
|
|
21964
|
-
* @static
|
|
21965
|
-
* @since 0.1.0
|
|
21966
|
-
* @memberOf _
|
|
21967
|
-
* @category Lang
|
|
21968
|
-
* @param {*} value The value to check.
|
|
21969
|
-
* @returns {boolean} Returns `true` if `value` is `undefined`, else `false`.
|
|
21970
|
-
* @example
|
|
21971
|
-
*
|
|
21972
|
-
* _.isUndefined(void 0);
|
|
21973
|
-
* // => true
|
|
21974
|
-
*
|
|
21975
|
-
* _.isUndefined(null);
|
|
21976
|
-
* // => false
|
|
21977
|
-
*/
|
|
21978
|
-
function isUndefined(value) {
|
|
21979
|
-
return value === undefined;
|
|
21980
|
-
}
|
|
21981
|
-
|
|
21982
|
-
var isUndefined_1 = isUndefined;
|
|
21983
|
-
|
|
21984
22076
|
/**
|
|
21985
22077
|
* Embed ThoughtSpot AI Conversation.
|
|
22078
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21986
22079
|
* @group Embed components
|
|
21987
22080
|
* @example
|
|
21988
22081
|
* ```js
|
|
@@ -21994,7 +22087,6 @@ var isUndefined_1 = isUndefined;
|
|
|
21994
22087
|
* });
|
|
21995
22088
|
* conversation.render();
|
|
21996
22089
|
* ```
|
|
21997
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
21998
22090
|
*/
|
|
21999
22091
|
let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
22000
22092
|
constructor(container, viewConfig) {
|
|
@@ -22010,7 +22102,11 @@ let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
|
22010
22102
|
getEmbedParamsObject() {
|
|
22011
22103
|
const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, updatedSpotterChatPrompt, spotterSidebarConfig, spotterChatConfig, } = this.viewConfig;
|
|
22012
22104
|
// Extract sidebar config properties
|
|
22013
|
-
const { enablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22105
|
+
const { enablePastConversationsSidebar: sidebarEnablePastConversationsSidebar, spotterSidebarTitle, spotterSidebarDefaultExpanded, spotterChatRenameLabel, spotterChatDeleteLabel, spotterDeleteConversationModalTitle, spotterPastConversationAlertMessage, spotterDocumentationUrl, spotterBestPracticesLabel, spotterConversationsBatchSize, spotterNewChatButtonTitle, } = spotterSidebarConfig || {};
|
|
22106
|
+
const resolvedEnablePastConversationsSidebar = resolveEnablePastConversationsSidebar({
|
|
22107
|
+
spotterSidebarConfigValue: sidebarEnablePastConversationsSidebar,
|
|
22108
|
+
standaloneValue: this.viewConfig.enablePastConversationsSidebar,
|
|
22109
|
+
});
|
|
22014
22110
|
if (!worksheetId) {
|
|
22015
22111
|
this.handleError({
|
|
22016
22112
|
errorType: ErrorDetailsTypes.VALIDATION_ERROR,
|
|
@@ -22028,6 +22124,7 @@ let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
|
22028
22124
|
setParamIfDefined(queryParams, Param.ShowSpotterLimitations, showSpotterLimitations, true);
|
|
22029
22125
|
setParamIfDefined(queryParams, Param.HideSampleQuestions, hideSampleQuestions, true);
|
|
22030
22126
|
setParamIfDefined(queryParams, Param.UpdatedSpotterChatPrompt, updatedSpotterChatPrompt, true);
|
|
22127
|
+
setParamIfDefined(queryParams, Param.EnablePastConversationsSidebar, resolvedEnablePastConversationsSidebar, true);
|
|
22031
22128
|
setParamIfDefined(queryParams, Param.SpotterSidebarDefaultExpanded, spotterSidebarDefaultExpanded, true);
|
|
22032
22129
|
// String params
|
|
22033
22130
|
setParamIfDefined(queryParams, Param.SpotterSidebarTitle, spotterSidebarTitle);
|
|
@@ -22062,13 +22159,9 @@ let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
|
22062
22159
|
return queryParams;
|
|
22063
22160
|
}
|
|
22064
22161
|
getIframeSrc() {
|
|
22065
|
-
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL,
|
|
22162
|
+
const { worksheetId, searchOptions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, } = this.viewConfig;
|
|
22066
22163
|
const path = 'insights/conv-assist';
|
|
22067
22164
|
const queryParams = this.getEmbedParamsObject();
|
|
22068
|
-
const enablePastConversationsSidebar = spotterSidebarConfig === null || spotterSidebarConfig === void 0 ? void 0 : spotterSidebarConfig.enablePastConversationsSidebar;
|
|
22069
|
-
if (!isUndefined_1(enablePastConversationsSidebar)) {
|
|
22070
|
-
queryParams[Param.EnablePastConversationsSidebar] = !!enablePastConversationsSidebar;
|
|
22071
|
-
}
|
|
22072
22165
|
let query = '';
|
|
22073
22166
|
const queryParamsString = getQueryParamString(queryParams, true);
|
|
22074
22167
|
if (queryParamsString) {
|
|
@@ -22097,8 +22190,9 @@ let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
|
22097
22190
|
};
|
|
22098
22191
|
/**
|
|
22099
22192
|
* Embed ThoughtSpot AI Conversation.
|
|
22100
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22101
22193
|
* Use {@link SpotterEmbed} instead
|
|
22194
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22195
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22102
22196
|
* @group Embed components
|
|
22103
22197
|
* @example
|
|
22104
22198
|
* ```js
|
|
@@ -22110,7 +22204,6 @@ let SpotterEmbed$1 = class SpotterEmbed extends TsEmbed {
|
|
|
22110
22204
|
* });
|
|
22111
22205
|
* conversation.render();
|
|
22112
22206
|
* ```
|
|
22113
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
22114
22207
|
*/
|
|
22115
22208
|
let ConversationEmbed$1 = class ConversationEmbed extends SpotterEmbed$1 {
|
|
22116
22209
|
constructor(container, viewConfig) {
|
|
@@ -22203,7 +22296,7 @@ const PreRenderedSearchEmbed = componentFactory(SearchEmbed$1, true);
|
|
|
22203
22296
|
* React component for Full app Embed.
|
|
22204
22297
|
* @example
|
|
22205
22298
|
* ```tsx
|
|
22206
|
-
* function
|
|
22299
|
+
* function App() {
|
|
22207
22300
|
* return <AppEmbed
|
|
22208
22301
|
* showPrimaryNavbar={false}
|
|
22209
22302
|
* pageId={Page.Liveboards}
|
|
@@ -22214,9 +22307,9 @@ const PreRenderedSearchEmbed = componentFactory(SearchEmbed$1, true);
|
|
|
22214
22307
|
*/
|
|
22215
22308
|
const AppEmbed = componentFactory(AppEmbed$1);
|
|
22216
22309
|
/**
|
|
22217
|
-
* React component for PreRendered
|
|
22310
|
+
* React component for PreRendered App embed.
|
|
22218
22311
|
*
|
|
22219
|
-
* PreRenderedAppEmbed will preRender the
|
|
22312
|
+
* PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
|
|
22220
22313
|
* default.
|
|
22221
22314
|
*
|
|
22222
22315
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -22256,7 +22349,7 @@ const PinboardEmbed = LiveboardEmbed;
|
|
|
22256
22349
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
22257
22350
|
*
|
|
22258
22351
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
22259
|
-
* tries to preRender the LiveboardEmbed, so it is recommended to
|
|
22352
|
+
* tries to preRender the LiveboardEmbed, so it is recommended to pass the
|
|
22260
22353
|
* liveboardId to both the components.
|
|
22261
22354
|
* @example
|
|
22262
22355
|
* ```tsx
|
|
@@ -22285,7 +22378,7 @@ const PreRenderedPinboardEmbed = PreRenderedLiveboardEmbed;
|
|
|
22285
22378
|
*/
|
|
22286
22379
|
const SearchBarEmbed = componentFactory(SearchBarEmbed$1);
|
|
22287
22380
|
/**
|
|
22288
|
-
* React component for PreRendered
|
|
22381
|
+
* React component for PreRendered SearchBar embed.
|
|
22289
22382
|
*
|
|
22290
22383
|
* PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
|
|
22291
22384
|
* default.
|
|
@@ -22317,9 +22410,9 @@ const PreRenderedSearchBarEmbed = componentFactory(SearchBarEmbed$1, true);
|
|
|
22317
22410
|
*/
|
|
22318
22411
|
const SageEmbed = componentFactory(SageEmbed$1);
|
|
22319
22412
|
/**
|
|
22320
|
-
* React component for PreRendered
|
|
22413
|
+
* React component for PreRendered Sage embed.
|
|
22321
22414
|
*
|
|
22322
|
-
* PreRenderedSageEmbed will preRender the
|
|
22415
|
+
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
22323
22416
|
* default.
|
|
22324
22417
|
*
|
|
22325
22418
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -22353,8 +22446,8 @@ const PreRenderedSageEmbed = componentFactory(SageEmbed$1, true);
|
|
|
22353
22446
|
const SpotterEmbed = componentFactory(SpotterEmbed$1);
|
|
22354
22447
|
/**
|
|
22355
22448
|
* React component for LLM based conversation BI.
|
|
22356
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22357
22449
|
* Use {@link SpotterEmbed} instead
|
|
22450
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
22358
22451
|
* @example
|
|
22359
22452
|
* ```tsx
|
|
22360
22453
|
* function Sage() {
|
|
@@ -22376,6 +22469,7 @@ const ConversationMessage = componentFactory(ConversationMessage$1);
|
|
|
22376
22469
|
* This component renders a single message response from your ThoughtSpot conversation,
|
|
22377
22470
|
* showing charts, visualizations, or text responses based on the user's query.
|
|
22378
22471
|
*
|
|
22472
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22379
22473
|
* @example
|
|
22380
22474
|
* ```tsx
|
|
22381
22475
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
@@ -22392,7 +22486,6 @@ const ConversationMessage = componentFactory(ConversationMessage$1);
|
|
|
22392
22486
|
* />
|
|
22393
22487
|
* }
|
|
22394
22488
|
* ```
|
|
22395
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22396
22489
|
*/
|
|
22397
22490
|
const SpotterMessage = React__default.forwardRef((props, ref) => {
|
|
22398
22491
|
const { message, query: _, ...otherProps } = props;
|
|
@@ -22404,7 +22497,7 @@ const SpotterMessage = React__default.forwardRef((props, ref) => {
|
|
|
22404
22497
|
* PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
|
|
22405
22498
|
* default.
|
|
22406
22499
|
*
|
|
22407
|
-
*
|
|
22500
|
+
* SpotterEmbed with preRenderId passed will call showPreRender on the embed.
|
|
22408
22501
|
* @example
|
|
22409
22502
|
* ```tsx
|
|
22410
22503
|
* function LandingPageComponent() {
|
|
@@ -22438,6 +22531,7 @@ function useEmbedRef() {
|
|
|
22438
22531
|
}
|
|
22439
22532
|
/**
|
|
22440
22533
|
*
|
|
22534
|
+
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
22441
22535
|
* @param config - EmbedConfig
|
|
22442
22536
|
* @returns AuthEventEmitter
|
|
22443
22537
|
* @example
|
|
@@ -22447,7 +22541,6 @@ function useEmbedRef() {
|
|
|
22447
22541
|
* return <LiveboardEmbed ref={ref} liveboardId={<id>} />
|
|
22448
22542
|
* }
|
|
22449
22543
|
* ```
|
|
22450
|
-
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
22451
22544
|
*/
|
|
22452
22545
|
function useInit(config) {
|
|
22453
22546
|
const ref = useRef(null);
|
|
@@ -22463,6 +22556,7 @@ function useInit(config) {
|
|
|
22463
22556
|
* This hook provides a sendMessage function that allows you to send natural language
|
|
22464
22557
|
* queries to your data and get back AI-generated responses with visualizations.
|
|
22465
22558
|
*
|
|
22559
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22466
22560
|
* @param config - Configuration object containing worksheetId and other options
|
|
22467
22561
|
* @returns Object with sendMessage function that returns conversation results
|
|
22468
22562
|
* @example
|
|
@@ -22480,7 +22574,6 @@ function useInit(config) {
|
|
|
22480
22574
|
* }
|
|
22481
22575
|
* };
|
|
22482
22576
|
* ```
|
|
22483
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
22484
22577
|
*/
|
|
22485
22578
|
function useSpotterAgent(config) {
|
|
22486
22579
|
const serviceRef = useRef(null);
|