@thoughtspot/visual-embed-sdk 1.13.0 → 1.14.1
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/CHANGELOG.md +7 -2
- package/dist/src/embed/app.d.ts +4 -3
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/liveboard.d.ts +6 -8
- package/dist/src/embed/pinboard.d.ts +91 -0
- package/dist/src/embed/search.d.ts +1 -1
- package/dist/src/embed/ts-embed.d.ts +4 -4
- package/dist/src/types.d.ts +83 -76
- package/dist/src/utils/authService.d.ts +1 -0
- package/dist/src/utils/plugin.d.ts +0 -0
- package/dist/src/v1/api.d.ts +19 -0
- package/dist/tsembed.es.js +103 -76
- package/dist/tsembed.js +103 -76
- package/lib/package.json +1 -1
- package/lib/src/auth.js +8 -2
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +18 -0
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/embed/app.d.ts +4 -3
- package/lib/src/embed/app.js +2 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.js +1 -1
- package/lib/src/embed/liveboard.d.ts +6 -8
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/pinboard.d.ts +91 -0
- package/lib/src/embed/pinboard.js +110 -0
- package/lib/src/embed/pinboard.js.map +1 -0
- package/lib/src/embed/search.d.ts +1 -1
- package/lib/src/embed/ts-embed.d.ts +4 -4
- package/lib/src/types.d.ts +83 -76
- package/lib/src/types.js +73 -68
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService.d.ts +1 -0
- package/lib/src/utils/authService.js +13 -0
- package/lib/src/utils/authService.js.map +1 -1
- package/lib/src/utils/authService.spec.js +15 -1
- package/lib/src/utils/authService.spec.js.map +1 -1
- package/lib/src/utils/plugin.d.ts +0 -0
- package/lib/src/utils/plugin.js +1 -0
- package/lib/src/utils/plugin.js.map +1 -0
- package/lib/src/utils/processData.js +7 -5
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +14 -0
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +99 -93
- package/package.json +1 -1
- package/src/auth.spec.ts +39 -0
- package/src/auth.ts +11 -5
- package/src/embed/app.ts +4 -3
- package/src/embed/base.ts +1 -1
- package/src/embed/liveboard.ts +6 -8
- package/src/embed/search.ts +1 -1
- package/src/embed/ts-embed.ts +4 -4
- package/src/types.ts +83 -76
- package/src/utils/authService.spec.ts +21 -0
- package/src/utils/authService.ts +20 -0
- package/src/utils/processData.spec.ts +17 -0
- package/src/utils/processData.ts +7 -5
package/lib/src/types.d.ts
CHANGED
|
@@ -12,9 +12,13 @@
|
|
|
12
12
|
*/
|
|
13
13
|
export declare enum AuthType {
|
|
14
14
|
/**
|
|
15
|
-
* No authentication.
|
|
15
|
+
* No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
|
|
16
16
|
*/
|
|
17
17
|
None = "None",
|
|
18
|
+
/**
|
|
19
|
+
* No authentication on the SDK. Passthrough to the embedded App.
|
|
20
|
+
*/
|
|
21
|
+
Passthrough = "None",
|
|
18
22
|
/**
|
|
19
23
|
* SSO using SAML
|
|
20
24
|
* @deprecated Use {@link SAML} instead
|
|
@@ -121,7 +125,7 @@ export interface EmbedConfig {
|
|
|
121
125
|
* terminated.
|
|
122
126
|
*
|
|
123
127
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
124
|
-
* @version SDK: 1.10.2 |
|
|
128
|
+
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
|
|
125
129
|
*/
|
|
126
130
|
redirectPath?: string;
|
|
127
131
|
/** @internal */
|
|
@@ -149,13 +153,13 @@ export interface EmbedConfig {
|
|
|
149
153
|
/**
|
|
150
154
|
* Disable redirection to the login page when the embedded session expires
|
|
151
155
|
* This flag is typically used alongside the combination of auth modes such as {@link AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
|
|
152
|
-
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl
|
|
156
|
+
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
153
157
|
* @default false
|
|
154
158
|
*/
|
|
155
159
|
disableLoginRedirect?: boolean;
|
|
156
160
|
/**
|
|
157
161
|
* This message is displayed on the embed view when the login fails.
|
|
158
|
-
* @version 1.10.1 | ThoughtSpot:
|
|
162
|
+
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
159
163
|
*/
|
|
160
164
|
loginFailedMessage?: string;
|
|
161
165
|
/**
|
|
@@ -167,14 +171,14 @@ export interface EmbedConfig {
|
|
|
167
171
|
* When there are multiple embeds, queue the render of embed to start
|
|
168
172
|
* after the previous embed's render is complete. This helps in the load performance
|
|
169
173
|
* by decreasing the load on the browser.
|
|
170
|
-
*
|
|
174
|
+
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
171
175
|
* @default false
|
|
172
176
|
*/
|
|
173
177
|
queueMultiRenders?: boolean;
|
|
174
178
|
/**
|
|
175
179
|
* Dynamic CSS Url to be injected in the loaded application.
|
|
176
180
|
* You would also need to set `style-src` in the CSP settings.
|
|
177
|
-
* @version 1.6.0
|
|
181
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
178
182
|
* @default ''
|
|
179
183
|
*/
|
|
180
184
|
customCssUrl?: string;
|
|
@@ -183,17 +187,19 @@ export interface EmbedConfig {
|
|
|
183
187
|
* and should be avoided. Listen to the NO_COOKIE_ACCESS event to handle the situation.
|
|
184
188
|
*
|
|
185
189
|
* This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
|
|
186
|
-
* @version SDK: 1.10.4 | ThoughtSpot:
|
|
190
|
+
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
187
191
|
*/
|
|
188
192
|
detectCookieAccessSlow?: boolean;
|
|
189
193
|
/**
|
|
190
194
|
* Hide beta alert warning message for SearchEmbed.
|
|
191
195
|
*
|
|
192
|
-
* @version SDK: 1.12.0 | ThoughtSpot: *
|
|
196
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
|
|
193
197
|
*/
|
|
194
198
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
195
199
|
/**
|
|
196
|
-
* Custom style params for embed Config
|
|
200
|
+
* Custom style params for embed Config.
|
|
201
|
+
*
|
|
202
|
+
* @version SDK: 1.16.0 | ThoughtSpot: 8.8.0.cl, 8.8.1-sw
|
|
197
203
|
*/
|
|
198
204
|
customisations?: CustomisationsInterface;
|
|
199
205
|
}
|
|
@@ -354,7 +360,7 @@ export declare enum EmbedEvent {
|
|
|
354
360
|
/**
|
|
355
361
|
* One or more data columns have been selected.
|
|
356
362
|
* @return columnIds - the list of columns
|
|
357
|
-
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
|
|
363
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
358
364
|
*/
|
|
359
365
|
AddRemoveColumns = "addRemoveColumns",
|
|
360
366
|
/**
|
|
@@ -366,13 +372,13 @@ export declare enum EmbedEvent {
|
|
|
366
372
|
/**
|
|
367
373
|
* A double click has been triggered on table/chart
|
|
368
374
|
* @return ContextMenuInputPoints - data point that is double clicked
|
|
369
|
-
* @version 1.5.0
|
|
375
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
370
376
|
*/
|
|
371
377
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
372
378
|
/**
|
|
373
379
|
* A click has been triggered on table/chart
|
|
374
380
|
* @return ContextMenuInputPoints - data point that is clicked
|
|
375
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
381
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
376
382
|
*/
|
|
377
383
|
VizPointClick = "vizPointClick",
|
|
378
384
|
/**
|
|
@@ -424,7 +430,7 @@ export declare enum EmbedEvent {
|
|
|
424
430
|
* Emitted when the embed does not have cookie access. This
|
|
425
431
|
* happens on Safari where third-party cookies are blocked by default.
|
|
426
432
|
*
|
|
427
|
-
* @version 1.1.0
|
|
433
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
428
434
|
*/
|
|
429
435
|
NoCookieAccess = "noCookieAccess",
|
|
430
436
|
/**
|
|
@@ -435,179 +441,180 @@ export declare enum EmbedEvent {
|
|
|
435
441
|
SAMLComplete = "samlComplete",
|
|
436
442
|
/**
|
|
437
443
|
* Emitted when any modal is opened in the app
|
|
438
|
-
* @version 1.6.0
|
|
444
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
439
445
|
*/
|
|
440
446
|
DialogOpen = "dialog-open",
|
|
441
447
|
/**
|
|
442
448
|
* Emitted when any modal is closed in the app
|
|
443
|
-
* @version 1.6.0
|
|
449
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
444
450
|
*/
|
|
445
451
|
DialogClose = "dialog-close",
|
|
446
452
|
/**
|
|
447
453
|
* Emitted when a liveboard has completed rendering,
|
|
448
454
|
* this event can be used as a hook to trigger events on the
|
|
449
455
|
* rendered liveboard
|
|
450
|
-
* @version 1.9.1
|
|
456
|
+
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
451
457
|
*/
|
|
452
458
|
LiveboardRendered = "PinboardRendered",
|
|
453
459
|
/**
|
|
454
460
|
* This can be used to register an event listener which
|
|
455
461
|
* is triggered on all events.
|
|
456
|
-
* @
|
|
462
|
+
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
457
463
|
*/
|
|
458
464
|
ALL = "*",
|
|
459
465
|
/**
|
|
460
466
|
* Emitted when answer is saved in the app
|
|
461
|
-
* @
|
|
467
|
+
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
462
468
|
*/
|
|
463
469
|
Save = "save",
|
|
464
470
|
/**
|
|
465
471
|
* Emitted when the download action is triggered on an answer
|
|
466
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
472
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
467
473
|
*/
|
|
468
474
|
Download = "download",
|
|
469
475
|
/**
|
|
470
476
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
471
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
477
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
472
478
|
*/
|
|
473
479
|
DownloadAsPdf = "downloadAsPdf",
|
|
474
480
|
/**
|
|
475
481
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
476
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
482
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
477
483
|
*/
|
|
478
484
|
DownloadAsCsv = "downloadAsCsv",
|
|
479
485
|
/**
|
|
480
486
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
481
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
487
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
482
488
|
*/
|
|
483
489
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
484
490
|
/**
|
|
485
491
|
* Emitted when an answer is deleted in the app
|
|
486
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
492
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
487
493
|
*/
|
|
488
494
|
AnswerDelete = "answerDelete",
|
|
489
495
|
/**
|
|
490
496
|
* Emitted when an answer is pinned to a Liveboard
|
|
491
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
497
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
492
498
|
*/
|
|
493
499
|
Pin = "pin",
|
|
494
500
|
/**
|
|
495
501
|
* Emitted when SpotIQ analysis is triggered
|
|
496
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
502
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
497
503
|
*/
|
|
498
504
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
499
505
|
/**
|
|
500
506
|
* Emitted when a user shares an object with another user or group
|
|
501
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
507
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
502
508
|
*/
|
|
503
509
|
Share = "share",
|
|
504
510
|
/**
|
|
505
511
|
* Emitted when a user clicks the Include action to include a specific value or data on a chart or table
|
|
506
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
512
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
507
513
|
*/
|
|
508
514
|
DrillInclude = "context-menu-item-include",
|
|
509
515
|
/**
|
|
510
516
|
* Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
|
|
511
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
517
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
512
518
|
*/
|
|
513
519
|
DrillExclude = "context-menu-item-exclude",
|
|
514
520
|
/**
|
|
515
521
|
* Emitted when copied column value on the app
|
|
516
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
522
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
517
523
|
*/
|
|
518
524
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
519
525
|
/**
|
|
520
526
|
* Emitted when a user clicks the Update TML action
|
|
521
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
527
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
522
528
|
*/
|
|
523
529
|
UpdateTML = "updateTSL",
|
|
524
530
|
/**
|
|
525
531
|
* Emitted when a user clicks the Edit TML action
|
|
526
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
532
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
527
533
|
*/
|
|
528
534
|
EditTML = "editTSL",
|
|
529
535
|
/**
|
|
530
536
|
* Emitted when ExportTML trigger in answer on the app
|
|
531
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
537
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
532
538
|
*/
|
|
533
539
|
ExportTML = "exportTSL",
|
|
534
540
|
/**
|
|
535
541
|
* Emitted when an answer is saved as a view
|
|
536
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
542
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
537
543
|
*/
|
|
538
544
|
SaveAsView = "saveAsView",
|
|
539
545
|
/**
|
|
540
546
|
* Emitted when copy of existing answer on the app
|
|
541
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
547
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
542
548
|
*/
|
|
543
549
|
CopyAEdit = "copyAEdit",
|
|
544
550
|
/**
|
|
545
551
|
* Emitted when a user clicks Show underlying data on an answe
|
|
546
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
552
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
547
553
|
*/
|
|
548
554
|
ShowUnderlyingData = "showUnderlyingData",
|
|
549
555
|
/**
|
|
550
556
|
* Emitted when an answer is switched to a chart or table view
|
|
551
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
557
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
552
558
|
*/
|
|
553
559
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
554
560
|
/**
|
|
555
|
-
*
|
|
561
|
+
* Internal event to communicate the initial settings back to the TS APP
|
|
562
|
+
* @hidden
|
|
556
563
|
*/
|
|
557
564
|
APP_INIT = "appInit",
|
|
558
565
|
/**
|
|
559
566
|
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
560
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
567
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
561
568
|
*/
|
|
562
569
|
LiveboardInfo = "pinboardInfo",
|
|
563
570
|
/**
|
|
564
571
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
565
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
572
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
566
573
|
*/
|
|
567
574
|
AddToFavorites = "addToFavorites",
|
|
568
575
|
/**
|
|
569
576
|
* Emitted when a user clicks Schedule on a Liveboard
|
|
570
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
577
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
571
578
|
*/
|
|
572
579
|
Schedule = "subscription",
|
|
573
580
|
/**
|
|
574
581
|
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
575
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
582
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
576
583
|
*/
|
|
577
584
|
Edit = "edit",
|
|
578
585
|
/**
|
|
579
586
|
* Emitted when a user clicks Make a copy on a Liveboard
|
|
580
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
587
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
581
588
|
*/
|
|
582
589
|
MakeACopy = "makeACopy",
|
|
583
590
|
/**
|
|
584
591
|
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
585
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
592
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
586
593
|
*/
|
|
587
594
|
Present = "present",
|
|
588
595
|
/**
|
|
589
596
|
* Emitted when a user clicks Delete on a Liveboard
|
|
590
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
597
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
591
598
|
*/
|
|
592
599
|
Delete = "delete",
|
|
593
600
|
/**
|
|
594
601
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
595
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
602
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
596
603
|
*/
|
|
597
604
|
SchedulesList = "schedule-list",
|
|
598
605
|
/**
|
|
599
606
|
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
600
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
607
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
601
608
|
*/
|
|
602
609
|
Cancel = "cancel",
|
|
603
610
|
/**
|
|
604
611
|
* Emitted when a user clicks Explore on a visualization
|
|
605
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
612
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
606
613
|
*/
|
|
607
614
|
Explore = "explore",
|
|
608
615
|
/**
|
|
609
616
|
* Emitted when a user clicks Copy link action on a visualization
|
|
610
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
617
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
611
618
|
*/
|
|
612
619
|
CopyLink = "embedDocument"
|
|
613
620
|
}
|
|
@@ -630,8 +637,8 @@ export declare enum HostEvent {
|
|
|
630
637
|
* @param points - an object containing selectedPoints/clickedPoints
|
|
631
638
|
* eg. { selectedPoints: []}
|
|
632
639
|
* @param columnGuid - a string guid of the column to drill by. This is optional,
|
|
633
|
-
* if not provided it will auto drill by the configured column.
|
|
634
|
-
* @version 1.5.0
|
|
640
|
+
* if not provided it will auto drill by the configured column.
|
|
641
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
635
642
|
*/
|
|
636
643
|
DrillDown = "triggerDrillDown",
|
|
637
644
|
/**
|
|
@@ -648,97 +655,97 @@ export declare enum HostEvent {
|
|
|
648
655
|
* Set the visible visualizations on a Liveboard.
|
|
649
656
|
* @param - an array of ids of visualizations to show, the ids not passed
|
|
650
657
|
* will be hidden.
|
|
651
|
-
* @version 1.6.0
|
|
658
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
652
659
|
*/
|
|
653
660
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
654
661
|
/**
|
|
655
662
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
656
663
|
* on to the existing runtime filters if they exist.
|
|
657
664
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
658
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
665
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
659
666
|
*/
|
|
660
667
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
661
668
|
/**
|
|
662
669
|
* Navigate to a specific page in App embed without any reload.
|
|
663
670
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
664
671
|
* @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
665
|
-
* @version SDK: 1.12.0 | ThoughtSpot
|
|
672
|
+
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
|
|
666
673
|
*/
|
|
667
674
|
Navigate = "Navigate",
|
|
668
675
|
/**
|
|
669
676
|
* Gets the current pinboard content.
|
|
670
|
-
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
|
|
677
|
+
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
671
678
|
*/
|
|
672
679
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
673
680
|
/**
|
|
674
681
|
* Triggers the Pin action on an embedded object
|
|
675
682
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
676
683
|
* can be left empty for search and visualization embeds
|
|
677
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
684
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
678
685
|
*/
|
|
679
686
|
Pin = "pin",
|
|
680
687
|
/**
|
|
681
688
|
* Triggers the Show Liveboard details action on a Liveboard
|
|
682
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
689
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
683
690
|
*/
|
|
684
691
|
LiveboardInfo = "pinboardInfo",
|
|
685
692
|
/**
|
|
686
693
|
* Triggers the Schedule action on a Liveboard
|
|
687
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
694
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
688
695
|
*/
|
|
689
696
|
Schedule = "subscription",
|
|
690
697
|
/**
|
|
691
698
|
* Triggers the Manage schedule action on a Liveboard
|
|
692
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
699
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
693
700
|
*/
|
|
694
701
|
SchedulesList = "schedule-list",
|
|
695
702
|
/**
|
|
696
703
|
* Triggers the Export TML action on a Liveboard
|
|
697
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
704
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
698
705
|
*/
|
|
699
706
|
ExportTML = "exportTSL",
|
|
700
707
|
/**
|
|
701
708
|
* Triggers the Edit TML action on a Liveboard
|
|
702
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
709
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
703
710
|
*/
|
|
704
711
|
EditTML = "editTSL",
|
|
705
712
|
/**
|
|
706
713
|
* Triggers the Update TML action on a Liveboard
|
|
707
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
714
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
708
715
|
*/
|
|
709
716
|
UpdateTML = "updateTSL",
|
|
710
717
|
/**
|
|
711
718
|
* Triggers the Download PDF action on a Liveboard
|
|
712
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
719
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
713
720
|
*/
|
|
714
721
|
DownloadAsPdf = "downloadAsPdf",
|
|
715
722
|
/**
|
|
716
723
|
* Triggers the Make a copy action on a Liveboard
|
|
717
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
724
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
718
725
|
*/
|
|
719
726
|
MakeACopy = "makeACopy",
|
|
720
727
|
/**
|
|
721
728
|
* Triggers the Delete action on a Liveboard
|
|
722
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
729
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
723
730
|
*/
|
|
724
731
|
Remove = "delete",
|
|
725
732
|
/**
|
|
726
733
|
* Triggers the Explore action on a visualization
|
|
727
734
|
* @param - an object with vizId as a key
|
|
728
735
|
* eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
|
|
729
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
736
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
730
737
|
*/
|
|
731
738
|
Explore = "explore",
|
|
732
739
|
/**
|
|
733
740
|
* Triggers the Create alert action on a visualization
|
|
734
741
|
* @param - an object with vizId as a key
|
|
735
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
742
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
736
743
|
*/
|
|
737
744
|
CreateMonitor = "createMonitor",
|
|
738
745
|
/**
|
|
739
746
|
* Triggers the Manage alert action on a visualization
|
|
740
747
|
* @param - an object with vizId as a key
|
|
741
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
748
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
742
749
|
*/
|
|
743
750
|
ManageMonitor = "manageMonitor",
|
|
744
751
|
/**
|
|
@@ -748,7 +755,7 @@ export declare enum HostEvent {
|
|
|
748
755
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
749
756
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
750
757
|
* vizEmbed.trigger((HostEvent.Edit)
|
|
751
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
758
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
752
759
|
*/
|
|
753
760
|
Edit = "edit",
|
|
754
761
|
/**
|
|
@@ -758,7 +765,7 @@ export declare enum HostEvent {
|
|
|
758
765
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
759
766
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
760
767
|
* vizEmbed.trigger((HostEvent.CopyLink)
|
|
761
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
768
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
762
769
|
*/
|
|
763
770
|
CopyLink = "embedDocument",
|
|
764
771
|
/**
|
|
@@ -768,7 +775,7 @@ export declare enum HostEvent {
|
|
|
768
775
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
769
776
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
770
777
|
* vizEmbed.trigger((HostEvent.Present)
|
|
771
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
|
|
778
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
772
779
|
*/
|
|
773
780
|
Present = "present"
|
|
774
781
|
}
|
|
@@ -948,27 +955,27 @@ export declare enum Action {
|
|
|
948
955
|
RequestAccess = "requestAccess",
|
|
949
956
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
950
957
|
/**
|
|
951
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
958
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
952
959
|
*/
|
|
953
960
|
AnswerDelete = "onDeleteAnswer",
|
|
954
961
|
/**
|
|
955
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
962
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
956
963
|
*/
|
|
957
964
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
958
965
|
/**
|
|
959
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
966
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
960
967
|
*/
|
|
961
968
|
AddToFavorites = "addToFavorites",
|
|
962
969
|
/**
|
|
963
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
|
|
970
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
964
971
|
*/
|
|
965
972
|
EditDetails = "editDetails",
|
|
966
973
|
/**
|
|
967
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
|
|
974
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
968
975
|
*/
|
|
969
976
|
CreateMonitor = "createMonitor",
|
|
970
977
|
/**
|
|
971
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl
|
|
978
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
972
979
|
*/
|
|
973
980
|
ReportError = "reportError"
|
|
974
981
|
}
|