@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
|
@@ -428,37 +428,37 @@ export interface CustomCssVariables {
|
|
|
428
428
|
/**
|
|
429
429
|
* Padding of the groups in the Liveboard.
|
|
430
430
|
*
|
|
431
|
-
* Please enable the Liveboard
|
|
431
|
+
* 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.
|
|
432
432
|
*/
|
|
433
433
|
"--ts-var-liveboard-group-padding"?: string;
|
|
434
434
|
/**
|
|
435
435
|
* Font size of the title of the groups in the Liveboard.
|
|
436
436
|
*
|
|
437
|
-
* Please enable the Liveboard
|
|
437
|
+
* 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.
|
|
438
438
|
*/
|
|
439
439
|
"--ts-var-liveboard-group-title-font-size"?: string;
|
|
440
440
|
/**
|
|
441
441
|
* Font weight of the title of the groups in the Liveboard.
|
|
442
442
|
*
|
|
443
|
-
* Please enable the Liveboard
|
|
443
|
+
* 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.
|
|
444
444
|
*/
|
|
445
445
|
"--ts-var-liveboard-group-title-font-weight"?: string;
|
|
446
446
|
/**
|
|
447
447
|
* Font size of the title of the tiles inside the groups in the Liveboard.
|
|
448
448
|
*
|
|
449
|
-
* Please enable the Liveboard
|
|
449
|
+
* 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.
|
|
450
450
|
*/
|
|
451
451
|
"--ts-var-liveboard-group-tile-title-font-size"?: string;
|
|
452
452
|
/**
|
|
453
453
|
* Font weight of the title of the tiles inside the groups in the Liveboard.
|
|
454
454
|
*
|
|
455
|
-
* Please enable the Liveboard
|
|
455
|
+
* 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.
|
|
456
456
|
*/
|
|
457
457
|
"--ts-var-liveboard-group-tile-title-font-weight"?: string;
|
|
458
458
|
/**
|
|
459
459
|
* Padding of the group tiles in the Liveboard.
|
|
460
460
|
*
|
|
461
|
-
* Please enable the Liveboard
|
|
461
|
+
* 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.
|
|
462
462
|
*/
|
|
463
463
|
"--ts-var-liveboard-group-tile-padding"?: string;
|
|
464
464
|
/**
|
|
@@ -468,13 +468,13 @@ export interface CustomCssVariables {
|
|
|
468
468
|
/**
|
|
469
469
|
* Background color of the groups in the Liveboard.
|
|
470
470
|
*
|
|
471
|
-
* Please enable the Liveboard
|
|
471
|
+
* 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.
|
|
472
472
|
*/
|
|
473
473
|
"--ts-var-liveboard-group-background"?: string;
|
|
474
474
|
/**
|
|
475
475
|
* Border color of the groups in the Liveboard.
|
|
476
476
|
*
|
|
477
|
-
* Please enable the Liveboard
|
|
477
|
+
* 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.
|
|
478
478
|
*/
|
|
479
479
|
"--ts-var-liveboard-group-border-color"?: string;
|
|
480
480
|
/**
|
|
@@ -488,55 +488,55 @@ export interface CustomCssVariables {
|
|
|
488
488
|
/**
|
|
489
489
|
* Font color of the title of the groups in the Liveboard.
|
|
490
490
|
*
|
|
491
|
-
* Please enable the Liveboard
|
|
491
|
+
* 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.
|
|
492
492
|
*/
|
|
493
493
|
"--ts-var-liveboard-group-title-font-color"?: string;
|
|
494
494
|
/**
|
|
495
495
|
* Font color of the description of the groups in the Liveboard.
|
|
496
496
|
*
|
|
497
|
-
* Please enable the Liveboard
|
|
497
|
+
* 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.
|
|
498
498
|
*/
|
|
499
499
|
"--ts-var-liveboard-group-description-font-color"?: string;
|
|
500
500
|
/**
|
|
501
501
|
* Font color of the title of the tiles inside the groups in the Liveboard.
|
|
502
502
|
*
|
|
503
|
-
* Please enable the Liveboard
|
|
503
|
+
* 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.
|
|
504
504
|
*/
|
|
505
505
|
"--ts-var-liveboard-group-tile-title-font-color"?: string;
|
|
506
506
|
/**
|
|
507
507
|
* Font color of the description of the tiles inside the groups in the Liveboard.
|
|
508
508
|
*
|
|
509
|
-
* Please enable the Liveboard
|
|
509
|
+
* 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.
|
|
510
510
|
*/
|
|
511
511
|
"--ts-var-liveboard-group-tile-description-font-color"?: string;
|
|
512
512
|
/**
|
|
513
513
|
* Background color of the tiles inside the groups in the Liveboard.
|
|
514
514
|
*
|
|
515
|
-
* Please enable the Liveboard
|
|
515
|
+
* 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.
|
|
516
516
|
*/
|
|
517
517
|
"--ts-var-liveboard-group-tile-background"?: string;
|
|
518
518
|
/**
|
|
519
519
|
* Background color of the filter chips in the Liveboard.
|
|
520
520
|
*
|
|
521
|
-
* Please enable the Liveboard
|
|
521
|
+
* 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.
|
|
522
522
|
*/
|
|
523
523
|
"--ts-var-liveboard-chip-background"?: string;
|
|
524
524
|
/**
|
|
525
525
|
* Font color of the filter chips in the Liveboard.
|
|
526
526
|
*
|
|
527
|
-
* Please enable the Liveboard
|
|
527
|
+
* 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.
|
|
528
528
|
*/
|
|
529
529
|
"--ts-var-liveboard-chip-color"?: string;
|
|
530
530
|
/**
|
|
531
531
|
* Background color of the filter chips in the Liveboard on hover.
|
|
532
532
|
*
|
|
533
|
-
* Please enable the Liveboard
|
|
533
|
+
* 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.
|
|
534
534
|
*/
|
|
535
535
|
"--ts-var-liveboard-chip--hover-background"?: string;
|
|
536
536
|
/**
|
|
537
537
|
* Background color of the filter chips in the Liveboard on active.
|
|
538
538
|
*
|
|
539
|
-
* Please enable the Liveboard
|
|
539
|
+
* 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.
|
|
540
540
|
*/
|
|
541
541
|
"--ts-var-liveboard-chip--active-background"?: string;
|
|
542
542
|
/**
|
|
@@ -809,6 +809,7 @@ declare class AnswerService {
|
|
|
809
809
|
* ]);
|
|
810
810
|
* console.log(await service.fetchData());
|
|
811
811
|
* });
|
|
812
|
+
* ```
|
|
812
813
|
*/
|
|
813
814
|
addColumnsByName(columnNames: string[]): Promise<any>;
|
|
814
815
|
/**
|
|
@@ -880,7 +881,7 @@ declare class AnswerService {
|
|
|
880
881
|
* const data = await underlying.fetchData(0, 100);
|
|
881
882
|
* })
|
|
882
883
|
* ```
|
|
883
|
-
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
884
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
|
|
884
885
|
*/
|
|
885
886
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
886
887
|
/**
|
|
@@ -921,6 +922,7 @@ declare enum AuthType {
|
|
|
921
922
|
* To use this:
|
|
922
923
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
923
924
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
925
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
924
926
|
* @example
|
|
925
927
|
* ```js
|
|
926
928
|
* init({
|
|
@@ -928,18 +930,17 @@ declare enum AuthType {
|
|
|
928
930
|
* authType: AuthType.EmbeddedSSO,
|
|
929
931
|
* });
|
|
930
932
|
* ```
|
|
931
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
932
933
|
*/
|
|
933
934
|
EmbeddedSSO = "EmbeddedSSO",
|
|
934
935
|
/**
|
|
935
|
-
* SSO using SAML
|
|
936
|
-
* @deprecated
|
|
936
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
937
|
+
* @deprecated This option is deprecated.
|
|
937
938
|
* @hidden
|
|
938
939
|
*/
|
|
939
940
|
SSO = "SSO_SAML",
|
|
940
941
|
/**
|
|
941
|
-
* SSO using SAML
|
|
942
|
-
* @deprecated
|
|
942
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
943
|
+
* @deprecated This option is deprecated.
|
|
943
944
|
* @hidden
|
|
944
945
|
*/
|
|
945
946
|
SAML = "SSO_SAML",
|
|
@@ -990,8 +991,9 @@ declare enum AuthType {
|
|
|
990
991
|
SAMLRedirect = "SSO_SAML",
|
|
991
992
|
/**
|
|
992
993
|
* SSO using OIDC
|
|
994
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
995
|
+
* @deprecated This option is deprecated.
|
|
993
996
|
* @hidden
|
|
994
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
995
997
|
*/
|
|
996
998
|
OIDC = "SSO_OIDC",
|
|
997
999
|
/**
|
|
@@ -1002,8 +1004,9 @@ declare enum AuthType {
|
|
|
1002
1004
|
OIDCRedirect = "SSO_OIDC",
|
|
1003
1005
|
/**
|
|
1004
1006
|
* Trusted authentication server
|
|
1007
|
+
* Use {@link TrustedAuth} instead
|
|
1008
|
+
* @deprecated This option is deprecated.
|
|
1005
1009
|
* @hidden
|
|
1006
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
1007
1010
|
*/
|
|
1008
1011
|
AuthServer = "AuthServer",
|
|
1009
1012
|
/**
|
|
@@ -1030,6 +1033,7 @@ declare enum AuthType {
|
|
|
1030
1033
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1031
1034
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1032
1035
|
* implemented by some browsers.
|
|
1036
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1033
1037
|
* @example
|
|
1034
1038
|
* ```js
|
|
1035
1039
|
* init({
|
|
@@ -1040,8 +1044,8 @@ declare enum AuthType {
|
|
|
1040
1044
|
* .then((response) => response.json())
|
|
1041
1045
|
* .then((data) => data.token);
|
|
1042
1046
|
* }
|
|
1047
|
+
* });
|
|
1043
1048
|
* ```
|
|
1044
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1045
1049
|
*/
|
|
1046
1050
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1047
1051
|
/**
|
|
@@ -1061,43 +1065,43 @@ export declare enum HomeLeftNavItem {
|
|
|
1061
1065
|
/**
|
|
1062
1066
|
* The *Search data* option in
|
|
1063
1067
|
* the *Insights* left navigation panel.
|
|
1064
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1068
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1065
1069
|
*/
|
|
1066
1070
|
SearchData = "search-data",
|
|
1067
1071
|
/**
|
|
1068
1072
|
* The *Home* menu option in
|
|
1069
1073
|
* the *Insights* left navigation panel.
|
|
1070
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1074
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1071
1075
|
*/
|
|
1072
1076
|
Home = "insights-home",
|
|
1073
1077
|
/**
|
|
1074
1078
|
* The *Liveboards* menu option in
|
|
1075
1079
|
* the *Insights* left navigation panel.
|
|
1076
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1080
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1077
1081
|
*/
|
|
1078
1082
|
Liveboards = "liveboards",
|
|
1079
1083
|
/**
|
|
1080
1084
|
* The *Answers* menu option in
|
|
1081
1085
|
* the *Insights* left navigation panel.
|
|
1082
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1086
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1083
1087
|
*/
|
|
1084
1088
|
Answers = "answers",
|
|
1085
1089
|
/**
|
|
1086
1090
|
* The *Monitor subscriptions* menu option in
|
|
1087
1091
|
* the *Insights* left navigation panel.
|
|
1088
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1092
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1089
1093
|
*/
|
|
1090
1094
|
MonitorSubscription = "monitor-alerts",
|
|
1091
1095
|
/**
|
|
1092
1096
|
* The *SpotIQ analysis* menu option in
|
|
1093
1097
|
* the *Insights* left navigation panel.
|
|
1094
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
1098
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1095
1099
|
*/
|
|
1096
1100
|
SpotIQAnalysis = "spotiq-analysis",
|
|
1097
1101
|
/**
|
|
1098
1102
|
* The *Liveboard schedules* menu option in
|
|
1099
1103
|
* the *Insights* left navigation panel.
|
|
1100
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
1104
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1101
1105
|
*/
|
|
1102
1106
|
LiveboardSchedules = "liveboard-schedules",
|
|
1103
1107
|
/**
|
|
@@ -1268,8 +1272,8 @@ export interface EmbedConfig {
|
|
|
1268
1272
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1269
1273
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1270
1274
|
* place.
|
|
1275
|
+
* @deprecated This option is deprecated.
|
|
1271
1276
|
* @default false
|
|
1272
|
-
* @deprecated
|
|
1273
1277
|
*/
|
|
1274
1278
|
noRedirect?: boolean;
|
|
1275
1279
|
/**
|
|
@@ -1278,8 +1282,8 @@ export interface EmbedConfig {
|
|
|
1278
1282
|
*
|
|
1279
1283
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1280
1284
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1281
|
-
* @default false
|
|
1282
1285
|
* @version SDK: 1.18.0
|
|
1286
|
+
* @default false
|
|
1283
1287
|
*/
|
|
1284
1288
|
inPopup?: boolean;
|
|
1285
1289
|
/**
|
|
@@ -1288,7 +1292,7 @@ export interface EmbedConfig {
|
|
|
1288
1292
|
* terminated.
|
|
1289
1293
|
*
|
|
1290
1294
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1291
|
-
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1295
|
+
* @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1292
1296
|
*/
|
|
1293
1297
|
redirectPath?: string;
|
|
1294
1298
|
/** @internal */
|
|
@@ -1361,7 +1365,7 @@ export interface EmbedConfig {
|
|
|
1361
1365
|
detectCookieAccessSlow?: boolean;
|
|
1362
1366
|
/**
|
|
1363
1367
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1364
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1368
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1365
1369
|
*/
|
|
1366
1370
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1367
1371
|
/**
|
|
@@ -1378,6 +1382,7 @@ export interface EmbedConfig {
|
|
|
1378
1382
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1379
1383
|
* button that the user can click to trigger the flow.
|
|
1380
1384
|
* This attribute sets a containing element for that button.
|
|
1385
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1381
1386
|
* @example
|
|
1382
1387
|
* ```js
|
|
1383
1388
|
* init({
|
|
@@ -1386,7 +1391,6 @@ export interface EmbedConfig {
|
|
|
1386
1391
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1387
1392
|
* })
|
|
1388
1393
|
* ```
|
|
1389
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1390
1394
|
*/
|
|
1391
1395
|
authTriggerContainer?: string | HTMLElement;
|
|
1392
1396
|
/**
|
|
@@ -1403,11 +1407,10 @@ export interface EmbedConfig {
|
|
|
1403
1407
|
*/
|
|
1404
1408
|
authTriggerText?: string;
|
|
1405
1409
|
/**
|
|
1406
|
-
* Prevent users from accessing
|
|
1407
|
-
*
|
|
1408
|
-
* outside of the iframe.
|
|
1409
|
-
* @default true
|
|
1410
|
+
* Prevent embedded application users from accessing ThoughtSpot
|
|
1411
|
+
* application pages outside of the iframe.
|
|
1410
1412
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1413
|
+
* @default true
|
|
1411
1414
|
*/
|
|
1412
1415
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1413
1416
|
/**
|
|
@@ -1437,6 +1440,7 @@ export interface EmbedConfig {
|
|
|
1437
1440
|
* other logs such as warnings, information alerts,
|
|
1438
1441
|
* and debug messages in the console output.
|
|
1439
1442
|
*
|
|
1443
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1440
1444
|
* @default LogLevel.ERROR
|
|
1441
1445
|
* @example
|
|
1442
1446
|
* ```js
|
|
@@ -1445,7 +1449,6 @@ export interface EmbedConfig {
|
|
|
1445
1449
|
* logLevel: LogLevel.SILENT
|
|
1446
1450
|
* })
|
|
1447
1451
|
* ```
|
|
1448
|
-
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
1449
1452
|
*/
|
|
1450
1453
|
logLevel?: LogLevel;
|
|
1451
1454
|
/**
|
|
@@ -1472,6 +1475,7 @@ export interface EmbedConfig {
|
|
|
1472
1475
|
* This flag is used to disable the token verification in the SDK.
|
|
1473
1476
|
* Enabling this flag will also disable the caching of the token.
|
|
1474
1477
|
* @hidden
|
|
1478
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1475
1479
|
* @example
|
|
1476
1480
|
* ```js
|
|
1477
1481
|
* init({
|
|
@@ -1479,12 +1483,11 @@ export interface EmbedConfig {
|
|
|
1479
1483
|
* disableTokenVerification : true
|
|
1480
1484
|
* })
|
|
1481
1485
|
* ```
|
|
1482
|
-
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
1483
1486
|
*/
|
|
1484
1487
|
disableTokenVerification?: boolean;
|
|
1485
1488
|
/**
|
|
1486
1489
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
1487
|
-
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1490
|
+
* @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
1488
1491
|
*/
|
|
1489
1492
|
disableLoginFailurePage?: boolean;
|
|
1490
1493
|
/**
|
|
@@ -1494,6 +1497,7 @@ export interface EmbedConfig {
|
|
|
1494
1497
|
* Warning: This option is for advanced use only and is used internally
|
|
1495
1498
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1496
1499
|
* list of supported keys and values associated with each.
|
|
1500
|
+
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1497
1501
|
* @example
|
|
1498
1502
|
* ```js
|
|
1499
1503
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1504,7 +1508,6 @@ export interface EmbedConfig {
|
|
|
1504
1508
|
* }
|
|
1505
1509
|
* });
|
|
1506
1510
|
* ```
|
|
1507
|
-
* @version SDK: 1.33.5 | ThoughtSpot: *
|
|
1508
1511
|
*/
|
|
1509
1512
|
additionalFlags?: {
|
|
1510
1513
|
[key: string]: string | number | boolean;
|
|
@@ -1512,6 +1515,7 @@ export interface EmbedConfig {
|
|
|
1512
1515
|
/**
|
|
1513
1516
|
* This is an object (key/val) for customVariables being
|
|
1514
1517
|
* used by the third party tool's script.
|
|
1518
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1515
1519
|
* @example
|
|
1516
1520
|
* ```js
|
|
1517
1521
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1522,15 +1526,14 @@ export interface EmbedConfig {
|
|
|
1522
1526
|
* }
|
|
1523
1527
|
* });
|
|
1524
1528
|
* ```
|
|
1525
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1526
1529
|
*/
|
|
1527
1530
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
1528
1531
|
disablePreauthCache?: boolean;
|
|
1529
1532
|
/**
|
|
1530
1533
|
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
1531
1534
|
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
1532
|
-
* @default true (feature is disabled by default)
|
|
1533
1535
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1536
|
+
* @default true (feature is disabled by default)
|
|
1534
1537
|
* @example
|
|
1535
1538
|
* ```js
|
|
1536
1539
|
* init({
|
|
@@ -1736,7 +1739,7 @@ export interface FrameParams {
|
|
|
1736
1739
|
*/
|
|
1737
1740
|
loading?: "lazy" | "eager" | "auto";
|
|
1738
1741
|
/**
|
|
1739
|
-
*
|
|
1742
|
+
* These parameters will be passed to the iframe
|
|
1740
1743
|
* as is.
|
|
1741
1744
|
*/
|
|
1742
1745
|
[key: string]: string | number | boolean | undefined;
|
|
@@ -1811,8 +1814,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1811
1814
|
*/
|
|
1812
1815
|
disabledActionReason?: string;
|
|
1813
1816
|
/**
|
|
1814
|
-
* The list of actions to hide from the embedded.
|
|
1815
|
-
*
|
|
1817
|
+
* The list of actions to hide from the embedded view.
|
|
1818
|
+
* These actions will be hidden from the user.
|
|
1816
1819
|
* Use this to hide an action.
|
|
1817
1820
|
*
|
|
1818
1821
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
@@ -1853,7 +1856,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1853
1856
|
* The locale settings to apply to the embedded view.
|
|
1854
1857
|
*
|
|
1855
1858
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1856
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
1859
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1857
1860
|
* @example
|
|
1858
1861
|
* ```js
|
|
1859
1862
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1868,12 +1871,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1868
1871
|
* This is an object (key/val) of override flags which will be applied
|
|
1869
1872
|
* to the internal embedded object. This can be used to add any
|
|
1870
1873
|
* URL flag.
|
|
1871
|
-
* If the same flags are passed in init, they will be
|
|
1874
|
+
* If the same flags are passed in init, they will be overridden by the values here.
|
|
1872
1875
|
* Warning: This option is for advanced use only and is used internally
|
|
1873
1876
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1874
1877
|
* list of supported keys and values associated with each.
|
|
1875
1878
|
*
|
|
1876
1879
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1880
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1877
1881
|
* @example
|
|
1878
1882
|
* ```js
|
|
1879
1883
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1885,7 +1889,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1885
1889
|
* },
|
|
1886
1890
|
* });
|
|
1887
1891
|
* ```
|
|
1888
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1889
1892
|
*/
|
|
1890
1893
|
additionalFlags?: {
|
|
1891
1894
|
[key: string]: string | number | boolean;
|
|
@@ -1928,6 +1931,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1928
1931
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1929
1932
|
*
|
|
1930
1933
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1934
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1931
1935
|
* @example
|
|
1932
1936
|
* ```js
|
|
1933
1937
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1937,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1937
1941
|
* });
|
|
1938
1942
|
* embed.showPreRender();
|
|
1939
1943
|
* ```
|
|
1940
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1941
1944
|
*/
|
|
1942
1945
|
preRenderId?: string;
|
|
1943
1946
|
/**
|
|
@@ -1947,7 +1950,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1947
1950
|
* its dimensions based on changes to the size of the embedding element.
|
|
1948
1951
|
* @type {boolean}
|
|
1949
1952
|
* @default false
|
|
1950
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
1953
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
1951
1954
|
* @example
|
|
1952
1955
|
* ```js
|
|
1953
1956
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1962,9 +1965,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1962
1965
|
doNotTrackPreRenderSize?: boolean;
|
|
1963
1966
|
/**
|
|
1964
1967
|
* Enable the V2 shell. This can provide performance benefits
|
|
1965
|
-
* due to a
|
|
1968
|
+
* due to a lighter-weight shell.
|
|
1966
1969
|
*
|
|
1967
1970
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1971
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1968
1972
|
* @example
|
|
1969
1973
|
* ```js
|
|
1970
1974
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -1973,7 +1977,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1973
1977
|
* enableV2Shell_experimental: true,
|
|
1974
1978
|
* });
|
|
1975
1979
|
* ```
|
|
1976
|
-
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1977
1980
|
*/
|
|
1978
1981
|
enableV2Shell_experimental?: boolean;
|
|
1979
1982
|
/**
|
|
@@ -1992,6 +1995,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1992
1995
|
* and disable redirection of links in a new tab.
|
|
1993
1996
|
*
|
|
1994
1997
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1998
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1995
1999
|
* @example
|
|
1996
2000
|
* ```js
|
|
1997
2001
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2000,7 +2004,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2000
2004
|
* disableRedirectionLinksInNewTab: true,
|
|
2001
2005
|
* });
|
|
2002
2006
|
* ```
|
|
2003
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2004
2007
|
*/
|
|
2005
2008
|
disableRedirectionLinksInNewTab?: boolean;
|
|
2006
2009
|
/**
|
|
@@ -2011,6 +2014,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2011
2014
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
2012
2015
|
*
|
|
2013
2016
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2017
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2014
2018
|
* @example
|
|
2015
2019
|
* ```js
|
|
2016
2020
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2019,24 +2023,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2019
2023
|
* overrideOrgId: 142536,
|
|
2020
2024
|
* });
|
|
2021
2025
|
* ```
|
|
2022
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2023
2026
|
*/
|
|
2024
2027
|
overrideOrgId?: number;
|
|
2025
2028
|
/**
|
|
2026
|
-
* Flag to override the *Open Link in New Tab* context
|
|
2029
|
+
* Flag to override the *Open Link in New Tab* context
|
|
2030
|
+
* menu option.
|
|
2027
2031
|
*
|
|
2028
|
-
*
|
|
2032
|
+
* For improved link override handling, use
|
|
2033
|
+
* {@link enableLinkOverridesV2} instead.
|
|
2034
|
+
*
|
|
2035
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2036
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2037
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2029
2038
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2030
2039
|
* @example
|
|
2031
2040
|
* ```js
|
|
2032
|
-
*
|
|
2033
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2041
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2034
2042
|
* ... // other embed view config
|
|
2035
|
-
* linkOverride:
|
|
2043
|
+
* linkOverride: true,
|
|
2036
2044
|
* })
|
|
2037
2045
|
* ```
|
|
2038
2046
|
*/
|
|
2039
2047
|
linkOverride?: boolean;
|
|
2048
|
+
/**
|
|
2049
|
+
* Enables the V2 link override mechanism with improved
|
|
2050
|
+
* handling. When enabled, navigation links within the
|
|
2051
|
+
* embedded ThoughtSpot app are intercepted and routed
|
|
2052
|
+
* through the SDK via the `EmbedEvent.DialogOpen`
|
|
2053
|
+
* event.
|
|
2054
|
+
*
|
|
2055
|
+
* The SDK automatically sends {@link linkOverride}
|
|
2056
|
+
* alongside this flag for backward compatibility with
|
|
2057
|
+
* older ThoughtSpot versions.
|
|
2058
|
+
*
|
|
2059
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2060
|
+
* `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2061
|
+
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2062
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
2063
|
+
* @example
|
|
2064
|
+
* ```js
|
|
2065
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2066
|
+
* ... // other embed view config
|
|
2067
|
+
* enableLinkOverridesV2: true,
|
|
2068
|
+
* });
|
|
2069
|
+
*
|
|
2070
|
+
* embed.on(EmbedEvent.DialogOpen, (payload) => {
|
|
2071
|
+
* console.log('Link clicked:', payload);
|
|
2072
|
+
* });
|
|
2073
|
+
* ```
|
|
2074
|
+
*/
|
|
2075
|
+
enableLinkOverridesV2?: boolean;
|
|
2040
2076
|
/**
|
|
2041
2077
|
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2042
2078
|
* Use this to set the primary action.
|
|
@@ -2061,7 +2097,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2061
2097
|
insertInToSlide?: boolean;
|
|
2062
2098
|
/**
|
|
2063
2099
|
* Show alert messages and toast messages in the embed.
|
|
2064
|
-
* Supported
|
|
2100
|
+
* Supported in all embed types.
|
|
2065
2101
|
*
|
|
2066
2102
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2067
2103
|
* @example
|
|
@@ -2300,8 +2336,9 @@ export interface HomePageConfig {
|
|
|
2300
2336
|
* *Liveboards* and *Answers*.
|
|
2301
2337
|
* For example: `hiddenListColumns = [ListPageColumns.Author]`
|
|
2302
2338
|
*
|
|
2303
|
-
* **Note**: This option is available only in full app embedding and requires
|
|
2304
|
-
* Starting with version 10.14.0.cl, you can
|
|
2339
|
+
* **Note**: This option is available only in full app embedding and requires
|
|
2340
|
+
* importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
|
|
2341
|
+
* use this attribute to
|
|
2305
2342
|
* hide the columns on all list pages in the *Insights* section.
|
|
2306
2343
|
*
|
|
2307
2344
|
* Supported embed types: `AppEmbed`
|
|
@@ -2341,11 +2378,12 @@ export interface HomePageConfig {
|
|
|
2341
2378
|
/**
|
|
2342
2379
|
* Reorder home page modules.
|
|
2343
2380
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2344
|
-
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2345
|
-
* **Note**: This attribute is not supported in the
|
|
2381
|
+
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2382
|
+
* HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
|
|
2383
|
+
* classic (v1) homepage.
|
|
2346
2384
|
*
|
|
2347
2385
|
* Supported embed types: `AppEmbed`
|
|
2348
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2386
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2349
2387
|
* @example
|
|
2350
2388
|
* ```js
|
|
2351
2389
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2366,6 +2404,7 @@ export interface HomePageConfig {
|
|
|
2366
2404
|
* **Note**: This attribute is not supported in the classic (v1) homepage.
|
|
2367
2405
|
*
|
|
2368
2406
|
* Supported embed types: `AppEmbed`
|
|
2407
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2369
2408
|
* @example
|
|
2370
2409
|
* ```js
|
|
2371
2410
|
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2376,7 +2415,6 @@ export interface HomePageConfig {
|
|
|
2376
2415
|
* ... //other embed view configuration attributes
|
|
2377
2416
|
* })
|
|
2378
2417
|
* ```
|
|
2379
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
2380
2418
|
*/
|
|
2381
2419
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2382
2420
|
}
|
|
@@ -2389,7 +2427,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2389
2427
|
* visualization, or Liveboard.
|
|
2390
2428
|
*
|
|
2391
2429
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2392
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2430
|
+
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2393
2431
|
* @example
|
|
2394
2432
|
* ```js
|
|
2395
2433
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2407,11 +2445,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2407
2445
|
*/
|
|
2408
2446
|
runtimeFilters?: RuntimeFilter[];
|
|
2409
2447
|
/**
|
|
2410
|
-
* The list of parameter
|
|
2448
|
+
* The list of parameter overrides to apply to a search Answer,
|
|
2411
2449
|
* visualization, or Liveboard.
|
|
2412
2450
|
*
|
|
2413
2451
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2414
|
-
* @version SDK
|
|
2452
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2415
2453
|
* @example
|
|
2416
2454
|
* ```js
|
|
2417
2455
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2431,6 +2469,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2431
2469
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2432
2470
|
*
|
|
2433
2471
|
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
2472
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2434
2473
|
* @example
|
|
2435
2474
|
* ```js
|
|
2436
2475
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
@@ -2439,7 +2478,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2439
2478
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
2440
2479
|
* })
|
|
2441
2480
|
* ```
|
|
2442
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2443
2481
|
*/
|
|
2444
2482
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2445
2483
|
/**
|
|
@@ -2462,7 +2500,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2462
2500
|
* when set to false, runtime parameters will be included in the URL
|
|
2463
2501
|
* (default behavior before SDK 1.45.0).
|
|
2464
2502
|
*
|
|
2465
|
-
* Irrespective of this flag, runtime
|
|
2503
|
+
* Irrespective of this flag, runtime parameters (if passed) will be applied to the
|
|
2466
2504
|
* embedded view.
|
|
2467
2505
|
* @default true
|
|
2468
2506
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
@@ -2481,14 +2519,15 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2481
2519
|
* ... // other embed view config
|
|
2482
2520
|
* collapseSearchBar: true,
|
|
2483
2521
|
* });
|
|
2522
|
+
* ```
|
|
2484
2523
|
*/
|
|
2485
2524
|
collapseSearchBar?: boolean;
|
|
2486
2525
|
/**
|
|
2487
2526
|
* Flag to control Data panel experience
|
|
2488
2527
|
*
|
|
2489
2528
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2529
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2490
2530
|
* @default true
|
|
2491
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2492
2531
|
* @example
|
|
2493
2532
|
* ```js
|
|
2494
2533
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -2521,6 +2560,7 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2521
2560
|
* the current time period in filter results.
|
|
2522
2561
|
*
|
|
2523
2562
|
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2563
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2524
2564
|
* @example
|
|
2525
2565
|
* ```js
|
|
2526
2566
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
@@ -2528,7 +2568,6 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2528
2568
|
* isThisPeriodInDateFiltersEnabled: true,
|
|
2529
2569
|
* })
|
|
2530
2570
|
* ```
|
|
2531
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
|
|
2532
2571
|
*/
|
|
2533
2572
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
2534
2573
|
}
|
|
@@ -2588,6 +2627,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2588
2627
|
* Boolean to control if Liveboard header is sticky or not.
|
|
2589
2628
|
*
|
|
2590
2629
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2630
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2591
2631
|
* @example
|
|
2592
2632
|
* ```js
|
|
2593
2633
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2596,7 +2636,6 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2596
2636
|
* isLiveboardHeaderSticky: true,
|
|
2597
2637
|
* });
|
|
2598
2638
|
* ```
|
|
2599
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2600
2639
|
*/
|
|
2601
2640
|
isLiveboardHeaderSticky?: boolean;
|
|
2602
2641
|
/**
|
|
@@ -2604,8 +2643,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2604
2643
|
*
|
|
2605
2644
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2606
2645
|
* @type {boolean}
|
|
2646
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
|
|
2607
2647
|
* @default false
|
|
2608
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
2609
2648
|
* @example
|
|
2610
2649
|
* ```js
|
|
2611
2650
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2621,8 +2660,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2621
2660
|
*
|
|
2622
2661
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2623
2662
|
* @type {boolean}
|
|
2663
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
|
|
2624
2664
|
* @default false
|
|
2625
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
2626
2665
|
* @example
|
|
2627
2666
|
* ```js
|
|
2628
2667
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2638,7 +2677,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2638
2677
|
* header.
|
|
2639
2678
|
*
|
|
2640
2679
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2641
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2680
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2642
2681
|
* @default true
|
|
2643
2682
|
* @example
|
|
2644
2683
|
* ```js
|
|
@@ -2653,10 +2692,12 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2653
2692
|
/**
|
|
2654
2693
|
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
2655
2694
|
*
|
|
2656
|
-
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2695
|
+
* **Note**: This feature is supported only if compact header is enabled on your
|
|
2696
|
+
* Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
|
|
2697
|
+
* attribute.
|
|
2657
2698
|
*
|
|
2658
2699
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2659
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
2700
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2660
2701
|
* @default false
|
|
2661
2702
|
* @example
|
|
2662
2703
|
* ```js
|
|
@@ -2674,7 +2715,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2674
2715
|
* compact header
|
|
2675
2716
|
*
|
|
2676
2717
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2677
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
2718
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2678
2719
|
* @default true
|
|
2679
2720
|
* @example
|
|
2680
2721
|
* ```js
|
|
@@ -2707,7 +2748,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2707
2748
|
* the cover and filters pages in the Liveboard PDF.
|
|
2708
2749
|
*
|
|
2709
2750
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2710
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
2751
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
|
|
2711
2752
|
* @example
|
|
2712
2753
|
* ```js
|
|
2713
2754
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -2719,9 +2760,9 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2719
2760
|
*/
|
|
2720
2761
|
coverAndFilterOptionInPDF?: boolean;
|
|
2721
2762
|
/**
|
|
2722
|
-
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2723
|
-
* When enabled, a unified modal is used to manage and update multiple filters
|
|
2724
|
-
* replacing the older individual filter interactions.
|
|
2763
|
+
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
2764
|
+
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
2765
|
+
* at once, replacing the older individual filter interactions.
|
|
2725
2766
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2726
2767
|
*
|
|
2727
2768
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
@@ -2752,7 +2793,8 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2752
2793
|
*/
|
|
2753
2794
|
isLinkParametersEnabled?: boolean;
|
|
2754
2795
|
/**
|
|
2755
|
-
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2796
|
+
* This flag is used to enable or disable the enhanced filter interactivity in
|
|
2797
|
+
* liveboard.
|
|
2756
2798
|
*
|
|
2757
2799
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2758
2800
|
* @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
|
|
@@ -2911,7 +2953,7 @@ export declare enum HomepageModule {
|
|
|
2911
2953
|
*/
|
|
2912
2954
|
Search = "SEARCH",
|
|
2913
2955
|
/**
|
|
2914
|
-
*
|
|
2956
|
+
* KPI watchlist module
|
|
2915
2957
|
*/
|
|
2916
2958
|
Watchlist = "WATCHLIST",
|
|
2917
2959
|
/**
|
|
@@ -2942,7 +2984,8 @@ export declare enum ListPageColumns {
|
|
|
2942
2984
|
*/
|
|
2943
2985
|
Favorites = "FAVOURITE",
|
|
2944
2986
|
/**
|
|
2945
|
-
*
|
|
2987
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
2988
|
+
* @deprecated This option is deprecated.
|
|
2946
2989
|
*/
|
|
2947
2990
|
Favourite = "FAVOURITE",
|
|
2948
2991
|
/**
|
|
@@ -3043,13 +3086,13 @@ export declare enum EmbedEvent {
|
|
|
3043
3086
|
/**
|
|
3044
3087
|
* Rendering has initialized.
|
|
3045
3088
|
* @example
|
|
3046
|
-
|
|
3089
|
+
* ```js
|
|
3047
3090
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
3048
3091
|
* //show a loader
|
|
3049
3092
|
* function showLoader() {
|
|
3050
3093
|
* document.getElementById("loader");
|
|
3051
3094
|
* }
|
|
3052
|
-
|
|
3095
|
+
* ```
|
|
3053
3096
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3054
3097
|
*/
|
|
3055
3098
|
Init = "init",
|
|
@@ -3057,11 +3100,11 @@ export declare enum EmbedEvent {
|
|
|
3057
3100
|
* Authentication has either succeeded or failed.
|
|
3058
3101
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3059
3102
|
* @example
|
|
3060
|
-
|
|
3103
|
+
* ```js
|
|
3061
3104
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
3062
3105
|
* console.log('AuthInit', payload);
|
|
3063
3106
|
* })
|
|
3064
|
-
|
|
3107
|
+
* ```
|
|
3065
3108
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
3066
3109
|
*/
|
|
3067
3110
|
AuthInit = "authInit",
|
|
@@ -3070,13 +3113,13 @@ export declare enum EmbedEvent {
|
|
|
3070
3113
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3071
3114
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3072
3115
|
* @example
|
|
3073
|
-
|
|
3116
|
+
* ```js
|
|
3074
3117
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
3075
3118
|
* //hide loader
|
|
3076
3119
|
* function hideLoader() {
|
|
3077
3120
|
* document.getElementById("loader");
|
|
3078
3121
|
* }
|
|
3079
|
-
|
|
3122
|
+
* ```
|
|
3080
3123
|
*/
|
|
3081
3124
|
Load = "load",
|
|
3082
3125
|
/**
|
|
@@ -3085,11 +3128,11 @@ export declare enum EmbedEvent {
|
|
|
3085
3128
|
* @return data - Answer of Liveboard data
|
|
3086
3129
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3087
3130
|
* @example
|
|
3088
|
-
|
|
3131
|
+
* ```js
|
|
3089
3132
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
3090
3133
|
* console.log('data', payload);
|
|
3091
3134
|
* })
|
|
3092
|
-
|
|
3135
|
+
* ```
|
|
3093
3136
|
* @important
|
|
3094
3137
|
*/
|
|
3095
3138
|
Data = "data",
|
|
@@ -3097,9 +3140,9 @@ export declare enum EmbedEvent {
|
|
|
3097
3140
|
* Search query has been updated by the user.
|
|
3098
3141
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3099
3142
|
* @example
|
|
3100
|
-
|
|
3143
|
+
* ```js
|
|
3101
3144
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
3102
|
-
|
|
3145
|
+
* ```
|
|
3103
3146
|
*/
|
|
3104
3147
|
QueryChanged = "queryChanged",
|
|
3105
3148
|
/**
|
|
@@ -3109,7 +3152,7 @@ export declare enum EmbedEvent {
|
|
|
3109
3152
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
3110
3153
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
3111
3154
|
* @example
|
|
3112
|
-
|
|
3155
|
+
* ```js
|
|
3113
3156
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
3114
3157
|
* points: {
|
|
3115
3158
|
* clickedPoint,
|
|
@@ -3117,12 +3160,12 @@ export declare enum EmbedEvent {
|
|
|
3117
3160
|
* },
|
|
3118
3161
|
* autoDrillDown: true,
|
|
3119
3162
|
* })
|
|
3120
|
-
|
|
3163
|
+
* ```
|
|
3121
3164
|
* In this example, `VizPointDoubleClick` event is used for
|
|
3122
3165
|
* triggering the `DrillDown` event when an area or specific
|
|
3123
3166
|
* data point on a table or chart is double-clicked.
|
|
3124
3167
|
* @example
|
|
3125
|
-
|
|
3168
|
+
* ```js
|
|
3126
3169
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3127
3170
|
* console.log(payload);
|
|
3128
3171
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -3136,7 +3179,7 @@ export declare enum EmbedEvent {
|
|
|
3136
3179
|
* autoDrillDown: true,
|
|
3137
3180
|
* })
|
|
3138
3181
|
* })
|
|
3139
|
-
|
|
3182
|
+
* ```
|
|
3140
3183
|
*/
|
|
3141
3184
|
Drilldown = "drillDown",
|
|
3142
3185
|
/**
|
|
@@ -3261,13 +3304,13 @@ export declare enum EmbedEvent {
|
|
|
3261
3304
|
* The ThoughtSpot authentication session has expired.
|
|
3262
3305
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3263
3306
|
* @example
|
|
3264
|
-
|
|
3307
|
+
* ```js
|
|
3265
3308
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
3266
3309
|
* //show auth expired banner
|
|
3267
3310
|
* function showAuthExpired() {
|
|
3268
3311
|
* document.getElementById("authExpiredBanner");
|
|
3269
3312
|
* }
|
|
3270
|
-
|
|
3313
|
+
* ```
|
|
3271
3314
|
*/
|
|
3272
3315
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3273
3316
|
/**
|
|
@@ -3302,22 +3345,22 @@ export declare enum EmbedEvent {
|
|
|
3302
3345
|
* Applicable to `SearchBarEmbed` only.
|
|
3303
3346
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3304
3347
|
* @example
|
|
3305
|
-
|
|
3348
|
+
* ```js
|
|
3306
3349
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
3307
3350
|
* .then(data => {
|
|
3308
3351
|
* console.log('Answer Data:', data);
|
|
3309
3352
|
* })
|
|
3310
|
-
|
|
3353
|
+
* ```
|
|
3311
3354
|
*/
|
|
3312
3355
|
GetDataClick = "getDataClick",
|
|
3313
3356
|
/**
|
|
3314
3357
|
* Detects the route change.
|
|
3315
3358
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3316
3359
|
* @example
|
|
3317
|
-
|
|
3360
|
+
* ```js
|
|
3318
3361
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
3319
3362
|
* console.log('data', payload))
|
|
3320
|
-
|
|
3363
|
+
* ```
|
|
3321
3364
|
*/
|
|
3322
3365
|
RouteChange = "ROUTE_CHANGE",
|
|
3323
3366
|
/**
|
|
@@ -3327,12 +3370,12 @@ export declare enum EmbedEvent {
|
|
|
3327
3370
|
V1Data = "exportVizDataToParent",
|
|
3328
3371
|
/**
|
|
3329
3372
|
* Emitted when the embed does not have cookie access. This happens
|
|
3330
|
-
* when
|
|
3331
|
-
*
|
|
3373
|
+
* when third-party cookies are blocked by Safari or other
|
|
3374
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
3332
3375
|
* @example
|
|
3333
|
-
|
|
3376
|
+
* ```js
|
|
3334
3377
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
3335
|
-
|
|
3378
|
+
* ```
|
|
3336
3379
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
3337
3380
|
*/
|
|
3338
3381
|
NoCookieAccess = "noCookieAccess",
|
|
@@ -3346,22 +3389,22 @@ export declare enum EmbedEvent {
|
|
|
3346
3389
|
* Emitted when any modal is opened in the app
|
|
3347
3390
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3348
3391
|
* @example
|
|
3349
|
-
|
|
3392
|
+
* ```js
|
|
3350
3393
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
3351
3394
|
* console.log('dialog open', payload);
|
|
3352
3395
|
* })
|
|
3353
|
-
|
|
3396
|
+
* ```
|
|
3354
3397
|
*/
|
|
3355
3398
|
DialogOpen = "dialog-open",
|
|
3356
3399
|
/**
|
|
3357
3400
|
* Emitted when any modal is closed in the app
|
|
3358
3401
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3359
3402
|
* @example
|
|
3360
|
-
|
|
3403
|
+
* ```js
|
|
3361
3404
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
3362
3405
|
* console.log('dialog close', payload);
|
|
3363
3406
|
* })
|
|
3364
|
-
|
|
3407
|
+
* ```
|
|
3365
3408
|
*/
|
|
3366
3409
|
DialogClose = "dialog-close",
|
|
3367
3410
|
/**
|
|
@@ -3370,39 +3413,39 @@ export declare enum EmbedEvent {
|
|
|
3370
3413
|
* other events on the rendered Liveboard.
|
|
3371
3414
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3372
3415
|
* @example
|
|
3373
|
-
|
|
3416
|
+
* ```js
|
|
3374
3417
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
3375
3418
|
console.log('Liveboard is rendered', payload);
|
|
3376
3419
|
})
|
|
3377
|
-
|
|
3420
|
+
* ```
|
|
3378
3421
|
* The following example shows how to trigger
|
|
3379
3422
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
3380
3423
|
* @example
|
|
3381
|
-
|
|
3424
|
+
* ```js
|
|
3382
3425
|
* const embedRef = useEmbedRef();
|
|
3383
3426
|
* const onLiveboardRendered = () => {
|
|
3384
3427
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
3385
3428
|
* };
|
|
3386
|
-
|
|
3429
|
+
* ```
|
|
3387
3430
|
*/
|
|
3388
3431
|
LiveboardRendered = "PinboardRendered",
|
|
3389
3432
|
/**
|
|
3390
3433
|
* Emits all events.
|
|
3391
|
-
* @
|
|
3434
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3392
3435
|
* @example
|
|
3393
|
-
|
|
3436
|
+
* ```js
|
|
3394
3437
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
3395
3438
|
* console.log('Embed Events', payload)
|
|
3396
3439
|
* })
|
|
3397
|
-
|
|
3440
|
+
* ```
|
|
3398
3441
|
*/
|
|
3399
3442
|
ALL = "*",
|
|
3400
3443
|
/**
|
|
3401
3444
|
* Emitted when an Answer is saved in the app.
|
|
3402
3445
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
3403
|
-
* @
|
|
3446
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3404
3447
|
* @example
|
|
3405
|
-
|
|
3448
|
+
* ```js
|
|
3406
3449
|
* //Emit when action starts
|
|
3407
3450
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3408
3451
|
* console.log('Save', payload)
|
|
@@ -3413,7 +3456,7 @@ export declare enum EmbedEvent {
|
|
|
3413
3456
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3414
3457
|
* console.log('Save', payload)
|
|
3415
3458
|
* })
|
|
3416
|
-
|
|
3459
|
+
* ```
|
|
3417
3460
|
*/
|
|
3418
3461
|
Save = "save",
|
|
3419
3462
|
/**
|
|
@@ -3425,106 +3468,112 @@ export declare enum EmbedEvent {
|
|
|
3425
3468
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
3426
3469
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3427
3470
|
* @example
|
|
3428
|
-
|
|
3471
|
+
* ```js
|
|
3429
3472
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3430
3473
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3431
3474
|
* })
|
|
3432
|
-
|
|
3475
|
+
* ```
|
|
3433
3476
|
*/
|
|
3434
3477
|
Download = "download",
|
|
3435
3478
|
/**
|
|
3436
3479
|
* Emitted when the download action is triggered on an Answer.
|
|
3437
|
-
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3480
|
+
* Use start:true to subscribe to when download is initiated, or end:true to
|
|
3481
|
+
* subscribe to when download is completed. Default is end:true.
|
|
3438
3482
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3439
3483
|
* @example
|
|
3440
|
-
|
|
3484
|
+
* ```js
|
|
3441
3485
|
* //emit when action starts
|
|
3442
3486
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3443
3487
|
* console.log('download PNG', payload)}, {start: true })
|
|
3444
3488
|
* //emit when action ends
|
|
3445
3489
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3446
3490
|
* console.log('download PNG', payload)})
|
|
3447
|
-
|
|
3491
|
+
* ```
|
|
3448
3492
|
*/
|
|
3449
3493
|
DownloadAsPng = "downloadAsPng",
|
|
3450
3494
|
/**
|
|
3451
3495
|
* Emitted when the Download as PDF action is triggered on an Answer
|
|
3452
|
-
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3496
|
+
* Use start:true to subscribe to when download as PDF is initiated, or end:true to
|
|
3497
|
+
* subscribe to when download as PDF is completed. Default is end:true.
|
|
3453
3498
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3454
3499
|
* @example
|
|
3455
|
-
|
|
3500
|
+
* ```js
|
|
3456
3501
|
* //emit when action starts
|
|
3457
3502
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3458
3503
|
* console.log('download PDF', payload)}, {start: true })
|
|
3459
3504
|
* //emit when action ends
|
|
3460
3505
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3461
3506
|
* console.log('download PDF', payload)})
|
|
3462
|
-
|
|
3507
|
+
* ```
|
|
3463
3508
|
*/
|
|
3464
3509
|
DownloadAsPdf = "downloadAsPdf",
|
|
3465
3510
|
/**
|
|
3466
3511
|
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
3467
|
-
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3512
|
+
* Use start:true to subscribe to when download as CSV is initiated, or end:true to
|
|
3513
|
+
* subscribe to when download as CSV is completed. Default is end:true.
|
|
3468
3514
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3469
3515
|
* @example
|
|
3470
|
-
|
|
3516
|
+
* ```js
|
|
3471
3517
|
* //emit when action starts
|
|
3472
3518
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3473
3519
|
* console.log('download CSV', payload)}, {start: true })
|
|
3474
3520
|
* //emit when action ends
|
|
3475
3521
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3476
3522
|
* console.log('download CSV', payload)})
|
|
3477
|
-
|
|
3523
|
+
* ```
|
|
3478
3524
|
*/
|
|
3479
3525
|
DownloadAsCsv = "downloadAsCsv",
|
|
3480
3526
|
/**
|
|
3481
3527
|
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
3482
|
-
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3528
|
+
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to
|
|
3529
|
+
* subscribe to when download as XLSX is completed. Default is end:true.
|
|
3483
3530
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3484
3531
|
* @example
|
|
3485
|
-
|
|
3532
|
+
* ```js
|
|
3486
3533
|
* //emit when action starts
|
|
3487
3534
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3488
3535
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3489
3536
|
* //emit when action ends
|
|
3490
3537
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3491
3538
|
* console.log('download Xlsx', payload)})
|
|
3492
|
-
|
|
3539
|
+
* ```
|
|
3493
3540
|
*/
|
|
3494
3541
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3495
3542
|
/**
|
|
3496
3543
|
* Emitted when an Answer is deleted in the app
|
|
3497
|
-
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3544
|
+
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
3545
|
+
* to when delete is completed. Default is end:true.
|
|
3498
3546
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3499
3547
|
* @example
|
|
3500
|
-
|
|
3548
|
+
* ```js
|
|
3501
3549
|
* //emit when action starts
|
|
3502
3550
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3503
3551
|
* console.log('delete answer', payload)}, {start: true })
|
|
3504
3552
|
* //trigger when action is completed
|
|
3505
3553
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3506
3554
|
* console.log('delete answer', payload)})
|
|
3507
|
-
|
|
3555
|
+
* ```
|
|
3508
3556
|
*/
|
|
3509
3557
|
AnswerDelete = "answerDelete",
|
|
3510
3558
|
/**
|
|
3511
3559
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
3512
3560
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
3513
3561
|
* @example
|
|
3514
|
-
|
|
3562
|
+
* ```js
|
|
3515
3563
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
3516
3564
|
* console.log('AI Highlights', payload);
|
|
3517
3565
|
* })
|
|
3518
|
-
|
|
3566
|
+
* ```
|
|
3519
3567
|
*/
|
|
3520
3568
|
AIHighlights = "AIHighlights",
|
|
3521
3569
|
/**
|
|
3522
3570
|
* Emitted when a user initiates the Pin action to
|
|
3523
3571
|
* add an Answer to a Liveboard.
|
|
3524
|
-
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3572
|
+
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
|
|
3573
|
+
* when pin is completed. Default is end:true.
|
|
3525
3574
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3526
3575
|
* @example
|
|
3527
|
-
|
|
3576
|
+
* ```js
|
|
3528
3577
|
* //emit when action starts
|
|
3529
3578
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3530
3579
|
* console.log('pin', payload)
|
|
@@ -3535,14 +3584,14 @@ export declare enum EmbedEvent {
|
|
|
3535
3584
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3536
3585
|
* console.log('pin', payload)
|
|
3537
3586
|
* })
|
|
3538
|
-
|
|
3587
|
+
* ```
|
|
3539
3588
|
*/
|
|
3540
3589
|
Pin = "pin",
|
|
3541
3590
|
/**
|
|
3542
3591
|
* Emitted when SpotIQ analysis is triggered
|
|
3543
3592
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3544
3593
|
* @example
|
|
3545
|
-
|
|
3594
|
+
* ```js
|
|
3546
3595
|
* //emit when action starts
|
|
3547
3596
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3548
3597
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -3553,14 +3602,14 @@ export declare enum EmbedEvent {
|
|
|
3553
3602
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3554
3603
|
* console.log('SpotIQ analyze', payload)
|
|
3555
3604
|
* })
|
|
3556
|
-
|
|
3605
|
+
* ```
|
|
3557
3606
|
*/
|
|
3558
3607
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3559
3608
|
/**
|
|
3560
3609
|
* Emitted when a user shares an object with another user or group
|
|
3561
3610
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3562
3611
|
* @example
|
|
3563
|
-
|
|
3612
|
+
* ```js
|
|
3564
3613
|
* //emit when action starts
|
|
3565
3614
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3566
3615
|
* console.log('Share', payload)
|
|
@@ -3571,7 +3620,7 @@ export declare enum EmbedEvent {
|
|
|
3571
3620
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3572
3621
|
* console.log('Share', payload)
|
|
3573
3622
|
* })
|
|
3574
|
-
|
|
3623
|
+
* ```
|
|
3575
3624
|
*/
|
|
3576
3625
|
Share = "share",
|
|
3577
3626
|
/**
|
|
@@ -3579,11 +3628,11 @@ export declare enum EmbedEvent {
|
|
|
3579
3628
|
* data on a chart or table.
|
|
3580
3629
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3581
3630
|
* @example
|
|
3582
|
-
|
|
3631
|
+
* ```js
|
|
3583
3632
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
3584
3633
|
* console.log('Drill include', payload);
|
|
3585
3634
|
* })
|
|
3586
|
-
|
|
3635
|
+
* ```
|
|
3587
3636
|
*/
|
|
3588
3637
|
DrillInclude = "context-menu-item-include",
|
|
3589
3638
|
/**
|
|
@@ -3591,22 +3640,22 @@ export declare enum EmbedEvent {
|
|
|
3591
3640
|
* data on a chart or table
|
|
3592
3641
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3593
3642
|
* @example
|
|
3594
|
-
|
|
3643
|
+
* ```js
|
|
3595
3644
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
3596
3645
|
* console.log('Drill exclude', payload);
|
|
3597
3646
|
* })
|
|
3598
|
-
|
|
3647
|
+
* ```
|
|
3599
3648
|
*/
|
|
3600
3649
|
DrillExclude = "context-menu-item-exclude",
|
|
3601
3650
|
/**
|
|
3602
3651
|
* Emitted when a column value is copied in the embedded app.
|
|
3603
3652
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3604
3653
|
* @example
|
|
3605
|
-
|
|
3606
|
-
*
|
|
3654
|
+
* ```js
|
|
3655
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
3607
3656
|
* console.log('copy to clipboard', payload);
|
|
3608
3657
|
* })
|
|
3609
|
-
|
|
3658
|
+
* ```
|
|
3610
3659
|
*/
|
|
3611
3660
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3612
3661
|
/**
|
|
@@ -3614,10 +3663,10 @@ export declare enum EmbedEvent {
|
|
|
3614
3663
|
* embedded Liveboard.
|
|
3615
3664
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3616
3665
|
* @example
|
|
3617
|
-
|
|
3666
|
+
* ```js
|
|
3618
3667
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
3619
3668
|
* })
|
|
3620
|
-
|
|
3669
|
+
* ```
|
|
3621
3670
|
*/
|
|
3622
3671
|
UpdateTML = "updateTSL",
|
|
3623
3672
|
/**
|
|
@@ -3625,75 +3674,77 @@ export declare enum EmbedEvent {
|
|
|
3625
3674
|
* on an embedded Liveboard.
|
|
3626
3675
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3627
3676
|
* @example
|
|
3628
|
-
|
|
3677
|
+
* ```js
|
|
3629
3678
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
3630
3679
|
* console.log('Edit TML', payload);
|
|
3631
3680
|
* })
|
|
3632
|
-
|
|
3681
|
+
* ```
|
|
3633
3682
|
*/
|
|
3634
3683
|
EditTML = "editTSL",
|
|
3635
3684
|
/**
|
|
3636
3685
|
* Emitted when the **Export TML** action is triggered on an
|
|
3637
3686
|
* an embedded object in the app
|
|
3638
|
-
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3687
|
+
* Use start:true to subscribe to when export is initiated, or end:true to subscribe
|
|
3688
|
+
* to when export is completed. Default is end:true.
|
|
3639
3689
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3640
3690
|
* @example
|
|
3641
|
-
|
|
3691
|
+
* ```js
|
|
3642
3692
|
* //emit when action starts
|
|
3643
3693
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3644
3694
|
* console.log('Export TML', payload)}, { start: true })
|
|
3645
3695
|
* //emit when action ends
|
|
3646
3696
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3647
3697
|
* console.log('Export TML', payload)})
|
|
3648
|
-
|
|
3698
|
+
* ```
|
|
3649
3699
|
*/
|
|
3650
3700
|
ExportTML = "exportTSL",
|
|
3651
3701
|
/**
|
|
3652
3702
|
* Emitted when an Answer is saved as a View.
|
|
3653
3703
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3654
3704
|
* @example
|
|
3655
|
-
|
|
3705
|
+
* ```js
|
|
3656
3706
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
3657
3707
|
* console.log('View', payload);
|
|
3658
3708
|
* })
|
|
3659
|
-
|
|
3709
|
+
* ```
|
|
3660
3710
|
*/
|
|
3661
3711
|
SaveAsView = "saveAsView",
|
|
3662
3712
|
/**
|
|
3663
3713
|
* Emitted when the user creates a copy of an Answer.
|
|
3664
|
-
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3714
|
+
* Use start:true to subscribe to when copy and edit is initiated, or end:true to
|
|
3715
|
+
* subscribe to when copy and edit is completed. Default is end:true.
|
|
3665
3716
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3666
3717
|
* @example
|
|
3667
|
-
|
|
3718
|
+
* ```js
|
|
3668
3719
|
* //emit when action starts
|
|
3669
3720
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3670
3721
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3671
3722
|
* //emit when action ends
|
|
3672
3723
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3673
3724
|
* console.log('Copy and edit', payload)})
|
|
3674
|
-
|
|
3725
|
+
* ```
|
|
3675
3726
|
*/
|
|
3676
3727
|
CopyAEdit = "copyAEdit",
|
|
3677
3728
|
/**
|
|
3678
3729
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3679
3730
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3680
3731
|
* @example
|
|
3681
|
-
|
|
3732
|
+
* ```js
|
|
3682
3733
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
3683
3734
|
* console.log('show data', payload);
|
|
3684
3735
|
* })
|
|
3685
|
-
|
|
3736
|
+
* ```
|
|
3686
3737
|
*/
|
|
3687
3738
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3688
3739
|
/**
|
|
3689
3740
|
* Emitted when an Answer is switched to a chart or table view.
|
|
3690
3741
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3691
3742
|
* @example
|
|
3692
|
-
|
|
3743
|
+
* ```js
|
|
3693
3744
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3694
3745
|
* console.log('switch view', payload);
|
|
3695
3746
|
* })
|
|
3696
|
-
|
|
3747
|
+
* ```
|
|
3697
3748
|
*/
|
|
3698
3749
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3699
3750
|
/**
|
|
@@ -3710,118 +3761,118 @@ export declare enum EmbedEvent {
|
|
|
3710
3761
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3711
3762
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3712
3763
|
* @example
|
|
3713
|
-
|
|
3764
|
+
* ```js
|
|
3714
3765
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
3715
3766
|
* console.log('Liveboard details', payload);
|
|
3716
3767
|
* })
|
|
3717
|
-
|
|
3768
|
+
* ```
|
|
3718
3769
|
*/
|
|
3719
3770
|
LiveboardInfo = "pinboardInfo",
|
|
3720
3771
|
/**
|
|
3721
3772
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3722
3773
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3723
3774
|
* @example
|
|
3724
|
-
|
|
3775
|
+
* ```js
|
|
3725
3776
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3726
3777
|
* console.log('favorites', payload);
|
|
3727
3778
|
* })
|
|
3728
|
-
|
|
3779
|
+
* ```
|
|
3729
3780
|
*/
|
|
3730
3781
|
AddToFavorites = "addToFavorites",
|
|
3731
3782
|
/**
|
|
3732
3783
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3733
3784
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3734
3785
|
* @example
|
|
3735
|
-
|
|
3786
|
+
* ```js
|
|
3736
3787
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3737
|
-
* console.log(
|
|
3788
|
+
* console.log('Liveboard schedule', payload);
|
|
3738
3789
|
* })
|
|
3739
|
-
|
|
3790
|
+
* ```
|
|
3740
3791
|
*/
|
|
3741
3792
|
Schedule = "subscription",
|
|
3742
3793
|
/**
|
|
3743
3794
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3744
3795
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3745
3796
|
* @example
|
|
3746
|
-
|
|
3797
|
+
* ```js
|
|
3747
3798
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3748
|
-
* console.log(
|
|
3799
|
+
* console.log('Liveboard edit', payload);
|
|
3749
3800
|
* })
|
|
3750
|
-
|
|
3801
|
+
* ```
|
|
3751
3802
|
*/
|
|
3752
3803
|
Edit = "edit",
|
|
3753
3804
|
/**
|
|
3754
3805
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3755
3806
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3756
3807
|
* @example
|
|
3757
|
-
|
|
3808
|
+
* ```js
|
|
3758
3809
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3759
|
-
* console.log(
|
|
3810
|
+
* console.log('Copy', payload);
|
|
3760
3811
|
* })
|
|
3761
|
-
|
|
3812
|
+
* ```
|
|
3762
3813
|
*/
|
|
3763
3814
|
MakeACopy = "makeACopy",
|
|
3764
3815
|
/**
|
|
3765
3816
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3766
3817
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3767
3818
|
* @example
|
|
3768
|
-
|
|
3819
|
+
* ```js
|
|
3769
3820
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3770
|
-
|
|
3821
|
+
* ```
|
|
3771
3822
|
* @example
|
|
3772
|
-
|
|
3823
|
+
* ```js
|
|
3773
3824
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3774
3825
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3775
3826
|
* })
|
|
3776
|
-
|
|
3827
|
+
* ```
|
|
3777
3828
|
*/
|
|
3778
3829
|
Present = "present",
|
|
3779
3830
|
/**
|
|
3780
3831
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3781
3832
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3782
3833
|
* @example
|
|
3783
|
-
|
|
3834
|
+
* ```js
|
|
3784
3835
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3785
3836
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3786
|
-
|
|
3837
|
+
* ```
|
|
3787
3838
|
*/
|
|
3788
3839
|
Delete = "delete",
|
|
3789
3840
|
/**
|
|
3790
3841
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3791
3842
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3792
3843
|
* @example
|
|
3793
|
-
|
|
3844
|
+
* ```js
|
|
3794
3845
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3795
|
-
|
|
3846
|
+
* ```
|
|
3796
3847
|
*/
|
|
3797
3848
|
SchedulesList = "schedule-list",
|
|
3798
3849
|
/**
|
|
3799
3850
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3800
3851
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3801
3852
|
* @example
|
|
3802
|
-
|
|
3853
|
+
* ```js
|
|
3803
3854
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3804
|
-
|
|
3855
|
+
* ```
|
|
3805
3856
|
*/
|
|
3806
3857
|
Cancel = "cancel",
|
|
3807
3858
|
/**
|
|
3808
3859
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3809
3860
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3810
3861
|
* @example
|
|
3811
|
-
|
|
3862
|
+
* ```js
|
|
3812
3863
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3813
3864
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3814
|
-
|
|
3865
|
+
* ```
|
|
3815
3866
|
*/
|
|
3816
3867
|
Explore = "explore",
|
|
3817
3868
|
/**
|
|
3818
3869
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
3819
3870
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3820
3871
|
* @example
|
|
3821
|
-
|
|
3872
|
+
* ```js
|
|
3822
3873
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3823
3874
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3824
|
-
|
|
3875
|
+
* ```
|
|
3825
3876
|
*/
|
|
3826
3877
|
CopyLink = "embedDocument",
|
|
3827
3878
|
/**
|
|
@@ -3829,21 +3880,21 @@ export declare enum EmbedEvent {
|
|
|
3829
3880
|
* visualization or Liveboard.
|
|
3830
3881
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3831
3882
|
* @example
|
|
3832
|
-
|
|
3883
|
+
* ```js
|
|
3833
3884
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3834
3885
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3835
|
-
|
|
3886
|
+
* ```
|
|
3836
3887
|
*/
|
|
3837
3888
|
CrossFilterChanged = "cross-filter-changed",
|
|
3838
3889
|
/**
|
|
3839
3890
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3840
3891
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3841
3892
|
* @example
|
|
3842
|
-
|
|
3893
|
+
* ```js
|
|
3843
3894
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3844
3895
|
* console.log('VizPointClick', payload)
|
|
3845
3896
|
* })
|
|
3846
|
-
|
|
3897
|
+
* ```
|
|
3847
3898
|
*/
|
|
3848
3899
|
VizPointRightClick = "vizPointRightClick",
|
|
3849
3900
|
/**
|
|
@@ -3857,35 +3908,35 @@ export declare enum EmbedEvent {
|
|
|
3857
3908
|
* filter details.
|
|
3858
3909
|
* @example
|
|
3859
3910
|
*
|
|
3860
|
-
|
|
3911
|
+
* ```js
|
|
3861
3912
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3862
3913
|
* console.log('payload', payload);
|
|
3863
3914
|
* })
|
|
3864
|
-
*
|
|
3915
|
+
* ```
|
|
3865
3916
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3866
3917
|
*/
|
|
3867
3918
|
FilterChanged = "filterChanged",
|
|
3868
3919
|
/**
|
|
3869
3920
|
* Emitted when a user clicks the **Go** button to initiate
|
|
3870
3921
|
* a Natural Language Search query
|
|
3871
|
-
* @version SDK
|
|
3922
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3872
3923
|
*/
|
|
3873
3924
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3874
3925
|
/**
|
|
3875
3926
|
* Emitted when a user selects a data source on the embedded
|
|
3876
3927
|
* Natural Language Search interface.
|
|
3877
3928
|
*
|
|
3878
|
-
* @version SDK
|
|
3929
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3879
3930
|
*/
|
|
3880
3931
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3881
3932
|
/**
|
|
3882
3933
|
* Emitted when a user updates a connection on the **Data** page
|
|
3883
|
-
* @version SDK
|
|
3934
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3884
3935
|
*/
|
|
3885
3936
|
UpdateConnection = "updateConnection",
|
|
3886
3937
|
/**
|
|
3887
3938
|
* Emitted when a user updates a connection on the **Data** page
|
|
3888
|
-
* @version SDK
|
|
3939
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3889
3940
|
*/
|
|
3890
3941
|
CreateConnection = "createConnection",
|
|
3891
3942
|
/**
|
|
@@ -3895,7 +3946,7 @@ export declare enum EmbedEvent {
|
|
|
3895
3946
|
* @returns viewId: string
|
|
3896
3947
|
* @returns liveboardId: string
|
|
3897
3948
|
* @returns isPublic: boolean
|
|
3898
|
-
* @version SDK
|
|
3949
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3899
3950
|
*/
|
|
3900
3951
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3901
3952
|
/**
|
|
@@ -3904,7 +3955,7 @@ export declare enum EmbedEvent {
|
|
|
3904
3955
|
* @returns viewId: string
|
|
3905
3956
|
* @returns liveboardId: string
|
|
3906
3957
|
* @returns isPublic: boolean
|
|
3907
|
-
* @version SDK
|
|
3958
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3908
3959
|
*/
|
|
3909
3960
|
SavePersonalisedView = "savePersonalisedView",
|
|
3910
3961
|
/**
|
|
@@ -3913,19 +3964,19 @@ export declare enum EmbedEvent {
|
|
|
3913
3964
|
* @returns viewId: string
|
|
3914
3965
|
* @returns liveboardId: string
|
|
3915
3966
|
* @returns isPublic: boolean
|
|
3916
|
-
* @version SDK
|
|
3967
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3917
3968
|
*/
|
|
3918
3969
|
ResetLiveboard = "resetLiveboard",
|
|
3919
3970
|
/**
|
|
3920
3971
|
* Emitted when a PersonalisedView is deleted.
|
|
3921
3972
|
* @returns views: string[]
|
|
3922
3973
|
* @returns liveboardId: string
|
|
3923
|
-
* @version SDK
|
|
3974
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3924
3975
|
*/
|
|
3925
3976
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3926
3977
|
/**
|
|
3927
3978
|
* Emitted when a user creates a Worksheet.
|
|
3928
|
-
* @version SDK
|
|
3979
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3929
3980
|
*/
|
|
3930
3981
|
CreateWorksheet = "createWorksheet",
|
|
3931
3982
|
/**
|
|
@@ -3934,12 +3985,12 @@ export declare enum EmbedEvent {
|
|
|
3934
3985
|
* @returns viewId: string
|
|
3935
3986
|
* @returns liveboardId: string
|
|
3936
3987
|
* @returns isPublic: boolean
|
|
3937
|
-
* @version SDK
|
|
3988
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3938
3989
|
*/
|
|
3939
3990
|
AskSageInit = "AskSageInit",
|
|
3940
3991
|
/**
|
|
3941
3992
|
* Emitted when a Liveboard or visualization is renamed.
|
|
3942
|
-
* @version SDK
|
|
3993
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
3943
3994
|
*/
|
|
3944
3995
|
Rename = "rename",
|
|
3945
3996
|
/**
|
|
@@ -3962,7 +4013,7 @@ export declare enum EmbedEvent {
|
|
|
3962
4013
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
3963
4014
|
* is `false` by using the `error` parameters in `responder`.
|
|
3964
4015
|
* - `errorText` - The error message text shown to the user.
|
|
3965
|
-
* @version SDK
|
|
4016
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
3966
4017
|
* @example
|
|
3967
4018
|
*
|
|
3968
4019
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -4014,8 +4065,8 @@ export declare enum EmbedEvent {
|
|
|
4014
4065
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4015
4066
|
* console.log('payload', payload);
|
|
4016
4067
|
* })
|
|
4017
|
-
|
|
4018
|
-
* @version SDK
|
|
4068
|
+
* ```
|
|
4069
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4019
4070
|
*/
|
|
4020
4071
|
ParameterChanged = "parameterChanged",
|
|
4021
4072
|
/**
|
|
@@ -4070,24 +4121,24 @@ export declare enum EmbedEvent {
|
|
|
4070
4121
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
4071
4122
|
* console.log('payload', payload);
|
|
4072
4123
|
* })
|
|
4073
|
-
|
|
4074
|
-
* @version SDK
|
|
4124
|
+
* ```
|
|
4125
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4075
4126
|
*/
|
|
4076
4127
|
CreateLiveboard = "createLiveboard",
|
|
4077
4128
|
/**
|
|
4078
4129
|
* Emitted when a user creates a Model.
|
|
4079
|
-
* @version SDK
|
|
4130
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4080
4131
|
*/
|
|
4081
4132
|
CreateModel = "createModel",
|
|
4082
4133
|
/**
|
|
4083
4134
|
* @hidden
|
|
4084
4135
|
* Emitted when a user exits present mode.
|
|
4085
|
-
* @version SDK
|
|
4136
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4086
4137
|
*/
|
|
4087
4138
|
ExitPresentMode = "exitPresentMode",
|
|
4088
4139
|
/**
|
|
4089
4140
|
* Emitted when a user requests the full height lazy load data.
|
|
4090
|
-
* @version SDK
|
|
4141
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4091
4142
|
* @hidden
|
|
4092
4143
|
*/
|
|
4093
4144
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
@@ -4098,7 +4149,7 @@ export declare enum EmbedEvent {
|
|
|
4098
4149
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
4099
4150
|
* console.log('payload', payload);
|
|
4100
4151
|
* })
|
|
4101
|
-
|
|
4152
|
+
* ```
|
|
4102
4153
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4103
4154
|
*/
|
|
4104
4155
|
SpotterData = "SpotterData",
|
|
@@ -4109,7 +4160,7 @@ export declare enum EmbedEvent {
|
|
|
4109
4160
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
4110
4161
|
* console.log('payload', payload);
|
|
4111
4162
|
* })
|
|
4112
|
-
|
|
4163
|
+
* ```
|
|
4113
4164
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4114
4165
|
*/
|
|
4115
4166
|
PreviewSpotterData = "PreviewSpotterData",
|
|
@@ -4120,7 +4171,7 @@ export declare enum EmbedEvent {
|
|
|
4120
4171
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
4121
4172
|
* console.log('payload', payload);
|
|
4122
4173
|
* })
|
|
4123
|
-
|
|
4174
|
+
* ```
|
|
4124
4175
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4125
4176
|
*/
|
|
4126
4177
|
AddToCoaching = "addToCoaching",
|
|
@@ -4142,7 +4193,7 @@ export declare enum EmbedEvent {
|
|
|
4142
4193
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
4143
4194
|
* console.log('payload', payload);
|
|
4144
4195
|
* })
|
|
4145
|
-
|
|
4196
|
+
* ```
|
|
4146
4197
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4147
4198
|
*/
|
|
4148
4199
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
@@ -4153,7 +4204,7 @@ export declare enum EmbedEvent {
|
|
|
4153
4204
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
4154
4205
|
* console.log('payload', payload);
|
|
4155
4206
|
* })
|
|
4156
|
-
|
|
4207
|
+
* ```
|
|
4157
4208
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4158
4209
|
*/
|
|
4159
4210
|
LastPromptEdited = "LastPromptEdited",
|
|
@@ -4164,18 +4215,18 @@ export declare enum EmbedEvent {
|
|
|
4164
4215
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
4165
4216
|
* console.log('payload', payload);
|
|
4166
4217
|
* })
|
|
4167
|
-
|
|
4218
|
+
* ```
|
|
4168
4219
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4169
4220
|
*/
|
|
4170
4221
|
LastPromptDeleted = "LastPromptDeleted",
|
|
4171
4222
|
/**
|
|
4172
|
-
* Emitted when the
|
|
4223
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
4173
4224
|
* @example
|
|
4174
4225
|
* ```js
|
|
4175
4226
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
4176
4227
|
* console.log('payload', payload);
|
|
4177
4228
|
* })
|
|
4178
|
-
|
|
4229
|
+
* ```
|
|
4179
4230
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4180
4231
|
*/
|
|
4181
4232
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
@@ -4186,7 +4237,7 @@ export declare enum EmbedEvent {
|
|
|
4186
4237
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
4187
4238
|
* console.log('payload', payload);
|
|
4188
4239
|
* })
|
|
4189
|
-
|
|
4240
|
+
* ```
|
|
4190
4241
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4191
4242
|
*/
|
|
4192
4243
|
SpotterInit = "spotterInit",
|
|
@@ -4197,7 +4248,7 @@ export declare enum EmbedEvent {
|
|
|
4197
4248
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
4198
4249
|
* console.log('payload', payload);
|
|
4199
4250
|
* })
|
|
4200
|
-
|
|
4251
|
+
* ```
|
|
4201
4252
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
4202
4253
|
*/
|
|
4203
4254
|
SpotterLoadComplete = "spotterLoadComplete",
|
|
@@ -4424,7 +4475,8 @@ export declare enum HostEvent {
|
|
|
4424
4475
|
* - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
|
|
4425
4476
|
* on the most popular column.
|
|
4426
4477
|
* - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
|
|
4427
|
-
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4478
|
+
* of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
|
|
4479
|
+
* **required**.
|
|
4428
4480
|
* @example
|
|
4429
4481
|
* ```js
|
|
4430
4482
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -4551,7 +4603,7 @@ export declare enum HostEvent {
|
|
|
4551
4603
|
* ```js
|
|
4552
4604
|
* appEmbed.navigateToPage(-1)
|
|
4553
4605
|
* ```
|
|
4554
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
4606
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
4555
4607
|
*/
|
|
4556
4608
|
Navigate = "Navigate",
|
|
4557
4609
|
/**
|
|
@@ -4620,7 +4672,8 @@ export declare enum HostEvent {
|
|
|
4620
4672
|
* the following parameters:
|
|
4621
4673
|
*
|
|
4622
4674
|
* @param - Includes the following keys:
|
|
4623
|
-
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4675
|
+
* - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
|
|
4676
|
+
* Liveboard.
|
|
4624
4677
|
* Optional when pinning a new chart or table generated from a Search query.
|
|
4625
4678
|
* **Required** in Spotter Embed.
|
|
4626
4679
|
* - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
|
|
@@ -4684,9 +4737,9 @@ export declare enum HostEvent {
|
|
|
4684
4737
|
* Trigger the **Show Liveboard details** action
|
|
4685
4738
|
* on an embedded Liveboard.
|
|
4686
4739
|
* @example
|
|
4687
|
-
|
|
4740
|
+
* ```js
|
|
4688
4741
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
4689
|
-
|
|
4742
|
+
* ```
|
|
4690
4743
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4691
4744
|
*/
|
|
4692
4745
|
LiveboardInfo = "pinboardInfo",
|
|
@@ -4814,7 +4867,7 @@ export declare enum HostEvent {
|
|
|
4814
4867
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4815
4868
|
* ```
|
|
4816
4869
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4817
|
-
*
|
|
4870
|
+
* @example
|
|
4818
4871
|
* ```js
|
|
4819
4872
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4820
4873
|
* ```
|
|
@@ -4876,7 +4929,8 @@ export declare enum HostEvent {
|
|
|
4876
4929
|
* This event is not supported in visualization embed and search embed.
|
|
4877
4930
|
* @param - Object parameter. Includes the following keys:
|
|
4878
4931
|
* - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
|
|
4879
|
-
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4932
|
+
* pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
|
|
4933
|
+
* is **required**.
|
|
4880
4934
|
*
|
|
4881
4935
|
* @example
|
|
4882
4936
|
* ```js
|
|
@@ -4905,7 +4959,7 @@ export declare enum HostEvent {
|
|
|
4905
4959
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4906
4960
|
* ```
|
|
4907
4961
|
* ```js
|
|
4908
|
-
* vizEmbed.trigger(
|
|
4962
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
4909
4963
|
* ```
|
|
4910
4964
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4911
4965
|
*/
|
|
@@ -4922,7 +4976,7 @@ export declare enum HostEvent {
|
|
|
4922
4976
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4923
4977
|
* ```
|
|
4924
4978
|
* ```js
|
|
4925
|
-
* vizEmbed.trigger(
|
|
4979
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
4926
4980
|
* ```
|
|
4927
4981
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4928
4982
|
*/
|
|
@@ -4937,23 +4991,22 @@ export declare enum HostEvent {
|
|
|
4937
4991
|
* );
|
|
4938
4992
|
* })
|
|
4939
4993
|
* ```
|
|
4940
|
-
*
|
|
4994
|
+
* @example
|
|
4941
4995
|
* ```js
|
|
4942
|
-
|
|
4943
|
-
|
|
4944
|
-
|
|
4945
|
-
|
|
4946
|
-
|
|
4947
|
-
|
|
4948
|
-
|
|
4949
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4996
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
4997
|
+
* let latestSpotterVizId = '';
|
|
4998
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
4999
|
+
* latestSpotterVizId = payload.data.id;
|
|
5000
|
+
* });
|
|
5001
|
+
*
|
|
5002
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
4950
5003
|
* vizId: latestSpotterVizId
|
|
4951
5004
|
* }).then((tml) => {
|
|
4952
5005
|
* console.log(
|
|
4953
5006
|
* tml.answer.search_query // TML representation of the search query
|
|
4954
5007
|
* );
|
|
4955
5008
|
* })
|
|
4956
|
-
|
|
5009
|
+
* ```
|
|
4957
5010
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
4958
5011
|
* @important
|
|
4959
5012
|
*/
|
|
@@ -5017,6 +5070,11 @@ export declare enum HostEvent {
|
|
|
5017
5070
|
/**
|
|
5018
5071
|
* Trigger the **Download** action on charts in
|
|
5019
5072
|
* the embedded view.
|
|
5073
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
5074
|
+
*
|
|
5075
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5076
|
+
*
|
|
5077
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5020
5078
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
5021
5079
|
* @example
|
|
5022
5080
|
* ```js
|
|
@@ -5035,9 +5093,6 @@ export declare enum HostEvent {
|
|
|
5035
5093
|
*
|
|
5036
5094
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
5037
5095
|
* ```
|
|
5038
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5039
|
-
* Use {@link DownloadAsPng}
|
|
5040
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
5041
5096
|
*/
|
|
5042
5097
|
Download = "downloadAsPng",
|
|
5043
5098
|
/**
|
|
@@ -5244,8 +5299,9 @@ export declare enum HostEvent {
|
|
|
5244
5299
|
/**
|
|
5245
5300
|
* Update one or several filters applied on a Liveboard.
|
|
5246
5301
|
* @param - Includes the following keys:
|
|
5247
|
-
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5248
|
-
* - `filters`: Multiple filter objects with column name, filter operator,
|
|
5302
|
+
* - `filter`: A single filter object containing column name, filter operator, and
|
|
5303
|
+
* values. - `filters`: Multiple filter objects with column name, filter operator,
|
|
5304
|
+
* and values for each.
|
|
5249
5305
|
*
|
|
5250
5306
|
* Each filter object must include the following attributes:
|
|
5251
5307
|
*
|
|
@@ -5475,8 +5531,8 @@ export declare enum HostEvent {
|
|
|
5475
5531
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5476
5532
|
* console.log('parameters', parameter);
|
|
5477
5533
|
* });
|
|
5478
|
-
|
|
5479
|
-
|
|
5534
|
+
* ```
|
|
5535
|
+
* ```js
|
|
5480
5536
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
5481
5537
|
* let latestSpotterVizId = '';
|
|
5482
5538
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -5484,7 +5540,7 @@ export declare enum HostEvent {
|
|
|
5484
5540
|
* });
|
|
5485
5541
|
*
|
|
5486
5542
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
5487
|
-
|
|
5543
|
+
* ```
|
|
5488
5544
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
5489
5545
|
*/
|
|
5490
5546
|
GetParameters = "GetParameters",
|
|
@@ -5501,7 +5557,7 @@ export declare enum HostEvent {
|
|
|
5501
5557
|
* Notify when info call is completed successfully
|
|
5502
5558
|
* ```js
|
|
5503
5559
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5504
|
-
|
|
5560
|
+
* ```
|
|
5505
5561
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5506
5562
|
*/
|
|
5507
5563
|
InfoSuccess = "InfoSuccess",
|
|
@@ -5514,8 +5570,8 @@ export declare enum HostEvent {
|
|
|
5514
5570
|
* triggered with a modal to prompt users to
|
|
5515
5571
|
* add a name and description for the Answer.
|
|
5516
5572
|
* @param - Includes the following keys:
|
|
5517
|
-
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5518
|
-
* - `name`: Optional. Name string for the Answer.
|
|
5573
|
+
* - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
|
|
5574
|
+
* embed. - `name`: Optional. Name string for the Answer.
|
|
5519
5575
|
* - `description`: Optional. Description text for the Answer.
|
|
5520
5576
|
* @example
|
|
5521
5577
|
* ```js
|
|
@@ -5604,7 +5660,7 @@ export declare enum HostEvent {
|
|
|
5604
5660
|
* ```js
|
|
5605
5661
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
5606
5662
|
*
|
|
5607
|
-
|
|
5663
|
+
* ```
|
|
5608
5664
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5609
5665
|
*/
|
|
5610
5666
|
AddToCoaching = "addToCoaching",
|
|
@@ -5646,7 +5702,7 @@ export declare enum HostEvent {
|
|
|
5646
5702
|
* });
|
|
5647
5703
|
*
|
|
5648
5704
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
5649
|
-
|
|
5705
|
+
* ```
|
|
5650
5706
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5651
5707
|
*/
|
|
5652
5708
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
@@ -5656,7 +5712,7 @@ export declare enum HostEvent {
|
|
|
5656
5712
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5657
5713
|
* ```js
|
|
5658
5714
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5659
|
-
|
|
5715
|
+
* ```
|
|
5660
5716
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5661
5717
|
*/
|
|
5662
5718
|
ExitPresentMode = "exitPresentMode",
|
|
@@ -5710,8 +5766,9 @@ export declare enum HostEvent {
|
|
|
5710
5766
|
/**
|
|
5711
5767
|
* Triggers a new conversation in Spotter embed.
|
|
5712
5768
|
*
|
|
5713
|
-
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5714
|
-
* Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5769
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
5770
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
5771
|
+
* instance.
|
|
5715
5772
|
*
|
|
5716
5773
|
* @example
|
|
5717
5774
|
* ```js
|
|
@@ -5889,14 +5946,14 @@ export declare enum Action {
|
|
|
5889
5946
|
* ```js
|
|
5890
5947
|
* disabledActions: [Action.CollapseDataPanel]
|
|
5891
5948
|
* ```
|
|
5892
|
-
* @version
|
|
5949
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
5893
5950
|
*/
|
|
5894
5951
|
CollapseDataSources = "collapseDataSources",
|
|
5895
5952
|
/**
|
|
5896
5953
|
* The **Collapse data panel** icon on the Search page.
|
|
5897
5954
|
* Collapses the data panel view.
|
|
5898
5955
|
*
|
|
5899
|
-
* @version
|
|
5956
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5900
5957
|
*
|
|
5901
5958
|
* @example
|
|
5902
5959
|
* ```js
|
|
@@ -6343,13 +6400,12 @@ export declare enum Action {
|
|
|
6343
6400
|
*/
|
|
6344
6401
|
CreateMonitor = "createMonitor",
|
|
6345
6402
|
/**
|
|
6346
|
-
* @
|
|
6347
|
-
*
|
|
6403
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6404
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
6348
6405
|
* @example
|
|
6349
6406
|
* ```js
|
|
6350
6407
|
* disabledActions: [Action.ReportError]
|
|
6351
6408
|
* ```
|
|
6352
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
6353
6409
|
*/
|
|
6354
6410
|
ReportError = "reportError",
|
|
6355
6411
|
/**
|
|
@@ -6359,7 +6415,7 @@ export declare enum Action {
|
|
|
6359
6415
|
* ```js
|
|
6360
6416
|
* disabledActions: [Action.SyncToSheets]
|
|
6361
6417
|
* ```
|
|
6362
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6418
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6363
6419
|
*/
|
|
6364
6420
|
SyncToSheets = "sync-to-sheets",
|
|
6365
6421
|
/**
|
|
@@ -6370,7 +6426,7 @@ export declare enum Action {
|
|
|
6370
6426
|
* ```js
|
|
6371
6427
|
* disabledActions: [Action.SyncToOtherApps]
|
|
6372
6428
|
* ```
|
|
6373
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6429
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6374
6430
|
*/
|
|
6375
6431
|
SyncToOtherApps = "sync-to-other-apps",
|
|
6376
6432
|
/**
|
|
@@ -6380,7 +6436,7 @@ export declare enum Action {
|
|
|
6380
6436
|
* ```js
|
|
6381
6437
|
* disabledActions: [Action.ManagePipelines]
|
|
6382
6438
|
* ```
|
|
6383
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6439
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
6384
6440
|
*/
|
|
6385
6441
|
ManagePipelines = "manage-pipeline",
|
|
6386
6442
|
/**
|
|
@@ -6692,7 +6748,7 @@ export declare enum Action {
|
|
|
6692
6748
|
* ```js
|
|
6693
6749
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
6694
6750
|
* ```
|
|
6695
|
-
* @version SDK
|
|
6751
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6696
6752
|
*/
|
|
6697
6753
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
6698
6754
|
/**
|
|
@@ -6702,7 +6758,7 @@ export declare enum Action {
|
|
|
6702
6758
|
* ```js
|
|
6703
6759
|
* disabledActions: [Action.LiveboardUsers]
|
|
6704
6760
|
* ```
|
|
6705
|
-
* @version SDK
|
|
6761
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
6706
6762
|
*/
|
|
6707
6763
|
LiveboardUsers = "liveboardUsers",
|
|
6708
6764
|
/**
|
|
@@ -6720,7 +6776,7 @@ export declare enum Action {
|
|
|
6720
6776
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
6721
6777
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
6722
6778
|
* ```
|
|
6723
|
-
* @version SDK
|
|
6779
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
6724
6780
|
*/
|
|
6725
6781
|
TML = "tml",
|
|
6726
6782
|
/**
|
|
@@ -6766,7 +6822,7 @@ export declare enum Action {
|
|
|
6766
6822
|
* ```js
|
|
6767
6823
|
* disabledActions: [Action.AddToWatchlist]
|
|
6768
6824
|
* ```
|
|
6769
|
-
* @version SDK
|
|
6825
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
6770
6826
|
*/
|
|
6771
6827
|
AddToWatchlist = "addToWatchlist",
|
|
6772
6828
|
/**
|
|
@@ -6776,7 +6832,7 @@ export declare enum Action {
|
|
|
6776
6832
|
* ```js
|
|
6777
6833
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
6778
6834
|
* ```
|
|
6779
|
-
* @version SDK
|
|
6835
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
6780
6836
|
*/
|
|
6781
6837
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
6782
6838
|
/**
|
|
@@ -6787,7 +6843,7 @@ export declare enum Action {
|
|
|
6787
6843
|
* ```js
|
|
6788
6844
|
* disabledActions: [Action.OrganiseFavourites]
|
|
6789
6845
|
* ```
|
|
6790
|
-
* @version SDK
|
|
6846
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
6791
6847
|
*/
|
|
6792
6848
|
OrganiseFavourites = "organiseFavourites",
|
|
6793
6849
|
/**
|
|
@@ -6848,7 +6904,7 @@ export declare enum Action {
|
|
|
6848
6904
|
* ```js
|
|
6849
6905
|
* disabledActions: [Action.ManageTags]
|
|
6850
6906
|
* ```
|
|
6851
|
-
* @version SDK
|
|
6907
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6852
6908
|
*/
|
|
6853
6909
|
ManageTags = "manageTags",
|
|
6854
6910
|
/**
|
|
@@ -7494,15 +7550,16 @@ declare enum EmbedErrorCodes {
|
|
|
7494
7550
|
/**
|
|
7495
7551
|
* Error event object emitted when an error occurs in an embedded component.
|
|
7496
7552
|
*
|
|
7497
|
-
* This interface defines the structure of error objects returned by the {@link
|
|
7498
|
-
* event. It provides detailed information about what went wrong,
|
|
7499
|
-
* a human-readable message, and a machine-readable error code.
|
|
7553
|
+
* This interface defines the structure of error objects returned by the {@link
|
|
7554
|
+
* EmbedEvent.Error} event. It provides detailed information about what went wrong,
|
|
7555
|
+
* including the error type, a human-readable message, and a machine-readable error code.
|
|
7500
7556
|
*
|
|
7501
7557
|
* ## Properties
|
|
7502
7558
|
*
|
|
7503
7559
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
7504
|
-
* - **message**: Human-readable error description (string or array of strings for
|
|
7505
|
-
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7560
|
+
* - **message**: Human-readable error description (string or array of strings for
|
|
7561
|
+
* multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
|
|
7562
|
+
* values
|
|
7506
7563
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
7507
7564
|
*
|
|
7508
7565
|
* ## Usage
|
|
@@ -7600,14 +7657,14 @@ export type ApiInterceptFlags = {
|
|
|
7600
7657
|
/**
|
|
7601
7658
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
7602
7659
|
*
|
|
7603
|
-
* Can be used for
|
|
7660
|
+
* Can be used for Search and App Embed from SDK 1.29.0
|
|
7604
7661
|
*
|
|
7605
|
-
* @version SDK
|
|
7662
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7606
7663
|
*/
|
|
7607
7664
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
7608
7665
|
/**
|
|
7609
7666
|
* This allows to intercept the urls passed, once intercepted the api will only
|
|
7610
|
-
* run based on the
|
|
7667
|
+
* run based on the response from the responder of ApiIntercept event.
|
|
7611
7668
|
*
|
|
7612
7669
|
* @example
|
|
7613
7670
|
* ```js
|
|
@@ -7618,7 +7675,7 @@ export type ApiInterceptFlags = {
|
|
|
7618
7675
|
* })
|
|
7619
7676
|
* ```
|
|
7620
7677
|
*
|
|
7621
|
-
* @version SDK
|
|
7678
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7622
7679
|
*/
|
|
7623
7680
|
interceptUrls?: (string | InterceptedApiType)[];
|
|
7624
7681
|
/**
|
|
@@ -7635,7 +7692,7 @@ export type ApiInterceptFlags = {
|
|
|
7635
7692
|
* })
|
|
7636
7693
|
* ```
|
|
7637
7694
|
*
|
|
7638
|
-
* @version SDK
|
|
7695
|
+
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
7639
7696
|
*/
|
|
7640
7697
|
interceptTimeout?: number;
|
|
7641
7698
|
};
|
|
@@ -7765,20 +7822,45 @@ declare enum AuthFailureType {
|
|
|
7765
7822
|
}
|
|
7766
7823
|
declare enum AuthStatus {
|
|
7767
7824
|
/**
|
|
7768
|
-
* Emits when the SDK fails to authenticate
|
|
7825
|
+
* Emits when the SDK fails to authenticate.
|
|
7769
7826
|
*/
|
|
7770
7827
|
FAILURE = "FAILURE",
|
|
7771
7828
|
/**
|
|
7772
|
-
* Emits when the SDK
|
|
7829
|
+
* Emits when the SDK authentication step completes
|
|
7830
|
+
* successfully (e.g., token exchange, cookie set).
|
|
7831
|
+
* This fires before any iframe is rendered. Use
|
|
7832
|
+
* this to know that auth passed and it is safe to
|
|
7833
|
+
* proceed with rendering. The callback receives no
|
|
7834
|
+
* arguments.
|
|
7835
|
+
* @example
|
|
7836
|
+
* ```js
|
|
7837
|
+
* const authEE = init({ ... });
|
|
7838
|
+
* authEE.on(AuthStatus.SDK_SUCCESS, () => {
|
|
7839
|
+
* // Auth done, iframe not loaded yet
|
|
7840
|
+
* });
|
|
7841
|
+
* ```
|
|
7773
7842
|
*/
|
|
7774
7843
|
SDK_SUCCESS = "SDK_SUCCESS",
|
|
7775
7844
|
/**
|
|
7776
7845
|
* @hidden
|
|
7777
|
-
* Emits when iframe is loaded and session
|
|
7846
|
+
* Emits when iframe is loaded and session
|
|
7847
|
+
* information is available.
|
|
7778
7848
|
*/
|
|
7779
7849
|
SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
|
|
7780
7850
|
/**
|
|
7781
|
-
* Emits when the app
|
|
7851
|
+
* Emits when the ThoughtSpot app inside the
|
|
7852
|
+
* embedded iframe confirms its session is active.
|
|
7853
|
+
* This fires after the iframe loads and sends back an `AuthInit` event.
|
|
7854
|
+
* @param sessionInfo Information about the user session, with details like `userGUID`.
|
|
7855
|
+
* @see EmbedEvent.AuthInit
|
|
7856
|
+
* @example
|
|
7857
|
+
* ```js
|
|
7858
|
+
* const authEE = init({ ... });
|
|
7859
|
+
* authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
|
|
7860
|
+
* // App is loaded and authenticated
|
|
7861
|
+
* console.log(sessionInfo.userGUID);
|
|
7862
|
+
* });
|
|
7863
|
+
* ```
|
|
7782
7864
|
*/
|
|
7783
7865
|
SUCCESS = "SUCCESS",
|
|
7784
7866
|
/**
|
|
@@ -8010,9 +8092,9 @@ declare class TsEmbed {
|
|
|
8010
8092
|
*/
|
|
8011
8093
|
private isPreRendered;
|
|
8012
8094
|
/**
|
|
8013
|
-
* Should we encode URL Query Params using base64 encoding which
|
|
8095
|
+
* Should we encode URL Query Params using base64 encoding which ThoughtSpot
|
|
8014
8096
|
* will generate for embedding. This provides additional security to
|
|
8015
|
-
*
|
|
8097
|
+
* ThoughtSpot clusters against Cross site scripting attacks.
|
|
8016
8098
|
* @default false
|
|
8017
8099
|
*/
|
|
8018
8100
|
private shouldEncodeUrlQueryParams;
|
|
@@ -8378,7 +8460,7 @@ declare class TsEmbed {
|
|
|
8378
8460
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
8379
8461
|
* session.
|
|
8380
8462
|
* @param vizId [Optional] to get for a specific viz in case of a Liveboard.
|
|
8381
|
-
* @version SDK: 1.25.0
|
|
8463
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
|
|
8382
8464
|
*/
|
|
8383
8465
|
getAnswerService(vizId?: string): Promise<AnswerService>;
|
|
8384
8466
|
/**
|
|
@@ -8465,7 +8547,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8465
8547
|
* but can be expanded manually.
|
|
8466
8548
|
*
|
|
8467
8549
|
* Supported embed types: `SearchEmbed`
|
|
8468
|
-
* @version
|
|
8550
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8469
8551
|
* @example
|
|
8470
8552
|
* ```js
|
|
8471
8553
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8480,7 +8562,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8480
8562
|
* but can be expanded manually.
|
|
8481
8563
|
*
|
|
8482
8564
|
* Supported embed types: `SearchEmbed`
|
|
8483
|
-
* @version
|
|
8565
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
8484
8566
|
* @example
|
|
8485
8567
|
* ```js
|
|
8486
8568
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8494,7 +8576,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8494
8576
|
* Show or hide the data sources panel.
|
|
8495
8577
|
*
|
|
8496
8578
|
* Supported embed types: `SearchEmbed`
|
|
8497
|
-
* @version
|
|
8579
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
8498
8580
|
* @example
|
|
8499
8581
|
* ```js
|
|
8500
8582
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8510,7 +8592,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8510
8592
|
* using raw answer data.
|
|
8511
8593
|
*
|
|
8512
8594
|
* Supported embed types: `SearchEmbed`
|
|
8513
|
-
* @version
|
|
8595
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
8514
8596
|
* @example
|
|
8515
8597
|
* ```js
|
|
8516
8598
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8539,7 +8621,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8539
8621
|
* format for presenting search data.
|
|
8540
8622
|
*
|
|
8541
8623
|
* Supported embed types: `SearchEmbed`
|
|
8542
|
-
* @version
|
|
8624
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8543
8625
|
* @example
|
|
8544
8626
|
* ```js
|
|
8545
8627
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8552,6 +8634,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8552
8634
|
/**
|
|
8553
8635
|
* The array of data source GUIDs to set on load.
|
|
8554
8636
|
* Only a single data source is supported currently.
|
|
8637
|
+
* Use {@link dataSource} instead.
|
|
8555
8638
|
* @deprecated Use `dataSource` instead.
|
|
8556
8639
|
*
|
|
8557
8640
|
* Supported embed types: `SearchEmbed`
|
|
@@ -8565,10 +8648,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8565
8648
|
*/
|
|
8566
8649
|
dataSources?: string[];
|
|
8567
8650
|
/**
|
|
8568
|
-
* The
|
|
8651
|
+
* The data source GUID to set on load.
|
|
8569
8652
|
*
|
|
8570
8653
|
* Supported embed types: `SearchEmbed`
|
|
8571
|
-
* @version
|
|
8654
|
+
* @version SDK: 1.19.0
|
|
8572
8655
|
* @example
|
|
8573
8656
|
* ```js
|
|
8574
8657
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8580,9 +8663,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8580
8663
|
dataSource?: string;
|
|
8581
8664
|
/**
|
|
8582
8665
|
* The initial search query to load the answer with.
|
|
8666
|
+
* Use {@link searchOptions} instead.
|
|
8583
8667
|
* @deprecated
|
|
8584
8668
|
*
|
|
8585
|
-
* Use {@link searchOptions} instead.
|
|
8586
8669
|
*/
|
|
8587
8670
|
searchQuery?: string;
|
|
8588
8671
|
/**
|
|
@@ -8611,7 +8694,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8611
8694
|
* If set to true, the search token string is not appended to the URL.
|
|
8612
8695
|
*
|
|
8613
8696
|
* Supported embed types: `SearchEmbed`
|
|
8614
|
-
* @version
|
|
8697
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
8615
8698
|
* @example
|
|
8616
8699
|
* ```js
|
|
8617
8700
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8628,7 +8711,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8628
8711
|
* The GUID of a saved answer to load initially.
|
|
8629
8712
|
*
|
|
8630
8713
|
* Supported embed types: `SearchEmbed`
|
|
8631
|
-
* @version
|
|
8714
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
8632
8715
|
* @example
|
|
8633
8716
|
* ```js
|
|
8634
8717
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -8657,14 +8740,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
8657
8740
|
* Flag to set if last selected dataSource should be used
|
|
8658
8741
|
*
|
|
8659
8742
|
* Supported embed types: `SearchEmbed`
|
|
8660
|
-
* @version
|
|
8743
|
+
* @version SDK: 1.24.0
|
|
8661
8744
|
*/
|
|
8662
8745
|
useLastSelectedSources?: boolean;
|
|
8663
8746
|
/**
|
|
8664
8747
|
* To set the initial state of the search bar in case of saved-answers.
|
|
8665
|
-
* @default false
|
|
8666
8748
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
8667
8749
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
8750
|
+
* @default false
|
|
8668
8751
|
*/
|
|
8669
8752
|
collapseSearchBarInitially?: boolean;
|
|
8670
8753
|
/**
|
|
@@ -8748,8 +8831,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8748
8831
|
* Only a single data source is supported currently.
|
|
8749
8832
|
*
|
|
8750
8833
|
* Supported embed types: `SearchBarEmbed`
|
|
8834
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
8751
8835
|
* @deprecated Use `dataSource` instead
|
|
8752
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
8753
8836
|
* @example
|
|
8754
8837
|
* ```js
|
|
8755
8838
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8763,7 +8846,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8763
8846
|
* Pass the ID of the source to be selected.
|
|
8764
8847
|
*
|
|
8765
8848
|
* Supported embed types: `SearchBarEmbed`
|
|
8766
|
-
* @version
|
|
8849
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
8767
8850
|
* @example
|
|
8768
8851
|
* ```js
|
|
8769
8852
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8777,7 +8860,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8777
8860
|
* Boolean to define if the last selected data source should be used
|
|
8778
8861
|
*
|
|
8779
8862
|
* Supported embed types: `SearchBarEmbed`
|
|
8780
|
-
* @version
|
|
8863
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
|
|
8781
8864
|
* @example
|
|
8782
8865
|
* ```js
|
|
8783
8866
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8799,7 +8882,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8799
8882
|
* the token string in the search bar.
|
|
8800
8883
|
*
|
|
8801
8884
|
* Supported embed types: `SearchBarEmbed`
|
|
8802
|
-
* @version
|
|
8885
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
8803
8886
|
* @example
|
|
8804
8887
|
* ```js
|
|
8805
8888
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -8817,10 +8900,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
8817
8900
|
* If set to true, the search token string is not appended to the URL.
|
|
8818
8901
|
*
|
|
8819
8902
|
* Supported embed types: `SearchBarEmbed`
|
|
8820
|
-
* @version
|
|
8903
|
+
* @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
8821
8904
|
* @example
|
|
8822
8905
|
* ```js
|
|
8823
|
-
* const embed = new
|
|
8906
|
+
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
8824
8907
|
* searchOptions: {
|
|
8825
8908
|
* searchTokenString: '[quantity purchased] [region]',
|
|
8826
8909
|
* executeSearch: true,
|
|
@@ -8873,7 +8956,7 @@ interface SearchOptions$1 {
|
|
|
8873
8956
|
/**
|
|
8874
8957
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
8875
8958
|
* GPT and LLM.
|
|
8876
|
-
* @version
|
|
8959
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8877
8960
|
*
|
|
8878
8961
|
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
8879
8962
|
* @group Embed components
|
|
@@ -8927,14 +9010,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8927
9010
|
hideAutocompleteSuggestions?: boolean;
|
|
8928
9011
|
/**
|
|
8929
9012
|
* Show or hide autocomplete suggestions for the search query string.
|
|
9013
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
8930
9014
|
* @deprecated
|
|
8931
9015
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
8932
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
8933
9016
|
*/
|
|
8934
9017
|
showObjectSuggestions?: boolean;
|
|
8935
9018
|
/**
|
|
8936
9019
|
* Show or hide sample questions.
|
|
8937
|
-
* The sample questions are autogenerated based on the data
|
|
9020
|
+
* The sample questions are autogenerated based on the data model
|
|
8938
9021
|
* selected for the search operation.
|
|
8939
9022
|
*
|
|
8940
9023
|
* Supported embed types: `SageEmbed`
|
|
@@ -8964,6 +9047,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8964
9047
|
* the token string in the search bar.
|
|
8965
9048
|
*
|
|
8966
9049
|
* Supported embed types: `SageEmbed`
|
|
9050
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8967
9051
|
* @example
|
|
8968
9052
|
* ```js
|
|
8969
9053
|
* searchOptions: {
|
|
@@ -8971,7 +9055,6 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
8971
9055
|
* executeSearch: true,
|
|
8972
9056
|
* }
|
|
8973
9057
|
* ```
|
|
8974
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
8975
9058
|
*/
|
|
8976
9059
|
searchOptions?: SearchOptions$1;
|
|
8977
9060
|
}
|
|
@@ -9011,81 +9094,81 @@ interface SearchOptions$2 {
|
|
|
9011
9094
|
* Configuration for the Spotter sidebar.
|
|
9012
9095
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
9013
9096
|
* @group Embed components
|
|
9014
|
-
* @version SDK: 1.
|
|
9097
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9015
9098
|
*/
|
|
9016
9099
|
export interface SpotterSidebarViewConfig {
|
|
9017
9100
|
/**
|
|
9018
9101
|
* Controls the visibility of the past conversations sidebar.
|
|
9019
9102
|
* @default false
|
|
9020
|
-
* @version SDK: 1.
|
|
9103
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9021
9104
|
*/
|
|
9022
9105
|
enablePastConversationsSidebar?: boolean;
|
|
9023
9106
|
/**
|
|
9024
9107
|
* Custom title text for the sidebar header.
|
|
9025
9108
|
* Defaults to translated "Spotter" text.
|
|
9026
|
-
* @version SDK: 1.
|
|
9109
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9027
9110
|
*/
|
|
9028
9111
|
spotterSidebarTitle?: string;
|
|
9029
9112
|
/**
|
|
9030
9113
|
* Boolean to set the default expanded state of the sidebar.
|
|
9031
9114
|
* @default false
|
|
9032
|
-
* @version SDK: 1.
|
|
9115
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9033
9116
|
*/
|
|
9034
9117
|
spotterSidebarDefaultExpanded?: boolean;
|
|
9035
9118
|
/**
|
|
9036
9119
|
* Custom label text for the rename action in the conversation edit menu.
|
|
9037
9120
|
* Defaults to translated "Rename" text.
|
|
9038
|
-
* @version SDK: 1.
|
|
9121
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9039
9122
|
*/
|
|
9040
9123
|
spotterChatRenameLabel?: string;
|
|
9041
9124
|
/**
|
|
9042
9125
|
* Custom label text for the delete action in the conversation edit menu.
|
|
9043
9126
|
* Defaults to translated "DELETE" text.
|
|
9044
|
-
* @version SDK: 1.
|
|
9127
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9045
9128
|
*/
|
|
9046
9129
|
spotterChatDeleteLabel?: string;
|
|
9047
9130
|
/**
|
|
9048
9131
|
* Custom title text for the delete conversation confirmation modal.
|
|
9049
9132
|
* Defaults to translated "Delete chat" text.
|
|
9050
|
-
* @version SDK: 1.
|
|
9133
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9051
9134
|
*/
|
|
9052
9135
|
spotterDeleteConversationModalTitle?: string;
|
|
9053
9136
|
/**
|
|
9054
9137
|
* Custom message text for the past conversation banner alert.
|
|
9055
9138
|
* Defaults to translated alert message.
|
|
9056
|
-
* @version SDK: 1.
|
|
9139
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9057
9140
|
*/
|
|
9058
9141
|
spotterPastConversationAlertMessage?: string;
|
|
9059
9142
|
/**
|
|
9060
9143
|
* Custom URL for the documentation/best practices link.
|
|
9061
9144
|
* Defaults to ThoughtSpot docs URL based on release version.
|
|
9062
9145
|
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
9063
|
-
* @version SDK: 1.
|
|
9146
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9064
9147
|
*/
|
|
9065
9148
|
spotterDocumentationUrl?: string;
|
|
9066
9149
|
/**
|
|
9067
9150
|
* Custom label text for the best practices button in the footer.
|
|
9068
9151
|
* Defaults to translated "Best Practices" text.
|
|
9069
|
-
* @version SDK: 1.
|
|
9152
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9070
9153
|
*/
|
|
9071
9154
|
spotterBestPracticesLabel?: string;
|
|
9072
9155
|
/**
|
|
9073
9156
|
* Number of conversations to fetch per batch when loading conversation history.
|
|
9074
9157
|
* @default 30
|
|
9075
|
-
* @version SDK: 1.
|
|
9158
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9076
9159
|
*/
|
|
9077
9160
|
spotterConversationsBatchSize?: number;
|
|
9078
9161
|
/**
|
|
9079
9162
|
* Custom title text for the "New Chat" button in the sidebar.
|
|
9080
9163
|
* Defaults to translated "New Chat" text.
|
|
9081
|
-
* @version SDK: 1.
|
|
9164
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9082
9165
|
*/
|
|
9083
9166
|
spotterNewChatButtonTitle?: string;
|
|
9084
9167
|
}
|
|
9085
9168
|
/**
|
|
9086
9169
|
* Configuration for customizing Spotter chat UI branding.
|
|
9087
|
-
* @group Embed components
|
|
9088
9170
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9171
|
+
* @group Embed components
|
|
9089
9172
|
*/
|
|
9090
9173
|
export interface SpotterChatViewConfig {
|
|
9091
9174
|
/**
|
|
@@ -9124,6 +9207,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9124
9207
|
* but still display the selected data source.
|
|
9125
9208
|
*
|
|
9126
9209
|
* Supported embed types: `SpotterEmbed`
|
|
9210
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9127
9211
|
* @example
|
|
9128
9212
|
* ```js
|
|
9129
9213
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9131,13 +9215,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9131
9215
|
* disableSourceSelection : true,
|
|
9132
9216
|
* })
|
|
9133
9217
|
* ```
|
|
9134
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9135
9218
|
*/
|
|
9136
9219
|
disableSourceSelection?: boolean;
|
|
9137
9220
|
/**
|
|
9138
9221
|
* hideSourceSelection : Hide data source selection
|
|
9139
9222
|
*
|
|
9140
9223
|
* Supported embed types: `SpotterEmbed`
|
|
9224
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9141
9225
|
* @example
|
|
9142
9226
|
* ```js
|
|
9143
9227
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9145,15 +9229,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9145
9229
|
* hideSourceSelection : true,
|
|
9146
9230
|
* })
|
|
9147
9231
|
* ```
|
|
9148
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9149
9232
|
*/
|
|
9150
9233
|
hideSourceSelection?: boolean;
|
|
9151
9234
|
/**
|
|
9152
9235
|
* Flag to control Data panel experience
|
|
9153
9236
|
*
|
|
9154
9237
|
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
9238
|
+
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
9155
9239
|
* @default true
|
|
9156
|
-
* @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
9157
9240
|
* @example
|
|
9158
9241
|
* ```js
|
|
9159
9242
|
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
@@ -9170,6 +9253,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9170
9253
|
* default is false.
|
|
9171
9254
|
*
|
|
9172
9255
|
* Supported embed types: `SpotterEmbed`
|
|
9256
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
9173
9257
|
* @example
|
|
9174
9258
|
* ```js
|
|
9175
9259
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9177,7 +9261,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9177
9261
|
* showSpotterLimitations : true,
|
|
9178
9262
|
* })
|
|
9179
9263
|
* ```
|
|
9180
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
9181
9264
|
*/
|
|
9182
9265
|
showSpotterLimitations?: boolean;
|
|
9183
9266
|
/**
|
|
@@ -9185,6 +9268,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9185
9268
|
* the initial screen of the conversation.
|
|
9186
9269
|
*
|
|
9187
9270
|
* Supported embed types: `SpotterEmbed`
|
|
9271
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9188
9272
|
* @example
|
|
9189
9273
|
* ```js
|
|
9190
9274
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9192,7 +9276,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9192
9276
|
* hideSampleQuestions : true,
|
|
9193
9277
|
* })
|
|
9194
9278
|
* ```
|
|
9195
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9196
9279
|
*/
|
|
9197
9280
|
hideSampleQuestions?: boolean;
|
|
9198
9281
|
/**
|
|
@@ -9200,6 +9283,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9200
9283
|
* visualization, or Liveboard.
|
|
9201
9284
|
*
|
|
9202
9285
|
* Supported embed types: `SpotterEmbed`
|
|
9286
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9203
9287
|
* @example
|
|
9204
9288
|
* ```js
|
|
9205
9289
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9213,7 +9297,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9213
9297
|
* ],
|
|
9214
9298
|
* })
|
|
9215
9299
|
* ```
|
|
9216
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9217
9300
|
*/
|
|
9218
9301
|
runtimeFilters?: RuntimeFilter[];
|
|
9219
9302
|
/**
|
|
@@ -9224,14 +9307,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9224
9307
|
* (default behavior before SDK 1.45.0).
|
|
9225
9308
|
*
|
|
9226
9309
|
* Supported embed types: `SpotterEmbed`
|
|
9227
|
-
* @default true
|
|
9228
9310
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9311
|
+
* @default true
|
|
9229
9312
|
*/
|
|
9230
9313
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
9231
9314
|
/**
|
|
9232
9315
|
* The list of runtime parameters to apply to the conversation.
|
|
9233
9316
|
*
|
|
9234
9317
|
* Supported embed types: `SpotterEmbed`
|
|
9318
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9235
9319
|
* @example
|
|
9236
9320
|
* ```js
|
|
9237
9321
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9244,7 +9328,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9244
9328
|
* ],
|
|
9245
9329
|
* })
|
|
9246
9330
|
* ```
|
|
9247
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9248
9331
|
*/
|
|
9249
9332
|
runtimeParameters?: RuntimeParameter[];
|
|
9250
9333
|
/**
|
|
@@ -9255,14 +9338,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9255
9338
|
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9256
9339
|
*
|
|
9257
9340
|
* Supported embed types: `SpotterEmbed`
|
|
9258
|
-
* @default true
|
|
9259
9341
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9342
|
+
* @default true
|
|
9260
9343
|
*/
|
|
9261
9344
|
excludeRuntimeParametersfromURL?: boolean;
|
|
9262
9345
|
/**
|
|
9263
9346
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9264
9347
|
*
|
|
9265
9348
|
* Supported embed types: `SpotterEmbed`
|
|
9349
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9266
9350
|
* @default false
|
|
9267
9351
|
* @example
|
|
9268
9352
|
* ```js
|
|
@@ -9271,17 +9355,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9271
9355
|
* updatedSpotterChatPrompt : true,
|
|
9272
9356
|
* })
|
|
9273
9357
|
* ```
|
|
9274
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9275
9358
|
*/
|
|
9276
9359
|
updatedSpotterChatPrompt?: boolean;
|
|
9360
|
+
/**
|
|
9361
|
+
* Controls the visibility of the past conversations sidebar.
|
|
9362
|
+
*
|
|
9363
|
+
* Supported embed types: `SpotterEmbed`
|
|
9364
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9365
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9366
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
9367
|
+
* @default false
|
|
9368
|
+
*/
|
|
9369
|
+
enablePastConversationsSidebar?: boolean;
|
|
9277
9370
|
/**
|
|
9278
9371
|
* Configuration for the Spotter sidebar UI customization.
|
|
9279
9372
|
*
|
|
9280
9373
|
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
9374
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9281
9375
|
* @example
|
|
9282
9376
|
* ```js
|
|
9283
9377
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9284
|
-
*
|
|
9378
|
+
* worksheetId: 'worksheet-id',
|
|
9379
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
9380
|
+
* enablePastConversationsSidebar: false,
|
|
9381
|
+
* // Recommended config; this value takes precedence
|
|
9285
9382
|
* spotterSidebarConfig: {
|
|
9286
9383
|
* enablePastConversationsSidebar: true,
|
|
9287
9384
|
* spotterSidebarTitle: 'My Conversations',
|
|
@@ -9289,7 +9386,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9289
9386
|
* },
|
|
9290
9387
|
* })
|
|
9291
9388
|
* ```
|
|
9292
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9293
9389
|
*/
|
|
9294
9390
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9295
9391
|
/**
|
|
@@ -9297,6 +9393,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9297
9393
|
* branding in tool response cards.
|
|
9298
9394
|
*
|
|
9299
9395
|
* Supported embed types: `SpotterEmbed`
|
|
9396
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9300
9397
|
* @example
|
|
9301
9398
|
* ```js
|
|
9302
9399
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
@@ -9307,14 +9404,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9307
9404
|
* },
|
|
9308
9405
|
* })
|
|
9309
9406
|
* ```
|
|
9310
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9311
9407
|
*/
|
|
9312
9408
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9313
9409
|
}
|
|
9314
9410
|
/**
|
|
9315
9411
|
* The configuration for the embedded spotterEmbed options.
|
|
9316
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
9317
9412
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
9413
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
9318
9414
|
* @group Embed components
|
|
9319
9415
|
*/
|
|
9320
9416
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
@@ -9423,7 +9519,7 @@ declare enum ListPage {
|
|
|
9423
9519
|
*/
|
|
9424
9520
|
export interface DiscoveryExperience {
|
|
9425
9521
|
/**
|
|
9426
|
-
* primaryNavbarVersion determines the version of the navigation
|
|
9522
|
+
* primaryNavbarVersion determines the version of the primary navigation bar.
|
|
9427
9523
|
*/
|
|
9428
9524
|
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
9429
9525
|
/**
|
|
@@ -9446,8 +9542,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9446
9542
|
* This flag also controls the homepage left navigation bar.
|
|
9447
9543
|
*
|
|
9448
9544
|
* Supported embed types: `AppEmbed`
|
|
9449
|
-
* @default true
|
|
9450
9545
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9546
|
+
* @default true
|
|
9451
9547
|
* @example
|
|
9452
9548
|
* ```js
|
|
9453
9549
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9468,8 +9564,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9468
9564
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9469
9565
|
*
|
|
9470
9566
|
* Supported embed types: `AppEmbed`
|
|
9471
|
-
* @default false
|
|
9472
9567
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9568
|
+
* @default false
|
|
9473
9569
|
* @example
|
|
9474
9570
|
* ```js
|
|
9475
9571
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9486,8 +9582,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9486
9582
|
* navigation bar is not hidden via `showPrimaryNavbar`.
|
|
9487
9583
|
*
|
|
9488
9584
|
* Supported embed types: `AppEmbed`
|
|
9489
|
-
* @default false
|
|
9490
9585
|
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
9586
|
+
* @default false
|
|
9491
9587
|
* @example
|
|
9492
9588
|
* ```js
|
|
9493
9589
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9498,12 +9594,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9498
9594
|
*/
|
|
9499
9595
|
disableProfileAndHelp?: boolean;
|
|
9500
9596
|
/**
|
|
9501
|
-
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9502
|
-
* @default true
|
|
9503
9597
|
* Whether the help menu in the top navigation bar should be served
|
|
9504
9598
|
* from Pendo or ThoughtSpot's internal help items.
|
|
9505
9599
|
*
|
|
9506
9600
|
* Supported embed types: `AppEmbed`
|
|
9601
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
9602
|
+
* @default true
|
|
9507
9603
|
* @example
|
|
9508
9604
|
* ```js
|
|
9509
9605
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9518,8 +9614,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9518
9614
|
* the top navigation bar in the V3 navigation experience.
|
|
9519
9615
|
*
|
|
9520
9616
|
* Supported embed types: `AppEmbed`
|
|
9521
|
-
* @default false
|
|
9522
9617
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9618
|
+
* @default false
|
|
9523
9619
|
* @example
|
|
9524
9620
|
* ```js
|
|
9525
9621
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9538,8 +9634,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9538
9634
|
* in the classic (V1) experience.
|
|
9539
9635
|
*
|
|
9540
9636
|
* Supported embed types: `AppEmbed`
|
|
9541
|
-
* @default true
|
|
9542
9637
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9638
|
+
* @default true
|
|
9543
9639
|
* @example
|
|
9544
9640
|
* ```js
|
|
9545
9641
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9557,8 +9653,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9557
9653
|
* in the classic (V1) and V2 experience modes.
|
|
9558
9654
|
*
|
|
9559
9655
|
* Supported embed types: `AppEmbed`
|
|
9560
|
-
* @default true
|
|
9561
9656
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9657
|
+
* @default true
|
|
9562
9658
|
* @example
|
|
9563
9659
|
* ```js
|
|
9564
9660
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9574,7 +9670,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9574
9670
|
* In the V3 experience, it shows or hides application selection
|
|
9575
9671
|
* icons on the left navigation panel.
|
|
9576
9672
|
* By default, the application selection menu and icons are
|
|
9577
|
-
* shown in the UI
|
|
9673
|
+
* shown in the UI.
|
|
9578
9674
|
*
|
|
9579
9675
|
* **Note**: This attribute is not supported in the classic (V1) experience.
|
|
9580
9676
|
*
|
|
@@ -9614,7 +9710,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9614
9710
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
9615
9711
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
9616
9712
|
*
|
|
9617
|
-
* For
|
|
9713
|
+
* For example, if you want the component to open to a specific Liveboard
|
|
9618
9714
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
9619
9715
|
*
|
|
9620
9716
|
* Supported embed types: `AppEmbed`
|
|
@@ -9632,7 +9728,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9632
9728
|
* The application page to set as the start page
|
|
9633
9729
|
* in the embedded view.
|
|
9634
9730
|
*
|
|
9635
|
-
* Use this to open to particular page in the app. To open to a specific
|
|
9731
|
+
* Use this to open to a particular page in the app. To open to a specific
|
|
9636
9732
|
* path within the app, use the `path` attribute which is more flexible.
|
|
9637
9733
|
*
|
|
9638
9734
|
* Supported embed types: `AppEmbed`
|
|
@@ -9712,8 +9808,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9712
9808
|
* If set to true, the Search Assist feature is enabled.
|
|
9713
9809
|
*
|
|
9714
9810
|
* Supported embed types: `AppEmbed`
|
|
9715
|
-
* @default true
|
|
9716
9811
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
9812
|
+
* @default true
|
|
9717
9813
|
* @example
|
|
9718
9814
|
* ```js
|
|
9719
9815
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9751,8 +9847,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9751
9847
|
* For more information,
|
|
9752
9848
|
* see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9753
9849
|
* Supported embed types: `AppEmbed`
|
|
9754
|
-
* @default false
|
|
9755
9850
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
9851
|
+
* @default false
|
|
9756
9852
|
* @example
|
|
9757
9853
|
* ```js
|
|
9758
9854
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9767,8 +9863,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9767
9863
|
* For more information, see
|
|
9768
9864
|
* link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
|
|
9769
9865
|
* Supported embed types: `AppEmbed`
|
|
9770
|
-
* @default false
|
|
9771
9866
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
9867
|
+
* @default false
|
|
9772
9868
|
* @example
|
|
9773
9869
|
* ```js
|
|
9774
9870
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9783,10 +9879,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9783
9879
|
*/
|
|
9784
9880
|
discoveryExperience?: DiscoveryExperience;
|
|
9785
9881
|
/**
|
|
9786
|
-
* To set the initial state of the search bar in case of saved-answers.
|
|
9882
|
+
* To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
|
|
9787
9883
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
9884
|
+
* @deprecated This flag is deprecated.
|
|
9788
9885
|
* @default false
|
|
9789
|
-
* @deprecated Use {@link collapseSearchBar} instead
|
|
9790
9886
|
*/
|
|
9791
9887
|
collapseSearchBarInitially?: boolean;
|
|
9792
9888
|
/**
|
|
@@ -9814,14 +9910,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9814
9910
|
* Flag to use home page search bar mode
|
|
9815
9911
|
*
|
|
9816
9912
|
* Supported embed types: `AppEmbed`
|
|
9817
|
-
* @version SDK
|
|
9913
|
+
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
9818
9914
|
*/
|
|
9819
9915
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
9820
9916
|
/**
|
|
9821
9917
|
* This flag is used to enable unified search experience for full app embed.
|
|
9822
9918
|
*
|
|
9823
9919
|
* Supported embed types: `AppEmbed`
|
|
9824
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
9920
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
9825
9921
|
* @default true
|
|
9826
9922
|
* @example
|
|
9827
9923
|
* ```js
|
|
@@ -9833,7 +9929,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9833
9929
|
*/
|
|
9834
9930
|
isUnifiedSearchExperienceEnabled?: boolean;
|
|
9835
9931
|
/**
|
|
9836
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
9932
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
9933
|
+
* @deprecated This flag is deprecated.
|
|
9837
9934
|
*
|
|
9838
9935
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9839
9936
|
* @type {boolean}
|
|
@@ -9849,7 +9946,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9849
9946
|
*/
|
|
9850
9947
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
9851
9948
|
/**
|
|
9852
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9949
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
9950
|
+
* mails
|
|
9853
9951
|
*
|
|
9854
9952
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
9855
9953
|
* @type {boolean}
|
|
@@ -9899,6 +9997,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9899
9997
|
/**
|
|
9900
9998
|
* This flag is used to enable the full height lazy load data.
|
|
9901
9999
|
*
|
|
10000
|
+
* @type {boolean}
|
|
10001
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10002
|
+
* @default false
|
|
9902
10003
|
* @example
|
|
9903
10004
|
* ```js
|
|
9904
10005
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -9907,39 +10008,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9907
10008
|
* lazyLoadingForFullHeight: true,
|
|
9908
10009
|
* })
|
|
9909
10010
|
* ```
|
|
9910
|
-
*
|
|
9911
|
-
* @type {boolean}
|
|
9912
|
-
* @default false
|
|
9913
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9914
10011
|
*/
|
|
9915
10012
|
lazyLoadingForFullHeight?: boolean;
|
|
9916
10013
|
/**
|
|
9917
10014
|
* The margin to be used for lazy loading.
|
|
9918
10015
|
*
|
|
9919
10016
|
* For example, if the margin is set to '10px',
|
|
9920
|
-
* the visualization will be loaded 10px before
|
|
10017
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
9921
10018
|
* viewport.
|
|
9922
10019
|
*
|
|
9923
10020
|
* The format is similar to CSS margin.
|
|
9924
10021
|
*
|
|
10022
|
+
* @type {string}
|
|
10023
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
9925
10024
|
* @example
|
|
9926
10025
|
* ```js
|
|
9927
10026
|
* const embed = new AppEmbed('#embed-container', {
|
|
9928
10027
|
* // ...other options
|
|
9929
10028
|
* fullHeight: true,
|
|
9930
10029
|
* lazyLoadingForFullHeight: true,
|
|
9931
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10030
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
9932
10031
|
* lazyLoadingMargin: '0px',
|
|
9933
10032
|
* })
|
|
9934
10033
|
* ```
|
|
9935
|
-
* @type {string}
|
|
9936
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
9937
10034
|
*/
|
|
9938
10035
|
lazyLoadingMargin?: string;
|
|
9939
10036
|
/**
|
|
9940
10037
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9941
10038
|
*
|
|
9942
10039
|
* Supported embed types: `AppEmbed`
|
|
10040
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9943
10041
|
* @default false
|
|
9944
10042
|
* @example
|
|
9945
10043
|
* ```js
|
|
@@ -9948,25 +10046,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9948
10046
|
* updatedSpotterChatPrompt : true,
|
|
9949
10047
|
* })
|
|
9950
10048
|
* ```
|
|
9951
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9952
10049
|
*/
|
|
9953
10050
|
updatedSpotterChatPrompt?: boolean;
|
|
10051
|
+
/**
|
|
10052
|
+
* Controls the visibility of the past conversations sidebar.
|
|
10053
|
+
*
|
|
10054
|
+
* Supported embed types: `AppEmbed`
|
|
10055
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
10056
|
+
* @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
10057
|
+
* Use `spotterSidebarConfig.enablePastConversationsSidebar`.
|
|
10058
|
+
* @default false
|
|
10059
|
+
*/
|
|
10060
|
+
enablePastConversationsSidebar?: boolean;
|
|
9954
10061
|
/**
|
|
9955
10062
|
* Configuration for the Spotter sidebar UI customization.
|
|
9956
10063
|
* Only applicable when navigating to Spotter within the app.
|
|
9957
10064
|
*
|
|
9958
10065
|
* Supported embed types: `AppEmbed`
|
|
10066
|
+
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
9959
10067
|
* @example
|
|
9960
10068
|
* ```js
|
|
9961
10069
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
9962
|
-
*
|
|
10070
|
+
* // Deprecated standalone flag (backward compatibility)
|
|
10071
|
+
* enablePastConversationsSidebar: false,
|
|
10072
|
+
* // Recommended config; this value takes precedence
|
|
9963
10073
|
* spotterSidebarConfig: {
|
|
9964
10074
|
* enablePastConversationsSidebar: true,
|
|
9965
10075
|
* spotterSidebarTitle: 'My Conversations',
|
|
9966
10076
|
* },
|
|
9967
10077
|
* })
|
|
9968
10078
|
* ```
|
|
9969
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9970
10079
|
*/
|
|
9971
10080
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9972
10081
|
/**
|
|
@@ -9974,6 +10083,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9974
10083
|
* branding in tool response cards.
|
|
9975
10084
|
*
|
|
9976
10085
|
* Supported embed types: `AppEmbed`
|
|
10086
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9977
10087
|
* @example
|
|
9978
10088
|
* ```js
|
|
9979
10089
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -9984,7 +10094,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
9984
10094
|
* },
|
|
9985
10095
|
* })
|
|
9986
10096
|
* ```
|
|
9987
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9988
10097
|
*/
|
|
9989
10098
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
9990
10099
|
/**
|
|
@@ -10004,6 +10113,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10004
10113
|
* ```
|
|
10005
10114
|
*/
|
|
10006
10115
|
minimumHeight?: number;
|
|
10116
|
+
/**
|
|
10117
|
+
* To enable the homepage announcement banner.
|
|
10118
|
+
* Controls the visibility of the announcement section
|
|
10119
|
+
* on the homepage.
|
|
10120
|
+
*
|
|
10121
|
+
* Supported embed types: `AppEmbed`
|
|
10122
|
+
* @example
|
|
10123
|
+
* ```js
|
|
10124
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
10125
|
+
* ... // other embed view config
|
|
10126
|
+
* enableHomepageAnnouncement: true,
|
|
10127
|
+
* })
|
|
10128
|
+
* ```
|
|
10129
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
10130
|
+
*/
|
|
10131
|
+
enableHomepageAnnouncement?: boolean;
|
|
10007
10132
|
}
|
|
10008
10133
|
declare class AppEmbed extends V1Embed {
|
|
10009
10134
|
protected viewConfig: AppViewConfig;
|
|
@@ -10090,9 +10215,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10090
10215
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
10091
10216
|
* incrementally as users scroll the page to view the charts and tables.
|
|
10092
10217
|
*
|
|
10093
|
-
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
10094
10218
|
*
|
|
10095
10219
|
* Supported embed types: `LiveboardEmbed`
|
|
10220
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
10096
10221
|
* @example
|
|
10097
10222
|
* ```js
|
|
10098
10223
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10103,14 +10228,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10103
10228
|
*/
|
|
10104
10229
|
fullHeight?: boolean;
|
|
10105
10230
|
/**
|
|
10106
|
-
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
10231
|
+
* This is the minimum height (in pixels) for a full-height Liveboard.
|
|
10107
10232
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
10108
10233
|
* other screens navigable from a Liveboard.
|
|
10109
10234
|
*
|
|
10110
10235
|
* Supported embed types: `LiveboardEmbed`
|
|
10111
10236
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
10112
|
-
* @default 500
|
|
10113
10237
|
* @deprecated Use `minimumHeight` instead.
|
|
10238
|
+
* @default 500
|
|
10114
10239
|
* @example
|
|
10115
10240
|
* ```js
|
|
10116
10241
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10139,7 +10264,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10139
10264
|
*/
|
|
10140
10265
|
minimumHeight?: number;
|
|
10141
10266
|
/**
|
|
10142
|
-
*
|
|
10267
|
+
* If set to true, the context menu in visualizations will be enabled.
|
|
10268
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10269
|
+
* @deprecated this option is deprecated.
|
|
10143
10270
|
* @example
|
|
10144
10271
|
* ```js
|
|
10145
10272
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10147,7 +10274,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10147
10274
|
* enableVizTransformations:true,
|
|
10148
10275
|
* })
|
|
10149
10276
|
* ```
|
|
10150
|
-
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
10151
10277
|
*/
|
|
10152
10278
|
enableVizTransformations?: boolean;
|
|
10153
10279
|
/**
|
|
@@ -10160,8 +10286,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10160
10286
|
* ```js
|
|
10161
10287
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10162
10288
|
* ... //other embed view config
|
|
10163
|
-
* liveboardId:id of liveboard,
|
|
10289
|
+
* liveboardId:'id of liveboard',
|
|
10164
10290
|
* })
|
|
10291
|
+
* ```
|
|
10165
10292
|
*/
|
|
10166
10293
|
liveboardId?: string;
|
|
10167
10294
|
/**
|
|
@@ -10214,6 +10341,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10214
10341
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
10215
10342
|
* ]
|
|
10216
10343
|
* })
|
|
10344
|
+
* ```
|
|
10217
10345
|
*/
|
|
10218
10346
|
visibleVizs?: string[];
|
|
10219
10347
|
/**
|
|
@@ -10241,6 +10369,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10241
10369
|
* Specify the tab ID.
|
|
10242
10370
|
*
|
|
10243
10371
|
* Supported embed types: `LiveboardEmbed`
|
|
10372
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10244
10373
|
* @example
|
|
10245
10374
|
* ```js
|
|
10246
10375
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10248,7 +10377,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10248
10377
|
* activeTabId:'id-1234',
|
|
10249
10378
|
* })
|
|
10250
10379
|
* ```
|
|
10251
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
10252
10380
|
*/
|
|
10253
10381
|
activeTabId?: string;
|
|
10254
10382
|
/**
|
|
@@ -10257,6 +10385,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10257
10385
|
* that includes specific filter selections.
|
|
10258
10386
|
*
|
|
10259
10387
|
* Supported embed types: `LiveboardEmbed`
|
|
10388
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10260
10389
|
* @example
|
|
10261
10390
|
* ```js
|
|
10262
10391
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10265,7 +10394,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10265
10394
|
* activeTabId: 'tab-guid',
|
|
10266
10395
|
* })
|
|
10267
10396
|
* ```
|
|
10268
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10269
10397
|
*/
|
|
10270
10398
|
personalizedViewId?: string;
|
|
10271
10399
|
/**
|
|
@@ -10286,13 +10414,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10286
10414
|
* Show a preview image of the visualization before the visualization loads.
|
|
10287
10415
|
* Only works for visualizations embeds with a viz id.
|
|
10288
10416
|
*
|
|
10289
|
-
* Also, viz
|
|
10417
|
+
* Also, viz snapshot should be enabled in the ThoughtSpot instance.
|
|
10290
10418
|
* Contact ThoughtSpot support to enable this feature.
|
|
10291
10419
|
*
|
|
10292
|
-
* Since
|
|
10420
|
+
* Since this will show preview images, be careful that it may show
|
|
10293
10421
|
* undesired data to the user when using row level security.
|
|
10294
10422
|
*
|
|
10295
10423
|
* Supported embed types: `LiveboardEmbed`
|
|
10424
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10296
10425
|
* @example
|
|
10297
10426
|
* ```js
|
|
10298
10427
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10302,7 +10431,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10302
10431
|
* });
|
|
10303
10432
|
* embed.render();
|
|
10304
10433
|
* ```
|
|
10305
|
-
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
10306
10434
|
*/
|
|
10307
10435
|
showPreviewLoader?: boolean;
|
|
10308
10436
|
/**
|
|
@@ -10310,13 +10438,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10310
10438
|
*
|
|
10311
10439
|
* Supported embed types: `LiveboardEmbed`
|
|
10312
10440
|
* @hidden
|
|
10313
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10441
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10314
10442
|
* @example
|
|
10315
10443
|
* ```js
|
|
10316
10444
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10317
10445
|
* ... //other embed view config
|
|
10318
|
-
* oAuthPollingInterval:
|
|
10446
|
+
* oAuthPollingInterval: 30000,
|
|
10319
10447
|
* })
|
|
10448
|
+
* ```
|
|
10320
10449
|
*/
|
|
10321
10450
|
oAuthPollingInterval?: number;
|
|
10322
10451
|
/**
|
|
@@ -10324,35 +10453,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10324
10453
|
*
|
|
10325
10454
|
* Supported embed types: `LiveboardEmbed`
|
|
10326
10455
|
* @hidden
|
|
10327
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10456
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10328
10457
|
* @example
|
|
10329
10458
|
* ```js
|
|
10330
10459
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10331
10460
|
* ... //other embed view config
|
|
10332
10461
|
* isForceRedirect: false,
|
|
10333
10462
|
* })
|
|
10463
|
+
* ```
|
|
10334
10464
|
*/
|
|
10335
10465
|
isForceRedirect?: boolean;
|
|
10336
10466
|
/**
|
|
10337
10467
|
* The source connection ID for authentication.
|
|
10338
|
-
* @hidden
|
|
10339
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
10340
10468
|
*
|
|
10341
10469
|
* Supported embed types: `LiveboardEmbed`
|
|
10470
|
+
* @hidden
|
|
10471
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
|
|
10342
10472
|
* @example
|
|
10343
10473
|
* ```js
|
|
10344
10474
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10345
10475
|
* ... //other embed view config
|
|
10346
10476
|
* dataSourceId: '',
|
|
10347
10477
|
* })
|
|
10478
|
+
* ```
|
|
10348
10479
|
*/
|
|
10349
10480
|
dataSourceId?: string;
|
|
10350
10481
|
/**
|
|
10351
|
-
* The list of tab IDs to hide from the embedded.
|
|
10352
|
-
*
|
|
10353
|
-
* Use this to hide
|
|
10482
|
+
* The list of tab IDs to hide from the embedded Liveboard.
|
|
10483
|
+
* These tabs will be hidden from their respective Liveboards.
|
|
10484
|
+
* Use this to hide a tab ID.
|
|
10354
10485
|
*
|
|
10355
10486
|
* Supported embed types: `LiveboardEmbed`
|
|
10487
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10356
10488
|
* @example
|
|
10357
10489
|
* ```js
|
|
10358
10490
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10363,7 +10495,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10363
10495
|
* ]
|
|
10364
10496
|
* });
|
|
10365
10497
|
* ```
|
|
10366
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
10367
10498
|
*/
|
|
10368
10499
|
hiddenTabs?: string[];
|
|
10369
10500
|
/**
|
|
@@ -10387,7 +10518,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10387
10518
|
*/
|
|
10388
10519
|
visibleTabs?: string[];
|
|
10389
10520
|
/**
|
|
10390
|
-
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
10521
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10522
|
+
* @deprecated This flag is deprecated.
|
|
10391
10523
|
*
|
|
10392
10524
|
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
10393
10525
|
* @type {boolean}
|
|
@@ -10403,7 +10535,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10403
10535
|
*/
|
|
10404
10536
|
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
10405
10537
|
/**
|
|
10406
|
-
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10538
|
+
* This flag is used to enable/disable the png embedding of liveboard in scheduled
|
|
10539
|
+
* mails
|
|
10407
10540
|
*
|
|
10408
10541
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
10409
10542
|
* @type {boolean}
|
|
@@ -10453,6 +10586,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10453
10586
|
/**
|
|
10454
10587
|
* This flag is used to enable the full height lazy load data.
|
|
10455
10588
|
*
|
|
10589
|
+
* @type {boolean}
|
|
10590
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10591
|
+
* @default false
|
|
10456
10592
|
* @example
|
|
10457
10593
|
* ```js
|
|
10458
10594
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10461,33 +10597,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10461
10597
|
* lazyLoadingForFullHeight: true,
|
|
10462
10598
|
* })
|
|
10463
10599
|
* ```
|
|
10464
|
-
*
|
|
10465
|
-
* @type {boolean}
|
|
10466
|
-
* @default false
|
|
10467
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10468
10600
|
*/
|
|
10469
10601
|
lazyLoadingForFullHeight?: boolean;
|
|
10470
10602
|
/**
|
|
10471
10603
|
* The margin to be used for lazy loading.
|
|
10472
10604
|
*
|
|
10473
10605
|
* For example, if the margin is set to '10px',
|
|
10474
|
-
* the visualization will be loaded 10px before
|
|
10606
|
+
* the visualization will be loaded 10px before its top edge is visible in the
|
|
10475
10607
|
* viewport.
|
|
10476
10608
|
*
|
|
10477
10609
|
* The format is similar to CSS margin.
|
|
10478
10610
|
*
|
|
10611
|
+
* @type {string}
|
|
10612
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
10479
10613
|
* @example
|
|
10480
10614
|
* ```js
|
|
10481
10615
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
10482
10616
|
* // ...other options
|
|
10483
10617
|
* fullHeight: true,
|
|
10484
10618
|
* lazyLoadingForFullHeight: true,
|
|
10485
|
-
* // Using 0px, the visualization will be only loaded when
|
|
10619
|
+
* // Using 0px, the visualization will be only loaded when it's visible in the viewport.
|
|
10486
10620
|
* lazyLoadingMargin: '0px',
|
|
10487
10621
|
* })
|
|
10488
10622
|
* ```
|
|
10489
|
-
* @type {string}
|
|
10490
|
-
* @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
|
|
10491
10623
|
*/
|
|
10492
10624
|
lazyLoadingMargin?: string;
|
|
10493
10625
|
/**
|
|
@@ -10495,6 +10627,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10495
10627
|
* of the spotter underneath the chat input.
|
|
10496
10628
|
* default is false.
|
|
10497
10629
|
*
|
|
10630
|
+
* @type {boolean}
|
|
10631
|
+
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10498
10632
|
* @example
|
|
10499
10633
|
* ```js
|
|
10500
10634
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -10502,14 +10636,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10502
10636
|
* showSpotterLimitations: true,
|
|
10503
10637
|
* })
|
|
10504
10638
|
* ```
|
|
10505
|
-
* @type {boolean}
|
|
10506
|
-
* @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
|
|
10507
10639
|
*/
|
|
10508
10640
|
showSpotterLimitations?: boolean;
|
|
10509
10641
|
/**
|
|
10510
10642
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
10511
10643
|
*
|
|
10512
10644
|
* Supported embed types: `LiveboardEmbed`
|
|
10645
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10513
10646
|
* @default false
|
|
10514
10647
|
* @example
|
|
10515
10648
|
* ```js
|
|
@@ -10518,7 +10651,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10518
10651
|
* updatedSpotterChatPrompt : true,
|
|
10519
10652
|
* })
|
|
10520
10653
|
* ```
|
|
10521
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10522
10654
|
*/
|
|
10523
10655
|
updatedSpotterChatPrompt?: boolean;
|
|
10524
10656
|
/**
|
|
@@ -10526,6 +10658,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10526
10658
|
* branding in tool response cards.
|
|
10527
10659
|
*
|
|
10528
10660
|
* Supported embed types: `LiveboardEmbed`
|
|
10661
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10529
10662
|
* @example
|
|
10530
10663
|
* ```js
|
|
10531
10664
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -10536,7 +10669,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
10536
10669
|
* },
|
|
10537
10670
|
* })
|
|
10538
10671
|
* ```
|
|
10539
|
-
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10540
10672
|
*/
|
|
10541
10673
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
10542
10674
|
}
|
|
@@ -10681,6 +10813,9 @@ export interface PreRenderProps {
|
|
|
10681
10813
|
* PreRender id to be used for PreRendering the embed.
|
|
10682
10814
|
* Use PreRender to render the embed in the background and then
|
|
10683
10815
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
10816
|
+
*
|
|
10817
|
+
* Use PreRendered react component for pre rendering embed components.
|
|
10818
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
|
|
10684
10819
|
* @example
|
|
10685
10820
|
* ```js
|
|
10686
10821
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -10689,8 +10824,6 @@ export interface PreRenderProps {
|
|
|
10689
10824
|
* });
|
|
10690
10825
|
* embed.showPreRender();
|
|
10691
10826
|
* ```
|
|
10692
|
-
*
|
|
10693
|
-
* Use PreRendered react component for pre rendering embed components.
|
|
10694
10827
|
* @example
|
|
10695
10828
|
* ```tsx
|
|
10696
10829
|
* function LandingPageComponent() {
|
|
@@ -10701,7 +10834,6 @@ export interface PreRenderProps {
|
|
|
10701
10834
|
* return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
|
|
10702
10835
|
* }
|
|
10703
10836
|
* ```
|
|
10704
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
|
|
10705
10837
|
*/
|
|
10706
10838
|
preRenderId: string;
|
|
10707
10839
|
}
|
|
@@ -10725,7 +10857,7 @@ export interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
10725
10857
|
* React component for Full app Embed.
|
|
10726
10858
|
* @example
|
|
10727
10859
|
* ```tsx
|
|
10728
|
-
* function
|
|
10860
|
+
* function App() {
|
|
10729
10861
|
* return <AppEmbed
|
|
10730
10862
|
* showPrimaryNavbar={false}
|
|
10731
10863
|
* pageId={Page.Liveboards}
|
|
@@ -10736,9 +10868,9 @@ export interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
10736
10868
|
*/
|
|
10737
10869
|
declare const AppEmbed$1: React$1.ForwardRefExoticComponent<AppProps & React$1.RefAttributes<AppEmbed>>;
|
|
10738
10870
|
/**
|
|
10739
|
-
* React component for PreRendered
|
|
10871
|
+
* React component for PreRendered App embed.
|
|
10740
10872
|
*
|
|
10741
|
-
* PreRenderedAppEmbed will preRender the
|
|
10873
|
+
* PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
|
|
10742
10874
|
* default.
|
|
10743
10875
|
*
|
|
10744
10876
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -10780,7 +10912,7 @@ export declare const PinboardEmbed: React$1.ForwardRefExoticComponent<LiveboardP
|
|
|
10780
10912
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
10781
10913
|
*
|
|
10782
10914
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
10783
|
-
* tries to preRender the LiveboardEmbed, so it is recommended to
|
|
10915
|
+
* tries to preRender the LiveboardEmbed, so it is recommended to pass the
|
|
10784
10916
|
* liveboardId to both the components.
|
|
10785
10917
|
* @example
|
|
10786
10918
|
* ```tsx
|
|
@@ -10811,7 +10943,7 @@ export interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
10811
10943
|
*/
|
|
10812
10944
|
declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & React$1.RefAttributes<SearchBarEmbed>>;
|
|
10813
10945
|
/**
|
|
10814
|
-
* React component for PreRendered
|
|
10946
|
+
* React component for PreRendered SearchBar embed.
|
|
10815
10947
|
*
|
|
10816
10948
|
* PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
|
|
10817
10949
|
* default.
|
|
@@ -10845,9 +10977,9 @@ export interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
10845
10977
|
*/
|
|
10846
10978
|
declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
|
|
10847
10979
|
/**
|
|
10848
|
-
* React component for PreRendered
|
|
10980
|
+
* React component for PreRendered Sage embed.
|
|
10849
10981
|
*
|
|
10850
|
-
* PreRenderedSageEmbed will preRender the
|
|
10982
|
+
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
10851
10983
|
* default.
|
|
10852
10984
|
*
|
|
10853
10985
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
@@ -10885,8 +11017,8 @@ export interface ConversationEmbedProps extends EmbedProps, ConversationViewConf
|
|
|
10885
11017
|
declare const SpotterEmbed$1: React$1.ForwardRefExoticComponent<SpotterEmbedProps & React$1.RefAttributes<SpotterEmbed>>;
|
|
10886
11018
|
/**
|
|
10887
11019
|
* React component for LLM based conversation BI.
|
|
10888
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10889
11020
|
* Use {@link SpotterEmbed} instead
|
|
11021
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10890
11022
|
* @example
|
|
10891
11023
|
* ```tsx
|
|
10892
11024
|
* function Sage() {
|
|
@@ -10915,6 +11047,7 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
|
|
|
10915
11047
|
* This component renders a single message response from your ThoughtSpot conversation,
|
|
10916
11048
|
* showing charts, visualizations, or text responses based on the user's query.
|
|
10917
11049
|
*
|
|
11050
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10918
11051
|
* @example
|
|
10919
11052
|
* ```tsx
|
|
10920
11053
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
@@ -10931,7 +11064,6 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
|
|
|
10931
11064
|
* />
|
|
10932
11065
|
* }
|
|
10933
11066
|
* ```
|
|
10934
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10935
11067
|
*/
|
|
10936
11068
|
export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
10937
11069
|
message: SpotterAgentMessageViewConfig;
|
|
@@ -10943,7 +11075,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
|
|
|
10943
11075
|
* PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
|
|
10944
11076
|
* default.
|
|
10945
11077
|
*
|
|
10946
|
-
*
|
|
11078
|
+
* SpotterEmbed with preRenderId passed will call showPreRender on the embed.
|
|
10947
11079
|
* @example
|
|
10948
11080
|
* ```tsx
|
|
10949
11081
|
* function LandingPageComponent() {
|
|
@@ -10976,6 +11108,7 @@ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof L
|
|
|
10976
11108
|
export declare function useEmbedRef<T extends EmbedComponent>(): React$1.MutableRefObject<React$1.ComponentRef<T>>;
|
|
10977
11109
|
/**
|
|
10978
11110
|
*
|
|
11111
|
+
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
10979
11112
|
* @param config - EmbedConfig
|
|
10980
11113
|
* @returns AuthEventEmitter
|
|
10981
11114
|
* @example
|
|
@@ -10985,7 +11118,6 @@ export declare function useEmbedRef<T extends EmbedComponent>(): React$1.Mutable
|
|
|
10985
11118
|
* return <LiveboardEmbed ref={ref} liveboardId={<id>} />
|
|
10986
11119
|
* }
|
|
10987
11120
|
* ```
|
|
10988
|
-
* @version SDK: 1.36.2 | ThoughtSpot: *
|
|
10989
11121
|
*/
|
|
10990
11122
|
export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<AuthEventEmitter>;
|
|
10991
11123
|
/**
|
|
@@ -10994,6 +11126,7 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
|
|
|
10994
11126
|
* This hook provides a sendMessage function that allows you to send natural language
|
|
10995
11127
|
* queries to your data and get back AI-generated responses with visualizations.
|
|
10996
11128
|
*
|
|
11129
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
10997
11130
|
* @param config - Configuration object containing worksheetId and other options
|
|
10998
11131
|
* @returns Object with sendMessage function that returns conversation results
|
|
10999
11132
|
* @example
|
|
@@ -11011,7 +11144,6 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
|
|
|
11011
11144
|
* }
|
|
11012
11145
|
* };
|
|
11013
11146
|
* ```
|
|
11014
|
-
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
11015
11147
|
*/
|
|
11016
11148
|
export declare function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
|
|
11017
11149
|
sendMessage: (query: string) => Promise<{
|