@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +29 -7
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.js +1 -3
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/authToken.js +0 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/authToken.spec.js +2 -1
- package/cjs/src/authToken.spec.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +62 -33
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -3
- 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/auto-frame-renderer.d.ts +41 -0
- package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.js +145 -0
- package/cjs/src/embed/auto-frame-renderer.js.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/cjs/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/cjs/src/embed/auto-frame-renderer.spec.js +195 -0
- package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -0
- package/cjs/src/embed/base.d.ts +2 -2
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +6 -9
- package/cjs/src/embed/base.js.map +1 -1
- 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/hostEventClient/host-event-client.js +0 -2
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +42 -35
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +6 -4
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +5 -3
- 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 -2
- package/cjs/src/embed/sage.js.map +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 +13 -12
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +0 -2
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +3 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +15 -9
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +37 -1
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +3 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +3 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -13
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +6 -3
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +350 -287
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +240 -218
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +9 -6
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +13 -15
- 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/graphql/preview-service.js +0 -1
- package/cjs/src/utils/graphql/preview-service.js.map +1 -1
- package/cjs/src/utils/processData.js +0 -5
- package/cjs/src/utils/processData.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-Vyh6Ha5f.js → index-DyX-x6uN.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 +62 -33
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/auto-frame-renderer.d.ts +41 -0
- package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/dist/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/dist/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/dist/src/embed/base.d.ts +2 -2
- package/dist/src/embed/base.d.ts.map +1 -1
- 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 -35
- 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 +13 -12
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +3 -3
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -2
- package/dist/src/index.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 +350 -287
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +9 -6
- 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 +359 -329
- package/dist/tsembed-react.js +358 -328
- package/dist/tsembed.es.js +490 -321
- package/dist/tsembed.js +489 -319
- package/dist/visual-embed-sdk-react-full.d.ts +574 -442
- package/dist/visual-embed-sdk-react.d.ts +572 -440
- package/dist/visual-embed-sdk.d.ts +622 -446
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +29 -7
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +1 -3
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/authToken.js +0 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/authToken.spec.js +2 -1
- package/lib/src/authToken.spec.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +62 -33
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +11 -4
- 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/auto-frame-renderer.d.ts +41 -0
- package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -0
- package/lib/src/embed/auto-frame-renderer.js +141 -0
- package/lib/src/embed/auto-frame-renderer.js.map +1 -0
- package/lib/src/embed/auto-frame-renderer.spec.d.ts +2 -0
- package/lib/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
- package/lib/src/embed/auto-frame-renderer.spec.js +192 -0
- package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -0
- package/lib/src/embed/base.d.ts +2 -2
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +6 -9
- package/lib/src/embed/base.js.map +1 -1
- 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/hostEventClient/host-event-client.js +0 -2
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +42 -35
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +6 -4
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +5 -3
- 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 -2
- package/lib/src/embed/sage.js.map +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 +13 -12
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +0 -2
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +3 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +15 -9
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +37 -1
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +3 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -0
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -13
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +6 -3
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +350 -287
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +240 -218
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +9 -6
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +12 -14
- 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/graphql/preview-service.js +0 -1
- package/lib/src/utils/graphql/preview-service.js.map +1 -1
- package/lib/src/utils/processData.js +0 -5
- package/lib/src/utils/processData.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/lib/src/visual-embed-sdk.d.ts +11466 -0
- package/package.json +1 -1
- package/src/auth.spec.ts +1 -1
- package/src/auth.ts +32 -7
- package/src/authToken.spec.ts +2 -1
- package/src/authToken.ts +1 -1
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +74 -36
- package/src/embed/auto-frame-renderer.spec.ts +266 -0
- package/src/embed/auto-frame-renderer.ts +152 -0
- package/src/embed/base.spec.ts +1 -1
- package/src/embed/base.ts +9 -10
- 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/hostEventClient/host-event-client.ts +2 -2
- package/src/embed/liveboard.spec.ts +5 -3
- package/src/embed/liveboard.ts +47 -38
- package/src/embed/sage.ts +6 -6
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.spec.ts +2 -2
- package/src/embed/search.ts +13 -12
- package/src/embed/ts-embed.spec.ts +44 -1
- package/src/embed/ts-embed.ts +14 -9
- package/src/index.ts +3 -0
- package/src/react/index.spec.tsx +6 -3
- package/src/react/index.tsx +16 -16
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +350 -286
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +14 -10
- package/src/utils/graphql/preview-service.ts +1 -1
- package/src/utils/processData.ts +5 -5
- package/src/utils.ts +14 -0
|
@@ -426,37 +426,37 @@ export interface CustomCssVariables {
|
|
|
426
426
|
/**
|
|
427
427
|
* Padding of the groups in the Liveboard.
|
|
428
428
|
*
|
|
429
|
-
* Please enable the Liveboard
|
|
429
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
430
430
|
*/
|
|
431
431
|
"--ts-var-liveboard-group-padding"?: string;
|
|
432
432
|
/**
|
|
433
433
|
* Font size of the title of the groups in the Liveboard.
|
|
434
434
|
*
|
|
435
|
-
* Please enable the Liveboard
|
|
435
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
436
436
|
*/
|
|
437
437
|
"--ts-var-liveboard-group-title-font-size"?: string;
|
|
438
438
|
/**
|
|
439
439
|
* Font weight of the title of the groups in the Liveboard.
|
|
440
440
|
*
|
|
441
|
-
* Please enable the Liveboard
|
|
441
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
442
442
|
*/
|
|
443
443
|
"--ts-var-liveboard-group-title-font-weight"?: string;
|
|
444
444
|
/**
|
|
445
445
|
* Font size of the title of the tiles inside the groups in the Liveboard.
|
|
446
446
|
*
|
|
447
|
-
* Please enable the Liveboard
|
|
447
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
448
448
|
*/
|
|
449
449
|
"--ts-var-liveboard-group-tile-title-font-size"?: string;
|
|
450
450
|
/**
|
|
451
451
|
* Font weight of the title of the tiles inside the groups in the Liveboard.
|
|
452
452
|
*
|
|
453
|
-
* Please enable the Liveboard
|
|
453
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
454
454
|
*/
|
|
455
455
|
"--ts-var-liveboard-group-tile-title-font-weight"?: string;
|
|
456
456
|
/**
|
|
457
457
|
* Padding of the group tiles in the Liveboard.
|
|
458
458
|
*
|
|
459
|
-
* Please enable the Liveboard
|
|
459
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
460
460
|
*/
|
|
461
461
|
"--ts-var-liveboard-group-tile-padding"?: string;
|
|
462
462
|
/**
|
|
@@ -466,13 +466,13 @@ export interface CustomCssVariables {
|
|
|
466
466
|
/**
|
|
467
467
|
* Background color of the groups in the Liveboard.
|
|
468
468
|
*
|
|
469
|
-
* Please enable the Liveboard
|
|
469
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
470
470
|
*/
|
|
471
471
|
"--ts-var-liveboard-group-background"?: string;
|
|
472
472
|
/**
|
|
473
473
|
* Border color of the groups in the Liveboard.
|
|
474
474
|
*
|
|
475
|
-
* Please enable the Liveboard
|
|
475
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
476
476
|
*/
|
|
477
477
|
"--ts-var-liveboard-group-border-color"?: string;
|
|
478
478
|
/**
|
|
@@ -486,55 +486,55 @@ export interface CustomCssVariables {
|
|
|
486
486
|
/**
|
|
487
487
|
* Font color of the title of the groups in the Liveboard.
|
|
488
488
|
*
|
|
489
|
-
* Please enable the Liveboard
|
|
489
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
490
490
|
*/
|
|
491
491
|
"--ts-var-liveboard-group-title-font-color"?: string;
|
|
492
492
|
/**
|
|
493
493
|
* Font color of the description of the groups in the Liveboard.
|
|
494
494
|
*
|
|
495
|
-
* Please enable the Liveboard
|
|
495
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
496
496
|
*/
|
|
497
497
|
"--ts-var-liveboard-group-description-font-color"?: string;
|
|
498
498
|
/**
|
|
499
499
|
* Font color of the title of the tiles inside the groups in the Liveboard.
|
|
500
500
|
*
|
|
501
|
-
* Please enable the Liveboard
|
|
501
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
502
502
|
*/
|
|
503
503
|
"--ts-var-liveboard-group-tile-title-font-color"?: string;
|
|
504
504
|
/**
|
|
505
505
|
* Font color of the description of the tiles inside the groups in the Liveboard.
|
|
506
506
|
*
|
|
507
|
-
* Please enable the Liveboard
|
|
507
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
508
508
|
*/
|
|
509
509
|
"--ts-var-liveboard-group-tile-description-font-color"?: string;
|
|
510
510
|
/**
|
|
511
511
|
* Background color of the tiles inside the groups in the Liveboard.
|
|
512
512
|
*
|
|
513
|
-
* Please enable the Liveboard
|
|
513
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
514
514
|
*/
|
|
515
515
|
"--ts-var-liveboard-group-tile-background"?: string;
|
|
516
516
|
/**
|
|
517
517
|
* Background color of the filter chips in the Liveboard.
|
|
518
518
|
*
|
|
519
|
-
* Please enable the Liveboard
|
|
519
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
520
520
|
*/
|
|
521
521
|
"--ts-var-liveboard-chip-background"?: string;
|
|
522
522
|
/**
|
|
523
523
|
* Font color of the filter chips in the Liveboard.
|
|
524
524
|
*
|
|
525
|
-
* Please enable the Liveboard
|
|
525
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
526
526
|
*/
|
|
527
527
|
"--ts-var-liveboard-chip-color"?: string;
|
|
528
528
|
/**
|
|
529
529
|
* Background color of the filter chips in the Liveboard on hover.
|
|
530
530
|
*
|
|
531
|
-
* Please enable the Liveboard
|
|
531
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
532
532
|
*/
|
|
533
533
|
"--ts-var-liveboard-chip--hover-background"?: string;
|
|
534
534
|
/**
|
|
535
535
|
* Background color of the filter chips in the Liveboard on active.
|
|
536
536
|
*
|
|
537
|
-
* Please enable the Liveboard
|
|
537
|
+
* Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
|
|
538
538
|
*/
|
|
539
539
|
"--ts-var-liveboard-chip--active-background"?: string;
|
|
540
540
|
/**
|
|
@@ -771,10 +771,11 @@ export interface UnderlyingDataPoint {
|
|
|
771
771
|
*
|
|
772
772
|
* You can use this service to:
|
|
773
773
|
*
|
|
774
|
-
* - Add or remove columns from Answers (`addColumns`, `removeColumns`,
|
|
775
|
-
* - Apply filters to Answers (`addFilter`)
|
|
776
|
-
* - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`,
|
|
777
|
-
* - Get data for specific points in visualizations
|
|
774
|
+
* - Add or remove columns from Answers (`addColumns`, `removeColumns`,
|
|
775
|
+
* `addColumnsByName`) - Apply filters to Answers (`addFilter`)
|
|
776
|
+
* - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`,
|
|
777
|
+
* `fetchCSVBlob`, `fetchPNGBlob`) - Get data for specific points in visualizations
|
|
778
|
+
* (`getUnderlyingDataForPoint`)
|
|
778
779
|
* - Run custom queries (`executeQuery`)
|
|
779
780
|
* - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
|
|
780
781
|
*
|
|
@@ -807,7 +808,7 @@ export interface UnderlyingDataPoint {
|
|
|
807
808
|
* });
|
|
808
809
|
* ```
|
|
809
810
|
*
|
|
810
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
811
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
811
812
|
* @group Events
|
|
812
813
|
*/
|
|
813
814
|
export declare class AnswerService {
|
|
@@ -855,6 +856,7 @@ export declare class AnswerService {
|
|
|
855
856
|
* ]);
|
|
856
857
|
* console.log(await service.fetchData());
|
|
857
858
|
* });
|
|
859
|
+
* ```
|
|
858
860
|
*/
|
|
859
861
|
addColumnsByName(columnNames: string[]): Promise<any>;
|
|
860
862
|
/**
|
|
@@ -926,7 +928,7 @@ export declare class AnswerService {
|
|
|
926
928
|
* const data = await underlying.fetchData(0, 100);
|
|
927
929
|
* })
|
|
928
930
|
* ```
|
|
929
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
931
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
930
932
|
*/
|
|
931
933
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
932
934
|
/**
|
|
@@ -947,7 +949,7 @@ export declare class AnswerService {
|
|
|
947
949
|
setTMLOverride(override: any): void;
|
|
948
950
|
}
|
|
949
951
|
/**
|
|
950
|
-
* The authentication mechanism for allowing access to
|
|
952
|
+
* The authentication mechanism for allowing access to
|
|
951
953
|
* the embedded app
|
|
952
954
|
* @group Authentication / Init
|
|
953
955
|
*/
|
|
@@ -972,6 +974,7 @@ export declare enum AuthType {
|
|
|
972
974
|
* To use this:
|
|
973
975
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
974
976
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
977
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
975
978
|
* @example
|
|
976
979
|
* ```js
|
|
977
980
|
* init({
|
|
@@ -979,18 +982,17 @@ export declare enum AuthType {
|
|
|
979
982
|
* authType: AuthType.EmbeddedSSO,
|
|
980
983
|
* });
|
|
981
984
|
* ```
|
|
982
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
983
985
|
*/
|
|
984
986
|
EmbeddedSSO = "EmbeddedSSO",
|
|
985
987
|
/**
|
|
986
|
-
* SSO using SAML
|
|
987
|
-
* @deprecated
|
|
988
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
989
|
+
* @deprecated This option is deprecated.
|
|
988
990
|
* @hidden
|
|
989
991
|
*/
|
|
990
992
|
SSO = "SSO_SAML",
|
|
991
993
|
/**
|
|
992
|
-
* SSO using SAML
|
|
993
|
-
* @deprecated
|
|
994
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
995
|
+
* @deprecated This option is deprecated.
|
|
994
996
|
* @hidden
|
|
995
997
|
*/
|
|
996
998
|
SAML = "SSO_SAML",
|
|
@@ -1041,8 +1043,9 @@ export declare enum AuthType {
|
|
|
1041
1043
|
SAMLRedirect = "SSO_SAML",
|
|
1042
1044
|
/**
|
|
1043
1045
|
* SSO using OIDC
|
|
1046
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
1047
|
+
* @deprecated This option is deprecated.
|
|
1044
1048
|
* @hidden
|
|
1045
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
1046
1049
|
*/
|
|
1047
1050
|
OIDC = "SSO_OIDC",
|
|
1048
1051
|
/**
|
|
@@ -1053,8 +1056,9 @@ export declare enum AuthType {
|
|
|
1053
1056
|
OIDCRedirect = "SSO_OIDC",
|
|
1054
1057
|
/**
|
|
1055
1058
|
* Trusted authentication server
|
|
1059
|
+
* Use {@link TrustedAuth} instead
|
|
1060
|
+
* @deprecated This option is deprecated.
|
|
1056
1061
|
* @hidden
|
|
1057
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
1058
1062
|
*/
|
|
1059
1063
|
AuthServer = "AuthServer",
|
|
1060
1064
|
/**
|
|
@@ -1081,6 +1085,7 @@ export declare enum AuthType {
|
|
|
1081
1085
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1082
1086
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1083
1087
|
* implemented by some browsers.
|
|
1088
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1084
1089
|
* @example
|
|
1085
1090
|
* ```js
|
|
1086
1091
|
* init({
|
|
@@ -1091,8 +1096,8 @@ export declare enum AuthType {
|
|
|
1091
1096
|
* .then((response) => response.json())
|
|
1092
1097
|
* .then((data) => data.token);
|
|
1093
1098
|
* }
|
|
1099
|
+
* });
|
|
1094
1100
|
* ```
|
|
1095
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1096
1101
|
*/
|
|
1097
1102
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1098
1103
|
/**
|
|
@@ -1112,43 +1117,43 @@ export declare enum HomeLeftNavItem {
|
|
|
1112
1117
|
/**
|
|
1113
1118
|
* The *Search data* option in
|
|
1114
1119
|
* the *Insights* left navigation panel.
|
|
1115
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1120
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1116
1121
|
*/
|
|
1117
1122
|
SearchData = "search-data",
|
|
1118
1123
|
/**
|
|
1119
1124
|
* The *Home* menu option in
|
|
1120
1125
|
* the *Insights* left navigation panel.
|
|
1121
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1126
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1122
1127
|
*/
|
|
1123
1128
|
Home = "insights-home",
|
|
1124
1129
|
/**
|
|
1125
1130
|
* The *Liveboards* menu option in
|
|
1126
1131
|
* the *Insights* left navigation panel.
|
|
1127
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1132
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1128
1133
|
*/
|
|
1129
1134
|
Liveboards = "liveboards",
|
|
1130
1135
|
/**
|
|
1131
1136
|
* The *Answers* menu option in
|
|
1132
1137
|
* the *Insights* left navigation panel.
|
|
1133
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1138
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1134
1139
|
*/
|
|
1135
1140
|
Answers = "answers",
|
|
1136
1141
|
/**
|
|
1137
1142
|
* The *Monitor subscriptions* menu option in
|
|
1138
1143
|
* the *Insights* left navigation panel.
|
|
1139
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1144
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1140
1145
|
*/
|
|
1141
1146
|
MonitorSubscription = "monitor-alerts",
|
|
1142
1147
|
/**
|
|
1143
1148
|
* The *SpotIQ analysis* menu option in
|
|
1144
1149
|
* the *Insights* left navigation panel.
|
|
1145
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1150
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1146
1151
|
*/
|
|
1147
1152
|
SpotIQAnalysis = "spotiq-analysis",
|
|
1148
1153
|
/**
|
|
1149
1154
|
* The *Liveboard schedules* menu option in
|
|
1150
1155
|
* the *Insights* left navigation panel.
|
|
1151
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
1156
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1152
1157
|
*/
|
|
1153
1158
|
LiveboardSchedules = "liveboard-schedules",
|
|
1154
1159
|
/**
|
|
@@ -1319,8 +1324,8 @@ export interface EmbedConfig {
|
|
|
1319
1324
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1320
1325
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1321
1326
|
* place.
|
|
1327
|
+
* @deprecated This option is deprecated.
|
|
1322
1328
|
* @default false
|
|
1323
|
-
* @deprecated
|
|
1324
1329
|
*/
|
|
1325
1330
|
noRedirect?: boolean;
|
|
1326
1331
|
/**
|
|
@@ -1329,8 +1334,8 @@ export interface EmbedConfig {
|
|
|
1329
1334
|
*
|
|
1330
1335
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1331
1336
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1332
|
-
* @default false
|
|
1333
1337
|
* @version SDK: 1.18.0
|
|
1338
|
+
* @default false
|
|
1334
1339
|
*/
|
|
1335
1340
|
inPopup?: boolean;
|
|
1336
1341
|
/**
|
|
@@ -1339,7 +1344,7 @@ export interface EmbedConfig {
|
|
|
1339
1344
|
* terminated.
|
|
1340
1345
|
*
|
|
1341
1346
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1342
|
-
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1347
|
+
* @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1343
1348
|
*/
|
|
1344
1349
|
redirectPath?: string;
|
|
1345
1350
|
/** @internal */
|
|
@@ -1412,7 +1417,7 @@ export interface EmbedConfig {
|
|
|
1412
1417
|
detectCookieAccessSlow?: boolean;
|
|
1413
1418
|
/**
|
|
1414
1419
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1415
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1420
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1416
1421
|
*/
|
|
1417
1422
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1418
1423
|
/**
|
|
@@ -1429,6 +1434,7 @@ export interface EmbedConfig {
|
|
|
1429
1434
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1430
1435
|
* button that the user can click to trigger the flow.
|
|
1431
1436
|
* This attribute sets a containing element for that button.
|
|
1437
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1432
1438
|
* @example
|
|
1433
1439
|
* ```js
|
|
1434
1440
|
* init({
|
|
@@ -1437,7 +1443,6 @@ export interface EmbedConfig {
|
|
|
1437
1443
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1438
1444
|
* })
|
|
1439
1445
|
* ```
|
|
1440
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1441
1446
|
*/
|
|
1442
1447
|
authTriggerContainer?: string | HTMLElement;
|
|
1443
1448
|
/**
|
|
@@ -1454,11 +1459,10 @@ export interface EmbedConfig {
|
|
|
1454
1459
|
*/
|
|
1455
1460
|
authTriggerText?: string;
|
|
1456
1461
|
/**
|
|
1457
|
-
* Prevent users from accessing
|
|
1458
|
-
*
|
|
1459
|
-
* outside of the iframe.
|
|
1460
|
-
* @default true
|
|
1462
|
+
* Prevent embedded application users from accessing ThoughtSpot
|
|
1463
|
+
* application pages outside of the iframe.
|
|
1461
1464
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1465
|
+
* @default true
|
|
1462
1466
|
*/
|
|
1463
1467
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1464
1468
|
/**
|
|
@@ -1488,6 +1492,7 @@ export interface EmbedConfig {
|
|
|
1488
1492
|
* other logs such as warnings, information alerts,
|
|
1489
1493
|
* and debug messages in the console output.
|
|
1490
1494
|
*
|
|
1495
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1491
1496
|
* @default LogLevel.ERROR
|
|
1492
1497
|
* @example
|
|
1493
1498
|
* ```js
|
|
@@ -1496,7 +1501,6 @@ export interface EmbedConfig {
|
|
|
1496
1501
|
* logLevel: LogLevel.SILENT
|
|
1497
1502
|
* })
|
|
1498
1503
|
* ```
|
|
1499
|
-
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1500
1504
|
*/
|
|
1501
1505
|
logLevel?: LogLevel;
|
|
1502
1506
|
/**
|
|
@@ -1523,6 +1527,7 @@ export interface EmbedConfig {
|
|
|
1523
1527
|
* This flag is used to disable the token verification in the SDK.
|
|
1524
1528
|
* Enabling this flag will also disable the caching of the token.
|
|
1525
1529
|
* @hidden
|
|
1530
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1526
1531
|
* @example
|
|
1527
1532
|
* ```js
|
|
1528
1533
|
* init({
|
|
@@ -1530,12 +1535,11 @@ export interface EmbedConfig {
|
|
|
1530
1535
|
* disableTokenVerification : true
|
|
1531
1536
|
* })
|
|
1532
1537
|
* ```
|
|
1533
|
-
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1534
1538
|
*/
|
|
1535
1539
|
disableTokenVerification?: boolean;
|
|
1536
1540
|
/**
|
|
1537
1541
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
1538
|
-
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1542
|
+
* @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1539
1543
|
*/
|
|
1540
1544
|
disableLoginFailurePage?: boolean;
|
|
1541
1545
|
/**
|
|
@@ -1545,6 +1549,7 @@ export interface EmbedConfig {
|
|
|
1545
1549
|
* Warning: This option is for advanced use only and is used internally
|
|
1546
1550
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1547
1551
|
* list of supported keys and values associated with each.
|
|
1552
|
+
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1548
1553
|
* @example
|
|
1549
1554
|
* ```js
|
|
1550
1555
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1555,7 +1560,6 @@ export interface EmbedConfig {
|
|
|
1555
1560
|
* }
|
|
1556
1561
|
* });
|
|
1557
1562
|
* ```
|
|
1558
|
-
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1559
1563
|
*/
|
|
1560
1564
|
additionalFlags?: {
|
|
1561
1565
|
[key: string]: string | number | boolean;
|
|
@@ -1563,6 +1567,7 @@ export interface EmbedConfig {
|
|
|
1563
1567
|
/**
|
|
1564
1568
|
* This is an object (key/val) for customVariables being
|
|
1565
1569
|
* used by the third party tool's script.
|
|
1570
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1566
1571
|
* @example
|
|
1567
1572
|
* ```js
|
|
1568
1573
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1573,15 +1578,14 @@ export interface EmbedConfig {
|
|
|
1573
1578
|
* }
|
|
1574
1579
|
* });
|
|
1575
1580
|
* ```
|
|
1576
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1577
1581
|
*/
|
|
1578
1582
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
1579
1583
|
disablePreauthCache?: boolean;
|
|
1580
1584
|
/**
|
|
1581
1585
|
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
1582
1586
|
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
1583
|
-
* @default true (feature is disabled by default)
|
|
1584
1587
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1588
|
+
* @default true (feature is disabled by default)
|
|
1585
1589
|
* @example
|
|
1586
1590
|
* ```js
|
|
1587
1591
|
* init({
|
|
@@ -1787,7 +1791,7 @@ export interface FrameParams {
|
|
|
1787
1791
|
*/
|
|
1788
1792
|
loading?: "lazy" | "eager" | "auto";
|
|
1789
1793
|
/**
|
|
1790
|
-
*
|
|
1794
|
+
* These parameters will be passed to the iframe
|
|
1791
1795
|
* as is.
|
|
1792
1796
|
*/
|
|
1793
1797
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -1862,8 +1866,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1862
1866
|
*/
|
|
1863
1867
|
disabledActionReason?: string;
|
|
1864
1868
|
/**
|
|
1865
|
-
* The list of actions to hide from the embedded.
|
|
1866
|
-
*
|
|
1869
|
+
* The list of actions to hide from the embedded view.
|
|
1870
|
+
* These actions will be hidden from the user.
|
|
1867
1871
|
* Use this to hide an action.
|
|
1868
1872
|
*
|
|
1869
1873
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -1904,7 +1908,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1904
1908
|
* The locale settings to apply to the embedded view.
|
|
1905
1909
|
*
|
|
1906
1910
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1907
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1911
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1908
1912
|
* @example
|
|
1909
1913
|
* ```js
|
|
1910
1914
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1919,12 +1923,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1919
1923
|
* This is an object (key/val) of override flags which will be applied
|
|
1920
1924
|
* to the internal embedded object. This can be used to add any
|
|
1921
1925
|
* URL flag.
|
|
1922
|
-
* If the same flags are passed in init, they will be
|
|
1926
|
+
* If the same flags are passed in init, they will be overridden by the values here.
|
|
1923
1927
|
* Warning: This option is for advanced use only and is used internally
|
|
1924
1928
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1925
1929
|
* list of supported keys and values associated with each.
|
|
1926
1930
|
*
|
|
1927
1931
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1932
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1928
1933
|
* @example
|
|
1929
1934
|
* ```js
|
|
1930
1935
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1936,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1936
1941
|
* },
|
|
1937
1942
|
* });
|
|
1938
1943
|
* ```
|
|
1939
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1940
1944
|
*/
|
|
1941
1945
|
additionalFlags?: {
|
|
1942
1946
|
[key: string]: string | number | boolean;
|
|
@@ -1979,6 +1983,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1979
1983
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1980
1984
|
*
|
|
1981
1985
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1986
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1982
1987
|
* @example
|
|
1983
1988
|
* ```js
|
|
1984
1989
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1988,7 +1993,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1988
1993
|
* });
|
|
1989
1994
|
* embed.showPreRender();
|
|
1990
1995
|
* ```
|
|
1991
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1992
1996
|
*/
|
|
1993
1997
|
preRenderId?: string;
|
|
1994
1998
|
/**
|
|
@@ -1998,7 +2002,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1998
2002
|
* its dimensions based on changes to the size of the embedding element.
|
|
1999
2003
|
* @type {boolean}
|
|
2000
2004
|
* @default false
|
|
2001
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2005
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
2002
2006
|
* @example
|
|
2003
2007
|
* ```js
|
|
2004
2008
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2013,9 +2017,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2013
2017
|
doNotTrackPreRenderSize?: boolean;
|
|
2014
2018
|
/**
|
|
2015
2019
|
* Enable the V2 shell. This can provide performance benefits
|
|
2016
|
-
* due to a
|
|
2020
|
+
* due to a lighter-weight shell.
|
|
2017
2021
|
*
|
|
2018
2022
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2023
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2019
2024
|
* @example
|
|
2020
2025
|
* ```js
|
|
2021
2026
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2024,7 +2029,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2024
2029
|
* enableV2Shell_experimental: true,
|
|
2025
2030
|
* });
|
|
2026
2031
|
* ```
|
|
2027
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2028
2032
|
*/
|
|
2029
2033
|
enableV2Shell_experimental?: boolean;
|
|
2030
2034
|
/**
|
|
@@ -2043,6 +2047,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2043
2047
|
* and disable redirection of links in a new tab.
|
|
2044
2048
|
*
|
|
2045
2049
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2050
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2046
2051
|
* @example
|
|
2047
2052
|
* ```js
|
|
2048
2053
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2051,7 +2056,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2051
2056
|
* disableRedirectionLinksInNewTab: true,
|
|
2052
2057
|
* });
|
|
2053
2058
|
* ```
|
|
2054
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2055
2059
|
*/
|
|
2056
2060
|
disableRedirectionLinksInNewTab?: boolean;
|
|
2057
2061
|
/**
|
|
@@ -2062,6 +2066,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2062
2066
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
2063
2067
|
*
|
|
2064
2068
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2069
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2065
2070
|
* @example
|
|
2066
2071
|
* ```js
|
|
2067
2072
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2070,24 +2075,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2070
2075
|
* overrideOrgId: 142536,
|
|
2071
2076
|
* });
|
|
2072
2077
|
* ```
|
|
2073
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2074
2078
|
*/
|
|
2075
2079
|
overrideOrgId?: number;
|
|
2076
2080
|
/**
|
|
2077
|
-
* Flag to override the *Open Link in New Tab* context
|
|
2081
|
+
* Flag to override the *Open Link in New Tab* context
|
|
2082
|
+
* menu option.
|
|
2078
2083
|
*
|
|
2079
|
-
*
|
|
2084
|
+
* For improved link override handling, use
|
|
2085
|
+
* {@link enableLinkOverridesV2} instead.
|
|
2086
|
+
*
|
|
2087
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2088
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2089
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2080
2090
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2081
2091
|
* @example
|
|
2082
2092
|
* ```js
|
|
2083
|
-
*
|
|
2084
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2093
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2085
2094
|
* ... // other embed view config
|
|
2086
|
-
* linkOverride:
|
|
2095
|
+
* linkOverride: true,
|
|
2087
2096
|
* })
|
|
2088
2097
|
* ```
|
|
2089
2098
|
*/
|
|
2090
2099
|
linkOverride?: boolean;
|
|
2100
|
+
/**
|
|
2101
|
+
* Enables the V2 link override mechanism with improved
|
|
2102
|
+
* handling. When enabled, navigation links within the
|
|
2103
|
+
* embedded ThoughtSpot app are intercepted and routed
|
|
2104
|
+
* through the SDK via the `EmbedEvent.DialogOpen`
|
|
2105
|
+
* event.
|
|
2106
|
+
*
|
|
2107
|
+
* The SDK automatically sends {@link linkOverride}
|
|
2108
|
+
* alongside this flag for backward compatibility with
|
|
2109
|
+
* older ThoughtSpot versions.
|
|
2110
|
+
*
|
|
2111
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2112
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2113
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2114
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
2115
|
+
* @example
|
|
2116
|
+
* ```js
|
|
2117
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2118
|
+
* ... // other embed view config
|
|
2119
|
+
* enableLinkOverridesV2: true,
|
|
2120
|
+
* });
|
|
2121
|
+
*
|
|
2122
|
+
* embed.on(EmbedEvent.DialogOpen, (payload) => {
|
|
2123
|
+
* console.log('Link clicked:', payload);
|
|
2124
|
+
* });
|
|
2125
|
+
* ```
|
|
2126
|
+
*/
|
|
2127
|
+
enableLinkOverridesV2?: boolean;
|
|
2091
2128
|
/**
|
|
2092
2129
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2093
2130
|
* Use this to set the primary action.
|
|
@@ -2112,7 +2149,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2112
2149
|
insertInToSlide?: boolean;
|
|
2113
2150
|
/**
|
|
2114
2151
|
* Show alert messages and toast messages in the embed.
|
|
2115
|
-
* Supported
|
|
2152
|
+
* Supported in all embed types.
|
|
2116
2153
|
*
|
|
2117
2154
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2118
2155
|
* @example
|
|
@@ -2342,6 +2379,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2342
2379
|
*/
|
|
2343
2380
|
useHostEventsV2?: boolean;
|
|
2344
2381
|
}
|
|
2382
|
+
export interface AutoMCPFrameRendererViewConfig extends BaseViewConfig {
|
|
2383
|
+
}
|
|
2345
2384
|
/**
|
|
2346
2385
|
* The configuration object for Home page embeds configs.
|
|
2347
2386
|
*/
|
|
@@ -2351,8 +2390,9 @@ export interface HomePageConfig {
|
|
|
2351
2390
|
* *Liveboards* and *Answers*.
|
|
2352
2391
|
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
2353
2392
|
*
|
|
2354
|
-
* **Note**: This option is available only in full app embedding and requires
|
|
2355
|
-
* Starting with version 10.14.0.cl, you can
|
|
2393
|
+
* **Note**: This option is available only in full app embedding and requires
|
|
2394
|
+
* importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
|
|
2395
|
+
* use this attribute to
|
|
2356
2396
|
* hide the columns on all list pages in the *Insights* section.
|
|
2357
2397
|
*
|
|
2358
2398
|
* Supported embed types: `AppEmbed`
|
|
@@ -2392,11 +2432,12 @@ export interface HomePageConfig {
|
|
|
2392
2432
|
/**
|
|
2393
2433
|
* Reorder home page modules.
|
|
2394
2434
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2395
|
-
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2396
|
-
* **Note**: This attribute is not supported in the
|
|
2435
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2436
|
+
* HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
|
|
2437
|
+
* classic (v1) homepage.
|
|
2397
2438
|
*
|
|
2398
2439
|
* Supported embed types: `AppEmbed`
|
|
2399
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2440
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2400
2441
|
* @example
|
|
2401
2442
|
* ```js
|
|
2402
2443
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2417,6 +2458,7 @@ export interface HomePageConfig {
|
|
|
2417
2458
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2418
2459
|
*
|
|
2419
2460
|
* Supported embed types: `AppEmbed`
|
|
2461
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2420
2462
|
* @example
|
|
2421
2463
|
* ```js
|
|
2422
2464
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2427,7 +2469,6 @@ export interface HomePageConfig {
|
|
|
2427
2469
|
* ... //other embed view configuration attributes
|
|
2428
2470
|
* })
|
|
2429
2471
|
* ```
|
|
2430
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2431
2472
|
*/
|
|
2432
2473
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2433
2474
|
}
|
|
@@ -2440,7 +2481,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2440
2481
|
* visualization, or Liveboard.
|
|
2441
2482
|
*
|
|
2442
2483
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2443
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2484
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2444
2485
|
* @example
|
|
2445
2486
|
* ```js
|
|
2446
2487
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2458,11 +2499,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2458
2499
|
*/
|
|
2459
2500
|
runtimeFilters?: RuntimeFilter[];
|
|
2460
2501
|
/**
|
|
2461
|
-
* The list of parameter
|
|
2502
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
2462
2503
|
* visualization, or Liveboard.
|
|
2463
2504
|
*
|
|
2464
2505
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2465
|
-
* @version SDK
|
|
2506
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2466
2507
|
* @example
|
|
2467
2508
|
* ```js
|
|
2468
2509
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2482,6 +2523,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2482
2523
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2483
2524
|
*
|
|
2484
2525
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
2526
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2485
2527
|
* @example
|
|
2486
2528
|
* ```js
|
|
2487
2529
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -2490,7 +2532,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2490
2532
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
2491
2533
|
* })
|
|
2492
2534
|
* ```
|
|
2493
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2494
2535
|
*/
|
|
2495
2536
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2496
2537
|
/**
|
|
@@ -2513,7 +2554,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2513
2554
|
* when set to false, runtime parameters will be included in the URL
|
|
2514
2555
|
* (default behavior before SDK 1.45.0).
|
|
2515
2556
|
*
|
|
2516
|
-
* Irrespective of this flag, runtime
|
|
2557
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
2517
2558
|
* embedded view.
|
|
2518
2559
|
* @default true
|
|
2519
2560
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -2532,14 +2573,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2532
2573
|
* ... // other embed view config
|
|
2533
2574
|
* collapseSearchBar: true,
|
|
2534
2575
|
* });
|
|
2576
|
+
* ```
|
|
2535
2577
|
*/
|
|
2536
2578
|
collapseSearchBar?: boolean;
|
|
2537
2579
|
/**
|
|
2538
2580
|
* Flag to control Data panel experience
|
|
2539
2581
|
*
|
|
2540
2582
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2583
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2541
2584
|
* @default true
|
|
2542
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2543
2585
|
* @example
|
|
2544
2586
|
* ```js
|
|
2545
2587
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -2572,6 +2614,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2572
2614
|
* the current time period in filter results.
|
|
2573
2615
|
*
|
|
2574
2616
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2617
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2575
2618
|
* @example
|
|
2576
2619
|
* ```js
|
|
2577
2620
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -2579,7 +2622,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2579
2622
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
2580
2623
|
* })
|
|
2581
2624
|
* ```
|
|
2582
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2583
2625
|
*/
|
|
2584
2626
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2585
2627
|
}
|
|
@@ -2639,6 +2681,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2639
2681
|
* Boolean to control if Liveboard header is sticky or not.
|
|
2640
2682
|
*
|
|
2641
2683
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2684
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2642
2685
|
* @example
|
|
2643
2686
|
* ```js
|
|
2644
2687
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2647,7 +2690,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2647
2690
|
* isLiveboardHeaderSticky: true,
|
|
2648
2691
|
* });
|
|
2649
2692
|
* ```
|
|
2650
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2651
2693
|
*/
|
|
2652
2694
|
isLiveboardHeaderSticky?: boolean;
|
|
2653
2695
|
/**
|
|
@@ -2655,8 +2697,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2655
2697
|
*
|
|
2656
2698
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2657
2699
|
* @type {boolean}
|
|
2700
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
2658
2701
|
* @default false
|
|
2659
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
2660
2702
|
* @example
|
|
2661
2703
|
* ```js
|
|
2662
2704
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2672,8 +2714,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2672
2714
|
*
|
|
2673
2715
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2674
2716
|
* @type {boolean}
|
|
2717
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
2675
2718
|
* @default false
|
|
2676
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
2677
2719
|
* @example
|
|
2678
2720
|
* ```js
|
|
2679
2721
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2689,7 +2731,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2689
2731
|
* header.
|
|
2690
2732
|
*
|
|
2691
2733
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2692
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2734
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2693
2735
|
* @default true
|
|
2694
2736
|
* @example
|
|
2695
2737
|
* ```js
|
|
@@ -2704,10 +2746,12 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2704
2746
|
/**
|
|
2705
2747
|
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
2706
2748
|
*
|
|
2707
|
-
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2749
|
+
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2750
|
+
* Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
|
|
2751
|
+
* attribute.
|
|
2708
2752
|
*
|
|
2709
2753
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2710
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
2754
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2711
2755
|
* @default false
|
|
2712
2756
|
* @example
|
|
2713
2757
|
* ```js
|
|
@@ -2725,7 +2769,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2725
2769
|
* compact header
|
|
2726
2770
|
*
|
|
2727
2771
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2728
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2772
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2729
2773
|
* @default true
|
|
2730
2774
|
* @example
|
|
2731
2775
|
* ```js
|
|
@@ -2758,7 +2802,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2758
2802
|
* the cover and filters pages in the Liveboard PDF.
|
|
2759
2803
|
*
|
|
2760
2804
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2761
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
2805
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
2762
2806
|
* @example
|
|
2763
2807
|
* ```js
|
|
2764
2808
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2770,9 +2814,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2770
2814
|
*/
|
|
2771
2815
|
coverAndFilterOptionInPDF?: boolean;
|
|
2772
2816
|
/**
|
|
2773
|
-
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2774
|
-
* When enabled, a unified modal is used to manage and update multiple filters
|
|
2775
|
-
* replacing the older individual filter interactions.
|
|
2817
|
+
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2818
|
+
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
2819
|
+
* at once, replacing the older individual filter interactions.
|
|
2776
2820
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2777
2821
|
*
|
|
2778
2822
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
@@ -2803,7 +2847,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2803
2847
|
*/
|
|
2804
2848
|
isLinkParametersEnabled?: boolean;
|
|
2805
2849
|
/**
|
|
2806
|
-
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2850
|
+
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2851
|
+
* liveboard.
|
|
2807
2852
|
*
|
|
2808
2853
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2809
2854
|
* @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
|
|
@@ -2962,7 +3007,7 @@ export declare enum HomepageModule {
|
|
|
2962
3007
|
*/
|
|
2963
3008
|
Search = "SEARCH",
|
|
2964
3009
|
/**
|
|
2965
|
-
*
|
|
3010
|
+
* KPI watchlist module
|
|
2966
3011
|
*/
|
|
2967
3012
|
Watchlist = "WATCHLIST",
|
|
2968
3013
|
/**
|
|
@@ -2993,7 +3038,8 @@ export declare enum ListPageColumns {
|
|
|
2993
3038
|
*/
|
|
2994
3039
|
Favorites = "FAVOURITE",
|
|
2995
3040
|
/**
|
|
2996
|
-
*
|
|
3041
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
3042
|
+
* @deprecated This option is deprecated.
|
|
2997
3043
|
*/
|
|
2998
3044
|
Favourite = "FAVOURITE",
|
|
2999
3045
|
/**
|
|
@@ -3094,13 +3140,13 @@ export declare enum EmbedEvent {
|
|
|
3094
3140
|
/**
|
|
3095
3141
|
* Rendering has initialized.
|
|
3096
3142
|
* @example
|
|
3097
|
-
|
|
3143
|
+
* ```js
|
|
3098
3144
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
3099
3145
|
* //show a loader
|
|
3100
3146
|
* function showLoader() {
|
|
3101
3147
|
* document.getElementById("loader");
|
|
3102
3148
|
* }
|
|
3103
|
-
|
|
3149
|
+
* ```
|
|
3104
3150
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3105
3151
|
*/
|
|
3106
3152
|
Init = "init",
|
|
@@ -3108,11 +3154,11 @@ export declare enum EmbedEvent {
|
|
|
3108
3154
|
* Authentication has either succeeded or failed.
|
|
3109
3155
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3110
3156
|
* @example
|
|
3111
|
-
|
|
3157
|
+
* ```js
|
|
3112
3158
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
3113
3159
|
* console.log('AuthInit', payload);
|
|
3114
3160
|
* })
|
|
3115
|
-
|
|
3161
|
+
* ```
|
|
3116
3162
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
3117
3163
|
*/
|
|
3118
3164
|
AuthInit = "authInit",
|
|
@@ -3121,13 +3167,13 @@ export declare enum EmbedEvent {
|
|
|
3121
3167
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3122
3168
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3123
3169
|
* @example
|
|
3124
|
-
|
|
3170
|
+
* ```js
|
|
3125
3171
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
3126
3172
|
* //hide loader
|
|
3127
3173
|
* function hideLoader() {
|
|
3128
3174
|
* document.getElementById("loader");
|
|
3129
3175
|
* }
|
|
3130
|
-
|
|
3176
|
+
* ```
|
|
3131
3177
|
*/
|
|
3132
3178
|
Load = "load",
|
|
3133
3179
|
/**
|
|
@@ -3136,11 +3182,11 @@ export declare enum EmbedEvent {
|
|
|
3136
3182
|
* @return data - Answer of Liveboard data
|
|
3137
3183
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3138
3184
|
* @example
|
|
3139
|
-
|
|
3185
|
+
* ```js
|
|
3140
3186
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
3141
3187
|
* console.log('data', payload);
|
|
3142
3188
|
* })
|
|
3143
|
-
|
|
3189
|
+
* ```
|
|
3144
3190
|
* @important
|
|
3145
3191
|
*/
|
|
3146
3192
|
Data = "data",
|
|
@@ -3148,9 +3194,9 @@ export declare enum EmbedEvent {
|
|
|
3148
3194
|
* Search query has been updated by the user.
|
|
3149
3195
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3150
3196
|
* @example
|
|
3151
|
-
|
|
3197
|
+
* ```js
|
|
3152
3198
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
3153
|
-
|
|
3199
|
+
* ```
|
|
3154
3200
|
*/
|
|
3155
3201
|
QueryChanged = "queryChanged",
|
|
3156
3202
|
/**
|
|
@@ -3160,7 +3206,7 @@ export declare enum EmbedEvent {
|
|
|
3160
3206
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
3161
3207
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
3162
3208
|
* @example
|
|
3163
|
-
|
|
3209
|
+
* ```js
|
|
3164
3210
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
3165
3211
|
* points: {
|
|
3166
3212
|
* clickedPoint,
|
|
@@ -3168,12 +3214,12 @@ export declare enum EmbedEvent {
|
|
|
3168
3214
|
* },
|
|
3169
3215
|
* autoDrillDown: true,
|
|
3170
3216
|
* })
|
|
3171
|
-
|
|
3217
|
+
* ```
|
|
3172
3218
|
* In this example, `VizPointDoubleClick` event is used for
|
|
3173
3219
|
* triggering the `DrillDown` event when an area or specific
|
|
3174
3220
|
* data point on a table or chart is double-clicked.
|
|
3175
3221
|
* @example
|
|
3176
|
-
|
|
3222
|
+
* ```js
|
|
3177
3223
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3178
3224
|
* console.log(payload);
|
|
3179
3225
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -3187,7 +3233,7 @@ export declare enum EmbedEvent {
|
|
|
3187
3233
|
* autoDrillDown: true,
|
|
3188
3234
|
* })
|
|
3189
3235
|
* })
|
|
3190
|
-
|
|
3236
|
+
* ```
|
|
3191
3237
|
*/
|
|
3192
3238
|
Drilldown = "drillDown",
|
|
3193
3239
|
/**
|
|
@@ -3312,13 +3358,13 @@ export declare enum EmbedEvent {
|
|
|
3312
3358
|
* The ThoughtSpot authentication session has expired.
|
|
3313
3359
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3314
3360
|
* @example
|
|
3315
|
-
|
|
3361
|
+
* ```js
|
|
3316
3362
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
3317
3363
|
* //show auth expired banner
|
|
3318
3364
|
* function showAuthExpired() {
|
|
3319
3365
|
* document.getElementById("authExpiredBanner");
|
|
3320
3366
|
* }
|
|
3321
|
-
|
|
3367
|
+
* ```
|
|
3322
3368
|
*/
|
|
3323
3369
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3324
3370
|
/**
|
|
@@ -3353,22 +3399,22 @@ export declare enum EmbedEvent {
|
|
|
3353
3399
|
* Applicable to `SearchBarEmbed` only.
|
|
3354
3400
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3355
3401
|
* @example
|
|
3356
|
-
|
|
3402
|
+
* ```js
|
|
3357
3403
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
3358
3404
|
* .then(data => {
|
|
3359
3405
|
* console.log('Answer Data:', data);
|
|
3360
3406
|
* })
|
|
3361
|
-
|
|
3407
|
+
* ```
|
|
3362
3408
|
*/
|
|
3363
3409
|
GetDataClick = "getDataClick",
|
|
3364
3410
|
/**
|
|
3365
3411
|
* Detects the route change.
|
|
3366
3412
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3367
3413
|
* @example
|
|
3368
|
-
|
|
3414
|
+
* ```js
|
|
3369
3415
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
3370
3416
|
* console.log('data', payload))
|
|
3371
|
-
|
|
3417
|
+
* ```
|
|
3372
3418
|
*/
|
|
3373
3419
|
RouteChange = "ROUTE_CHANGE",
|
|
3374
3420
|
/**
|
|
@@ -3378,12 +3424,12 @@ export declare enum EmbedEvent {
|
|
|
3378
3424
|
V1Data = "exportVizDataToParent",
|
|
3379
3425
|
/**
|
|
3380
3426
|
* Emitted when the embed does not have cookie access. This happens
|
|
3381
|
-
* when
|
|
3382
|
-
*
|
|
3427
|
+
* when third-party cookies are blocked by Safari or other
|
|
3428
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
3383
3429
|
* @example
|
|
3384
|
-
|
|
3430
|
+
* ```js
|
|
3385
3431
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
3386
|
-
|
|
3432
|
+
* ```
|
|
3387
3433
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
3388
3434
|
*/
|
|
3389
3435
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -3397,22 +3443,22 @@ export declare enum EmbedEvent {
|
|
|
3397
3443
|
* Emitted when any modal is opened in the app
|
|
3398
3444
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3399
3445
|
* @example
|
|
3400
|
-
|
|
3446
|
+
* ```js
|
|
3401
3447
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
3402
3448
|
* console.log('dialog open', payload);
|
|
3403
3449
|
* })
|
|
3404
|
-
|
|
3450
|
+
* ```
|
|
3405
3451
|
*/
|
|
3406
3452
|
DialogOpen = "dialog-open",
|
|
3407
3453
|
/**
|
|
3408
3454
|
* Emitted when any modal is closed in the app
|
|
3409
3455
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3410
3456
|
* @example
|
|
3411
|
-
|
|
3457
|
+
* ```js
|
|
3412
3458
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
3413
3459
|
* console.log('dialog close', payload);
|
|
3414
3460
|
* })
|
|
3415
|
-
|
|
3461
|
+
* ```
|
|
3416
3462
|
*/
|
|
3417
3463
|
DialogClose = "dialog-close",
|
|
3418
3464
|
/**
|
|
@@ -3421,39 +3467,39 @@ export declare enum EmbedEvent {
|
|
|
3421
3467
|
* other events on the rendered Liveboard.
|
|
3422
3468
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3423
3469
|
* @example
|
|
3424
|
-
|
|
3470
|
+
* ```js
|
|
3425
3471
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
3426
3472
|
console.log('Liveboard is rendered', payload);
|
|
3427
3473
|
})
|
|
3428
|
-
|
|
3474
|
+
* ```
|
|
3429
3475
|
* The following example shows how to trigger
|
|
3430
3476
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
3431
3477
|
* @example
|
|
3432
|
-
|
|
3478
|
+
* ```js
|
|
3433
3479
|
* const embedRef = useEmbedRef();
|
|
3434
3480
|
* const onLiveboardRendered = () => {
|
|
3435
3481
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
3436
3482
|
* };
|
|
3437
|
-
|
|
3483
|
+
* ```
|
|
3438
3484
|
*/
|
|
3439
3485
|
LiveboardRendered = "PinboardRendered",
|
|
3440
3486
|
/**
|
|
3441
3487
|
* Emits all events.
|
|
3442
|
-
* @
|
|
3488
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3443
3489
|
* @example
|
|
3444
|
-
|
|
3490
|
+
* ```js
|
|
3445
3491
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
3446
3492
|
* console.log('Embed Events', payload)
|
|
3447
3493
|
* })
|
|
3448
|
-
|
|
3494
|
+
* ```
|
|
3449
3495
|
*/
|
|
3450
3496
|
ALL = "*",
|
|
3451
3497
|
/**
|
|
3452
3498
|
* Emitted when an Answer is saved in the app.
|
|
3453
3499
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
3454
|
-
* @
|
|
3500
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3455
3501
|
* @example
|
|
3456
|
-
|
|
3502
|
+
* ```js
|
|
3457
3503
|
* //Emit when action starts
|
|
3458
3504
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3459
3505
|
* console.log('Save', payload)
|
|
@@ -3464,7 +3510,7 @@ export declare enum EmbedEvent {
|
|
|
3464
3510
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3465
3511
|
* console.log('Save', payload)
|
|
3466
3512
|
* })
|
|
3467
|
-
|
|
3513
|
+
* ```
|
|
3468
3514
|
*/
|
|
3469
3515
|
Save = "save",
|
|
3470
3516
|
/**
|
|
@@ -3476,106 +3522,112 @@ export declare enum EmbedEvent {
|
|
|
3476
3522
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
3477
3523
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3478
3524
|
* @example
|
|
3479
|
-
|
|
3525
|
+
* ```js
|
|
3480
3526
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3481
3527
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3482
3528
|
* })
|
|
3483
|
-
|
|
3529
|
+
* ```
|
|
3484
3530
|
*/
|
|
3485
3531
|
Download = "download",
|
|
3486
3532
|
/**
|
|
3487
3533
|
* Emitted when the download action is triggered on an Answer.
|
|
3488
|
-
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3534
|
+
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3535
|
+
* subscribe to when download is completed. Default is end:true.
|
|
3489
3536
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3490
3537
|
* @example
|
|
3491
|
-
|
|
3538
|
+
* ```js
|
|
3492
3539
|
* //emit when action starts
|
|
3493
3540
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3494
3541
|
* console.log('download PNG', payload)}, {start: true })
|
|
3495
3542
|
* //emit when action ends
|
|
3496
3543
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3497
3544
|
* console.log('download PNG', payload)})
|
|
3498
|
-
|
|
3545
|
+
* ```
|
|
3499
3546
|
*/
|
|
3500
3547
|
DownloadAsPng = "downloadAsPng",
|
|
3501
3548
|
/**
|
|
3502
3549
|
* Emitted when the Download as PDF action is triggered on an Answer
|
|
3503
|
-
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3550
|
+
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3551
|
+
* subscribe to when download as PDF is completed. Default is end:true.
|
|
3504
3552
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3505
3553
|
* @example
|
|
3506
|
-
|
|
3554
|
+
* ```js
|
|
3507
3555
|
* //emit when action starts
|
|
3508
3556
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3509
3557
|
* console.log('download PDF', payload)}, {start: true })
|
|
3510
3558
|
* //emit when action ends
|
|
3511
3559
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3512
3560
|
* console.log('download PDF', payload)})
|
|
3513
|
-
|
|
3561
|
+
* ```
|
|
3514
3562
|
*/
|
|
3515
3563
|
DownloadAsPdf = "downloadAsPdf",
|
|
3516
3564
|
/**
|
|
3517
3565
|
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
3518
|
-
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3566
|
+
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3567
|
+
* subscribe to when download as CSV is completed. Default is end:true.
|
|
3519
3568
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3520
3569
|
* @example
|
|
3521
|
-
|
|
3570
|
+
* ```js
|
|
3522
3571
|
* //emit when action starts
|
|
3523
3572
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3524
3573
|
* console.log('download CSV', payload)}, {start: true })
|
|
3525
3574
|
* //emit when action ends
|
|
3526
3575
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3527
3576
|
* console.log('download CSV', payload)})
|
|
3528
|
-
|
|
3577
|
+
* ```
|
|
3529
3578
|
*/
|
|
3530
3579
|
DownloadAsCsv = "downloadAsCsv",
|
|
3531
3580
|
/**
|
|
3532
3581
|
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
3533
|
-
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3582
|
+
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3583
|
+
* subscribe to when download as XLSX is completed. Default is end:true.
|
|
3534
3584
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3535
3585
|
* @example
|
|
3536
|
-
|
|
3586
|
+
* ```js
|
|
3537
3587
|
* //emit when action starts
|
|
3538
3588
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3539
3589
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3540
3590
|
* //emit when action ends
|
|
3541
3591
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3542
3592
|
* console.log('download Xlsx', payload)})
|
|
3543
|
-
|
|
3593
|
+
* ```
|
|
3544
3594
|
*/
|
|
3545
3595
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3546
3596
|
/**
|
|
3547
3597
|
* Emitted when an Answer is deleted in the app
|
|
3548
|
-
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3598
|
+
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3599
|
+
* to when delete is completed. Default is end:true.
|
|
3549
3600
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3550
3601
|
* @example
|
|
3551
|
-
|
|
3602
|
+
* ```js
|
|
3552
3603
|
* //emit when action starts
|
|
3553
3604
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3554
3605
|
* console.log('delete answer', payload)}, {start: true })
|
|
3555
3606
|
* //trigger when action is completed
|
|
3556
3607
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3557
3608
|
* console.log('delete answer', payload)})
|
|
3558
|
-
|
|
3609
|
+
* ```
|
|
3559
3610
|
*/
|
|
3560
3611
|
AnswerDelete = "answerDelete",
|
|
3561
3612
|
/**
|
|
3562
3613
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
3563
3614
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
3564
3615
|
* @example
|
|
3565
|
-
|
|
3616
|
+
* ```js
|
|
3566
3617
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
3567
3618
|
* console.log('AI Highlights', payload);
|
|
3568
3619
|
* })
|
|
3569
|
-
|
|
3620
|
+
* ```
|
|
3570
3621
|
*/
|
|
3571
3622
|
AIHighlights = "AIHighlights",
|
|
3572
3623
|
/**
|
|
3573
3624
|
* Emitted when a user initiates the Pin action to
|
|
3574
3625
|
* add an Answer to a Liveboard.
|
|
3575
|
-
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3626
|
+
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3627
|
+
* when pin is completed. Default is end:true.
|
|
3576
3628
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3577
3629
|
* @example
|
|
3578
|
-
|
|
3630
|
+
* ```js
|
|
3579
3631
|
* //emit when action starts
|
|
3580
3632
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3581
3633
|
* console.log('pin', payload)
|
|
@@ -3586,14 +3638,14 @@ export declare enum EmbedEvent {
|
|
|
3586
3638
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3587
3639
|
* console.log('pin', payload)
|
|
3588
3640
|
* })
|
|
3589
|
-
|
|
3641
|
+
* ```
|
|
3590
3642
|
*/
|
|
3591
3643
|
Pin = "pin",
|
|
3592
3644
|
/**
|
|
3593
3645
|
* Emitted when SpotIQ analysis is triggered
|
|
3594
3646
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3595
3647
|
* @example
|
|
3596
|
-
|
|
3648
|
+
* ```js
|
|
3597
3649
|
* //emit when action starts
|
|
3598
3650
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3599
3651
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -3604,14 +3656,14 @@ export declare enum EmbedEvent {
|
|
|
3604
3656
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3605
3657
|
* console.log('SpotIQ analyze', payload)
|
|
3606
3658
|
* })
|
|
3607
|
-
|
|
3659
|
+
* ```
|
|
3608
3660
|
*/
|
|
3609
3661
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3610
3662
|
/**
|
|
3611
3663
|
* Emitted when a user shares an object with another user or group
|
|
3612
3664
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3613
3665
|
* @example
|
|
3614
|
-
|
|
3666
|
+
* ```js
|
|
3615
3667
|
* //emit when action starts
|
|
3616
3668
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3617
3669
|
* console.log('Share', payload)
|
|
@@ -3622,7 +3674,7 @@ export declare enum EmbedEvent {
|
|
|
3622
3674
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3623
3675
|
* console.log('Share', payload)
|
|
3624
3676
|
* })
|
|
3625
|
-
|
|
3677
|
+
* ```
|
|
3626
3678
|
*/
|
|
3627
3679
|
Share = "share",
|
|
3628
3680
|
/**
|
|
@@ -3630,11 +3682,11 @@ export declare enum EmbedEvent {
|
|
|
3630
3682
|
* data on a chart or table.
|
|
3631
3683
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3632
3684
|
* @example
|
|
3633
|
-
|
|
3685
|
+
* ```js
|
|
3634
3686
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
3635
3687
|
* console.log('Drill include', payload);
|
|
3636
3688
|
* })
|
|
3637
|
-
|
|
3689
|
+
* ```
|
|
3638
3690
|
*/
|
|
3639
3691
|
DrillInclude = "context-menu-item-include",
|
|
3640
3692
|
/**
|
|
@@ -3642,22 +3694,22 @@ export declare enum EmbedEvent {
|
|
|
3642
3694
|
* data on a chart or table
|
|
3643
3695
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3644
3696
|
* @example
|
|
3645
|
-
|
|
3697
|
+
* ```js
|
|
3646
3698
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
3647
3699
|
* console.log('Drill exclude', payload);
|
|
3648
3700
|
* })
|
|
3649
|
-
|
|
3701
|
+
* ```
|
|
3650
3702
|
*/
|
|
3651
3703
|
DrillExclude = "context-menu-item-exclude",
|
|
3652
3704
|
/**
|
|
3653
3705
|
* Emitted when a column value is copied in the embedded app.
|
|
3654
3706
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3655
3707
|
* @example
|
|
3656
|
-
|
|
3657
|
-
*
|
|
3708
|
+
* ```js
|
|
3709
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
3658
3710
|
* console.log('copy to clipboard', payload);
|
|
3659
3711
|
* })
|
|
3660
|
-
|
|
3712
|
+
* ```
|
|
3661
3713
|
*/
|
|
3662
3714
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3663
3715
|
/**
|
|
@@ -3665,10 +3717,10 @@ export declare enum EmbedEvent {
|
|
|
3665
3717
|
* embedded Liveboard.
|
|
3666
3718
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3667
3719
|
* @example
|
|
3668
|
-
|
|
3720
|
+
* ```js
|
|
3669
3721
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
3670
3722
|
* })
|
|
3671
|
-
|
|
3723
|
+
* ```
|
|
3672
3724
|
*/
|
|
3673
3725
|
UpdateTML = "updateTSL",
|
|
3674
3726
|
/**
|
|
@@ -3676,75 +3728,77 @@ export declare enum EmbedEvent {
|
|
|
3676
3728
|
* on an embedded Liveboard.
|
|
3677
3729
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3678
3730
|
* @example
|
|
3679
|
-
|
|
3731
|
+
* ```js
|
|
3680
3732
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
3681
3733
|
* console.log('Edit TML', payload);
|
|
3682
3734
|
* })
|
|
3683
|
-
|
|
3735
|
+
* ```
|
|
3684
3736
|
*/
|
|
3685
3737
|
EditTML = "editTSL",
|
|
3686
3738
|
/**
|
|
3687
3739
|
* Emitted when the **Export TML** action is triggered on an
|
|
3688
3740
|
* an embedded object in the app
|
|
3689
|
-
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3741
|
+
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3742
|
+
* to when export is completed. Default is end:true.
|
|
3690
3743
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3691
3744
|
* @example
|
|
3692
|
-
|
|
3745
|
+
* ```js
|
|
3693
3746
|
* //emit when action starts
|
|
3694
3747
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3695
3748
|
* console.log('Export TML', payload)}, { start: true })
|
|
3696
3749
|
* //emit when action ends
|
|
3697
3750
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3698
3751
|
* console.log('Export TML', payload)})
|
|
3699
|
-
|
|
3752
|
+
* ```
|
|
3700
3753
|
*/
|
|
3701
3754
|
ExportTML = "exportTSL",
|
|
3702
3755
|
/**
|
|
3703
3756
|
* Emitted when an Answer is saved as a View.
|
|
3704
3757
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3705
3758
|
* @example
|
|
3706
|
-
|
|
3759
|
+
* ```js
|
|
3707
3760
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
3708
3761
|
* console.log('View', payload);
|
|
3709
3762
|
* })
|
|
3710
|
-
|
|
3763
|
+
* ```
|
|
3711
3764
|
*/
|
|
3712
3765
|
SaveAsView = "saveAsView",
|
|
3713
3766
|
/**
|
|
3714
3767
|
* Emitted when the user creates a copy of an Answer.
|
|
3715
|
-
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3768
|
+
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3769
|
+
* subscribe to when copy and edit is completed. Default is end:true.
|
|
3716
3770
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3717
3771
|
* @example
|
|
3718
|
-
|
|
3772
|
+
* ```js
|
|
3719
3773
|
* //emit when action starts
|
|
3720
3774
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3721
3775
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3722
3776
|
* //emit when action ends
|
|
3723
3777
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3724
3778
|
* console.log('Copy and edit', payload)})
|
|
3725
|
-
|
|
3779
|
+
* ```
|
|
3726
3780
|
*/
|
|
3727
3781
|
CopyAEdit = "copyAEdit",
|
|
3728
3782
|
/**
|
|
3729
3783
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3730
3784
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3731
3785
|
* @example
|
|
3732
|
-
|
|
3786
|
+
* ```js
|
|
3733
3787
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
3734
3788
|
* console.log('show data', payload);
|
|
3735
3789
|
* })
|
|
3736
|
-
|
|
3790
|
+
* ```
|
|
3737
3791
|
*/
|
|
3738
3792
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3739
3793
|
/**
|
|
3740
3794
|
* Emitted when an Answer is switched to a chart or table view.
|
|
3741
3795
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3742
3796
|
* @example
|
|
3743
|
-
|
|
3797
|
+
* ```js
|
|
3744
3798
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3745
3799
|
* console.log('switch view', payload);
|
|
3746
3800
|
* })
|
|
3747
|
-
|
|
3801
|
+
* ```
|
|
3748
3802
|
*/
|
|
3749
3803
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3750
3804
|
/**
|
|
@@ -3761,118 +3815,118 @@ export declare enum EmbedEvent {
|
|
|
3761
3815
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3762
3816
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3763
3817
|
* @example
|
|
3764
|
-
|
|
3818
|
+
* ```js
|
|
3765
3819
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
3766
3820
|
* console.log('Liveboard details', payload);
|
|
3767
3821
|
* })
|
|
3768
|
-
|
|
3822
|
+
* ```
|
|
3769
3823
|
*/
|
|
3770
3824
|
LiveboardInfo = "pinboardInfo",
|
|
3771
3825
|
/**
|
|
3772
3826
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3773
3827
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3774
3828
|
* @example
|
|
3775
|
-
|
|
3829
|
+
* ```js
|
|
3776
3830
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3777
3831
|
* console.log('favorites', payload);
|
|
3778
3832
|
* })
|
|
3779
|
-
|
|
3833
|
+
* ```
|
|
3780
3834
|
*/
|
|
3781
3835
|
AddToFavorites = "addToFavorites",
|
|
3782
3836
|
/**
|
|
3783
3837
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3784
3838
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3785
3839
|
* @example
|
|
3786
|
-
|
|
3840
|
+
* ```js
|
|
3787
3841
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3788
|
-
* console.log(
|
|
3842
|
+
* console.log('Liveboard schedule', payload);
|
|
3789
3843
|
* })
|
|
3790
|
-
|
|
3844
|
+
* ```
|
|
3791
3845
|
*/
|
|
3792
3846
|
Schedule = "subscription",
|
|
3793
3847
|
/**
|
|
3794
3848
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3795
3849
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3796
3850
|
* @example
|
|
3797
|
-
|
|
3851
|
+
* ```js
|
|
3798
3852
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3799
|
-
* console.log(
|
|
3853
|
+
* console.log('Liveboard edit', payload);
|
|
3800
3854
|
* })
|
|
3801
|
-
|
|
3855
|
+
* ```
|
|
3802
3856
|
*/
|
|
3803
3857
|
Edit = "edit",
|
|
3804
3858
|
/**
|
|
3805
3859
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3806
3860
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3807
3861
|
* @example
|
|
3808
|
-
|
|
3862
|
+
* ```js
|
|
3809
3863
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3810
|
-
* console.log(
|
|
3864
|
+
* console.log('Copy', payload);
|
|
3811
3865
|
* })
|
|
3812
|
-
|
|
3866
|
+
* ```
|
|
3813
3867
|
*/
|
|
3814
3868
|
MakeACopy = "makeACopy",
|
|
3815
3869
|
/**
|
|
3816
3870
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3817
3871
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3818
3872
|
* @example
|
|
3819
|
-
|
|
3873
|
+
* ```js
|
|
3820
3874
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3821
|
-
|
|
3875
|
+
* ```
|
|
3822
3876
|
* @example
|
|
3823
|
-
|
|
3877
|
+
* ```js
|
|
3824
3878
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3825
3879
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3826
3880
|
* })
|
|
3827
|
-
|
|
3881
|
+
* ```
|
|
3828
3882
|
*/
|
|
3829
3883
|
Present = "present",
|
|
3830
3884
|
/**
|
|
3831
3885
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3832
3886
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3833
3887
|
* @example
|
|
3834
|
-
|
|
3888
|
+
* ```js
|
|
3835
3889
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3836
3890
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3837
|
-
|
|
3891
|
+
* ```
|
|
3838
3892
|
*/
|
|
3839
3893
|
Delete = "delete",
|
|
3840
3894
|
/**
|
|
3841
3895
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3842
3896
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3843
3897
|
* @example
|
|
3844
|
-
|
|
3898
|
+
* ```js
|
|
3845
3899
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3846
|
-
|
|
3900
|
+
* ```
|
|
3847
3901
|
*/
|
|
3848
3902
|
SchedulesList = "schedule-list",
|
|
3849
3903
|
/**
|
|
3850
3904
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3851
3905
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3852
3906
|
* @example
|
|
3853
|
-
|
|
3907
|
+
* ```js
|
|
3854
3908
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3855
|
-
|
|
3909
|
+
* ```
|
|
3856
3910
|
*/
|
|
3857
3911
|
Cancel = "cancel",
|
|
3858
3912
|
/**
|
|
3859
3913
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3860
3914
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3861
3915
|
* @example
|
|
3862
|
-
|
|
3916
|
+
* ```js
|
|
3863
3917
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3864
3918
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3865
|
-
|
|
3919
|
+
* ```
|
|
3866
3920
|
*/
|
|
3867
3921
|
Explore = "explore",
|
|
3868
3922
|
/**
|
|
3869
3923
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3870
3924
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3871
3925
|
* @example
|
|
3872
|
-
|
|
3926
|
+
* ```js
|
|
3873
3927
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3874
3928
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3875
|
-
|
|
3929
|
+
* ```
|
|
3876
3930
|
*/
|
|
3877
3931
|
CopyLink = "embedDocument",
|
|
3878
3932
|
/**
|
|
@@ -3880,21 +3934,21 @@ export declare enum EmbedEvent {
|
|
|
3880
3934
|
* visualization or Liveboard.
|
|
3881
3935
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3882
3936
|
* @example
|
|
3883
|
-
|
|
3937
|
+
* ```js
|
|
3884
3938
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3885
3939
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3886
|
-
|
|
3940
|
+
* ```
|
|
3887
3941
|
*/
|
|
3888
3942
|
CrossFilterChanged = "cross-filter-changed",
|
|
3889
3943
|
/**
|
|
3890
3944
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3891
3945
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3892
3946
|
* @example
|
|
3893
|
-
|
|
3947
|
+
* ```js
|
|
3894
3948
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3895
3949
|
* console.log('VizPointClick', payload)
|
|
3896
3950
|
* })
|
|
3897
|
-
|
|
3951
|
+
* ```
|
|
3898
3952
|
*/
|
|
3899
3953
|
VizPointRightClick = "vizPointRightClick",
|
|
3900
3954
|
/**
|
|
@@ -3908,35 +3962,35 @@ export declare enum EmbedEvent {
|
|
|
3908
3962
|
* filter details.
|
|
3909
3963
|
* @example
|
|
3910
3964
|
*
|
|
3911
|
-
|
|
3965
|
+
* ```js
|
|
3912
3966
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3913
3967
|
* console.log('payload', payload);
|
|
3914
3968
|
* })
|
|
3915
|
-
*
|
|
3969
|
+
* ```
|
|
3916
3970
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3917
3971
|
*/
|
|
3918
3972
|
FilterChanged = "filterChanged",
|
|
3919
3973
|
/**
|
|
3920
3974
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3921
3975
|
* a Natural Language Search query
|
|
3922
|
-
* @version SDK
|
|
3976
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3923
3977
|
*/
|
|
3924
3978
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3925
3979
|
/**
|
|
3926
3980
|
* Emitted when a user selects a data source on the embedded
|
|
3927
3981
|
* Natural Language Search interface.
|
|
3928
3982
|
*
|
|
3929
|
-
* @version SDK
|
|
3983
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3930
3984
|
*/
|
|
3931
3985
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3932
3986
|
/**
|
|
3933
3987
|
* Emitted when a user updates a connection on the **Data** page
|
|
3934
|
-
* @version SDK
|
|
3988
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3935
3989
|
*/
|
|
3936
3990
|
UpdateConnection = "updateConnection",
|
|
3937
3991
|
/**
|
|
3938
3992
|
* Emitted when a user updates a connection on the **Data** page
|
|
3939
|
-
* @version SDK
|
|
3993
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3940
3994
|
*/
|
|
3941
3995
|
CreateConnection = "createConnection",
|
|
3942
3996
|
/**
|
|
@@ -3946,7 +4000,7 @@ export declare enum EmbedEvent {
|
|
|
3946
4000
|
* @returns viewId: string
|
|
3947
4001
|
* @returns liveboardId: string
|
|
3948
4002
|
* @returns isPublic: boolean
|
|
3949
|
-
* @version SDK
|
|
4003
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3950
4004
|
*/
|
|
3951
4005
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3952
4006
|
/**
|
|
@@ -3955,7 +4009,7 @@ export declare enum EmbedEvent {
|
|
|
3955
4009
|
* @returns viewId: string
|
|
3956
4010
|
* @returns liveboardId: string
|
|
3957
4011
|
* @returns isPublic: boolean
|
|
3958
|
-
* @version SDK
|
|
4012
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3959
4013
|
*/
|
|
3960
4014
|
SavePersonalisedView = "savePersonalisedView",
|
|
3961
4015
|
/**
|
|
@@ -3964,19 +4018,19 @@ export declare enum EmbedEvent {
|
|
|
3964
4018
|
* @returns viewId: string
|
|
3965
4019
|
* @returns liveboardId: string
|
|
3966
4020
|
* @returns isPublic: boolean
|
|
3967
|
-
* @version SDK
|
|
4021
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3968
4022
|
*/
|
|
3969
4023
|
ResetLiveboard = "resetLiveboard",
|
|
3970
4024
|
/**
|
|
3971
4025
|
* Emitted when a PersonalisedView is deleted.
|
|
3972
4026
|
* @returns views: string[]
|
|
3973
4027
|
* @returns liveboardId: string
|
|
3974
|
-
* @version SDK
|
|
4028
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3975
4029
|
*/
|
|
3976
4030
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3977
4031
|
/**
|
|
3978
4032
|
* Emitted when a user creates a Worksheet.
|
|
3979
|
-
* @version SDK
|
|
4033
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3980
4034
|
*/
|
|
3981
4035
|
CreateWorksheet = "createWorksheet",
|
|
3982
4036
|
/**
|
|
@@ -3985,12 +4039,12 @@ export declare enum EmbedEvent {
|
|
|
3985
4039
|
* @returns viewId: string
|
|
3986
4040
|
* @returns liveboardId: string
|
|
3987
4041
|
* @returns isPublic: boolean
|
|
3988
|
-
* @version SDK
|
|
4042
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3989
4043
|
*/
|
|
3990
4044
|
AskSageInit = "AskSageInit",
|
|
3991
4045
|
/**
|
|
3992
4046
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3993
|
-
* @version SDK
|
|
4047
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3994
4048
|
*/
|
|
3995
4049
|
Rename = "rename",
|
|
3996
4050
|
/**
|
|
@@ -4013,7 +4067,7 @@ export declare enum EmbedEvent {
|
|
|
4013
4067
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
4014
4068
|
* is `false` by using the `error` parameters in `responder`.
|
|
4015
4069
|
* - `errorText` - The error message text shown to the user.
|
|
4016
|
-
* @version SDK
|
|
4070
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4017
4071
|
* @example
|
|
4018
4072
|
*
|
|
4019
4073
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -4065,8 +4119,8 @@ export declare enum EmbedEvent {
|
|
|
4065
4119
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4066
4120
|
* console.log('payload', payload);
|
|
4067
4121
|
* })
|
|
4068
|
-
|
|
4069
|
-
* @version SDK
|
|
4122
|
+
* ```
|
|
4123
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4070
4124
|
*/
|
|
4071
4125
|
ParameterChanged = "parameterChanged",
|
|
4072
4126
|
/**
|
|
@@ -4121,24 +4175,24 @@ export declare enum EmbedEvent {
|
|
|
4121
4175
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
4122
4176
|
* console.log('payload', payload);
|
|
4123
4177
|
* })
|
|
4124
|
-
|
|
4125
|
-
* @version SDK
|
|
4178
|
+
* ```
|
|
4179
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4126
4180
|
*/
|
|
4127
4181
|
CreateLiveboard = "createLiveboard",
|
|
4128
4182
|
/**
|
|
4129
4183
|
* Emitted when a user creates a Model.
|
|
4130
|
-
* @version SDK
|
|
4184
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4131
4185
|
*/
|
|
4132
4186
|
CreateModel = "createModel",
|
|
4133
4187
|
/**
|
|
4134
4188
|
* @hidden
|
|
4135
4189
|
* Emitted when a user exits present mode.
|
|
4136
|
-
* @version SDK
|
|
4190
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4137
4191
|
*/
|
|
4138
4192
|
ExitPresentMode = "exitPresentMode",
|
|
4139
4193
|
/**
|
|
4140
4194
|
* Emitted when a user requests the full height lazy load data.
|
|
4141
|
-
* @version SDK
|
|
4195
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4142
4196
|
* @hidden
|
|
4143
4197
|
*/
|
|
4144
4198
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -4149,7 +4203,7 @@ export declare enum EmbedEvent {
|
|
|
4149
4203
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
4150
4204
|
* console.log('payload', payload);
|
|
4151
4205
|
* })
|
|
4152
|
-
|
|
4206
|
+
* ```
|
|
4153
4207
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4154
4208
|
*/
|
|
4155
4209
|
SpotterData = "SpotterData",
|
|
@@ -4160,7 +4214,7 @@ export declare enum EmbedEvent {
|
|
|
4160
4214
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
4161
4215
|
* console.log('payload', payload);
|
|
4162
4216
|
* })
|
|
4163
|
-
|
|
4217
|
+
* ```
|
|
4164
4218
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4165
4219
|
*/
|
|
4166
4220
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -4171,7 +4225,7 @@ export declare enum EmbedEvent {
|
|
|
4171
4225
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
4172
4226
|
* console.log('payload', payload);
|
|
4173
4227
|
* })
|
|
4174
|
-
|
|
4228
|
+
* ```
|
|
4175
4229
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4176
4230
|
*/
|
|
4177
4231
|
AddToCoaching = "addToCoaching",
|
|
@@ -4193,7 +4247,7 @@ export declare enum EmbedEvent {
|
|
|
4193
4247
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
4194
4248
|
* console.log('payload', payload);
|
|
4195
4249
|
* })
|
|
4196
|
-
|
|
4250
|
+
* ```
|
|
4197
4251
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4198
4252
|
*/
|
|
4199
4253
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -4204,7 +4258,7 @@ export declare enum EmbedEvent {
|
|
|
4204
4258
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
4205
4259
|
* console.log('payload', payload);
|
|
4206
4260
|
* })
|
|
4207
|
-
|
|
4261
|
+
* ```
|
|
4208
4262
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4209
4263
|
*/
|
|
4210
4264
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -4215,18 +4269,18 @@ export declare enum EmbedEvent {
|
|
|
4215
4269
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
4216
4270
|
* console.log('payload', payload);
|
|
4217
4271
|
* })
|
|
4218
|
-
|
|
4272
|
+
* ```
|
|
4219
4273
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4220
4274
|
*/
|
|
4221
4275
|
LastPromptDeleted = "LastPromptDeleted",
|
|
4222
4276
|
/**
|
|
4223
|
-
* Emitted when the
|
|
4277
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
4224
4278
|
* @example
|
|
4225
4279
|
* ```js
|
|
4226
4280
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
4227
4281
|
* console.log('payload', payload);
|
|
4228
4282
|
* })
|
|
4229
|
-
|
|
4283
|
+
* ```
|
|
4230
4284
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4231
4285
|
*/
|
|
4232
4286
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -4237,7 +4291,7 @@ export declare enum EmbedEvent {
|
|
|
4237
4291
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
4238
4292
|
* console.log('payload', payload);
|
|
4239
4293
|
* })
|
|
4240
|
-
|
|
4294
|
+
* ```
|
|
4241
4295
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4242
4296
|
*/
|
|
4243
4297
|
SpotterInit = "spotterInit",
|
|
@@ -4248,7 +4302,7 @@ export declare enum EmbedEvent {
|
|
|
4248
4302
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
4249
4303
|
* console.log('payload', payload);
|
|
4250
4304
|
* })
|
|
4251
|
-
|
|
4305
|
+
* ```
|
|
4252
4306
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
4253
4307
|
*/
|
|
4254
4308
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -4475,7 +4529,8 @@ export declare enum HostEvent {
|
|
|
4475
4529
|
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
4476
4530
|
* on the most popular column.
|
|
4477
4531
|
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
4478
|
-
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4532
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4533
|
+
* **required**.
|
|
4479
4534
|
* @example
|
|
4480
4535
|
* ```js
|
|
4481
4536
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4602,7 +4657,7 @@ export declare enum HostEvent {
|
|
|
4602
4657
|
* ```js
|
|
4603
4658
|
* appEmbed.navigateToPage(-1)
|
|
4604
4659
|
* ```
|
|
4605
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
4660
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
4606
4661
|
*/
|
|
4607
4662
|
Navigate = "Navigate",
|
|
4608
4663
|
/**
|
|
@@ -4671,7 +4726,8 @@ export declare enum HostEvent {
|
|
|
4671
4726
|
* the following parameters:
|
|
4672
4727
|
*
|
|
4673
4728
|
* @param - Includes the following keys:
|
|
4674
|
-
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4729
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4730
|
+
* Liveboard.
|
|
4675
4731
|
* Optional when pinning a new chart or table generated from a Search query.
|
|
4676
4732
|
* **Required** in Spotter Embed.
|
|
4677
4733
|
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
@@ -4735,9 +4791,9 @@ export declare enum HostEvent {
|
|
|
4735
4791
|
* Trigger the **Show Liveboard details** action
|
|
4736
4792
|
* on an embedded Liveboard.
|
|
4737
4793
|
* @example
|
|
4738
|
-
|
|
4794
|
+
* ```js
|
|
4739
4795
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
4740
|
-
|
|
4796
|
+
* ```
|
|
4741
4797
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4742
4798
|
*/
|
|
4743
4799
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -4865,7 +4921,7 @@ export declare enum HostEvent {
|
|
|
4865
4921
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4866
4922
|
* ```
|
|
4867
4923
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4868
|
-
*
|
|
4924
|
+
* @example
|
|
4869
4925
|
* ```js
|
|
4870
4926
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4871
4927
|
* ```
|
|
@@ -4927,7 +4983,8 @@ export declare enum HostEvent {
|
|
|
4927
4983
|
* This event is not supported in visualization embed and search embed.
|
|
4928
4984
|
* @param - Object parameter. Includes the following keys:
|
|
4929
4985
|
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4930
|
-
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4986
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4987
|
+
* is **required**.
|
|
4931
4988
|
*
|
|
4932
4989
|
* @example
|
|
4933
4990
|
* ```js
|
|
@@ -4956,7 +5013,7 @@ export declare enum HostEvent {
|
|
|
4956
5013
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4957
5014
|
* ```
|
|
4958
5015
|
* ```js
|
|
4959
|
-
* vizEmbed.trigger(
|
|
5016
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4960
5017
|
* ```
|
|
4961
5018
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4962
5019
|
*/
|
|
@@ -4973,7 +5030,7 @@ export declare enum HostEvent {
|
|
|
4973
5030
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4974
5031
|
* ```
|
|
4975
5032
|
* ```js
|
|
4976
|
-
* vizEmbed.trigger(
|
|
5033
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4977
5034
|
* ```
|
|
4978
5035
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4979
5036
|
*/
|
|
@@ -4988,23 +5045,22 @@ export declare enum HostEvent {
|
|
|
4988
5045
|
* );
|
|
4989
5046
|
* })
|
|
4990
5047
|
* ```
|
|
4991
|
-
*
|
|
5048
|
+
* @example
|
|
4992
5049
|
* ```js
|
|
4993
|
-
|
|
4994
|
-
|
|
4995
|
-
|
|
4996
|
-
|
|
4997
|
-
|
|
4998
|
-
|
|
4999
|
-
|
|
5000
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
5050
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
5051
|
+
* let latestSpotterVizId = '';
|
|
5052
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
5053
|
+
* latestSpotterVizId = payload.data.id;
|
|
5054
|
+
* });
|
|
5055
|
+
*
|
|
5056
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
5001
5057
|
* vizId: latestSpotterVizId
|
|
5002
5058
|
* }).then((tml) => {
|
|
5003
5059
|
* console.log(
|
|
5004
5060
|
* tml.answer.search_query // TML representation of the search query
|
|
5005
5061
|
* );
|
|
5006
5062
|
* })
|
|
5007
|
-
|
|
5063
|
+
* ```
|
|
5008
5064
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5009
5065
|
* @important
|
|
5010
5066
|
*/
|
|
@@ -5068,6 +5124,11 @@ export declare enum HostEvent {
|
|
|
5068
5124
|
/**
|
|
5069
5125
|
* Trigger the **Download** action on charts in
|
|
5070
5126
|
* the embedded view.
|
|
5127
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
5128
|
+
*
|
|
5129
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5130
|
+
*
|
|
5131
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5071
5132
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
5072
5133
|
* @example
|
|
5073
5134
|
* ```js
|
|
@@ -5086,9 +5147,6 @@ export declare enum HostEvent {
|
|
|
5086
5147
|
*
|
|
5087
5148
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
5088
5149
|
* ```
|
|
5089
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5090
|
-
* Use {@link DownloadAsPng}
|
|
5091
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5092
5150
|
*/
|
|
5093
5151
|
Download = "downloadAsPng",
|
|
5094
5152
|
/**
|
|
@@ -5295,8 +5353,9 @@ export declare enum HostEvent {
|
|
|
5295
5353
|
/**
|
|
5296
5354
|
* Update one or several filters applied on a Liveboard.
|
|
5297
5355
|
* @param - Includes the following keys:
|
|
5298
|
-
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5299
|
-
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
5356
|
+
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5357
|
+
* values. - `filters`: Multiple filter objects with column name, filter operator,
|
|
5358
|
+
* and values for each.
|
|
5300
5359
|
*
|
|
5301
5360
|
* Each filter object must include the following attributes:
|
|
5302
5361
|
*
|
|
@@ -5526,8 +5585,8 @@ export declare enum HostEvent {
|
|
|
5526
5585
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5527
5586
|
* console.log('parameters', parameter);
|
|
5528
5587
|
* });
|
|
5529
|
-
|
|
5530
|
-
|
|
5588
|
+
* ```
|
|
5589
|
+
* ```js
|
|
5531
5590
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
5532
5591
|
* let latestSpotterVizId = '';
|
|
5533
5592
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -5535,7 +5594,7 @@ export declare enum HostEvent {
|
|
|
5535
5594
|
* });
|
|
5536
5595
|
*
|
|
5537
5596
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
5538
|
-
|
|
5597
|
+
* ```
|
|
5539
5598
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5540
5599
|
*/
|
|
5541
5600
|
GetParameters = "GetParameters",
|
|
@@ -5552,7 +5611,7 @@ export declare enum HostEvent {
|
|
|
5552
5611
|
* Notify when info call is completed successfully
|
|
5553
5612
|
* ```js
|
|
5554
5613
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5555
|
-
|
|
5614
|
+
* ```
|
|
5556
5615
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5557
5616
|
*/
|
|
5558
5617
|
InfoSuccess = "InfoSuccess",
|
|
@@ -5565,8 +5624,8 @@ export declare enum HostEvent {
|
|
|
5565
5624
|
* triggered with a modal to prompt users to
|
|
5566
5625
|
* add a name and description for the Answer.
|
|
5567
5626
|
* @param - Includes the following keys:
|
|
5568
|
-
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5569
|
-
* - `name`: Optional. Name string for the Answer.
|
|
5627
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5628
|
+
* embed. - `name`: Optional. Name string for the Answer.
|
|
5570
5629
|
* - `description`: Optional. Description text for the Answer.
|
|
5571
5630
|
* @example
|
|
5572
5631
|
* ```js
|
|
@@ -5655,7 +5714,7 @@ export declare enum HostEvent {
|
|
|
5655
5714
|
* ```js
|
|
5656
5715
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5657
5716
|
*
|
|
5658
|
-
|
|
5717
|
+
* ```
|
|
5659
5718
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5660
5719
|
*/
|
|
5661
5720
|
AddToCoaching = "addToCoaching",
|
|
@@ -5697,7 +5756,7 @@ export declare enum HostEvent {
|
|
|
5697
5756
|
* });
|
|
5698
5757
|
*
|
|
5699
5758
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
5700
|
-
|
|
5759
|
+
* ```
|
|
5701
5760
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5702
5761
|
*/
|
|
5703
5762
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -5707,7 +5766,7 @@ export declare enum HostEvent {
|
|
|
5707
5766
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5708
5767
|
* ```js
|
|
5709
5768
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5710
|
-
|
|
5769
|
+
* ```
|
|
5711
5770
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5712
5771
|
*/
|
|
5713
5772
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -5761,8 +5820,9 @@ export declare enum HostEvent {
|
|
|
5761
5820
|
/**
|
|
5762
5821
|
* Triggers a new conversation in Spotter embed.
|
|
5763
5822
|
*
|
|
5764
|
-
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5765
|
-
* Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5823
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5824
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5825
|
+
* instance.
|
|
5766
5826
|
*
|
|
5767
5827
|
* @example
|
|
5768
5828
|
* ```js
|
|
@@ -5958,14 +6018,14 @@ export declare enum Action {
|
|
|
5958
6018
|
* ```js
|
|
5959
6019
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5960
6020
|
* ```
|
|
5961
|
-
* @version
|
|
6021
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5962
6022
|
*/
|
|
5963
6023
|
CollapseDataSources = "collapseDataSources",
|
|
5964
6024
|
/**
|
|
5965
6025
|
* The **Collapse data panel** icon on the Search page.
|
|
5966
6026
|
* Collapses the data panel view.
|
|
5967
6027
|
*
|
|
5968
|
-
* @version
|
|
6028
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5969
6029
|
*
|
|
5970
6030
|
* @example
|
|
5971
6031
|
* ```js
|
|
@@ -6412,13 +6472,12 @@ export declare enum Action {
|
|
|
6412
6472
|
*/
|
|
6413
6473
|
CreateMonitor = "createMonitor",
|
|
6414
6474
|
/**
|
|
6415
|
-
* @
|
|
6416
|
-
*
|
|
6475
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6476
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
6417
6477
|
* @example
|
|
6418
6478
|
* ```js
|
|
6419
6479
|
* disabledActions: [Action.ReportError]
|
|
6420
6480
|
* ```
|
|
6421
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6422
6481
|
*/
|
|
6423
6482
|
ReportError = "reportError",
|
|
6424
6483
|
/**
|
|
@@ -6428,7 +6487,7 @@ export declare enum Action {
|
|
|
6428
6487
|
* ```js
|
|
6429
6488
|
* disabledActions: [Action.SyncToSheets]
|
|
6430
6489
|
* ```
|
|
6431
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6490
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6432
6491
|
*/
|
|
6433
6492
|
SyncToSheets = "sync-to-sheets",
|
|
6434
6493
|
/**
|
|
@@ -6439,7 +6498,7 @@ export declare enum Action {
|
|
|
6439
6498
|
* ```js
|
|
6440
6499
|
* disabledActions: [Action.SyncToOtherApps]
|
|
6441
6500
|
* ```
|
|
6442
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6501
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6443
6502
|
*/
|
|
6444
6503
|
SyncToOtherApps = "sync-to-other-apps",
|
|
6445
6504
|
/**
|
|
@@ -6449,7 +6508,7 @@ export declare enum Action {
|
|
|
6449
6508
|
* ```js
|
|
6450
6509
|
* disabledActions: [Action.ManagePipelines]
|
|
6451
6510
|
* ```
|
|
6452
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6511
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6453
6512
|
*/
|
|
6454
6513
|
ManagePipelines = "manage-pipeline",
|
|
6455
6514
|
/**
|
|
@@ -6761,7 +6820,7 @@ export declare enum Action {
|
|
|
6761
6820
|
* ```js
|
|
6762
6821
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6763
6822
|
* ```
|
|
6764
|
-
* @version SDK
|
|
6823
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6765
6824
|
*/
|
|
6766
6825
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6767
6826
|
/**
|
|
@@ -6771,7 +6830,7 @@ export declare enum Action {
|
|
|
6771
6830
|
* ```js
|
|
6772
6831
|
* disabledActions: [Action.LiveboardUsers]
|
|
6773
6832
|
* ```
|
|
6774
|
-
* @version SDK
|
|
6833
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6775
6834
|
*/
|
|
6776
6835
|
LiveboardUsers = "liveboardUsers",
|
|
6777
6836
|
/**
|
|
@@ -6789,7 +6848,7 @@ export declare enum Action {
|
|
|
6789
6848
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6790
6849
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6791
6850
|
* ```
|
|
6792
|
-
* @version SDK
|
|
6851
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6793
6852
|
*/
|
|
6794
6853
|
TML = "tml",
|
|
6795
6854
|
/**
|
|
@@ -6835,7 +6894,7 @@ export declare enum Action {
|
|
|
6835
6894
|
* ```js
|
|
6836
6895
|
* disabledActions: [Action.AddToWatchlist]
|
|
6837
6896
|
* ```
|
|
6838
|
-
* @version SDK
|
|
6897
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6839
6898
|
*/
|
|
6840
6899
|
AddToWatchlist = "addToWatchlist",
|
|
6841
6900
|
/**
|
|
@@ -6845,7 +6904,7 @@ export declare enum Action {
|
|
|
6845
6904
|
* ```js
|
|
6846
6905
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6847
6906
|
* ```
|
|
6848
|
-
* @version SDK
|
|
6907
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6849
6908
|
*/
|
|
6850
6909
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6851
6910
|
/**
|
|
@@ -6856,7 +6915,7 @@ export declare enum Action {
|
|
|
6856
6915
|
* ```js
|
|
6857
6916
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6858
6917
|
* ```
|
|
6859
|
-
* @version SDK
|
|
6918
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6860
6919
|
*/
|
|
6861
6920
|
OrganiseFavourites = "organiseFavourites",
|
|
6862
6921
|
/**
|
|
@@ -6917,7 +6976,7 @@ export declare enum Action {
|
|
|
6917
6976
|
* ```js
|
|
6918
6977
|
* disabledActions: [Action.ManageTags]
|
|
6919
6978
|
* ```
|
|
6920
|
-
* @version SDK
|
|
6979
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6921
6980
|
*/
|
|
6922
6981
|
ManageTags = "manageTags",
|
|
6923
6982
|
/**
|
|
@@ -7601,7 +7660,9 @@ export declare enum ErrorDetailsTypes {
|
|
|
7601
7660
|
NETWORK = "NETWORK"
|
|
7602
7661
|
}
|
|
7603
7662
|
/**
|
|
7604
|
-
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use
|
|
7663
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use
|
|
7664
|
+
* {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error
|
|
7665
|
+
* handling and debugging.
|
|
7605
7666
|
*
|
|
7606
7667
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
7607
7668
|
* @group Error Handling
|
|
@@ -7660,15 +7721,16 @@ export declare enum EmbedErrorCodes {
|
|
|
7660
7721
|
/**
|
|
7661
7722
|
* Error event object emitted when an error occurs in an embedded component.
|
|
7662
7723
|
*
|
|
7663
|
-
* This interface defines the structure of error objects returned by the {@link
|
|
7664
|
-
* event. It provides detailed information about what went wrong,
|
|
7665
|
-
* a human-readable message, and a machine-readable error code.
|
|
7724
|
+
* This interface defines the structure of error objects returned by the {@link
|
|
7725
|
+
* EmbedEvent.Error} event. It provides detailed information about what went wrong,
|
|
7726
|
+
* including the error type, a human-readable message, and a machine-readable error code.
|
|
7666
7727
|
*
|
|
7667
7728
|
* ## Properties
|
|
7668
7729
|
*
|
|
7669
7730
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
7670
|
-
* - **message**: Human-readable error description (string or array of strings for
|
|
7671
|
-
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7731
|
+
* - **message**: Human-readable error description (string or array of strings for
|
|
7732
|
+
* multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7733
|
+
* values
|
|
7672
7734
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
7673
7735
|
*
|
|
7674
7736
|
* ## Usage
|
|
@@ -7769,14 +7831,14 @@ export type ApiInterceptFlags = {
|
|
|
7769
7831
|
/**
|
|
7770
7832
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7771
7833
|
*
|
|
7772
|
-
* Can be used for
|
|
7834
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7773
7835
|
*
|
|
7774
|
-
* @version SDK
|
|
7836
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7775
7837
|
*/
|
|
7776
7838
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7777
7839
|
/**
|
|
7778
7840
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7779
|
-
* run based on the
|
|
7841
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7780
7842
|
*
|
|
7781
7843
|
* @example
|
|
7782
7844
|
* ```js
|
|
@@ -7787,7 +7849,7 @@ export type ApiInterceptFlags = {
|
|
|
7787
7849
|
* })
|
|
7788
7850
|
* ```
|
|
7789
7851
|
*
|
|
7790
|
-
* @version SDK
|
|
7852
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7791
7853
|
*/
|
|
7792
7854
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7793
7855
|
/**
|
|
@@ -7804,7 +7866,7 @@ export type ApiInterceptFlags = {
|
|
|
7804
7866
|
* })
|
|
7805
7867
|
* ```
|
|
7806
7868
|
*
|
|
7807
|
-
* @version SDK
|
|
7869
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7808
7870
|
*/
|
|
7809
7871
|
interceptTimeout?: number;
|
|
7810
7872
|
};
|
|
@@ -8057,9 +8119,9 @@ declare class TsEmbed {
|
|
|
8057
8119
|
*/
|
|
8058
8120
|
private isPreRendered;
|
|
8059
8121
|
/**
|
|
8060
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
8122
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
8061
8123
|
* will generate for embedding. This provides additional security to
|
|
8062
|
-
*
|
|
8124
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
8063
8125
|
* @default false
|
|
8064
8126
|
*/
|
|
8065
8127
|
private shouldEncodeUrlQueryParams;
|
|
@@ -8425,7 +8487,7 @@ declare class TsEmbed {
|
|
|
8425
8487
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
8426
8488
|
* session.
|
|
8427
8489
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
8428
|
-
* @version SDK: 1.25.0
|
|
8490
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
8429
8491
|
*/
|
|
8430
8492
|
getAnswerService(vizId?: string): Promise<AnswerService>;
|
|
8431
8493
|
/**
|
|
@@ -8484,81 +8546,81 @@ export interface SearchOptions {
|
|
|
8484
8546
|
* Configuration for the Spotter sidebar.
|
|
8485
8547
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
8486
8548
|
* @group Embed components
|
|
8487
|
-
* @version SDK: 1.
|
|
8549
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8488
8550
|
*/
|
|
8489
8551
|
export interface SpotterSidebarViewConfig {
|
|
8490
8552
|
/**
|
|
8491
8553
|
* Controls the visibility of the past conversations sidebar.
|
|
8492
8554
|
* @default false
|
|
8493
|
-
* @version SDK: 1.
|
|
8555
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8494
8556
|
*/
|
|
8495
8557
|
enablePastConversationsSidebar?: boolean;
|
|
8496
8558
|
/**
|
|
8497
8559
|
* Custom title text for the sidebar header.
|
|
8498
8560
|
* Defaults to translated "Spotter" text.
|
|
8499
|
-
* @version SDK: 1.
|
|
8561
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8500
8562
|
*/
|
|
8501
8563
|
spotterSidebarTitle?: string;
|
|
8502
8564
|
/**
|
|
8503
8565
|
* Boolean to set the default expanded state of the sidebar.
|
|
8504
8566
|
* @default false
|
|
8505
|
-
* @version SDK: 1.
|
|
8567
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8506
8568
|
*/
|
|
8507
8569
|
spotterSidebarDefaultExpanded?: boolean;
|
|
8508
8570
|
/**
|
|
8509
8571
|
* Custom label text for the rename action in the conversation edit menu.
|
|
8510
8572
|
* Defaults to translated "Rename" text.
|
|
8511
|
-
* @version SDK: 1.
|
|
8573
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8512
8574
|
*/
|
|
8513
8575
|
spotterChatRenameLabel?: string;
|
|
8514
8576
|
/**
|
|
8515
8577
|
* Custom label text for the delete action in the conversation edit menu.
|
|
8516
8578
|
* Defaults to translated "DELETE" text.
|
|
8517
|
-
* @version SDK: 1.
|
|
8579
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8518
8580
|
*/
|
|
8519
8581
|
spotterChatDeleteLabel?: string;
|
|
8520
8582
|
/**
|
|
8521
8583
|
* Custom title text for the delete conversation confirmation modal.
|
|
8522
8584
|
* Defaults to translated "Delete chat" text.
|
|
8523
|
-
* @version SDK: 1.
|
|
8585
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8524
8586
|
*/
|
|
8525
8587
|
spotterDeleteConversationModalTitle?: string;
|
|
8526
8588
|
/**
|
|
8527
8589
|
* Custom message text for the past conversation banner alert.
|
|
8528
8590
|
* Defaults to translated alert message.
|
|
8529
|
-
* @version SDK: 1.
|
|
8591
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8530
8592
|
*/
|
|
8531
8593
|
spotterPastConversationAlertMessage?: string;
|
|
8532
8594
|
/**
|
|
8533
8595
|
* Custom URL for the documentation/best practices link.
|
|
8534
8596
|
* Defaults to ThoughtSpot docs URL based on release version.
|
|
8535
8597
|
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
8536
|
-
* @version SDK: 1.
|
|
8598
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8537
8599
|
*/
|
|
8538
8600
|
spotterDocumentationUrl?: string;
|
|
8539
8601
|
/**
|
|
8540
8602
|
* Custom label text for the best practices button in the footer.
|
|
8541
8603
|
* Defaults to translated "Best Practices" text.
|
|
8542
|
-
* @version SDK: 1.
|
|
8604
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8543
8605
|
*/
|
|
8544
8606
|
spotterBestPracticesLabel?: string;
|
|
8545
8607
|
/**
|
|
8546
8608
|
* Number of conversations to fetch per batch when loading conversation history.
|
|
8547
8609
|
* @default 30
|
|
8548
|
-
* @version SDK: 1.
|
|
8610
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8549
8611
|
*/
|
|
8550
8612
|
spotterConversationsBatchSize?: number;
|
|
8551
8613
|
/**
|
|
8552
8614
|
* Custom title text for the "New Chat" button in the sidebar.
|
|
8553
8615
|
* Defaults to translated "New Chat" text.
|
|
8554
|
-
* @version SDK: 1.
|
|
8616
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8555
8617
|
*/
|
|
8556
8618
|
spotterNewChatButtonTitle?: string;
|
|
8557
8619
|
}
|
|
8558
8620
|
/**
|
|
8559
8621
|
* Configuration for customizing Spotter chat UI branding.
|
|
8560
|
-
* @group Embed components
|
|
8561
8622
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8623
|
+
* @group Embed components
|
|
8562
8624
|
*/
|
|
8563
8625
|
export interface SpotterChatViewConfig {
|
|
8564
8626
|
/**
|
|
@@ -8597,6 +8659,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8597
8659
|
* but still display the selected data source.
|
|
8598
8660
|
*
|
|
8599
8661
|
* Supported embed types: `SpotterEmbed`
|
|
8662
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8600
8663
|
* @example
|
|
8601
8664
|
* ```js
|
|
8602
8665
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8604,13 +8667,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8604
8667
|
* disableSourceSelection : true,
|
|
8605
8668
|
* })
|
|
8606
8669
|
* ```
|
|
8607
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8608
8670
|
*/
|
|
8609
8671
|
disableSourceSelection?: boolean;
|
|
8610
8672
|
/**
|
|
8611
8673
|
* hideSourceSelection : Hide data source selection
|
|
8612
8674
|
*
|
|
8613
8675
|
* Supported embed types: `SpotterEmbed`
|
|
8676
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8614
8677
|
* @example
|
|
8615
8678
|
* ```js
|
|
8616
8679
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8618,15 +8681,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8618
8681
|
* hideSourceSelection : true,
|
|
8619
8682
|
* })
|
|
8620
8683
|
* ```
|
|
8621
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8622
8684
|
*/
|
|
8623
8685
|
hideSourceSelection?: boolean;
|
|
8624
8686
|
/**
|
|
8625
8687
|
* Flag to control Data panel experience
|
|
8626
8688
|
*
|
|
8627
8689
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
8690
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8628
8691
|
* @default true
|
|
8629
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8630
8692
|
* @example
|
|
8631
8693
|
* ```js
|
|
8632
8694
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -8643,6 +8705,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8643
8705
|
* default is false.
|
|
8644
8706
|
*
|
|
8645
8707
|
* Supported embed types: `SpotterEmbed`
|
|
8708
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8646
8709
|
* @example
|
|
8647
8710
|
* ```js
|
|
8648
8711
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8650,7 +8713,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8650
8713
|
* showSpotterLimitations : true,
|
|
8651
8714
|
* })
|
|
8652
8715
|
* ```
|
|
8653
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8654
8716
|
*/
|
|
8655
8717
|
showSpotterLimitations?: boolean;
|
|
8656
8718
|
/**
|
|
@@ -8658,6 +8720,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8658
8720
|
* the initial screen of the conversation.
|
|
8659
8721
|
*
|
|
8660
8722
|
* Supported embed types: `SpotterEmbed`
|
|
8723
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8661
8724
|
* @example
|
|
8662
8725
|
* ```js
|
|
8663
8726
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8665,7 +8728,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8665
8728
|
* hideSampleQuestions : true,
|
|
8666
8729
|
* })
|
|
8667
8730
|
* ```
|
|
8668
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8669
8731
|
*/
|
|
8670
8732
|
hideSampleQuestions?: boolean;
|
|
8671
8733
|
/**
|
|
@@ -8673,6 +8735,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8673
8735
|
* visualization, or Liveboard.
|
|
8674
8736
|
*
|
|
8675
8737
|
* Supported embed types: `SpotterEmbed`
|
|
8738
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8676
8739
|
* @example
|
|
8677
8740
|
* ```js
|
|
8678
8741
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8686,7 +8749,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8686
8749
|
* ],
|
|
8687
8750
|
* })
|
|
8688
8751
|
* ```
|
|
8689
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8690
8752
|
*/
|
|
8691
8753
|
runtimeFilters?: RuntimeFilter[];
|
|
8692
8754
|
/**
|
|
@@ -8697,14 +8759,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8697
8759
|
* (default behavior before SDK 1.45.0).
|
|
8698
8760
|
*
|
|
8699
8761
|
* Supported embed types: `SpotterEmbed`
|
|
8700
|
-
* @default true
|
|
8701
8762
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8763
|
+
* @default true
|
|
8702
8764
|
*/
|
|
8703
8765
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
8704
8766
|
/**
|
|
8705
8767
|
* The list of runtime parameters to apply to the conversation.
|
|
8706
8768
|
*
|
|
8707
8769
|
* Supported embed types: `SpotterEmbed`
|
|
8770
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8708
8771
|
* @example
|
|
8709
8772
|
* ```js
|
|
8710
8773
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8717,7 +8780,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8717
8780
|
* ],
|
|
8718
8781
|
* })
|
|
8719
8782
|
* ```
|
|
8720
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8721
8783
|
*/
|
|
8722
8784
|
runtimeParameters?: RuntimeParameter[];
|
|
8723
8785
|
/**
|
|
@@ -8728,14 +8790,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8728
8790
|
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
8729
8791
|
*
|
|
8730
8792
|
* Supported embed types: `SpotterEmbed`
|
|
8731
|
-
* @default true
|
|
8732
8793
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8794
|
+
* @default true
|
|
8733
8795
|
*/
|
|
8734
8796
|
excludeRuntimeParametersfromURL?: boolean;
|
|
8735
8797
|
/**
|
|
8736
8798
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
8737
8799
|
*
|
|
8738
8800
|
* Supported embed types: `SpotterEmbed`
|
|
8801
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8739
8802
|
* @default false
|
|
8740
8803
|
* @example
|
|
8741
8804
|
* ```js
|
|
@@ -8744,17 +8807,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8744
8807
|
* updatedSpotterChatPrompt : true,
|
|
8745
8808
|
* })
|
|
8746
8809
|
* ```
|
|
8747
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8748
8810
|
*/
|
|
8749
8811
|
updatedSpotterChatPrompt?: boolean;
|
|
8812
|
+
/**
|
|
8813
|
+
* Controls the visibility of the past conversations sidebar.
|
|
8814
|
+
*
|
|
8815
|
+
* Supported embed types: `SpotterEmbed`
|
|
8816
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8817
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8818
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
8819
|
+
* @default false
|
|
8820
|
+
*/
|
|
8821
|
+
enablePastConversationsSidebar?: boolean;
|
|
8750
8822
|
/**
|
|
8751
8823
|
* Configuration for the Spotter sidebar UI customization.
|
|
8752
8824
|
*
|
|
8753
8825
|
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
8826
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
8754
8827
|
* @example
|
|
8755
8828
|
* ```js
|
|
8756
8829
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8757
|
-
*
|
|
8830
|
+
* worksheetId: 'worksheet-id',
|
|
8831
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
8832
|
+
* enablePastConversationsSidebar: false,
|
|
8833
|
+
* // Recommended config; this value takes precedence
|
|
8758
8834
|
* spotterSidebarConfig: {
|
|
8759
8835
|
* enablePastConversationsSidebar: true,
|
|
8760
8836
|
* spotterSidebarTitle: 'My Conversations',
|
|
@@ -8762,7 +8838,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8762
8838
|
* },
|
|
8763
8839
|
* })
|
|
8764
8840
|
* ```
|
|
8765
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8766
8841
|
*/
|
|
8767
8842
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
8768
8843
|
/**
|
|
@@ -8770,6 +8845,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8770
8845
|
* branding in tool response cards.
|
|
8771
8846
|
*
|
|
8772
8847
|
* Supported embed types: `SpotterEmbed`
|
|
8848
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8773
8849
|
* @example
|
|
8774
8850
|
* ```js
|
|
8775
8851
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -8780,20 +8856,20 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
8780
8856
|
* },
|
|
8781
8857
|
* })
|
|
8782
8858
|
* ```
|
|
8783
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8784
8859
|
*/
|
|
8785
8860
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
8786
8861
|
}
|
|
8787
8862
|
/**
|
|
8788
8863
|
* The configuration for the embedded spotterEmbed options.
|
|
8789
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8790
8864
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
8865
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8791
8866
|
* @group Embed components
|
|
8792
8867
|
*/
|
|
8793
8868
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
8794
8869
|
}
|
|
8795
8870
|
/**
|
|
8796
8871
|
* Embed ThoughtSpot AI Conversation.
|
|
8872
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8797
8873
|
* @group Embed components
|
|
8798
8874
|
* @example
|
|
8799
8875
|
* ```js
|
|
@@ -8805,7 +8881,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
8805
8881
|
* });
|
|
8806
8882
|
* conversation.render();
|
|
8807
8883
|
* ```
|
|
8808
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8809
8884
|
*/
|
|
8810
8885
|
export declare class SpotterEmbed extends TsEmbed {
|
|
8811
8886
|
protected viewConfig: SpotterEmbedViewConfig;
|
|
@@ -8816,8 +8891,9 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
8816
8891
|
}
|
|
8817
8892
|
/**
|
|
8818
8893
|
* Embed ThoughtSpot AI Conversation.
|
|
8819
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8820
8894
|
* Use {@link SpotterEmbed} instead
|
|
8895
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8896
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8821
8897
|
* @group Embed components
|
|
8822
8898
|
* @example
|
|
8823
8899
|
* ```js
|
|
@@ -8829,7 +8905,6 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
8829
8905
|
* });
|
|
8830
8906
|
* conversation.render();
|
|
8831
8907
|
* ```
|
|
8832
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8833
8908
|
*/
|
|
8834
8909
|
export declare class ConversationEmbed extends SpotterEmbed {
|
|
8835
8910
|
protected viewConfig: ConversationViewConfig;
|
|
@@ -8944,7 +9019,7 @@ export declare enum ListPage {
|
|
|
8944
9019
|
*/
|
|
8945
9020
|
export interface DiscoveryExperience {
|
|
8946
9021
|
/**
|
|
8947
|
-
* primaryNavbarVersion determines the version of the navigation
|
|
9022
|
+
* primaryNavbarVersion determines the version of the primary navigation bar.
|
|
8948
9023
|
*/
|
|
8949
9024
|
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
8950
9025
|
/**
|
|
@@ -8967,8 +9042,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8967
9042
|
* This flag also controls the homepage left navigation bar.
|
|
8968
9043
|
*
|
|
8969
9044
|
* Supported embed types: `AppEmbed`
|
|
8970
|
-
* @default true
|
|
8971
9045
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9046
|
+
* @default true
|
|
8972
9047
|
* @example
|
|
8973
9048
|
* ```js
|
|
8974
9049
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -8989,8 +9064,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8989
9064
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
8990
9065
|
*
|
|
8991
9066
|
* Supported embed types: `AppEmbed`
|
|
8992
|
-
* @default false
|
|
8993
9067
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9068
|
+
* @default false
|
|
8994
9069
|
* @example
|
|
8995
9070
|
* ```js
|
|
8996
9071
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9007,8 +9082,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9007
9082
|
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
9008
9083
|
*
|
|
9009
9084
|
* Supported embed types: `AppEmbed`
|
|
9010
|
-
* @default false
|
|
9011
9085
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9086
|
+
* @default false
|
|
9012
9087
|
* @example
|
|
9013
9088
|
* ```js
|
|
9014
9089
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9019,12 +9094,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9019
9094
|
*/
|
|
9020
9095
|
disableProfileAndHelp?: boolean;
|
|
9021
9096
|
/**
|
|
9022
|
-
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9023
|
-
* @default true
|
|
9024
9097
|
* Whether the help menu in the top navigation bar should be served
|
|
9025
9098
|
* from Pendo or ThoughtSpot's internal help items.
|
|
9026
9099
|
*
|
|
9027
9100
|
* Supported embed types: `AppEmbed`
|
|
9101
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9102
|
+
* @default true
|
|
9028
9103
|
* @example
|
|
9029
9104
|
* ```js
|
|
9030
9105
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9039,8 +9114,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9039
9114
|
* the top navigation bar in the V3 navigation experience.
|
|
9040
9115
|
*
|
|
9041
9116
|
* Supported embed types: `AppEmbed`
|
|
9042
|
-
* @default false
|
|
9043
9117
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9118
|
+
* @default false
|
|
9044
9119
|
* @example
|
|
9045
9120
|
* ```js
|
|
9046
9121
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9059,8 +9134,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9059
9134
|
* in the classic (V1) experience.
|
|
9060
9135
|
*
|
|
9061
9136
|
* Supported embed types: `AppEmbed`
|
|
9062
|
-
* @default true
|
|
9063
9137
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9138
|
+
* @default true
|
|
9064
9139
|
* @example
|
|
9065
9140
|
* ```js
|
|
9066
9141
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9078,8 +9153,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9078
9153
|
* in the classic (V1) and V2 experience modes.
|
|
9079
9154
|
*
|
|
9080
9155
|
* Supported embed types: `AppEmbed`
|
|
9081
|
-
* @default true
|
|
9082
9156
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9157
|
+
* @default true
|
|
9083
9158
|
* @example
|
|
9084
9159
|
* ```js
|
|
9085
9160
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9095,7 +9170,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9095
9170
|
* In the V3 experience, it shows or hides application selection
|
|
9096
9171
|
* icons on the left navigation panel.
|
|
9097
9172
|
* By default, the application selection menu and icons are
|
|
9098
|
-
* shown in the UI
|
|
9173
|
+
* shown in the UI.
|
|
9099
9174
|
*
|
|
9100
9175
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9101
9176
|
*
|
|
@@ -9135,7 +9210,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9135
9210
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
9136
9211
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
9137
9212
|
*
|
|
9138
|
-
* For
|
|
9213
|
+
* For example, if you want the component to open to a specific Liveboard
|
|
9139
9214
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
9140
9215
|
*
|
|
9141
9216
|
* Supported embed types: `AppEmbed`
|
|
@@ -9153,7 +9228,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9153
9228
|
* The application page to set as the start page
|
|
9154
9229
|
* in the embedded view.
|
|
9155
9230
|
*
|
|
9156
|
-
* Use this to open to particular page in the app. To open to a specific
|
|
9231
|
+
* Use this to open to a particular page in the app. To open to a specific
|
|
9157
9232
|
* path within the app, use the `path` attribute which is more flexible.
|
|
9158
9233
|
*
|
|
9159
9234
|
* Supported embed types: `AppEmbed`
|
|
@@ -9233,8 +9308,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9233
9308
|
* If set to true, the Search Assist feature is enabled.
|
|
9234
9309
|
*
|
|
9235
9310
|
* Supported embed types: `AppEmbed`
|
|
9236
|
-
* @default true
|
|
9237
9311
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
9312
|
+
* @default true
|
|
9238
9313
|
* @example
|
|
9239
9314
|
* ```js
|
|
9240
9315
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9272,8 +9347,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9272
9347
|
* For more information,
|
|
9273
9348
|
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9274
9349
|
* Supported embed types: `AppEmbed`
|
|
9275
|
-
* @default false
|
|
9276
9350
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9351
|
+
* @default false
|
|
9277
9352
|
* @example
|
|
9278
9353
|
* ```js
|
|
9279
9354
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9288,8 +9363,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9288
9363
|
* For more information, see
|
|
9289
9364
|
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9290
9365
|
* Supported embed types: `AppEmbed`
|
|
9291
|
-
* @default false
|
|
9292
9366
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9367
|
+
* @default false
|
|
9293
9368
|
* @example
|
|
9294
9369
|
* ```js
|
|
9295
9370
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9304,10 +9379,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9304
9379
|
*/
|
|
9305
9380
|
discoveryExperience?: DiscoveryExperience;
|
|
9306
9381
|
/**
|
|
9307
|
-
* To set the initial state of the search bar in case of saved-answers.
|
|
9382
|
+
* To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
|
|
9308
9383
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9384
|
+
* @deprecated This flag is deprecated.
|
|
9309
9385
|
* @default false
|
|
9310
|
-
* @deprecated Use {@link collapseSearchBar} instead
|
|
9311
9386
|
*/
|
|
9312
9387
|
collapseSearchBarInitially?: boolean;
|
|
9313
9388
|
/**
|
|
@@ -9335,14 +9410,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9335
9410
|
* Flag to use home page search bar mode
|
|
9336
9411
|
*
|
|
9337
9412
|
* Supported embed types: `AppEmbed`
|
|
9338
|
-
* @version SDK
|
|
9413
|
+
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
9339
9414
|
*/
|
|
9340
9415
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
9341
9416
|
/**
|
|
9342
9417
|
* This flag is used to enable unified search experience for full app embed.
|
|
9343
9418
|
*
|
|
9344
9419
|
* Supported embed types: `AppEmbed`
|
|
9345
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
9420
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
9346
9421
|
* @default true
|
|
9347
9422
|
* @example
|
|
9348
9423
|
* ```js
|
|
@@ -9354,7 +9429,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9354
9429
|
*/
|
|
9355
9430
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
9356
9431
|
/**
|
|
9357
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
9432
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
9433
|
+
* @deprecated This flag is deprecated.
|
|
9358
9434
|
*
|
|
9359
9435
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9360
9436
|
* @type {boolean}
|
|
@@ -9370,7 +9446,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9370
9446
|
*/
|
|
9371
9447
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
9372
9448
|
/**
|
|
9373
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9449
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9450
|
+
* mails
|
|
9374
9451
|
*
|
|
9375
9452
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9376
9453
|
* @type {boolean}
|
|
@@ -9420,6 +9497,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9420
9497
|
/**
|
|
9421
9498
|
* This flag is used to enable the full height lazy load data.
|
|
9422
9499
|
*
|
|
9500
|
+
* @type {boolean}
|
|
9501
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9502
|
+
* @default false
|
|
9423
9503
|
* @example
|
|
9424
9504
|
* ```js
|
|
9425
9505
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -9428,39 +9508,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9428
9508
|
* lazyLoadingForFullHeight: true,
|
|
9429
9509
|
* })
|
|
9430
9510
|
* ```
|
|
9431
|
-
*
|
|
9432
|
-
* @type {boolean}
|
|
9433
|
-
* @default false
|
|
9434
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9435
9511
|
*/
|
|
9436
9512
|
lazyLoadingForFullHeight?: boolean;
|
|
9437
9513
|
/**
|
|
9438
9514
|
* The margin to be used for lazy loading.
|
|
9439
9515
|
*
|
|
9440
9516
|
* For example, if the margin is set to '10px',
|
|
9441
|
-
* the visualization will be loaded 10px before
|
|
9517
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9442
9518
|
* viewport.
|
|
9443
9519
|
*
|
|
9444
9520
|
* The format is similar to CSS margin.
|
|
9445
9521
|
*
|
|
9522
|
+
* @type {string}
|
|
9523
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9446
9524
|
* @example
|
|
9447
9525
|
* ```js
|
|
9448
9526
|
* const embed = new AppEmbed('#embed-container', {
|
|
9449
9527
|
* // ...other options
|
|
9450
9528
|
* fullHeight: true,
|
|
9451
9529
|
* lazyLoadingForFullHeight: true,
|
|
9452
|
-
* // Using 0px, the visualization will be only loaded when
|
|
9530
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
9453
9531
|
* lazyLoadingMargin: '0px',
|
|
9454
9532
|
* })
|
|
9455
9533
|
* ```
|
|
9456
|
-
* @type {string}
|
|
9457
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9458
9534
|
*/
|
|
9459
9535
|
lazyLoadingMargin?: string;
|
|
9460
9536
|
/**
|
|
9461
9537
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9462
9538
|
*
|
|
9463
9539
|
* Supported embed types: `AppEmbed`
|
|
9540
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9464
9541
|
* @default false
|
|
9465
9542
|
* @example
|
|
9466
9543
|
* ```js
|
|
@@ -9469,25 +9546,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9469
9546
|
* updatedSpotterChatPrompt : true,
|
|
9470
9547
|
* })
|
|
9471
9548
|
* ```
|
|
9472
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9473
9549
|
*/
|
|
9474
9550
|
updatedSpotterChatPrompt?: boolean;
|
|
9551
|
+
/**
|
|
9552
|
+
* Controls the visibility of the past conversations sidebar.
|
|
9553
|
+
*
|
|
9554
|
+
* Supported embed types: `AppEmbed`
|
|
9555
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9556
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9557
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
9558
|
+
* @default false
|
|
9559
|
+
*/
|
|
9560
|
+
enablePastConversationsSidebar?: boolean;
|
|
9475
9561
|
/**
|
|
9476
9562
|
* Configuration for the Spotter sidebar UI customization.
|
|
9477
9563
|
* Only applicable when navigating to Spotter within the app.
|
|
9478
9564
|
*
|
|
9479
9565
|
* Supported embed types: `AppEmbed`
|
|
9566
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9480
9567
|
* @example
|
|
9481
9568
|
* ```js
|
|
9482
9569
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
9483
|
-
*
|
|
9570
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
9571
|
+
* enablePastConversationsSidebar: false,
|
|
9572
|
+
* // Recommended config; this value takes precedence
|
|
9484
9573
|
* spotterSidebarConfig: {
|
|
9485
9574
|
* enablePastConversationsSidebar: true,
|
|
9486
9575
|
* spotterSidebarTitle: 'My Conversations',
|
|
9487
9576
|
* },
|
|
9488
9577
|
* })
|
|
9489
9578
|
* ```
|
|
9490
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9491
9579
|
*/
|
|
9492
9580
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9493
9581
|
/**
|
|
@@ -9495,6 +9583,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9495
9583
|
* branding in tool response cards.
|
|
9496
9584
|
*
|
|
9497
9585
|
* Supported embed types: `AppEmbed`
|
|
9586
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9498
9587
|
* @example
|
|
9499
9588
|
* ```js
|
|
9500
9589
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9505,7 +9594,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9505
9594
|
* },
|
|
9506
9595
|
* })
|
|
9507
9596
|
* ```
|
|
9508
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9509
9597
|
*/
|
|
9510
9598
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9511
9599
|
/**
|
|
@@ -9525,6 +9613,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9525
9613
|
* ```
|
|
9526
9614
|
*/
|
|
9527
9615
|
minimumHeight?: number;
|
|
9616
|
+
/**
|
|
9617
|
+
* To enable the homepage announcement banner.
|
|
9618
|
+
* Controls the visibility of the announcement section
|
|
9619
|
+
* on the homepage.
|
|
9620
|
+
*
|
|
9621
|
+
* Supported embed types: `AppEmbed`
|
|
9622
|
+
* @example
|
|
9623
|
+
* ```js
|
|
9624
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
9625
|
+
* ... // other embed view config
|
|
9626
|
+
* enableHomepageAnnouncement: true,
|
|
9627
|
+
* })
|
|
9628
|
+
* ```
|
|
9629
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
9630
|
+
*/
|
|
9631
|
+
enableHomepageAnnouncement?: boolean;
|
|
9528
9632
|
}
|
|
9529
9633
|
/**
|
|
9530
9634
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -9651,20 +9755,45 @@ export declare enum AuthFailureType {
|
|
|
9651
9755
|
*/
|
|
9652
9756
|
export declare enum AuthStatus {
|
|
9653
9757
|
/**
|
|
9654
|
-
* Emits when the SDK fails to authenticate
|
|
9758
|
+
* Emits when the SDK fails to authenticate.
|
|
9655
9759
|
*/
|
|
9656
9760
|
FAILURE = "FAILURE",
|
|
9657
9761
|
/**
|
|
9658
|
-
* Emits when the SDK
|
|
9762
|
+
* Emits when the SDK authentication step completes
|
|
9763
|
+
* successfully (e.g., token exchange, cookie set).
|
|
9764
|
+
* This fires before any iframe is rendered. Use
|
|
9765
|
+
* this to know that auth passed and it is safe to
|
|
9766
|
+
* proceed with rendering. The callback receives no
|
|
9767
|
+
* arguments.
|
|
9768
|
+
* @example
|
|
9769
|
+
* ```js
|
|
9770
|
+
* const authEE = init({ ... });
|
|
9771
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
9772
|
+
* // Auth done, iframe not loaded yet
|
|
9773
|
+
* });
|
|
9774
|
+
* ```
|
|
9659
9775
|
*/
|
|
9660
9776
|
SDK_SUCCESS = "SDK_SUCCESS",
|
|
9661
9777
|
/**
|
|
9662
9778
|
* @hidden
|
|
9663
|
-
* Emits when iframe is loaded and session
|
|
9779
|
+
* Emits when iframe is loaded and session
|
|
9780
|
+
* information is available.
|
|
9664
9781
|
*/
|
|
9665
9782
|
SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
|
|
9666
9783
|
/**
|
|
9667
|
-
* Emits when the app
|
|
9784
|
+
* Emits when the ThoughtSpot app inside the
|
|
9785
|
+
* embedded iframe confirms its session is active.
|
|
9786
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
9787
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
9788
|
+
* @see EmbedEvent.AuthInit
|
|
9789
|
+
* @example
|
|
9790
|
+
* ```js
|
|
9791
|
+
* const authEE = init({ ... });
|
|
9792
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
9793
|
+
* // App is loaded and authenticated
|
|
9794
|
+
* console.log(sessionInfo.userGUID);
|
|
9795
|
+
* });
|
|
9796
|
+
* ```
|
|
9668
9797
|
*/
|
|
9669
9798
|
SUCCESS = "SUCCESS",
|
|
9670
9799
|
/**
|
|
@@ -9813,7 +9942,7 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
9813
9942
|
* }).catch(error => {
|
|
9814
9943
|
* console.error(error);
|
|
9815
9944
|
* });
|
|
9816
|
-
|
|
9945
|
+
* ```
|
|
9817
9946
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
9818
9947
|
* @group Global methods
|
|
9819
9948
|
*/
|
|
@@ -9851,9 +9980,9 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
9851
9980
|
export declare const exportTML: (data: exportTMLInput) => Promise<any>;
|
|
9852
9981
|
/**
|
|
9853
9982
|
* Reloads the ThoughtSpot iframe.
|
|
9983
|
+
* @version SDK: 1.43.1
|
|
9854
9984
|
* @param iFrame
|
|
9855
9985
|
* @group Global methods
|
|
9856
|
-
* @version SDK: 1.43.1
|
|
9857
9986
|
*/
|
|
9858
9987
|
export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
|
|
9859
9988
|
/**
|
|
@@ -9872,9 +10001,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9872
10001
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
9873
10002
|
* incrementally as users scroll the page to view the charts and tables.
|
|
9874
10003
|
*
|
|
9875
|
-
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9876
10004
|
*
|
|
9877
10005
|
* Supported embed types: `LiveboardEmbed`
|
|
10006
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
9878
10007
|
* @example
|
|
9879
10008
|
* ```js
|
|
9880
10009
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9885,14 +10014,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9885
10014
|
*/
|
|
9886
10015
|
fullHeight?: boolean;
|
|
9887
10016
|
/**
|
|
9888
|
-
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
10017
|
+
* This is the minimum height (in pixels) for a full-height Liveboard.
|
|
9889
10018
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
9890
10019
|
* other screens navigable from a Liveboard.
|
|
9891
10020
|
*
|
|
9892
10021
|
* Supported embed types: `LiveboardEmbed`
|
|
9893
10022
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
9894
|
-
* @default 500
|
|
9895
10023
|
* @deprecated Use `minimumHeight` instead.
|
|
10024
|
+
* @default 500
|
|
9896
10025
|
* @example
|
|
9897
10026
|
* ```js
|
|
9898
10027
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -9921,7 +10050,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9921
10050
|
*/
|
|
9922
10051
|
minimumHeight?: number;
|
|
9923
10052
|
/**
|
|
9924
|
-
*
|
|
10053
|
+
* If set to true, the context menu in visualizations will be enabled.
|
|
10054
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10055
|
+
* @deprecated this option is deprecated.
|
|
9925
10056
|
* @example
|
|
9926
10057
|
* ```js
|
|
9927
10058
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -9929,7 +10060,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9929
10060
|
* enableVizTransformations:true,
|
|
9930
10061
|
* })
|
|
9931
10062
|
* ```
|
|
9932
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
9933
10063
|
*/
|
|
9934
10064
|
enableVizTransformations?: boolean;
|
|
9935
10065
|
/**
|
|
@@ -9942,8 +10072,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9942
10072
|
* ```js
|
|
9943
10073
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9944
10074
|
* ... //other embed view config
|
|
9945
|
-
* liveboardId:id of liveboard,
|
|
10075
|
+
* liveboardId:'id of liveboard',
|
|
9946
10076
|
* })
|
|
10077
|
+
* ```
|
|
9947
10078
|
*/
|
|
9948
10079
|
liveboardId?: string;
|
|
9949
10080
|
/**
|
|
@@ -9996,6 +10127,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9996
10127
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
9997
10128
|
* ]
|
|
9998
10129
|
* })
|
|
10130
|
+
* ```
|
|
9999
10131
|
*/
|
|
10000
10132
|
visibleVizs?: string[];
|
|
10001
10133
|
/**
|
|
@@ -10023,6 +10155,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10023
10155
|
* Specify the tab ID.
|
|
10024
10156
|
*
|
|
10025
10157
|
* Supported embed types: `LiveboardEmbed`
|
|
10158
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10026
10159
|
* @example
|
|
10027
10160
|
* ```js
|
|
10028
10161
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10030,7 +10163,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10030
10163
|
* activeTabId:'id-1234',
|
|
10031
10164
|
* })
|
|
10032
10165
|
* ```
|
|
10033
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10034
10166
|
*/
|
|
10035
10167
|
activeTabId?: string;
|
|
10036
10168
|
/**
|
|
@@ -10039,6 +10171,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10039
10171
|
* that includes specific filter selections.
|
|
10040
10172
|
*
|
|
10041
10173
|
* Supported embed types: `LiveboardEmbed`
|
|
10174
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10042
10175
|
* @example
|
|
10043
10176
|
* ```js
|
|
10044
10177
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10047,7 +10180,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10047
10180
|
* activeTabId: 'tab-guid',
|
|
10048
10181
|
* })
|
|
10049
10182
|
* ```
|
|
10050
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10051
10183
|
*/
|
|
10052
10184
|
personalizedViewId?: string;
|
|
10053
10185
|
/**
|
|
@@ -10068,13 +10200,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10068
10200
|
* Show a preview image of the visualization before the visualization loads.
|
|
10069
10201
|
* Only works for visualizations embeds with a viz id.
|
|
10070
10202
|
*
|
|
10071
|
-
* Also, viz
|
|
10203
|
+
* Also, viz snapshot should be enabled in the ThoughtSpot instance.
|
|
10072
10204
|
* Contact ThoughtSpot support to enable this feature.
|
|
10073
10205
|
*
|
|
10074
|
-
* Since
|
|
10206
|
+
* Since this will show preview images, be careful that it may show
|
|
10075
10207
|
* undesired data to the user when using row level security.
|
|
10076
10208
|
*
|
|
10077
10209
|
* Supported embed types: `LiveboardEmbed`
|
|
10210
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10078
10211
|
* @example
|
|
10079
10212
|
* ```js
|
|
10080
10213
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10084,7 +10217,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10084
10217
|
* });
|
|
10085
10218
|
* embed.render();
|
|
10086
10219
|
* ```
|
|
10087
|
-
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10088
10220
|
*/
|
|
10089
10221
|
showPreviewLoader?: boolean;
|
|
10090
10222
|
/**
|
|
@@ -10092,13 +10224,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10092
10224
|
*
|
|
10093
10225
|
* Supported embed types: `LiveboardEmbed`
|
|
10094
10226
|
* @hidden
|
|
10095
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10227
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10096
10228
|
* @example
|
|
10097
10229
|
* ```js
|
|
10098
10230
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10099
10231
|
* ... //other embed view config
|
|
10100
|
-
* oAuthPollingInterval:
|
|
10232
|
+
* oAuthPollingInterval: 30000,
|
|
10101
10233
|
* })
|
|
10234
|
+
* ```
|
|
10102
10235
|
*/
|
|
10103
10236
|
oAuthPollingInterval?: number;
|
|
10104
10237
|
/**
|
|
@@ -10106,35 +10239,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10106
10239
|
*
|
|
10107
10240
|
* Supported embed types: `LiveboardEmbed`
|
|
10108
10241
|
* @hidden
|
|
10109
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10242
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10110
10243
|
* @example
|
|
10111
10244
|
* ```js
|
|
10112
10245
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10113
10246
|
* ... //other embed view config
|
|
10114
10247
|
* isForceRedirect: false,
|
|
10115
10248
|
* })
|
|
10249
|
+
* ```
|
|
10116
10250
|
*/
|
|
10117
10251
|
isForceRedirect?: boolean;
|
|
10118
10252
|
/**
|
|
10119
10253
|
* The source connection ID for authentication.
|
|
10120
|
-
* @hidden
|
|
10121
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10122
10254
|
*
|
|
10123
10255
|
* Supported embed types: `LiveboardEmbed`
|
|
10256
|
+
* @hidden
|
|
10257
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10124
10258
|
* @example
|
|
10125
10259
|
* ```js
|
|
10126
10260
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10127
10261
|
* ... //other embed view config
|
|
10128
10262
|
* dataSourceId: '',
|
|
10129
10263
|
* })
|
|
10264
|
+
* ```
|
|
10130
10265
|
*/
|
|
10131
10266
|
dataSourceId?: string;
|
|
10132
10267
|
/**
|
|
10133
|
-
* The list of tab IDs to hide from the embedded.
|
|
10134
|
-
*
|
|
10135
|
-
* Use this to hide
|
|
10268
|
+
* The list of tab IDs to hide from the embedded Liveboard.
|
|
10269
|
+
* These tabs will be hidden from their respective Liveboards.
|
|
10270
|
+
* Use this to hide a tab ID.
|
|
10136
10271
|
*
|
|
10137
10272
|
* Supported embed types: `LiveboardEmbed`
|
|
10273
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10138
10274
|
* @example
|
|
10139
10275
|
* ```js
|
|
10140
10276
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10145,7 +10281,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10145
10281
|
* ]
|
|
10146
10282
|
* });
|
|
10147
10283
|
* ```
|
|
10148
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10149
10284
|
*/
|
|
10150
10285
|
hiddenTabs?: string[];
|
|
10151
10286
|
/**
|
|
@@ -10169,7 +10304,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10169
10304
|
*/
|
|
10170
10305
|
visibleTabs?: string[];
|
|
10171
10306
|
/**
|
|
10172
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
10307
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10308
|
+
* @deprecated This flag is deprecated.
|
|
10173
10309
|
*
|
|
10174
10310
|
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
10175
10311
|
* @type {boolean}
|
|
@@ -10185,7 +10321,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10185
10321
|
*/
|
|
10186
10322
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
10187
10323
|
/**
|
|
10188
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10324
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10325
|
+
* mails
|
|
10189
10326
|
*
|
|
10190
10327
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
10191
10328
|
* @type {boolean}
|
|
@@ -10235,6 +10372,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10235
10372
|
/**
|
|
10236
10373
|
* This flag is used to enable the full height lazy load data.
|
|
10237
10374
|
*
|
|
10375
|
+
* @type {boolean}
|
|
10376
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10377
|
+
* @default false
|
|
10238
10378
|
* @example
|
|
10239
10379
|
* ```js
|
|
10240
10380
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10243,33 +10383,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10243
10383
|
* lazyLoadingForFullHeight: true,
|
|
10244
10384
|
* })
|
|
10245
10385
|
* ```
|
|
10246
|
-
*
|
|
10247
|
-
* @type {boolean}
|
|
10248
|
-
* @default false
|
|
10249
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10250
10386
|
*/
|
|
10251
10387
|
lazyLoadingForFullHeight?: boolean;
|
|
10252
10388
|
/**
|
|
10253
10389
|
* The margin to be used for lazy loading.
|
|
10254
10390
|
*
|
|
10255
10391
|
* For example, if the margin is set to '10px',
|
|
10256
|
-
* the visualization will be loaded 10px before
|
|
10392
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
10257
10393
|
* viewport.
|
|
10258
10394
|
*
|
|
10259
10395
|
* The format is similar to CSS margin.
|
|
10260
10396
|
*
|
|
10397
|
+
* @type {string}
|
|
10398
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10261
10399
|
* @example
|
|
10262
10400
|
* ```js
|
|
10263
10401
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
10264
10402
|
* // ...other options
|
|
10265
10403
|
* fullHeight: true,
|
|
10266
10404
|
* lazyLoadingForFullHeight: true,
|
|
10267
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10405
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
10268
10406
|
* lazyLoadingMargin: '0px',
|
|
10269
10407
|
* })
|
|
10270
10408
|
* ```
|
|
10271
|
-
* @type {string}
|
|
10272
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10273
10409
|
*/
|
|
10274
10410
|
lazyLoadingMargin?: string;
|
|
10275
10411
|
/**
|
|
@@ -10277,6 +10413,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10277
10413
|
* of the spotter underneath the chat input.
|
|
10278
10414
|
* default is false.
|
|
10279
10415
|
*
|
|
10416
|
+
* @type {boolean}
|
|
10417
|
+
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10280
10418
|
* @example
|
|
10281
10419
|
* ```js
|
|
10282
10420
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10284,14 +10422,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10284
10422
|
* showSpotterLimitations: true,
|
|
10285
10423
|
* })
|
|
10286
10424
|
* ```
|
|
10287
|
-
* @type {boolean}
|
|
10288
|
-
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10289
10425
|
*/
|
|
10290
10426
|
showSpotterLimitations?: boolean;
|
|
10291
10427
|
/**
|
|
10292
10428
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
10293
10429
|
*
|
|
10294
10430
|
* Supported embed types: `LiveboardEmbed`
|
|
10431
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10295
10432
|
* @default false
|
|
10296
10433
|
* @example
|
|
10297
10434
|
* ```js
|
|
@@ -10300,7 +10437,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10300
10437
|
* updatedSpotterChatPrompt : true,
|
|
10301
10438
|
* })
|
|
10302
10439
|
* ```
|
|
10303
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10304
10440
|
*/
|
|
10305
10441
|
updatedSpotterChatPrompt?: boolean;
|
|
10306
10442
|
/**
|
|
@@ -10308,6 +10444,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10308
10444
|
* branding in tool response cards.
|
|
10309
10445
|
*
|
|
10310
10446
|
* Supported embed types: `LiveboardEmbed`
|
|
10447
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10311
10448
|
* @example
|
|
10312
10449
|
* ```js
|
|
10313
10450
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10318,7 +10455,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10318
10455
|
* },
|
|
10319
10456
|
* })
|
|
10320
10457
|
* ```
|
|
10321
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10322
10458
|
*/
|
|
10323
10459
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
10324
10460
|
}
|
|
@@ -10326,6 +10462,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10326
10462
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
10327
10463
|
* waits for the authentication to complete, so you need not wait for
|
|
10328
10464
|
* `AuthStatus.SUCCESS`.
|
|
10465
|
+
* @group Embed components
|
|
10329
10466
|
* @example
|
|
10330
10467
|
* ```js
|
|
10331
10468
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10335,7 +10472,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10335
10472
|
* // .. other params here.
|
|
10336
10473
|
* })
|
|
10337
10474
|
* ```
|
|
10338
|
-
* @group Embed components
|
|
10339
10475
|
*/
|
|
10340
10476
|
export declare class LiveboardEmbed extends V1Embed {
|
|
10341
10477
|
protected viewConfig: LiveboardViewConfig;
|
|
@@ -10455,7 +10591,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10455
10591
|
* but can be expanded manually.
|
|
10456
10592
|
*
|
|
10457
10593
|
* Supported embed types: `SearchEmbed`
|
|
10458
|
-
* @version
|
|
10594
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10459
10595
|
* @example
|
|
10460
10596
|
* ```js
|
|
10461
10597
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10470,7 +10606,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10470
10606
|
* but can be expanded manually.
|
|
10471
10607
|
*
|
|
10472
10608
|
* Supported embed types: `SearchEmbed`
|
|
10473
|
-
* @version
|
|
10609
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
10474
10610
|
* @example
|
|
10475
10611
|
* ```js
|
|
10476
10612
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10484,7 +10620,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10484
10620
|
* Show or hide the data sources panel.
|
|
10485
10621
|
*
|
|
10486
10622
|
* Supported embed types: `SearchEmbed`
|
|
10487
|
-
* @version
|
|
10623
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
10488
10624
|
* @example
|
|
10489
10625
|
* ```js
|
|
10490
10626
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10500,7 +10636,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10500
10636
|
* using raw answer data.
|
|
10501
10637
|
*
|
|
10502
10638
|
* Supported embed types: `SearchEmbed`
|
|
10503
|
-
* @version
|
|
10639
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
10504
10640
|
* @example
|
|
10505
10641
|
* ```js
|
|
10506
10642
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10529,7 +10665,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10529
10665
|
* format for presenting search data.
|
|
10530
10666
|
*
|
|
10531
10667
|
* Supported embed types: `SearchEmbed`
|
|
10532
|
-
* @version
|
|
10668
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10533
10669
|
* @example
|
|
10534
10670
|
* ```js
|
|
10535
10671
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10542,6 +10678,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10542
10678
|
/**
|
|
10543
10679
|
* The array of data source GUIDs to set on load.
|
|
10544
10680
|
* Only a single data source is supported currently.
|
|
10681
|
+
* Use {@link dataSource} instead.
|
|
10545
10682
|
* @deprecated Use `dataSource` instead.
|
|
10546
10683
|
*
|
|
10547
10684
|
* Supported embed types: `SearchEmbed`
|
|
@@ -10555,10 +10692,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10555
10692
|
*/
|
|
10556
10693
|
dataSources?: string[];
|
|
10557
10694
|
/**
|
|
10558
|
-
* The
|
|
10695
|
+
* The data source GUID to set on load.
|
|
10559
10696
|
*
|
|
10560
10697
|
* Supported embed types: `SearchEmbed`
|
|
10561
|
-
* @version
|
|
10698
|
+
* @version SDK: 1.19.0
|
|
10562
10699
|
* @example
|
|
10563
10700
|
* ```js
|
|
10564
10701
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10570,9 +10707,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10570
10707
|
dataSource?: string;
|
|
10571
10708
|
/**
|
|
10572
10709
|
* The initial search query to load the answer with.
|
|
10710
|
+
* Use {@link searchOptions} instead.
|
|
10573
10711
|
* @deprecated
|
|
10574
10712
|
*
|
|
10575
|
-
* Use {@link searchOptions} instead.
|
|
10576
10713
|
*/
|
|
10577
10714
|
searchQuery?: string;
|
|
10578
10715
|
/**
|
|
@@ -10601,7 +10738,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10601
10738
|
* If set to true, the search token string is not appended to the URL.
|
|
10602
10739
|
*
|
|
10603
10740
|
* Supported embed types: `SearchEmbed`
|
|
10604
|
-
* @version
|
|
10741
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
10605
10742
|
* @example
|
|
10606
10743
|
* ```js
|
|
10607
10744
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10618,7 +10755,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10618
10755
|
* The GUID of a saved answer to load initially.
|
|
10619
10756
|
*
|
|
10620
10757
|
* Supported embed types: `SearchEmbed`
|
|
10621
|
-
* @version
|
|
10758
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10622
10759
|
* @example
|
|
10623
10760
|
* ```js
|
|
10624
10761
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -10647,14 +10784,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
10647
10784
|
* Flag to set if last selected dataSource should be used
|
|
10648
10785
|
*
|
|
10649
10786
|
* Supported embed types: `SearchEmbed`
|
|
10650
|
-
* @version
|
|
10787
|
+
* @version SDK: 1.24.0
|
|
10651
10788
|
*/
|
|
10652
10789
|
useLastSelectedSources?: boolean;
|
|
10653
10790
|
/**
|
|
10654
10791
|
* To set the initial state of the search bar in case of saved-answers.
|
|
10655
|
-
* @default false
|
|
10656
10792
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10657
10793
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
10794
|
+
* @default false
|
|
10658
10795
|
*/
|
|
10659
10796
|
collapseSearchBarInitially?: boolean;
|
|
10660
10797
|
/**
|
|
@@ -10742,8 +10879,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10742
10879
|
* Only a single data source is supported currently.
|
|
10743
10880
|
*
|
|
10744
10881
|
* Supported embed types: `SearchBarEmbed`
|
|
10882
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
10745
10883
|
* @deprecated Use `dataSource` instead
|
|
10746
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
10747
10884
|
* @example
|
|
10748
10885
|
* ```js
|
|
10749
10886
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10757,7 +10894,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10757
10894
|
* Pass the ID of the source to be selected.
|
|
10758
10895
|
*
|
|
10759
10896
|
* Supported embed types: `SearchBarEmbed`
|
|
10760
|
-
* @version
|
|
10897
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
10761
10898
|
* @example
|
|
10762
10899
|
* ```js
|
|
10763
10900
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10771,7 +10908,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10771
10908
|
* Boolean to define if the last selected data source should be used
|
|
10772
10909
|
*
|
|
10773
10910
|
* Supported embed types: `SearchBarEmbed`
|
|
10774
|
-
* @version
|
|
10911
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
|
|
10775
10912
|
* @example
|
|
10776
10913
|
* ```js
|
|
10777
10914
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10793,7 +10930,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10793
10930
|
* the token string in the search bar.
|
|
10794
10931
|
*
|
|
10795
10932
|
* Supported embed types: `SearchBarEmbed`
|
|
10796
|
-
* @version
|
|
10933
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
10797
10934
|
* @example
|
|
10798
10935
|
* ```js
|
|
10799
10936
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -10811,10 +10948,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10811
10948
|
* If set to true, the search token string is not appended to the URL.
|
|
10812
10949
|
*
|
|
10813
10950
|
* Supported embed types: `SearchBarEmbed`
|
|
10814
|
-
* @version
|
|
10951
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
10815
10952
|
* @example
|
|
10816
10953
|
* ```js
|
|
10817
|
-
* const embed = new
|
|
10954
|
+
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
10818
10955
|
* searchOptions: {
|
|
10819
10956
|
* searchTokenString: '[quantity purchased] [region]',
|
|
10820
10957
|
* executeSearch: true,
|
|
@@ -10830,7 +10967,7 @@ interface SearchAppInitData$1 extends DefaultAppInitData {
|
|
|
10830
10967
|
}
|
|
10831
10968
|
/**
|
|
10832
10969
|
* Embed ThoughtSpot search bar
|
|
10833
|
-
* @version
|
|
10970
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
10834
10971
|
* @group Embed components
|
|
10835
10972
|
*/
|
|
10836
10973
|
export declare class SearchBarEmbed extends TsEmbed {
|
|
@@ -10868,8 +11005,8 @@ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, "prima
|
|
|
10868
11005
|
}
|
|
10869
11006
|
/**
|
|
10870
11007
|
* Configuration for conversation options.
|
|
10871
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10872
11008
|
* Use {@link SpotterAgentEmbedViewConfig} instead
|
|
11009
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10873
11010
|
* @group Embed components
|
|
10874
11011
|
*/
|
|
10875
11012
|
export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
|
|
@@ -10892,6 +11029,8 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
10892
11029
|
/**
|
|
10893
11030
|
* Create a conversation embed, which can be integrated inside
|
|
10894
11031
|
* chatbots or other conversational interfaces.
|
|
11032
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
11033
|
+
* @group Embed components
|
|
10895
11034
|
* @example
|
|
10896
11035
|
* ```js
|
|
10897
11036
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10905,8 +11044,6 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
10905
11044
|
* // append the container to the DOM
|
|
10906
11045
|
* document.body.appendChild(container); // or to any other element
|
|
10907
11046
|
* ```
|
|
10908
|
-
* @group Embed components
|
|
10909
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
10910
11047
|
*/
|
|
10911
11048
|
export declare class SpotterAgentEmbed {
|
|
10912
11049
|
private viewConfig;
|
|
@@ -10944,8 +11081,9 @@ export declare class SpotterAgentEmbed {
|
|
|
10944
11081
|
/**
|
|
10945
11082
|
* Create a conversation embed, which can be integrated inside
|
|
10946
11083
|
* chatbots or other conversational interfaces.
|
|
10947
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10948
11084
|
* Use {@link SpotterAgentEmbed} instead
|
|
11085
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
11086
|
+
* @group Embed components
|
|
10949
11087
|
* @example
|
|
10950
11088
|
* ```js
|
|
10951
11089
|
* import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -10959,7 +11097,6 @@ export declare class SpotterAgentEmbed {
|
|
|
10959
11097
|
* // append the container to the DOM
|
|
10960
11098
|
* document.body.appendChild(container); // or to any other element
|
|
10961
11099
|
* ```
|
|
10962
|
-
* @group Embed components
|
|
10963
11100
|
*/
|
|
10964
11101
|
export declare class BodylessConversation extends SpotterAgentEmbed {
|
|
10965
11102
|
constructor(viewConfig: BodylessConversationViewConfig);
|
|
@@ -11004,7 +11141,7 @@ interface SearchOptions$2 {
|
|
|
11004
11141
|
/**
|
|
11005
11142
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
11006
11143
|
* GPT and LLM.
|
|
11007
|
-
* @version
|
|
11144
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
11008
11145
|
*
|
|
11009
11146
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
11010
11147
|
* @group Embed components
|
|
@@ -11058,14 +11195,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
11058
11195
|
hideAutocompleteSuggestions?: boolean;
|
|
11059
11196
|
/**
|
|
11060
11197
|
* Show or hide autocomplete suggestions for the search query string.
|
|
11198
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
11061
11199
|
* @deprecated
|
|
11062
11200
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
11063
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
11064
11201
|
*/
|
|
11065
11202
|
showObjectSuggestions?: boolean;
|
|
11066
11203
|
/**
|
|
11067
11204
|
* Show or hide sample questions.
|
|
11068
|
-
* The sample questions are autogenerated based on the data
|
|
11205
|
+
* The sample questions are autogenerated based on the data model
|
|
11069
11206
|
* selected for the search operation.
|
|
11070
11207
|
*
|
|
11071
11208
|
* Supported embed types: `SageEmbed`
|
|
@@ -11095,6 +11232,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
11095
11232
|
* the token string in the search bar.
|
|
11096
11233
|
*
|
|
11097
11234
|
* Supported embed types: `SageEmbed`
|
|
11235
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
11098
11236
|
* @example
|
|
11099
11237
|
* ```js
|
|
11100
11238
|
* searchOptions: {
|
|
@@ -11102,13 +11240,12 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
11102
11240
|
* executeSearch: true,
|
|
11103
11241
|
* }
|
|
11104
11242
|
* ```
|
|
11105
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
11106
11243
|
*/
|
|
11107
11244
|
searchOptions?: SearchOptions$2;
|
|
11108
11245
|
}
|
|
11109
11246
|
/**
|
|
11110
11247
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
11111
|
-
* @version
|
|
11248
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
11112
11249
|
*
|
|
11113
11250
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
11114
11251
|
* @group Embed components
|
|
@@ -11223,7 +11360,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
|
|
|
11223
11360
|
* tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
|
|
11224
11361
|
* // .. fetch options ..
|
|
11225
11362
|
* });
|
|
11226
|
-
|
|
11363
|
+
* ```
|
|
11227
11364
|
* @version SDK: 1.28.0
|
|
11228
11365
|
* @group Global methods
|
|
11229
11366
|
*/
|
|
@@ -11282,6 +11419,45 @@ export declare const createLiveboardWithAnswers: (answers: AnswerService[], name
|
|
|
11282
11419
|
* @group Authentication / Init
|
|
11283
11420
|
*/
|
|
11284
11421
|
export declare const resetCachedAuthToken: () => void;
|
|
11422
|
+
/**
|
|
11423
|
+
* Starts an automatic renderer that watches the DOM for iframes containing
|
|
11424
|
+
* the `tsmcp=true` query parameter and replaces them with fully configured
|
|
11425
|
+
* ThoughtSpot embed iframes. The query parameter is automatically added by
|
|
11426
|
+
* the ThoughtSpot MCP server.
|
|
11427
|
+
*
|
|
11428
|
+
* A {@link MutationObserver} is set up on `document.body` to detect both
|
|
11429
|
+
* directly added iframes and iframes nested within added container elements.
|
|
11430
|
+
* Each matching iframe is replaced in-place with a new ThoughtSpot embed
|
|
11431
|
+
* iframe that merges the original iframe's query parameters with the SDK
|
|
11432
|
+
* embed parameters.
|
|
11433
|
+
*
|
|
11434
|
+
* Call {@link MutationObserver.disconnect | observer.disconnect()} on the
|
|
11435
|
+
* returned observer to stop monitoring the DOM.
|
|
11436
|
+
*
|
|
11437
|
+
* @param viewConfig - Optional configuration for the auto-rendered embeds.
|
|
11438
|
+
* Accepts all properties from {@link AutoMCPFrameRendererViewConfig}.
|
|
11439
|
+
* Defaults to an empty config.
|
|
11440
|
+
* @returns A {@link MutationObserver} instance that is actively observing
|
|
11441
|
+
* `document.body`. Disconnect it when monitoring is no longer needed.
|
|
11442
|
+
*
|
|
11443
|
+
* @example
|
|
11444
|
+
* ```js
|
|
11445
|
+
* import { startAutoMCPFrameRenderer } from '@thoughtspot/visual-embed-sdk';
|
|
11446
|
+
*
|
|
11447
|
+
* // Start watching the DOM for tsmcp iframes
|
|
11448
|
+
* const observer = startAutoMCPFrameRenderer({
|
|
11449
|
+
* // optional view config overrides
|
|
11450
|
+
* });
|
|
11451
|
+
*
|
|
11452
|
+
* // Later, stop watching
|
|
11453
|
+
* observer.disconnect();
|
|
11454
|
+
* ```
|
|
11455
|
+
*
|
|
11456
|
+
* @example
|
|
11457
|
+
* Detailed example of how to use the auto-frame renderer:
|
|
11458
|
+
* [Python React Agent Simple UI](https://github.com/thoughtspot/developer-examples/tree/main/mcp/python-react-agent-simple-ui)
|
|
11459
|
+
*/
|
|
11460
|
+
export declare function startAutoMCPFrameRenderer(viewConfig?: AutoMCPFrameRendererViewConfig): MutationObserver;
|
|
11285
11461
|
|
|
11286
11462
|
export {
|
|
11287
11463
|
getEmbedConfig as getInitConfig,
|