@thoughtspot/visual-embed-sdk 1.23.0-alpha.0 → 1.24.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/css-variables.d.ts +1 -1
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/liveboard.d.ts +6 -0
  5. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  6. package/cjs/src/embed/liveboard.js +4 -1
  7. package/cjs/src/embed/liveboard.js.map +1 -1
  8. package/cjs/src/embed/liveboard.spec.js +12 -0
  9. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  10. package/cjs/src/embed/sage.d.ts +15 -0
  11. package/cjs/src/embed/sage.d.ts.map +1 -1
  12. package/cjs/src/embed/sage.js +13 -3
  13. package/cjs/src/embed/sage.js.map +1 -1
  14. package/cjs/src/embed/sage.spec.js +1 -1
  15. package/cjs/src/embed/sage.spec.js.map +1 -1
  16. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  17. package/cjs/src/embed/ts-embed.js +11 -1
  18. package/cjs/src/embed/ts-embed.js.map +1 -1
  19. package/cjs/src/embed/ts-embed.spec.js +69 -0
  20. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  21. package/cjs/src/types.d.ts +956 -199
  22. package/cjs/src/types.d.ts.map +1 -1
  23. package/cjs/src/types.js +914 -180
  24. package/cjs/src/types.js.map +1 -1
  25. package/dist/src/css-variables.d.ts +1 -1
  26. package/dist/src/css-variables.d.ts.map +1 -1
  27. package/dist/src/embed/liveboard.d.ts +6 -0
  28. package/dist/src/embed/liveboard.d.ts.map +1 -1
  29. package/dist/src/embed/sage.d.ts +15 -0
  30. package/dist/src/embed/sage.d.ts.map +1 -1
  31. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  32. package/dist/src/types.d.ts +956 -199
  33. package/dist/src/types.d.ts.map +1 -1
  34. package/dist/tsembed-react.es.js +943 -186
  35. package/dist/tsembed-react.js +925 -178
  36. package/dist/tsembed.es.js +943 -186
  37. package/dist/tsembed.js +925 -178
  38. package/dist/visual-embed-sdk-react-full.d.ts +991 -213
  39. package/dist/visual-embed-sdk-react.d.ts +991 -213
  40. package/dist/visual-embed-sdk.d.ts +994 -216
  41. package/lib/package.json +1 -1
  42. package/lib/src/css-variables.d.ts +1 -1
  43. package/lib/src/css-variables.d.ts.map +1 -1
  44. package/lib/src/embed/liveboard.d.ts +6 -0
  45. package/lib/src/embed/liveboard.d.ts.map +1 -1
  46. package/lib/src/embed/liveboard.js +4 -1
  47. package/lib/src/embed/liveboard.js.map +1 -1
  48. package/lib/src/embed/liveboard.spec.js +12 -0
  49. package/lib/src/embed/liveboard.spec.js.map +1 -1
  50. package/lib/src/embed/sage.d.ts +15 -0
  51. package/lib/src/embed/sage.d.ts.map +1 -1
  52. package/lib/src/embed/sage.js +13 -3
  53. package/lib/src/embed/sage.js.map +1 -1
  54. package/lib/src/embed/sage.spec.js +1 -1
  55. package/lib/src/embed/sage.spec.js.map +1 -1
  56. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  57. package/lib/src/embed/ts-embed.js +11 -1
  58. package/lib/src/embed/ts-embed.js.map +1 -1
  59. package/lib/src/embed/ts-embed.spec.js +69 -0
  60. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  61. package/lib/src/types.d.ts +956 -199
  62. package/lib/src/types.d.ts.map +1 -1
  63. package/lib/src/types.js +914 -180
  64. package/lib/src/types.js.map +1 -1
  65. package/lib/src/visual-embed-sdk.d.ts +994 -216
  66. package/package.json +1 -1
  67. package/src/css-variables.ts +1 -1
  68. package/src/embed/liveboard.spec.ts +16 -0
  69. package/src/embed/liveboard.ts +10 -0
  70. package/src/embed/sage.spec.ts +1 -1
  71. package/src/embed/sage.ts +25 -2
  72. package/src/embed/ts-embed.spec.ts +79 -0
  73. package/src/embed/ts-embed.ts +13 -1
  74. package/src/types.ts +969 -199
package/cjs/src/types.js CHANGED
@@ -167,7 +167,7 @@ var AuthType;
167
167
  * .then((data) => data.token);
168
168
  * }
169
169
  * ```
170
- * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
170
+ * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
171
171
  */
172
172
  AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
173
173
  /**
@@ -317,7 +317,7 @@ var EmbedEvent;
317
317
  * One or more data columns have been selected.
318
318
  *
319
319
  * @returns columnIds - the list of columns
320
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
320
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
321
321
  */
322
322
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
323
323
  /**
@@ -350,7 +350,7 @@ var EmbedEvent;
350
350
  * });
351
351
  * ```
352
352
  * @return viz, clickedPoint - metadata about point that is clicked
353
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
353
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
354
354
  * @important
355
355
  */
356
356
  EmbedEvent["VizPointClick"] = "vizPointClick";
@@ -400,7 +400,7 @@ var EmbedEvent;
400
400
  * Emitted when the "Get Data" button in Search Bar embed
401
401
  * is clicked.
402
402
  *
403
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
403
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
404
404
  */
405
405
  EmbedEvent["GetDataClick"] = "getDataClick";
406
406
  /**
@@ -430,13 +430,13 @@ var EmbedEvent;
430
430
  /**
431
431
  * Emitted when any modal is opened in the app
432
432
  *
433
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
433
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
434
434
  */
435
435
  EmbedEvent["DialogOpen"] = "dialog-open";
436
436
  /**
437
437
  * Emitted when any modal is closed in the app
438
438
  *
439
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
439
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
440
440
  */
441
441
  EmbedEvent["DialogClose"] = "dialog-close";
442
442
  /**
@@ -444,136 +444,136 @@ var EmbedEvent;
444
444
  * You can use this event as a hook to trigger
445
445
  * other events on the rendered Liveboard.
446
446
  *
447
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
447
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
448
448
  */
449
449
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
450
450
  /**
451
451
  * This can be used to register an event listener which
452
452
  * is triggered on all events.
453
453
  *
454
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
454
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
455
455
  */
456
456
  EmbedEvent["ALL"] = "*";
457
457
  /**
458
- * Emitted when answer is saved in the app
458
+ * Emitted when an Answer is saved in the app
459
459
  *
460
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
460
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
461
461
  */
462
462
  EmbedEvent["Save"] = "save";
463
463
  /**
464
464
  * Emitted when the download action is triggered on an answer
465
465
  *
466
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
466
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
467
467
  */
468
468
  EmbedEvent["Download"] = "download";
469
469
  /**
470
470
  * Emitted when the download action is triggered on an answer
471
471
  *
472
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
472
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
473
473
  */
474
474
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
475
475
  /**
476
476
  * Emitted when the Download as PDF action is triggered on an answer
477
477
  *
478
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
478
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
479
479
  */
480
480
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
481
481
  /**
482
482
  * Emitted when the Download as CSV action is triggered on an answer
483
483
  *
484
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
484
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
485
485
  */
486
486
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
487
487
  /**
488
488
  * Emitted when the Download as XLSX action is triggered on an answer
489
489
  *
490
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
490
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
491
491
  */
492
492
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
493
493
  /**
494
494
  * Emitted when an answer is deleted in the app
495
495
  *
496
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
496
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
497
497
  */
498
498
  EmbedEvent["AnswerDelete"] = "answerDelete";
499
499
  /**
500
500
  * Emitted when an answer is pinned to a Liveboard
501
501
  *
502
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
502
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
503
503
  */
504
504
  EmbedEvent["Pin"] = "pin";
505
505
  /**
506
506
  * Emitted when SpotIQ analysis is triggered
507
507
  *
508
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
508
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
509
509
  */
510
510
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
511
511
  /**
512
512
  * Emitted when a user shares an object with another user or group
513
513
  *
514
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
514
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
515
515
  */
516
516
  EmbedEvent["Share"] = "share";
517
517
  /**
518
518
  * Emitted when a user clicks the Include action to include a specific value or data
519
519
  * on a chart or table
520
520
  *
521
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
521
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
522
522
  */
523
523
  EmbedEvent["DrillInclude"] = "context-menu-item-include";
524
524
  /**
525
525
  * Emitted when a user clicks the Exclude action to exclude a specific value or data
526
526
  * on a chart or table
527
527
  *
528
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
528
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
529
529
  */
530
530
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
531
531
  /**
532
532
  * Emitted when copied column value on the app
533
533
  *
534
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
534
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
535
535
  */
