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