536
536
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
537
537
  /**
538
538
  * Emitted when a user clicks the Update TML action
539
539
  *
540
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
540
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
541
541
  */
542
542
  EmbedEvent["UpdateTML"] = "updateTSL";
543
543
  /**
544
544
  * Emitted when a user clicks the Edit TML action
545
545
  *
546
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
546
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
547
547
  */
548
548
  EmbedEvent["EditTML"] = "editTSL";
549
549
  /**
550
550
  * Emitted when ExportTML trigger in answer on the app
551
551
  *
552
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
552
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
553
553
  */
554
554
  EmbedEvent["ExportTML"] = "exportTSL";
555
555
  /**
556
556
  * Emitted when an answer is saved as a view
557
557
  *
558
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
558
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
559
559
  */
560
560
  EmbedEvent["SaveAsView"] = "saveAsView";
561
561
  /**
562
562
  * Emitted when copy of existing answer on the app
563
563
  *
564
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
564
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
565
565
  */
566
566
  EmbedEvent["CopyAEdit"] = "copyAEdit";
567
567
  /**
568
568
  * Emitted when a user clicks Show underlying data on an answe
569
569
  *
570
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
570
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
571
571
  */
572
572
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
573
573
  /**
574
574
  * Emitted when an answer is switched to a chart or table view
575
575
  *
576
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
576
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
577
577
  */
578
578
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
579
579
  /**
@@ -585,67 +585,67 @@ var EmbedEvent;
585
585
  /**
586
586
  * Emitted when a user clicks Show Liveboard details on a Liveboard
587
587
  *
588
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
588
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
589
589
  */
590
590
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
591
591
  /**
592
592
  * Emitted when a user clicks on the Favorite icon on a Liveboard
593
593
  *
594
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
594
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
595
595
  */
596
596
  EmbedEvent["AddToFavorites"] = "addToFavorites";
597
597
  /**
598
598
  * Emitted when a user clicks Schedule on a Liveboard
599
599
  *
600
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
600
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
601
601
  */
602
602
  EmbedEvent["Schedule"] = "subscription";
603
603
  /**
604
604
  * Emitted when a user clicks Edit on a Liveboard or visualization
605
605
  *
606
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
606
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
607
607
  */
608
608
  EmbedEvent["Edit"] = "edit";
609
609
  /**
610
610
  * Emitted when a user clicks Make a copy on a Liveboard
611
611
  *
612
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
612
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
613
613
  */
614
614
  EmbedEvent["MakeACopy"] = "makeACopy";
615
615
  /**
616
616
  * Emitted when a user clicks Present on a Liveboard or visualization
617
617
  *
618
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
618
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
619
619
  */
620
620
  EmbedEvent["Present"] = "present";
621
621
  /**
622
622
  * Emitted when a user clicks Delete on a Liveboard
623
623
  *
624
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
624
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
625
625
  */
626
626
  EmbedEvent["Delete"] = "delete";
627
627
  /**
628
628
  * Emitted when a user clicks Manage schedules on a Liveboard
629
629
  *
630
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
630
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
631
631
  */
632
632
  EmbedEvent["SchedulesList"] = "schedule-list";
633
633
  /**
634
634
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
635
635
  *
636
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
636
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
637
637
  */
638
638
  EmbedEvent["Cancel"] = "cancel";
639
639
  /**
640
640
  * Emitted when a user clicks Explore on a visualization
641
641
  *
642
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
642
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
643
643
  */
644
644
  EmbedEvent["Explore"] = "explore";
645
645
  /**
646
646
  * Emitted when a user clicks Copy link action on a visualization
647
647
  *
648
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
648
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
649
649
  */
650
650
  EmbedEvent["CopyLink"] = "embedDocument";
651
651
  /**
@@ -666,6 +666,24 @@ var EmbedEvent;
666
666
  * @hidden
667
667
  */
668
668
  EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
669
+ /**
670
+ * Emitted when a user changes any filter on a Liveboard.
671
+ *
672
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
673
+ */
674
+ EmbedEvent["FilterChanged"] = "filterChanged";
675
+ /**
676
+ * Emitted when a user click on Go button in Sage Embed
677
+ *
678
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
679
+ */
680
+ EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
681
+ /**
682
+ * Emitten when a user select data source in Sage Embed
683
+ *
684
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
685
+ */
686
+ EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
669
687
  })(EmbedEvent = exports.EmbedEvent || (exports.EmbedEvent = {}));
670
688
  /**
671
689
  * Event types that can be triggered by the host application
@@ -693,13 +711,15 @@ var EmbedEvent;
693
711
  var HostEvent;
694
712
  (function (HostEvent) {
695
713
  /**
696
- * Trigger a search
714
+ * Triggers a search query in AppEmbed and SearchEmbed
715
+ * deployments.
716
+ * Includes the following properties:
697
717
  *
698
718
  * @param - dataSourceIds - The data source GUID to Search on
699
719
  * - Although an array, only a single source
700
- * is supported at this time.
701
- * @param - searchQuery - The search query
702
- * @param - execute - execute the existing / updated query
720
+ * is supported.
721
+ * @param - searchQuery - Query string with search tokens
722
+ * @param - execute - executes the existing / updated query
703
723
  * @example
704
724
  * ```js
705
725
  * searchEmbed.trigger(HostEvent.Search, {
@@ -711,13 +731,14 @@ var HostEvent;
711
731
  */
712
732
  HostEvent["Search"] = "search";
713
733
  /**
714
- * Trigger a drill on certain points by certain column
734
+ * Triggers a drill on certain points of the specified column
735
+ * Includes the following properties:
715
736
  *
716
737
  * @param - points - an object containing selectedPoints/clickedPoints
717
- * eg. { selectedPoints: []}
718
- * @param - columnGuid - a string guid of the column to drill by. This is optional,
719
- * if not provided it will auto drill by the configured
720
- * column.
738
+ * to drill to. For example, { selectedPoints: []}
739
+ * @param - columnGuid - Optional. GUID of the column to drill
740
+ * by. If not provided it will auto drill by the configured
741
+ * column.
721
742
  * @example
722
743
  * ```js
723
744
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -750,17 +771,17 @@ var HostEvent;
750
771
  */
751
772
  HostEvent["Reload"] = "reload";
752
773
  /**
753
- * Set the visible visualizations on a Liveboard.
774
+ * Sets the visible visualizations on a Liveboard.
754
775
  *
755
- * @param - an array of ids of visualizations to show, the ids not passed
756
- * will be hidden.
776
+ * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
777
+ * in this parameter will be hidden.
757
778
  * @example
758
779
  * ```js
759
780
  * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
760
781
  * '730496d6-6903-4601-937e-2c691821af3c',
761
782
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
762
783
  * ```
763
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
784
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
764
785
  */
765
786
  HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
766
787
  /**
@@ -777,8 +798,18 @@ var HostEvent;
777
798
  */
778
799
  HostEvent["SetActiveTab"] = "SetActiveTab";
779
800
  /**
780
- * Update the runtime filters. The runtime filters passed here are extended
781
- * on to the existing runtime filters if they exist.
801
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
802
+ * runtime filters passed here are appended to the existing runtime
803
+ * filters.
804
+ * Pass an array of runtime filters with the following attributes:
805
+ * `columnName`
806
+ * _String_. The name of the column to filter on.
807
+ * `operator`
808
+ * Runtime filter operator to apply. For information,
809
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
810
+ * `values`
811
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
812
+ * operators such as BW and IN accept multiple operands.
782
813
  *
783
814
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
784
815
  * @example
@@ -788,12 +819,12 @@ var HostEvent;
788
819
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
789
820
  * ])
790
821
  * ```
791
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
822
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
792
823
  * @important
793
824
  */
794
825
  HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
795
826
  /**
796
- * Navigate to a specific page in App embed without any reload.
827
+ * Navigate to a specific page in the embedded application without reloading the page.
797
828
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
798
829
  *
799
830
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
@@ -801,12 +832,12 @@ var HostEvent;
801
832
  * ```js
802
833
  * appEmbed.navigateToPage(-1)
803
834
  * ```
804
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
835
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
805
836
  */
806
837
  HostEvent["Navigate"] = "Navigate";
807
838
  /**
808
839
  * Opens the filter panel for a particular column.
809
- * Works with Search embed.
840
+ * Works with Search and Liveboard embed.
810
841
  *
811
842
  * @param - { columnId: string,
812
843
  * name: string,
@@ -815,233 +846,257 @@ var HostEvent;
815
846
  * @example
816
847
  * ```js
817
848
  * searchEmbed.trigger(HostEvent.OpenFilter,
818
- * { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
849
+ * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
850
+ * LiveboardEmbed.trigger(HostEvent.OpenFilter,
851
+ * { columnId: '<column-GUID>'})
819
852
  * ```
820
853
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
821
854
  */
822
855
  HostEvent["OpenFilter"] = "openFilter";
823
856
  /**
824
- * Adds the columns to the current Search.
857
+ * Adds columns to the current search query.
825
858
  *
826
859
  * @param - { columnIds: string[] }
827
860
  * @example
828
861
  * ```js
829
- * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
862
+ * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
830
863
  * ```
831
864
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
832
865
  */
833
866
  HostEvent["AddColumns"] = "addColumns";
834
867
  /**
835
- * Removes a column from the current Search.
868
+ * Removes a column from the current search query.
836
869
  *
837
870
  * @param - { columnId: string }
838
871
  * @example
839
872
  * ```js
840
- * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
873
+ * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
841
874
  * ```
842
875
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
843
876
  */
844
877
  HostEvent["RemoveColumn"] = "removeColumn";
845
878
  /**
846
- * Gets the current pinboard content.
879
+ * Gets the current Liveboard content.
847
880
  *
848
881
  * @example
849
882
  * ```js
850
883
  * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
851
884
  * ```
852
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
885
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
853
886
  */
854
887
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
855
888
  /**
856
- * Triggers the Pin action on an embedded object
889
+ * Triggers the **Pin** action on an embedded object
857
890
  *
858
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
859
- * can be left empty for search and visualization embeds
891
+ * @param - Liveboard embed takes the `vizId` as a
892
+ * key. Can be left undefined when embedding Search, full app or
893
+ * a visualization.
860
894
  * @example
861
895
  * ```js
862
896
  * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
897
+ * ```
898
+ * ```js
863
899
  * vizEmbed.trigger(HostEvent.Pin)
900
+ * ```
901
+ * ```js
864
902
  * searchEmbed.trigger(HostEvent.Pin)
865
903
  * ```
866
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
904
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
867
905
  */
868
906
  HostEvent["Pin"] = "pin";
869
907
  /**
870
- * Triggers the Show Liveboard details action on a Liveboard
908
+ * Triggers the **Show Liveboard details** action on a Liveboard
871
909
  *
872
910
  * @example
873
911
  * ```js
874
912
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
875
913
  * ```
876
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
914
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
877
915
  */
878
916
  HostEvent["LiveboardInfo"] = "pinboardInfo";
879
917
  /**
880
- * Triggers the Schedule action on a Liveboard
918
+ * Triggers the **Schedule** action on a Liveboard
881
919
  *
882
920
  * @example
883
921
  * ```js
884
922
  * liveboardEmbed.trigger(HostEvent.Schedule)
885
923
  * ```
886
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
924
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
887
925
  */
888
926
  HostEvent["Schedule"] = "subscription";
889
927
  /**
890
- * Triggers the Manage schedule action on a Liveboard
928
+ * Triggers the **Manage schedule** action on a Liveboard
891
929
  *
892
930
  * @example
893
931
  * ```js
894
932
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
895
933
  * ```
896
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
934
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
897
935
  */
898
936
  HostEvent["SchedulesList"] = "schedule-list";
899
937
  /**
900
- * Triggers the Export TML action on a Liveboard
938
+ * Triggers the **Export TML** action on a Liveboard
901
939
  *
902
940
  * @example
903
941
  * ```js
904
942
  * liveboardEmbed.trigger(HostEvent.ExportTML)
905
943
  * ```
906
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
944
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
907
945
  */
908
946
  HostEvent["ExportTML"] = "exportTSL";
909
947
  /**
910
- * Triggers the Edit TML action on a Liveboard
948
+ * Triggers the **Edit TML** action on a Liveboard
911
949
  *
912
950
  * @example
913
951
  * ```js
914
952
  * liveboardEmbed.trigger(HostEvent.EditTML)
915
953
  * ```
916
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
954
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
917
955
  */
918
956
  HostEvent["EditTML"] = "editTSL";
919
957
  /**
920
- * Triggers the Update TML action on a Liveboard
958
+ * Triggers the **Update TML** action on a Liveboard
921
959
  *
922
960
  * @example
923
961
  * ```js
924
962
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
925
963
  * ```
926
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
964
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
927
965
  */
928
966
  HostEvent["UpdateTML"] = "updateTSL";
929
967
  /**
930
- * Triggers the Download PDF action on a Liveboard
968
+ * Triggers the **Download PDF** action on a Liveboard
931
969
  *
932
970
  * @example
933
971
  * ```js
934
972
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
935
973
  * ```
936
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
974
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
937
975
  */
938
976
  HostEvent["DownloadAsPdf"] = "downloadAsPdf";
939
977
  /**
940
- * Triggers the Make a copy action on a Liveboard, search or visualization
978
+ * Triggers the **Make a copy** action on a Liveboard, Search, or
979
+ * visualization page
941
980
  *
942
981
  * @example
943
982
  * ```js
944
983
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
984
+ * ```
985
+ * ```js
945
986
  * vizEmbed.trigger(HostEvent.MakeACopy)
987
+ * ```
988
+ * ```js
946
989
  * searchEmbed.trigger(HostEvent.MakeACopy)
947
990
  * ```
948
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
991
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
949
992
  */
950
993
  HostEvent["MakeACopy"] = "makeACopy";
951
994
  /**
952
- * Triggers the Delete action on a Liveboard
995
+ * Triggers the **Delete** action on a Liveboard
953
996
  *
954
997
  * @example
955
998
  * ```js
956
999
  * appEmbed.trigger(HostEvent.Remove)
957
1000
  * ```
958
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1001
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
959
1002
  */
960
1003
  HostEvent["Remove"] = "delete";
961
1004
  /**
962
- * Triggers the Explore action on a visualization
1005
+ * Triggers the **Explore* action on a visualization
963
1006
  *
964
- * @param - an object with vizId as a key
1007
+ * @param - an object with `vizId` as a key
965
1008
  * @example
966
1009
  * ```js
967
1010
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
968
1011
  * ```
969
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1012
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
970
1013
  */
971
1014
  HostEvent["Explore"] = "explore";
972
1015
  /**
973
- * Triggers the Create alert action on a visualization
1016
+ * Triggers the **Create alert** action on a visualization
974
1017
  *
975
- * @param - an object with vizId as a key
1018
+ * @param - an object with `vizId` as a key
976
1019
  * @example
977
1020
  * ```js
978
1021
  * liveboardEmbed.trigger(HostEvent.CreateMonitor {
979
1022
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
980
1023
  * })
981
1024
  * ```
982
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1025
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
983
1026
  */
984
1027
  HostEvent["CreateMonitor"] = "createMonitor";
985
1028
  /**
986
- * Triggers the Manage alert action on a visualization
1029
+ * Triggers the **Manage alerts** action on a visualization
987
1030
  *
988
- * @param - an object with vizId as a key
1031
+ * @param - an object with `vizId` as a key
989
1032
  * @example
990
1033
  * ```js
991
1034
  * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
992
1035
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
993
1036
  * })
994
1037
  * ```
995
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1038
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
996
1039
  */
997
1040
  HostEvent["ManageMonitor"] = "manageMonitor";
998
1041
  /**
999
- * Triggers the Edit action on a Liveboard or visualization
1042
+ * Triggers the **Edit** action on a Liveboard or visualization
1000
1043
  *
1001
- * @param - object - to trigger the action for a specfic visualization
1002
- * in Liveboard embed, pass in vizId as a key
1044
+ * @param - object - To trigger the action for a specific visualization
1045
+ * in Liveboard embed, pass in `vizId` as a key.
1046
+ * Can be left undefined when embedding Search, full app, or
1047
+ * a visualization.
1003
1048
  * @example
1004
1049
  * ```js
1005
1050
  * liveboardEmbed.trigger(HostEvent.Edit)
1006
- *
1051
+ * ```
1052
+ * ```js
1007
1053
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
1008
1054
  * '730496d6-6903-4601-937e-2c691821af3c'})
1009
- *
1055
+ * ```
1056
+ * ```js
1010
1057
  * vizEmbed.trigger((HostEvent.Edit)
1011
1058
  * ```
1012
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1059
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1013
1060
  */
1014
1061
  HostEvent["Edit"] = "edit";
1015
1062
  /**
1016
- * Triggers the Copy link action on a Liveboard or visualization
1063
+ * Triggers the **Copy link** action on a Liveboard or visualization
1017
1064
  *
1018
- * @param - object - to trigger the action for a s
1019
- * pecfic visualization in Liveboard embed, pass in vizId as a key
1065
+ * @param - object - to trigger the action for a
1066
+ * specific visualization in Liveboard embed, pass in `vizId` as a key
1020
1067
  * @example
1021
1068
  * ```js
1022
1069
  * liveboardEmbed.trigger(HostEvent.CopyLink)
1070
+ * ```
1071
+ * ```js
1023
1072
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1073
+ * ```
1074
+ * ```js
1024
1075
  * vizEmbed.trigger((HostEvent.CopyLink)
1025
1076
  * ```
1026
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1077
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1027
1078
  */
1028
1079
  HostEvent["CopyLink"] = "embedDocument";
1029
1080
  /**
1030
- * Triggers the Present action on a Liveboard or visualization
1081
+ * Triggers the **Present** action on a Liveboard or visualization
1031
1082
  *
1032
- * @param - object - to trigger the action for a specfic visualization
1033
- * in Liveboard embed, pass in vizId as a key
1083
+ * @param - object - to trigger the action for a specific visualization
1084
+ * in Liveboard embed, pass in `vizId` as a key
1034
1085
  * @example
1035
1086
  * ```js
1036
1087
  * liveboardEmbed.trigger(HostEvent.Present)
1088
+ * ```
1089
+ * ```js
1037
1090
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1091
+ * ```
1092
+ * ```js
1038
1093
  * vizEmbed.trigger((HostEvent.Present)
1039
1094
  * ```
1040
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
1095
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1041
1096
  */
1042
1097
  HostEvent["Present"] = "present";
1043
1098
  /**
1044
- * Get TML for the current search.
1099
+ * Gets TML for the current search.
1045
1100
  *
1046
1101
  * @example
1047
1102
  * ```js
@@ -1051,78 +1106,90 @@ var HostEvent;
1051
1106
  * );
1052
1107
  * })
1053
1108
  * ```
1054
- * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
1109
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
1055
1110
  * @important
1056
1111
  */
1057
1112
  HostEvent["GetTML"] = "getTML";
1058
1113
  /**
1059
- * Triggers the ShowUnderlyingData action on visualization or search
1114
+ * Triggers the **Show underlying data** action on visualization or search
1060
1115
  *
1061
1116
  * @param - an object with vizId as a key
1062
1117
  * @example
1063
1118
  * ```js
1064
1119
  * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
1065
1120
  * '730496d6-6903-4601-937e-2c691821af3c'})
1066
- *
1121
+ * ```
1122
+ * ```js
1067
1123
  * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
1068
- *
1124
+ * ```
1125
+ * ```js
1069
1126
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
1070
1127
  * ```
1071
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1128
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1072
1129
  */
1073
1130
  HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
1074
1131
  /**
1075
- * Triggers the Delete action on visualization or search
1132
+ * Triggers the **Delete** action on visualization or search
1076
1133
  *
1077
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1078
- * can be left empty for search and visualization embeds
1134
+ * @param - Liveboard embed takes an object with `vizId` as a key.
1135
+ * Can be left empty if embedding Search or visualization.
1079
1136
  * @example
1080
1137
  * ```js
1081
1138
  * liveboardEmbed.trigger(HostEvent.Delete, {vizId:
1082
1139
  * '730496d6-6903-4601-937e-2c691821af3c'})
1083
- *
1140
+ * ```
1141
+ * ```js
1084
1142
  * vizEmbed.trigger(HostEvent.Delete)
1085
- *
1143
+ * ```
1144
+ * ```js
1086
1145
  * searchEmbed.trigger(HostEvent.Delete)
1087
1146
  * ```
1088
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1147
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1089
1148
  */
1090
1149
  HostEvent["Delete"] = "onDeleteAnswer";
1091
1150
  /**
1092
- * Triggers the SpotIQAnalyze action on visualization or search
1151
+ * Triggers the **SpotIQ analyze** action on visualization
1152
+ * or search.
1093
1153
  *
1094
- * @param - incase of Liveboard embed, takes in an object with vizId as a key
1095
- * can be left empty for search and visualization embeds
1154
+ * @param - Liveboard embed takes `vizId` as a
1155
+ * key. Can be left undefined when embedding Search or
1156
+ * visualization.
1096
1157
  * @example
1097
1158
  * ```js
1098
1159
  * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
1099
1160
  * '730496d6-6903-4601-937e-2c691821af3c'})
1100
- *
1161
+ * ```
1162
+ * ```js
1101
1163
  * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
1102
- *
1164
+ * ```
1165
+ * ```js
1103
1166
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
1104
1167
  * ```
1105
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1168
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1106
1169
  */
1107
1170
  HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
1108
1171
  /**
1109
- * Triggers the Download action on visualization or search when Displaymode is Chart
1172
+ * Triggers the **Download** action on charts in
1173
+ * the embedded view.
1110
1174
  *
1111
1175
  * @example
1112
1176
  * ```js
1113
1177
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
1114
1178
  * '730496d6-6903-4601-937e-2c691821af3c'})
1115
- *
1179
+ * ```
1180
+ * ```js
1116
1181
  * vizEmbed.trigger(HostEvent.Download)
1117
- *
1182
+ * ```
1183
+ * ```js
1118
1184
  * searchEmbed.trigger(HostEvent.Download)
1119
1185
  * ```
1120
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
1121
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1186
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
1187
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1122
1188
  */
1123
1189
  HostEvent["Download"] = "downloadAsPng";
1124
1190
  /**
1125
- * Triggers the Download action on visualization or search when Displaymode is Chart
1191
+ * Triggers the **Download** > **PNG** action on
1192
+ * charts in the embedded view.
1126
1193
  *
1127
1194
  * @example
1128
1195
  * ```js
@@ -1133,115 +1200,197 @@ var HostEvent;
1133
1200
  *
1134
1201
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
1135
1202
  * ```
1136
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
1203
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
1137
1204
  */
1138
1205
  HostEvent["DownloadAsPng"] = "downloadAsPng";
1139
1206
  /**
1140
- * Triggers the downloadAsCSV action on visualization or search
1207
+ * Triggers the **Download** > **CSV** action on tables in
1208
+ * the embedded view.
1141
1209
  *
1142
1210
  * @example
1143
1211
  * ```js
1144
1212
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
1145
1213
  * '730496d6-6903-4601-937e-2c691821af3c'})
1146
- *
1214
+ * ```
1215
+ * ```js
1147
1216
  * vizEmbed.trigger(HostEvent.DownloadAsCsv)
1148
- *
1217
+ * ```
1218
+ * ```js
1149
1219
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
1150
1220
  * ```
1151
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1221
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1152
1222
  */
1153
1223
  HostEvent["DownloadAsCsv"] = "downloadAsCSV";
1154
1224
  /**
1155
- * Triggers the downloadAsXLSX action on visualization or search
1225
+ * Triggers the **Download** > **XLSX** action on tables
1226
+ * in the embedded view.
1156
1227
  *
1157
1228
  * @example
1158
1229
  * ```js
1159
1230
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
1160
1231
  * '730496d6-6903-4601-937e-2c691821af3c'})
1161
- *
1232
+ * ```
1233
+ * ```js
1162
1234
  * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
1163
- *
1235
+ * ```
1236
+ * ```js
1164
1237
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
1165
1238
  * ```
1166
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1239
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1167
1240
  */
1168
1241
  HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
1169
1242
  /**
1170
- * Triggers the Share action on a liveboard or answer
1243
+ * Triggers the **Share** action on an embedded
1244
+ * Liveboard or Answer.
1171
1245
  *
1172
1246
  * @example
1173
1247
  * ```js
1174
1248
  * liveboardEmbed.trigger(HostEvent.Share)
1175
- *
1249
+ * ```
1250
+ * ```js
1176
1251
  * searchEmbed.trigger(HostEvent.Share)
1177
1252
  * ```
1178
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1253
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1179
1254
  */
1180
1255
  HostEvent["Share"] = "share";
1181
1256
  /**
1182
- * Trigger the Save action on a liveboard or answer
1257
+ * Triggers the **Save** action on a Liveboard or Answer.
1258
+ * Saves the changes.
1183
1259
  *
1184
1260
  * @example
1185
1261
  * ```js
1186
1262
  * liveboardEmbed.trigger(HostEvent.Save)
1187
- *
1263
+ * ```
1264
+ * ```js
1188
1265
  * searchEmbed.trigger(HostEvent.Save)
1189
1266
  * ```
1190
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1267
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1191
1268
  */
1192
1269
  HostEvent["Save"] = "save";
1193
1270
  /**
1194
- * Triggers the SyncToSheets action on visualization
1271
+ * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
1272
+ * Sends data from an Answer or Liveboard visualization to a Google sheet.
1195
1273
  *
1196
- * @param - an object with vizId as a key
1274
+ * @param - an object with `vizId` as a key
1197
1275
  * @example
1198
1276
  * ```js
1199
1277
  * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
1200
1278
  * '730496d6-6903-4601-937e-2c691821af3c'})
1201
- *
1279
+ * ```
1280
+ * ```js
1202
1281
  * vizEmbed.trigger(HostEvent.SyncToSheets)
1203
1282
  * ```
1204
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1283
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1205
1284
  */
1206
1285
  HostEvent["SyncToSheets"] = "sync-to-sheets";
1207
1286
  /**
1208
- * Triggers the SyncToOtherApps action on visualization
1287
+ * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
1288
+ * Sends data from an Answer or Liveboard visualization to third-party apps such
1289
+ * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1209
1290
  *
1210
1291
  * @param - an object with vizId as a key
1211
1292
  * @example
1212
1293
  * ```js
1213
1294
  * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
1214
1295
  * '730496d6-6903-4601-937e-2c691821af3c'})
1215
- *
1296
+ * ```
1297
+ * ```js
1216
1298
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
1217
1299
  * ```
1218
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1300
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1219
1301
  */
1220
1302
  HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
1221
1303
  /**
1222
- * Triggers the ManagePipelines action on visualization
1304
+ * Triggers the **Manage pipelines** action on an embedded
1305
+ * visualization or Answer.
1306
+ * Allows users to manage ThoughtSpot Sync pipelines.
1223
1307
  *
1224
- * @param - an object with vizId as a key
1308
+ * @param - an object with `vizId` as a key
1225
1309
  * @example
1226
1310
  * ```js
1227
1311
  * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
1228
1312
  * '730496d6-6903-4601-937e-2c691821af3c'})
1229
- *
1313
+ * ```
1314
+ * ```js
1230
1315
  * vizEmbed.trigger(HostEvent.ManagePipelines)
1231
1316
  * ```
1232
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
1317
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
1233
1318
  */
1234
1319
  HostEvent["ManagePipelines"] = "manage-pipeline";
1235
1320
  /**
1236
- * Triggers the Reset search in answer
1321
+ * Triggers the Reset search on the Search page
1237
1322
  *
1238
1323
  * @example
1239
1324
  * ```js
1240
1325
  * searchEmbed.trigger(HostEvent.ResetSearch)
1241
1326
  * ```
1242
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
1327
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
1243
1328
  */
1244
1329
  HostEvent["ResetSearch"] = "resetSearch";
1330
+ /**
1331
+ * Gets the currents visible and runtime filters applied on a Liveboard
1332
+ *
1333
+ * @example
1334
+ * liveboardEmbed.trigger(HostEvent.GetFilters)
1335
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1336
+ */
1337
+ HostEvent["GetFilters"] = "getFilters";
1338
+ /**
1339
+ * Updates the visible filters on the Liveboard.
1340
+ *
1341
+ * @param - filter: filter object containing column name and filter operation and values
1342
+ * @example
1343
+ *
1344
+ * ```js
1345
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1346
+ * filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
1347
+ * })
1348
+ * ```
1349
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1350
+ */
1351
+ HostEvent["UpdateFilters"] = "updateFilters";
1352
+ /*
1353
+ * Get Tab for the current Liveboard.
1354
+ *
1355
+ * @example
1356
+ * ```js
1357
+ * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
1358
+ * console.log(
1359
+ * tabDetails // TabDetails of current LB
1360
+ * );
1361
+ * })
1362
+ * ```
1363
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1364
+ */
1365
+ HostEvent["GetTabs"] = "getTabs";
1366
+ /**
1367
+ * Set the visible Tabs on a Liveboard.
1368
+ *
1369
+ * @param - an array of ids of Tabs to show, the ids not passed
1370
+ * will be hidden.
1371
+ * @example
1372
+ * ```js
1373
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
1374
+ * '430496d6-6903-4601-937e-2c691821af3c',
1375
+ * 'f547ec54-2a37-4516-a222-2b06719af726'])
1376
+ * ```
1377
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1378
+ */
1379
+ HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1380
+ /**
1381
+ * Set the hidden tabs on a Liveboard.
1382
+ *
1383
+ * @param - an array of ids of Tabs to hide, the ids not passed
1384
+ * will be shown.
1385
+ * @example
1386
+ * ```js
1387
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
1388
+ * '630496d6-6903-4601-937e-2c691821af3c',
1389
+ * 'i547ec54-2a37-4516-a222-2b06719af726'])
1390
+ * ```
1391
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
1392
+ */
1393
+ HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
1245
1394
  })(HostEvent = exports.HostEvent || (exports.HostEvent = {}));
1246
1395
  /**
1247
1396
  * The different visual modes that the data sources panel within
@@ -1324,27 +1473,52 @@ var Param;
1324
1473
  Param["HideLiveboardHeader"] = "hideLiveboardHeader";
1325
1474
  Param["ShowLiveboardDescription"] = "showLiveboardDescription";
1326
1475
  Param["ShowLiveboardTitle"] = "showLiveboardTitle";
1476
+ Param["HiddenTabs"] = "hideTabs";
1477
+ Param["VisibleTabs"] = "visibleTabs";
1478
+ Param["HideTabPanel"] = "hideTabPanel";
1479
+ Param["HideSampleQuestions"] = "hideSampleQuestions";
1480
+ Param["WorksheetId"] = "worksheetId";
1481
+ Param["Query"] = "query,";
1327
1482
  })(Param = exports.Param || (exports.Param = {}));
1328
1483
  /**
1329
- * The list of actions that can be performed on visual ThoughtSpot
1330
- * entities, such as answers and Liveboards.
1331
- *
1332
- * This enum is used to specify the actions that could be disabled,
1333
- * hidden or made visible.
1484
+ * ThoughtSpot application pages include actions and menu commands
1485
+ * for various user-initiated operations. These actions are represented
1486
+ * as enumeration members in the SDK. To show, hide, or disable
1487
+ * specific actions in the embedded view, define the Action
1488
+ * enumeration members in the `disabledActions`, `visibleActions`,
1489
+ * or `hiddenActions` array.
1334
1490
  *
1335
1491
  * @example
1336
1492
  * ```js
1337
1493
  * const embed = new LiveboardEmbed('#embed-container', {
1338
1494
  * ... // other options
1339
- * visibleActions: [Action.Save, Action.Explore],
1340
- * disableActions: [Action.Save],
1341
- * hiddenActions: [Action.Download], // Set either this or visibleActions
1495
+ * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
1496
+ * disabledActions: [Action.Download],
1497
+ * //hiddenActions: [], // Set either this or visibleActions
1498
+ * })
1499
+ * ```
1500
+ * @example
1501
+ * ```js
1502
+ * const embed = new LiveboardEmbed('#embed-container', {
1503
+ * ... // other options
1504
+ * //visibleActions: [],
1505
+ * disabledActions: [Action.Download],
1506
+ * hiddenActions: [Action.Edit, ActionAction.Explore],
1342
1507
  * })
1343
1508
  * ```
1344
1509
  */
1345
1510
  // eslint-disable-next-line no-shadow
1346
1511
  var Action;
1347
1512
  (function (Action) {
1513
+ /**
1514
+ * The **Save** action on an Answer or Liveboard.
1515
+ * Allows users to save the changes.
1516
+ *
1517
+ * @example
1518
+ * ```js
1519
+ * disabledActions: [Action.SaveAsView]
1520
+ * ```
1521
+ */
1348
1522
  Action["Save"] = "save";
1349
1523
  /**
1350
1524
  * @hidden
@@ -1354,27 +1528,147 @@ var Action;
1354
1528
  * @hidden
1355
1529
  */
1356
1530
  Action["SaveUntitled"] = "saveUntitled";
1531
+ /**
1532
+ * The **Save as View** action on the Answer
1533
+ * page. Saves an Answer as a View object.
1534
+ *
1535
+ * @example
1536
+ * ```js
1537
+ * disabledActions: [Action.SaveAsView]
1538
+ * ```
1539
+ */
1357
1540
  Action["SaveAsView"] = "saveAsView";
1541
+ /**
1542
+ * The **Make a copy** action on a Liveboard or Answer
1543
+ * page.
1544
+ * Creates a copy of the Liveboard, visualization,
1545
+ * or Answer.
1546
+ *
1547
+ * @example
1548
+ * ```js
1549
+ * disabledActions: [Action.MakeACopy]
1550
+ * ```
1551
+ */
1358
1552
  Action["MakeACopy"] = "makeACopy";
1553
+ /**
1554
+ * The **Copy and Edit** action on a Liveboard.
1555
+ * This action is now replaced with `Action.MakeACopy`.
1556
+ *
1557
+ * @example
1558
+ * ```js
1559
+ * disabledActions: [Action.EditACopy]
1560
+ * ```
1561
+ */
1359
1562
  Action["EditACopy"] = "editACopy";
1563
+ /**
1564
+ * The **Copy link** menu action on a Liveboard visualization.
1565
+ * Copies the visualization URL
1566
+ *
1567
+ * @example
1568
+ * ```js
1569
+ * disabledActions: [Action.CopyLink]
1570
+ * ```
1571
+ */
1360
1572
  Action["CopyLink"] = "embedDocument";
1361
1573
  /**
1362
1574
  * @hidden
1363
1575
  */
1364
1576
  Action["ResetLayout"] = "resetLayout";
1577
+ /**
1578
+ * The **Schedule** menu action on a Liveboard.
1579
+ * Allows scheduling a Liveboard notification.
1580
+ *
1581
+ * @example
1582
+ * ```js
1583
+ * disabledActions: [Action.Schedule]
1584
+ * ```
1585
+ */
1365
1586
  Action["Schedule"] = "subscription";
1587
+ /**
1588
+ * The **Manage schedules** menu action on a Liveboard.
1589
+ * Allows users to manage scheduled Liveboard jobs.
1590
+ *
1591
+ * @example
1592
+ * ```js
1593
+ * disabledActions: [Action.SchedulesList]
1594
+ * ```
1595
+ */
1366
1596
  Action["SchedulesList"] = "schedule-list";
1597
+ /**
1598
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
1599
+ * Allows users to share an object with other users and groups.
1600
+ *
1601
+ * @example
1602
+ * ```js
1603
+ * disabledActions: [Action.Share]
1604
+ * ```
1605
+ */
1367
1606
  Action["Share"] = "share";
1607
+ /**
1608
+ * The **Add filter** action on a Liveboard and Search page.
1609
+ * Allows adding filters to Answers and visualizations on a Liveboard.
1610
+ *
1611
+ * @example
1612
+ * ```js
1613
+ * disabledActions: [Action.AddFilter]
1614
+ * ```
1615
+ */
1368
1616
  Action["AddFilter"] = "addFilter";
1617
+ /**
1618
+ * Filter configuration options on a Liveboard and Search page.
1619
+ * Allows configuring filter options when adding filters to a
1620
+ * Liveboard or Answer.
1621
+ *
1622
+ * @example
1623
+ * ```js
1624
+ * disabledActions: [Action.ConfigureFilter]
1625
+ * ```
1626
+ */
1369
1627
  Action["ConfigureFilter"] = "configureFilter";
1370
1628
  Action["CollapseDataSources"] = "collapseDataSources";
1629
+ /**
1630
+ * The **Choose sources** button on Search page.
1631
+ * Allows selecting data sources for search queries.
1632
+ *
1633
+ * @example
1634
+ * ```js
1635
+ * disabledActions: [Action.ChooseDataSources]
1636
+ * ```
1637
+ */
1371
1638
  Action["ChooseDataSources"] = "chooseDataSources";
1639
+ /**
1640
+ * The **Create formula** action on a Search or Answer page.
1641
+ * Allows adding formulas to an Answer.
1642
+ *
1643
+ * @example
1644
+ * ```js
1645
+ * disabledActions: [Action.AddFormula]
1646
+ * ```
1647
+ */
1372
1648
  Action["AddFormula"] = "addFormula";
1649
+ /**
1650
+ * The **Add parameter** action on a Liveboard or Answer.
1651
+ * Allows adding Parameters to a Liveboard or Answer.
1652
+ *
1653
+ * @example
1654
+ * ```js
1655
+ * disabledActions: [Action.AddParameter]
1656
+ * ```
1657
+ */
1373
1658
  Action["AddParameter"] = "addParameter";
1374
1659
  /**
1375
1660
  * @hidden
1376
1661
  */
1377
1662
  Action["SearchOnTop"] = "searchOnTop";
1663
+ /**
1664
+ * The **SpotIQ analyze** menu action on a visualization or
1665
+ * Answer page.
1666
+ *
1667
+ * @example
1668
+ * ```js
1669
+ * disabledActions: [Action.SpotIQAnalyze]
1670
+ * ```
1671
+ */
1378
1672
  Action["SpotIQAnalyze"] = "spotIQAnalyze";
1379
1673
  /**
1380
1674
  * @hidden
@@ -1389,24 +1683,165 @@ var Action;
1389
1683
  * @hidden
1390
1684
  */
1391
1685
  Action["ReplaySearch"] = "replaySearch";
1686
+ /**
1687
+ * The **Show underlying data** menu action on a visualization or
1688
+ * Answer page.
1689
+ *
1690
+ * @example
1691
+ * ```js
1692
+ * disabledActions: [Action.ShowUnderlyingData]
1693
+ * ```
1694
+ */
1392
1695
  Action["ShowUnderlyingData"] = "showUnderlyingData";
1696
+ /**
1697
+ * The **Download** menu action on Liveboard visualizations
1698
+ * and Answers.
1699
+ * Allows downloading a visualization or Answer.
1700
+ *
1701
+ * @example
1702
+ * ```js
1703
+ * disabledActions: [Action.DownloadAsPng]
1704
+ * ```
1705
+ */
1393
1706
  Action["Download"] = "download";
1707
+ /**
1708
+ * The **Download** > **PNG** menu action for charts on a Liveboard
1709
+ * or Answer page.
1710
+ * Downloads a visualization or Answer as a PNG file.
1711
+ *
1712
+ * @example
1713
+ * ```js
1714
+ * disabledActions: [Action.DownloadAsPng]
1715
+ * ```
1716
+ */
1394
1717
  Action["DownloadAsPng"] = "downloadAsPng";
1718
+ /**
1719
+ * The **Download** > **PDF** menu action on a Liveboard.
1720
+ * Downloads a visualization or Answer as a PDF file.
1721
+ *
1722
+ * @example
1723
+ * ```js
1724
+ * disabledActions: [Action.DownloadAsPdf]
1725
+ * ```
1726
+ */
1395
1727
  Action["DownloadAsPdf"] = "downloadAsPdf";
1728
+ /**
1729
+ * The **Download** > **CSV** menu action for tables on a Liveboard
1730
+ * or Answer page.
1731
+ * Downloads a visualization or Answer in the XLSX format.
1732
+ *
1733
+ * @example
1734
+ * ```js
1735
+ * disabledActions: [Action.DownloadAsCsv]
1736
+ * ```
1737
+ */
1396
1738
  Action["DownloadAsCsv"] = "downloadAsCSV";
1739
+ /**
1740
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
1741
+ * or Answer page.
1742
+ * Downloads a visualization or Answer in the XLSX format.
1743
+ *
1744
+ * @example
1745
+ * ```js
1746
+ * disabledActions: [Action.DownloadAsXlsx]
1747
+ * ```
1748
+ */
1397
1749
  Action["DownloadAsXlsx"] = "downloadAsXLSX";
1398
1750
  /**
1399
1751
  * @hidden
1400
1752
  */
1401
1753
  Action["DownloadTrace"] = "downloadTrace";
1754
+ /**
1755
+ * The **Export TML** menu action on Liveboard, Answers
1756
+ * Worksheets and Data Connections page.
1757
+ * Exports an object as a TML file.
1758
+ *
1759
+ * @example
1760
+ * ```js
1761
+ * disabledActions: [Action.ExportTML]
1762
+ * ```
1763
+ */
1402
1764
  Action["ExportTML"] = "exportTSL";
1765
+ /**
1766
+ * The **Import TML** menu action for Liveboards and Answers.
1767
+ * Imports TML representation of ThoughtSpot objects.
1768
+ *
1769
+ * @example
1770
+ * ```js
1771
+ * disabledActions: [Action.ImportTML]
1772
+ * ```
1773
+ */
1403
1774
  Action["ImportTML"] = "importTSL";
1775
+ /**
1776
+ * The **Update TML** menu action for Liveboards and Answers.
1777
+ * Update TML representation of ThoughtSpot objects.
1778
+ *
1779
+ * @example
1780
+ * ```js
1781
+ * disabledActions: [Action.UpdateTML]
1782
+ * ```
1783
+ */
1404
1784
  Action["UpdateTML"] = "updateTSL";
1785
+ /**
1786
+ * The **Edit TML** menu action for Liveboards and Answers.
1787
+ * Opens the TML editor.
1788
+ *
1789
+ * @example
1790
+ * ```js
1791
+ * disabledActions: [Action.EditTML]
1792
+ * ```
1793
+ */
1405
1794
  Action["EditTML"] = "editTSL";
1795
+ /**
1796
+ * The **Present** menu action for Liveboards and Answers.
1797
+ * Allows presenting a Liveboard or visualization in
1798
+ * slideshow mode.
1799
+ *
1800
+ * @example
1801
+ * ```js
1802
+ * disabledActions: [Action.Present]
1803
+ * ```
1804
+ */
1406
1805
  Action["Present"] = "present";
1806
+ /**
1807
+ * The tile resize options in the visualization menu.
1808
+ * Allows switching between different preset layouts.
1809
+ *
1810
+ * @example
1811
+ * ```js
1812
+ * disabledActions: [Action.ToggleSize]
1813
+ * ```
1814
+ */
1407
1815
  Action["ToggleSize"] = "toggleSize";
1816
+ /**
1817
+ * The *Edit* action on the Liveboard page and in the
1818
+ * visualization menu.
1819
+ * Opens a Liveboard or visualization in edit mode.
1820
+ *
1821
+ * @example
1822
+ * ```js
1823
+ * disabledActions: [Action.Edit]
1824
+ * ```
1825
+ */
1408
1826
  Action["Edit"] = "edit";
1827
+ /**
1828
+ * The text edit option for Liveboard and visualization titles.
1829
+ *
1830
+ * @example
1831
+ * ```js
1832
+ * disabledActions: [Action.EditTitle]
1833
+ * ```
1834
+ */
1409
1835
  Action["EditTitle"] = "editTitle";
1836
+ /**
1837
+ * The **Delete** menu action on Liveboards and visualizations.
1838
+ * Deletes a Liveboard or a visualization from a Liveboard.
1839
+ *
1840
+ * @example
1841
+ * ```js
1842
+ * disabledActions: [Action.Remove]
1843
+ * ```
1844
+ */
1410
1845
  Action["Remove"] = "delete";
1411
1846
  /**
1412
1847
  * @hidden
@@ -1428,6 +1863,17 @@ var Action;
1428
1863
  * @hidden
1429
1864
  */
1430
1865
  Action["PinboardInfo"] = "pinboardInfo";
1866
+ /**
1867
+ * The **Show Liveboard details** menu action on a Liveboard.
1868
+ * Displays details such as the name, description, and
1869
+ * author of the Liveboard, and timestamp of Liveboard creation
1870
+ * and update.
1871
+ *
1872
+ * @example
1873
+ * ```js
1874
+ * disabledActions: [Action.LiveboardInfo]
1875
+ * ```
1876
+ */
1431
1877
  Action["LiveboardInfo"] = "pinboardInfo";
1432
1878
  /**
1433
1879
  * @hidden
@@ -1438,20 +1884,67 @@ var Action;
1438
1884
  */
1439
1885
  Action["DownloadEmbraceQueries"] = "downloadEmbraceQueries";
1440
1886
  /**
1441
- * Pin action.
1887
+ * The **Pin** menu action on an Answer or
1888
+ * Search results page.
1889
+ *
1890
+ * @example
1891
+ * ```js
1892
+ * disabledActions: [Action.Pin]
1893
+ * ```
1442
1894
  */
1443
1895
  Action["Pin"] = "pin";
1444
1896
  /**
1445
1897
  * @hidden
1446
1898
  */
1447
1899
  Action["AnalysisInfo"] = "analysisInfo";
1900
+ /**
1901
+ * The **Schedule** menu action on a Liveboard.
1902
+ *
1903
+ * @example
1904
+ * ```js
1905
+ * disabledActions: [Action.Subscription]
1906
+ * ```
1907
+ */
1448
1908
  Action["Subscription"] = "subscription";
1449
1909
  /**
1450
- * Explore action.
1910
+ * The **Explore** action on Liveboard visualizations
1911
+ *
1912
+ * @example
1913
+ * ```js
1914
+ * disabledActions: [Action.Explore]
1915
+ * ```
1451
1916
  */
1452
1917
  Action["Explore"] = "explore";
1918
+ /**
1919
+ * The action to include data points on a drilled-down Answer
1920
+ * or visualization
1921
+ *
1922
+ * @example
1923
+ * ```js
1924
+ * disabledActions: [Action.DrillInclude]
1925
+ * ```
1926
+ */
1453
1927
  Action["DrillInclude"] = "context-menu-item-include";
1928
+ /**
1929
+ * The action to exclude data points on a drilled-down Answer
1930
+ * or visualization
1931
+ *
1932
+ * @example
1933
+ * ```js
1934
+ * disabledActions: [Action.DrillInclude]
1935
+ * ```
1936
+ */
1454
1937
  Action["DrillExclude"] = "context-menu-item-exclude";
1938
+ /**
1939
+ * The **Copy to clipboard** menu action on tables in an Answer
1940
+ * or Liveboard.
1941
+ * Copies the selected data point.
1942
+ *
1943
+ * @example
1944
+ * ```js
1945
+ * disabledActions: [Action.CopyToClipboard]
1946
+ * ```
1947
+ */
1455
1948
  Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
1456
1949
  Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
1457
1950
  /**
@@ -1460,89 +1953,291 @@ var Action;
1460
1953
  Action["DrillEdit"] = "context-menu-item-edit";
1461
1954
  Action["EditMeasure"] = "context-menu-item-edit-measure";
1462
1955
  Action["Separator"] = "context-menu-item-separator";
1956
+ /**
1957
+ * The **Drill down** menu action on Answers and Liveboard
1958
+ * visualizations.
1959
+ * Allows drilling down to a specific data point on a chart or table.
1960
+ *
1961
+ * @example
1962
+ * ```js
1963
+ * disabledActions: [Action.DrillDown]
1964
+ * ```
1965
+ */
1463
1966
  Action["DrillDown"] = "DRILL";
1967
+ /**
1968
+ * The request access action on Liveboards.
1969
+ * Allows users with view permissions to request edit access to a Liveboard.
1970
+ *
1971
+ * @example
1972
+ * ```js
1973
+ * disabledActions: [Action.RequestAccess]
1974
+ * ```
1975
+ */
1464
1976
  Action["RequestAccess"] = "requestAccess";
1465
- Action["QueryDetailsButtons"] = "queryDetailsButtons";
1466
1977
  /**
1467
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1978
+ * The **Query visualizer** and **Query SQL** buttons in Query details panel
1979
+ * of the Answer page
1980
+ *
1981
+ * @example
1982
+ * ```js
1983
+ * disabledActions: [Action.QueryDetailsButtons]
1984
+ * ```
1985
+ */
1986
+ Action["QueryDetailsButtons"] = "QueryDetailsButtons";
1987
+ /**
1988
+ * The **Delete** action for Answers.
1989
+ *
1990
+ * @example
1991
+ * ```js
1992
+ * disabledActions: [Action.AnswerDelete]
1993
+ * ```
1994
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1468
1995
  */
1469
1996
  Action["AnswerDelete"] = "onDeleteAnswer";
1470
1997
  /**
1471
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1998
+ * The Chart switcher icon on Answer and visualization pages.
1999
+ *
2000
+ * @example
2001
+ * ```js
2002
+ * disabledActions: [Action.AnswerChartSwitcher]
2003
+ * ```
2004
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1472
2005
  */
1473
2006
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
1474
2007
  /**
1475
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2008
+ * Favorites icon (*) on Answers, Liveboard, and Data pages
2009
+ *
2010
+ * @example
2011
+ * ```js
2012
+ * disabledActions: [Action.AddToFavorites]
2013
+ * ```
2014
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1476
2015
  */
1477
2016
  Action["AddToFavorites"] = "addToFavorites";
1478
2017
  /**
1479
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
2018
+ * The edit icon on Liveboards (Classic experience).
2019
+ *
2020
+ * @example
2021
+ * ```js
2022
+ * disabledActions: [Action.EditDetails]
2023
+ * ```
2024
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1480
2025
  */
1481
2026
  Action["EditDetails"] = "editDetails";
1482
2027
  /**
1483
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2028
+ * The Create alert action on KPI charts.
2029
+ *
2030
+ * @example
2031
+ * ```js
2032
+ * disabledActions: [Action.CreateMonitor ]
2033
+ * ```
2034
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1484
2035
  */
1485
2036
  Action["CreateMonitor"] = "createMonitor";
1486
2037
  /**
1487
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
2038
+ * @example
2039
+ * ```js
2040
+ * disabledActions: [Action.ReportError]
2041
+ * ```
2042
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1488
2043
  */
1489
2044
  Action["ReportError"] = "reportError";
2045
+ /**
2046
+ * The **Sync to sheets** action on Answers and Liveboard visualizations.
2047
+ * Allows sending data to a Google Sheet.
2048
+ *
2049
+ * @example
2050
+ * ```js
2051
+ * disabledActions: [Action.SyncToSheets]
2052
+ * ```
2053
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2054
+ */
1490
2055
  Action["SyncToSheets"] = "sync-to-sheets";
2056
+ /**
2057
+ * The **Sync to other apps** action on Answers and Liveboard visualizations.
2058
+ * Allows sending data to third-party apps like Slack, Salesforce,
2059
+ * Microsoft Teams, and so on.
2060
+ *
2061
+ * @example
2062
+ * ```js
2063
+ * disabledActions: [Action.SyncToOtherApps]
2064
+ * ```
2065
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2066
+ */
1491
2067
  Action["SyncToOtherApps"] = "sync-to-other-apps";
2068
+ /**
2069
+ * The **Manage pipelines** action on Answers and Liveboard visualizations.
2070
+ * Allows users to manage data sync pipelines to third-party apps.
2071
+ *
2072
+ * @example
2073
+ * ```js
2074
+ * disabledActions: [Action.SyncToOtherApps]
2075
+ * ```
2076
+ * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
2077
+ */
1492
2078
  Action["ManagePipelines"] = "manage-pipeline";
1493
2079
  /**
2080
+ * The **Filter** action on Liveboard visualizations.
2081
+ * Allows users to apply cross-filters on a Liveboard.
2082
+ *
2083
+ * @example
2084
+ * ```js
2085
+ * disabledActions: [Action.CrossFilter]
2086
+ * ```
1494
2087
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1495
2088
  */
1496
2089
  Action["CrossFilter"] = "context-menu-item-cross-filter";
1497
2090
  /**
2091
+ * The **Remove** action that appears when cross filters are applied
2092
+ * on a Liveboard.
2093
+ * Removes filters applied o a visualization.
2094
+ *
2095
+ * @example
2096
+ * ```js
2097
+ * disabledActions: [Action.RemoveCrossFilter]
2098
+ * ```
1498
2099
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1499
2100
  */
1500
2101
  Action["RemoveCrossFilter"] = "context-menu-item-remove-cross-filter";
1501
2102
  /**
2103
+ * The **Aggregate** option in the chart axis or the
2104
+ * table column customization menu.
2105
+ * Provides aggregation options to analyze the data on a chart or table.
2106
+ *
2107
+ * @example
2108
+ * ```js
2109
+ * disabledActions: [Action.AxisMenuAggregate]
2110
+ * ```
1502
2111
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1503
2112
  */
1504
2113
  Action["AxisMenuAggregate"] = "axisMenuAggregate";
1505
2114
  /**
2115
+ * The **Time bucket** option in the chart axis or table column
2116
+ * customization menu.
2117
+ * Allows defining time metric for date comparison.
2118
+ *
2119
+ * @example
2120
+ * ```js
2121
+ * disabledActions: [Action.AxisMenuTimeBucket]
2122
+ * ```
1506
2123
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1507
2124
  */
1508
2125
  Action["AxisMenuTimeBucket"] = "axisMenuTimeBucket";
1509
2126
  /**
2127
+ * The **Filter** action in the chart axis or table column
2128
+ * customization menu.
2129
+ *
2130
+ * @example
2131
+ * ```js
2132
+ * disabledActions: [Action.AxisMenuFilter]
2133
+ * ```
1510
2134
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1511
2135
  */
1512
2136
  Action["AxisMenuFilter"] = "axisMenuFilter";
1513
2137
  /**
2138
+ * The **Conditional formatting** action on chart or table.
2139
+ * Allows adding rules for conditional formatting of data
2140
+ * points on a chart or table.
2141
+ *
2142
+ * @example
2143
+ * ```js
2144
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2145
+ * ```
1514
2146
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1515
2147
  */
1516
2148
  Action["AxisMenuConditionalFormat"] = "axisMenuConditionalFormat";
1517
2149
  /**
2150
+ * The **Sort** menu action on a table or chart axis
2151
+ * Sorts data in ascending or descending order.
2152
+ * Allows adding, editing, or removing filters.
2153
+ *
2154
+ * @example
2155
+ * ```js
2156
+ * disabledActions: [Action.AxisMenuConditionalFormat]
2157
+ * ```
1518
2158
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1519
2159
  */
1520
2160
  Action["AxisMenuSort"] = "axisMenuSort";
1521
2161
  /**
2162
+ * The **Group** option in the chart axis or table column
2163
+ * customization menu.
2164
+ * Allows grouping data points if the axes use the same
2165
+ * unit of measurement and a similar scale.
2166
+ *
2167
+ * @example
2168
+ * ```js
2169
+ * disabledActions: [Action.AxisMenuGroup]
2170
+ * ```
1522
2171
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1523
2172
  */
1524
2173
  Action["AxisMenuGroup"] = "axisMenuGroup";
1525
2174
  /**
2175
+ * The **Position** option in the axis customization menu.
2176
+ * Allows changing the position of the axis to the
2177
+ * left or right side of the chart.
2178
+ *
2179
+ * @example
2180
+ * ```js
2181
+ * disabledActions: [Action.AxisMenuPosition]
2182
+ * ```
1526
2183
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1527
2184
  */
1528
2185
  Action["AxisMenuPosition"] = "axisMenuPosition";
1529
2186
  /**
2187
+ * The **Rename** option in the chart axis or table column customization menu.
2188
+ * Renames the axis label on a chart or the column header on a table.
2189
+ *
2190
+ * @example
2191
+ * ```js
2192
+ * disabledActions: [Action.AxisMenuRename]
2193
+ * ```
1530
2194
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1531
2195
  */
1532
2196
  Action["AxisMenuRename"] = "axisMenuRename";
1533
2197
  /**
2198
+ * The **Edit** action in the axis customization menu.
2199
+ * Allows editing the axis name, position, minimum and maximum values,
2200
+ * and format of a column.
2201
+ *
2202
+ * @example
2203
+ * ```js
2204
+ * disabledActions: [Action.AxisMenuEdit]
2205
+ * ```
1534
2206
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1535
2207
  */
1536
2208
  Action["AxisMenuEdit"] = "axisMenuEdit";
1537
2209
  /**
2210
+ * The **Number format** action to customize the format of
2211
+ * the data labels on a chart or table.
2212
+ *
2213
+ * @example
2214
+ * ```js
2215
+ * disabledActions: [Action.AxisMenuNumberFormat]
2216
+ * ```
1538
2217
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1539
2218
  */
1540
2219
  Action["AxisMenuNumberFormat"] = "axisMenuNumberFormat";
1541
2220
  /**
2221
+ * The **Text wrapping** action on a table.
2222
+ * Wraps or clips column text on a table.
2223
+ *
2224
+ * @example
2225
+ * ```js
2226
+ * disabledActions: [Action.AxisMenuTextWrapping]
2227
+ * ```
1542
2228
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1543
2229
  */
1544
2230
  Action["AxisMenuTextWrapping"] = "axisMenuTextWrapping";
1545
2231
  /**
2232
+ * The **Remove** action in the chart axis or table column
2233
+ * customization menu.
2234
+ * Removes the data labels from a chart or the column of a
2235
+ * table visualization.
2236
+ *
2237
+ * @example
2238
+ * ```js
2239
+ * disabledActions: [Action.AxisMenuRemove]
2240
+ * ```
1546
2241
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1547
2242
  */
1548
2243
  Action["AxisMenuRemove"] = "axisMenuRemove";
@@ -1551,9 +2246,48 @@ var Action;
1551
2246
  */
1552
2247
  Action["InsertInToSlide"] = "insertInToSlide";
1553
2248
  /**
2249
+ * The **Rename** menu action on Liveboards and visualizations.
2250
+ * Allows renaming a Liveboard or visualization.
2251
+ *
2252
+ * @example
2253
+ * ```js
2254
+ * disabledActions: [Action.RenameModalTitleDescription]
2255
+ * ```
1554
2256
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1555
2257
  */
1556
2258
  Action["RenameModalTitleDescription"] = "renameModalTitleDescription";
2259
+ /**
2260
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2261
+ */
2262
+ Action["RequestVerification"] = "requestVerification";
2263
+ /**
2264
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2265
+ */
2266
+ Action["MarkAsVerified"] = "markAsVerified";
2267
+ /**
2268
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2269
+ */
2270
+ Action["AddTab"] = "addTab";
2271
+ /**
2272
+ * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
2273
+ */
2274
+ Action["EnableContextualChangeAnalysis"] = "enableContextualChangeAnalysis";
2275
+ /**
2276
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2277
+ */
2278
+ Action["ShowSageQuery"] = "showSageQuery";
2279
+ /**
2280
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2281
+ */
2282
+ Action["EditSageAnswer"] = "editSageAnswer";
2283
+ /**
2284
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2285
+ */
2286
+ Action["SageAnswerFeedback"] = "sageAnswerFeedback";
2287
+ /**
2288
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
2289
+ */
2290
+ Action["ModifySageAnswer"] = "modifySageAnswer";
1557
2291
  })(Action = exports.Action || (exports.Action = {}));
1558
2292
  // eslint-disable-next-line no-shadow
1559
2293
  var OperationType;