@thoughtspot/visual-embed-sdk 1.28.5 → 1.29.0-addfilter.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/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +2 -2
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +1 -1
- package/cjs/src/authToken.js +1 -1
- package/cjs/src/embed/app.d.ts +58 -7
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +40 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +11 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +1 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +6 -6
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -1
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +8 -2
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/search.d.ts +56 -5
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +41 -5
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +11 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +14 -8
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +9 -18
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.spec.js +1 -13
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +58 -31
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +44 -20
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/answerService/answerService.d.ts +34 -0
- package/cjs/src/utils/answerService/answerService.d.ts.map +1 -0
- package/cjs/src/utils/answerService/answerService.js +142 -0
- package/cjs/src/utils/answerService/answerService.js.map +1 -0
- package/cjs/src/utils/answerService/answerService.spec.d.ts +1 -0
- package/cjs/src/utils/answerService/answerService.spec.d.ts.map +1 -0
- package/cjs/src/utils/answerService/answerService.spec.js +1 -0
- package/cjs/src/utils/answerService/answerService.spec.js.map +1 -0
- package/cjs/src/utils/answerService/graphql-queries.d.ts +6 -0
- package/cjs/src/utils/answerService/graphql-queries.d.ts.map +1 -0
- package/cjs/src/utils/answerService/graphql-queries.js +123 -0
- package/cjs/src/utils/answerService/graphql-queries.js.map +1 -0
- package/cjs/src/utils/answerService.d.ts +10 -0
- package/cjs/src/utils/answerService.d.ts.map +1 -0
- package/cjs/src/utils/answerService.js +61 -0
- package/cjs/src/utils/answerService.js.map +1 -0
- package/cjs/src/utils/answerService.spec.d.ts +2 -0
- package/cjs/src/utils/answerService.spec.d.ts.map +1 -0
- package/cjs/src/utils/answerService.spec.js +31 -0
- package/cjs/src/utils/answerService.spec.js.map +1 -0
- package/cjs/src/utils/authService.d.ts +37 -0
- package/cjs/src/utils/authService.d.ts.map +1 -0
- package/cjs/src/utils/authService.js +106 -0
- package/cjs/src/utils/authService.js.map +1 -0
- package/cjs/src/utils/authService.spec.d.ts +2 -0
- package/cjs/src/utils/authService.spec.d.ts.map +1 -0
- package/cjs/src/utils/authService.spec.js +72 -0
- package/cjs/src/utils/authService.spec.js.map +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +2 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +57 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +39 -2
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +70 -2
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +78 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/graphql-queries.d.ts +5 -0
- package/cjs/src/utils/graphql/answerService/graphql-queries.d.ts.map +1 -0
- package/cjs/src/utils/graphql/answerService/graphql-queries.js +80 -0
- package/cjs/src/utils/graphql/answerService/graphql-queries.js.map +1 -0
- package/cjs/src/utils/processData.js +1 -1
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +1 -1
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +2 -1
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +19 -2
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +1 -1
- package/dist/src/embed/app.d.ts +58 -7
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +8 -2
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +56 -5
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +58 -31
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/answerService.d.ts +10 -0
- package/dist/src/utils/answerService.d.ts.map +1 -0
- package/dist/src/utils/answerService.spec.d.ts +2 -0
- package/dist/src/utils/answerService.spec.d.ts.map +1 -0
- package/dist/src/utils/authService.d.ts +37 -0
- package/dist/src/utils/authService.d.ts.map +1 -0
- package/dist/src/utils/authService.spec.d.ts +2 -0
- package/dist/src/utils/authService.spec.d.ts.map +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +2 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +39 -2
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +2 -1
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +7164 -6922
- package/dist/tsembed-react.js +7204 -6962
- package/dist/tsembed.es.js +7427 -7185
- package/dist/tsembed.js +15698 -15456
- package/dist/visual-embed-sdk-react-full.d.ts +216 -44
- package/dist/visual-embed-sdk-react.d.ts +216 -44
- package/dist/visual-embed-sdk.d.ts +216 -44
- package/lib/package.json +1 -1
- package/lib/src/.index.d.ts.swp +0 -0
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +3 -3
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +1 -1
- package/lib/src/authToken.js +1 -1
- package/lib/src/embed/app.d.ts +58 -7
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +39 -3
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +12 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +5 -5
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +8 -2
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/search.d.ts +56 -5
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +41 -5
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +12 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +17 -11
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +9 -18
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.spec.js +1 -13
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +58 -31
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +44 -20
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/answerService/answerService.d.ts +34 -0
- package/lib/src/utils/answerService/answerService.d.ts.map +1 -0
- package/lib/src/utils/answerService/answerService.js +137 -0
- package/lib/src/utils/answerService/answerService.js.map +1 -0
- package/lib/src/utils/answerService/answerService.spec.d.ts +1 -0
- package/lib/src/utils/answerService/answerService.spec.d.ts.map +1 -0
- package/lib/src/utils/answerService/answerService.spec.js +1 -0
- package/lib/src/utils/answerService/answerService.spec.js.map +1 -0
- package/lib/src/utils/answerService/graphql-queries.d.ts +6 -0
- package/lib/src/utils/answerService/graphql-queries.d.ts.map +1 -0
- package/lib/src/utils/answerService/graphql-queries.js +120 -0
- package/lib/src/utils/answerService/graphql-queries.js.map +1 -0
- package/lib/src/utils/answerService.d.ts +10 -0
- package/lib/src/utils/answerService.d.ts.map +1 -0
- package/lib/src/utils/answerService.js +57 -0
- package/lib/src/utils/answerService.js.map +1 -0
- package/lib/src/utils/answerService.spec.d.ts +2 -0
- package/lib/src/utils/answerService.spec.d.ts.map +1 -0
- package/lib/src/utils/answerService.spec.js +29 -0
- package/lib/src/utils/answerService.spec.js.map +1 -0
- package/lib/src/utils/authService/authService.spec.js +1 -1
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/authService.d.ts +37 -0
- package/lib/src/utils/authService.d.ts.map +1 -0
- package/lib/src/utils/authService.js +97 -0
- package/lib/src/utils/authService.js.map +1 -0
- package/lib/src/utils/authService.spec.d.ts +2 -0
- package/lib/src/utils/authService.spec.d.ts.map +1 -0
- package/lib/src/utils/authService.spec.js +70 -0
- package/lib/src/utils/authService.spec.js.map +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +2 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +56 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +39 -2
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +71 -3
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +80 -2
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/graphql/answerService/graphql-queries.d.ts +5 -0
- package/lib/src/utils/graphql/answerService/graphql-queries.d.ts.map +1 -0
- package/lib/src/utils/graphql/answerService/graphql-queries.js +77 -0
- package/lib/src/utils/graphql/answerService/graphql-queries.js.map +1 -0
- package/lib/src/utils/processData.js +1 -1
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +1 -1
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils.d.ts +2 -1
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +17 -1
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +221 -49
- package/package.json +1 -1
- package/src/auth.ts +6 -6
- package/src/authToken.ts +1 -1
- package/src/embed/app.spec.ts +22 -1
- package/src/embed/app.ts +86 -9
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +14 -14
- package/src/embed/liveboard.ts +16 -3
- package/src/embed/search.spec.ts +20 -1
- package/src/embed/search.ts +85 -11
- package/src/embed/ts-embed.spec.ts +26 -34
- package/src/embed/ts-embed.ts +52 -41
- package/src/react/index.spec.tsx +1 -30
- package/src/types.ts +56 -30
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/graphql/answerService/answer-queries.ts +58 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +88 -2
- package/src/utils/graphql/answerService/answerService.ts +87 -4
- package/src/utils/processData.spec.ts +1 -1
- package/src/utils/processData.ts +1 -1
- package/src/utils.ts +21 -2
|
@@ -517,6 +517,24 @@ export interface SearchOptions {
|
|
|
517
517
|
*/
|
|
518
518
|
executeSearch?: boolean;
|
|
519
519
|
}
|
|
520
|
+
/**
|
|
521
|
+
* Define the initial state os column custom group accordions
|
|
522
|
+
* in data panel v2.
|
|
523
|
+
*/
|
|
524
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
525
|
+
/**
|
|
526
|
+
* Expand all the accordion initially in data panel v2.
|
|
527
|
+
*/
|
|
528
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
529
|
+
/**
|
|
530
|
+
* Collapse all the accordions initially in data panel v2.
|
|
531
|
+
*/
|
|
532
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
533
|
+
/**
|
|
534
|
+
* Expand the first accordion and collapse the rest.
|
|
535
|
+
*/
|
|
536
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
537
|
+
}
|
|
520
538
|
/**
|
|
521
539
|
* The configuration attributes for the embedded search view.
|
|
522
540
|
*
|
|
@@ -528,6 +546,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
528
546
|
* but can be expanded manually.
|
|
529
547
|
*
|
|
530
548
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
549
|
+
*
|
|
531
550
|
* @example
|
|
532
551
|
* ```js
|
|
533
552
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -541,6 +560,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
541
560
|
* Show or hide the data sources panel.
|
|
542
561
|
*
|
|
543
562
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
563
|
+
*
|
|
544
564
|
* @example
|
|
545
565
|
* ```js
|
|
546
566
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -556,6 +576,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
556
576
|
* using raw answer data.
|
|
557
577
|
*
|
|
558
578
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
579
|
+
*
|
|
559
580
|
* @example
|
|
560
581
|
* ```js
|
|
561
582
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -565,14 +586,11 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
565
586
|
* ```
|
|
566
587
|
*/
|
|
567
588
|
hideResults?: boolean;
|
|
568
|
-
/**
|
|
569
|
-
* If set to true, expands all the data sources panel.
|
|
570
|
-
*/
|
|
571
|
-
expandAllDataSource?: boolean;
|
|
572
589
|
/**
|
|
573
590
|
* If set to true, the Search Assist feature is enabled.
|
|
574
591
|
*
|
|
575
592
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
593
|
+
*
|
|
576
594
|
* @example
|
|
577
595
|
* ```js
|
|
578
596
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -587,6 +605,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
587
605
|
* format for presenting search data.
|
|
588
606
|
*
|
|
589
607
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
608
|
+
*
|
|
590
609
|
* @example
|
|
591
610
|
* ```js
|
|
592
611
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -600,6 +619,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
600
619
|
* Only a single data source is supported currently.
|
|
601
620
|
*
|
|
602
621
|
* @deprecated Use `dataSource` instead.
|
|
622
|
+
*
|
|
603
623
|
* @example
|
|
604
624
|
* ```js
|
|
605
625
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -613,6 +633,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
613
633
|
* The array of data source GUIDs to set on load.
|
|
614
634
|
*
|
|
615
635
|
* @version: SDK: 1.19.0
|
|
636
|
+
*
|
|
616
637
|
* @example
|
|
617
638
|
* ```js
|
|
618
639
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -654,6 +675,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
654
675
|
* The GUID of a saved answer to load initially.
|
|
655
676
|
*
|
|
656
677
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
678
|
+
*
|
|
657
679
|
* @example
|
|
658
680
|
* ```js
|
|
659
681
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -668,6 +690,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
668
690
|
* The chart/table should still be visible.
|
|
669
691
|
*
|
|
670
692
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
693
|
+
*
|
|
671
694
|
* @example
|
|
672
695
|
* ```js
|
|
673
696
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -682,6 +705,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
682
705
|
*
|
|
683
706
|
* @default false
|
|
684
707
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
708
|
+
*
|
|
685
709
|
* @example
|
|
686
710
|
* ```js
|
|
687
711
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -719,6 +743,33 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
719
743
|
* ```
|
|
720
744
|
*/
|
|
721
745
|
enableCustomColumnGroups?: boolean;
|
|
746
|
+
/**
|
|
747
|
+
* Flag to enable onBeforeSearchExecute Embed Event
|
|
748
|
+
*
|
|
749
|
+
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
750
|
+
*/
|
|
751
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
752
|
+
/**
|
|
753
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
754
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
755
|
+
* List of different enum values:-
|
|
756
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
757
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
758
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
759
|
+
*
|
|
760
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
761
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
762
|
+
*
|
|
763
|
+
* @example
|
|
764
|
+
* ```js
|
|
765
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
766
|
+
* ... // other options
|
|
767
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
768
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
769
|
+
* });
|
|
770
|
+
* ```
|
|
771
|
+
*/
|
|
772
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
722
773
|
}
|
|
723
774
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
724
775
|
/**
|
|
@@ -790,6 +841,24 @@ export declare enum Page {
|
|
|
790
841
|
*/
|
|
791
842
|
SpotIQ = "insights"
|
|
792
843
|
}
|
|
844
|
+
/**
|
|
845
|
+
* Define the initial state os column custom group accordions
|
|
846
|
+
* in data panel v2.
|
|
847
|
+
*/
|
|
848
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
849
|
+
/**
|
|
850
|
+
* Expand all the accordion initially in data panel v2.
|
|
851
|
+
*/
|
|
852
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
853
|
+
/**
|
|
854
|
+
* Collapse all the accordions initially in data panel v2.
|
|
855
|
+
*/
|
|
856
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
857
|
+
/**
|
|
858
|
+
* Expand the first accordion and collapse the rest.
|
|
859
|
+
*/
|
|
860
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
861
|
+
}
|
|
793
862
|
/**
|
|
794
863
|
* The view configuration for full app embedding.
|
|
795
864
|
*
|
|
@@ -803,6 +872,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
803
872
|
*
|
|
804
873
|
* @default true
|
|
805
874
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
875
|
+
*
|
|
806
876
|
* @example
|
|
807
877
|
* ```js
|
|
808
878
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -818,7 +888,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
818
888
|
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
819
889
|
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
820
890
|
*
|
|
821
|
-
*
|
|
822
891
|
* **Note**: This option does not apply to the classic homepage.
|
|
823
892
|
* To access the updated modular homepage, set
|
|
824
893
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -838,9 +907,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
838
907
|
/**
|
|
839
908
|
* Control the visibility of the help (?) and profile buttons on the
|
|
840
909
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
841
|
-
*
|
|
842
910
|
* @default false
|
|
843
911
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
912
|
+
*
|
|
844
913
|
* @example
|
|
845
914
|
* ```js
|
|
846
915
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -854,7 +923,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
854
923
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
855
924
|
* By default, the application switcher is shown.
|
|
856
925
|
*
|
|
857
|
-
*
|
|
858
926
|
* **Note**: This option does not apply to the classic homepage.
|
|
859
927
|
* To access the updated modular homepage, set
|
|
860
928
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -875,7 +943,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
875
943
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
876
944
|
* By default, the Org switcher button is shown.
|
|
877
945
|
*
|
|
878
|
-
*
|
|
879
946
|
* **Note**: This option does not apply to the classic homepage.
|
|
880
947
|
* To access the updated modular homepage, set
|
|
881
948
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -902,6 +969,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
902
969
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
903
970
|
*
|
|
904
971
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
972
|
+
*
|
|
905
973
|
* @example
|
|
906
974
|
* ```js
|
|
907
975
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -919,6 +987,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
919
987
|
* path within the app, use the `path` attribute which is more flexible.
|
|
920
988
|
*
|
|
921
989
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
990
|
+
*
|
|
922
991
|
* @example
|
|
923
992
|
* ```js
|
|
924
993
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -947,6 +1016,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
947
1016
|
* The array of GUIDs to be hidden
|
|
948
1017
|
*
|
|
949
1018
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1019
|
+
*
|
|
950
1020
|
* @example
|
|
951
1021
|
* ```js
|
|
952
1022
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -969,9 +1039,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
969
1039
|
liveboardV2?: boolean;
|
|
970
1040
|
/**
|
|
971
1041
|
* If set to true, the Search Assist feature is enabled.
|
|
972
|
-
*
|
|
973
1042
|
* @default true
|
|
1043
|
+
*
|
|
974
1044
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
1045
|
+
*
|
|
975
1046
|
* @example
|
|
976
1047
|
* ```js
|
|
977
1048
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -986,6 +1057,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
986
1057
|
* according to the height of the pages which support fullHeight mode.
|
|
987
1058
|
*
|
|
988
1059
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
1060
|
+
*
|
|
989
1061
|
* @example
|
|
990
1062
|
* ```js
|
|
991
1063
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1008,6 +1080,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1008
1080
|
*
|
|
1009
1081
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1010
1082
|
* @default false
|
|
1083
|
+
*
|
|
1011
1084
|
* @example
|
|
1012
1085
|
* ```js
|
|
1013
1086
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1022,6 +1095,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1022
1095
|
*
|
|
1023
1096
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1024
1097
|
* @default false
|
|
1098
|
+
*
|
|
1025
1099
|
* @example
|
|
1026
1100
|
* ```js
|
|
1027
1101
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1036,6 +1110,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1036
1110
|
*
|
|
1037
1111
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1038
1112
|
* @default false
|
|
1113
|
+
*
|
|
1039
1114
|
* @example
|
|
1040
1115
|
* ```js
|
|
1041
1116
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1088,7 +1163,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1088
1163
|
*/
|
|
1089
1164
|
collapseSearchBarInitially?: boolean;
|
|
1090
1165
|
/**
|
|
1091
|
-
* To enable custom column groups in data panel v2
|
|
1166
|
+
* To enable custom column groups in data panel v2.
|
|
1092
1167
|
*
|
|
1093
1168
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1094
1169
|
* @default false
|
|
@@ -1102,6 +1177,27 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1102
1177
|
* ```
|
|
1103
1178
|
*/
|
|
1104
1179
|
enableCustomColumnGroups?: boolean;
|
|
1180
|
+
/**
|
|
1181
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
1182
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
1183
|
+
* List of different enum values:-
|
|
1184
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1185
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1186
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1187
|
+
*
|
|
1188
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1189
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1190
|
+
*
|
|
1191
|
+
* @example
|
|
1192
|
+
* ```js
|
|
1193
|
+
* const embed = new AppEmbed('#embed', {
|
|
1194
|
+
* ... // other app view config
|
|
1195
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
1196
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
1197
|
+
* });
|
|
1198
|
+
* ```
|
|
1199
|
+
*/
|
|
1200
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1105
1201
|
/**
|
|
1106
1202
|
* This flag is used to enable the 2 column layout in liveboard
|
|
1107
1203
|
*
|
|
@@ -1118,6 +1214,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1118
1214
|
* ```
|
|
1119
1215
|
*/
|
|
1120
1216
|
enable2ColumnLayout?: boolean;
|
|
1217
|
+
/**
|
|
1218
|
+
* Flag to use OnBeforeSearchExecute embed event
|
|
1219
|
+
*
|
|
1220
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
1221
|
+
*/
|
|
1222
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1121
1223
|
}
|
|
1122
1224
|
/**
|
|
1123
1225
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -1194,6 +1296,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1194
1296
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1195
1297
|
*
|
|
1196
1298
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1299
|
+
*
|
|
1197
1300
|
* @example
|
|
1198
1301
|
* ```js
|
|
1199
1302
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1222,6 +1325,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1222
1325
|
defaultHeight?: number;
|
|
1223
1326
|
/**
|
|
1224
1327
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
1328
|
+
*
|
|
1225
1329
|
* @example
|
|
1226
1330
|
* ```js
|
|
1227
1331
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1229,6 +1333,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1229
1333
|
* enableVizTransformations:true,
|
|
1230
1334
|
* })
|
|
1231
1335
|
* ```
|
|
1336
|
+
*
|
|
1232
1337
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1233
1338
|
*/
|
|
1234
1339
|
enableVizTransformations?: boolean;
|
|
@@ -1255,6 +1360,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1255
1360
|
* The visualization within the Liveboard to display.
|
|
1256
1361
|
*
|
|
1257
1362
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1363
|
+
*
|
|
1258
1364
|
* @example
|
|
1259
1365
|
* ```js
|
|
1260
1366
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1284,6 +1390,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1284
1390
|
* event.
|
|
1285
1391
|
*
|
|
1286
1392
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1393
|
+
*
|
|
1287
1394
|
* @example
|
|
1288
1395
|
* ```js
|
|
1289
1396
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1333,6 +1440,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1333
1440
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1334
1441
|
*
|
|
1335
1442
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1443
|
+
*
|
|
1336
1444
|
* @example
|
|
1337
1445
|
* ```js
|
|
1338
1446
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1358,9 +1466,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1358
1466
|
hideLiveboardHeader?: boolean;
|
|
1359
1467
|
/**
|
|
1360
1468
|
* Show or hide the Liveboard title.
|
|
1361
|
-
*
|
|
1362
1469
|
* @default false
|
|
1363
1470
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1471
|
+
*
|
|
1364
1472
|
* @example
|
|
1365
1473
|
* ```js
|
|
1366
1474
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1372,9 +1480,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1372
1480
|
showLiveboardTitle?: boolean;
|
|
1373
1481
|
/**
|
|
1374
1482
|
* Show or hide the Liveboard description.
|
|
1375
|
-
*
|
|
1376
1483
|
* @default false
|
|
1377
1484
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1485
|
+
*
|
|
1378
1486
|
* @example
|
|
1379
1487
|
* ```js
|
|
1380
1488
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1964,7 +2072,6 @@ export declare enum AuthType {
|
|
|
1964
2072
|
* .then((data) => data.token);
|
|
1965
2073
|
* }
|
|
1966
2074
|
* });
|
|
1967
|
-
* });
|
|
1968
2075
|
* ```
|
|
1969
2076
|
*/
|
|
1970
2077
|
TrustedAuthToken = "AuthServer",
|
|
@@ -2465,6 +2572,7 @@ export interface ViewConfig {
|
|
|
2465
2572
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2466
2573
|
*
|
|
2467
2574
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2575
|
+
*
|
|
2468
2576
|
* @example
|
|
2469
2577
|
* ```js
|
|
2470
2578
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2503,7 +2611,6 @@ export interface ViewConfig {
|
|
|
2503
2611
|
disabledActions?: Action[];
|
|
2504
2612
|
/**
|
|
2505
2613
|
* The tooltip to display for disabled actions.
|
|
2506
|
-
*
|
|
2507
2614
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2508
2615
|
* @example
|
|
2509
2616
|
* ```js
|
|
@@ -2521,6 +2628,7 @@ export interface ViewConfig {
|
|
|
2521
2628
|
* Use this to hide an action.
|
|
2522
2629
|
*
|
|
2523
2630
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2631
|
+
*
|
|
2524
2632
|
* @example
|
|
2525
2633
|
* ```js
|
|
2526
2634
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2541,6 +2649,7 @@ export interface ViewConfig {
|
|
|
2541
2649
|
*
|
|
2542
2650
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2543
2651
|
* @important
|
|
2652
|
+
*
|
|
2544
2653
|
* @example
|
|
2545
2654
|
* ```js
|
|
2546
2655
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2554,6 +2663,7 @@ export interface ViewConfig {
|
|
|
2554
2663
|
* Show alert messages and toast messages in the embedded view.
|
|
2555
2664
|
*
|
|
2556
2665
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2666
|
+
*
|
|
2557
2667
|
* @example
|
|
2558
2668
|
* ```js
|
|
2559
2669
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2568,6 +2678,7 @@ export interface ViewConfig {
|
|
|
2568
2678
|
* visualization, or Liveboard.
|
|
2569
2679
|
*
|
|
2570
2680
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2681
|
+
*
|
|
2571
2682
|
* @example
|
|
2572
2683
|
* ```js
|
|
2573
2684
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2588,6 +2699,7 @@ export interface ViewConfig {
|
|
|
2588
2699
|
* visualization, or Liveboard.
|
|
2589
2700
|
*
|
|
2590
2701
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2702
|
+
*
|
|
2591
2703
|
* @example
|
|
2592
2704
|
* ```js
|
|
2593
2705
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2622,7 +2734,6 @@ export interface ViewConfig {
|
|
|
2622
2734
|
* Warning: This option is for advanced use only and is used internally
|
|
2623
2735
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
2624
2736
|
* list of supported keys and values associated with each.
|
|
2625
|
-
*
|
|
2626
2737
|
* @example
|
|
2627
2738
|
* ```js
|
|
2628
2739
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2651,6 +2762,7 @@ export interface ViewConfig {
|
|
|
2651
2762
|
* child inside it.
|
|
2652
2763
|
*
|
|
2653
2764
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2765
|
+
*
|
|
2654
2766
|
* @example
|
|
2655
2767
|
* ```js
|
|
2656
2768
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2736,8 +2848,6 @@ export interface ViewConfig {
|
|
|
2736
2848
|
* Hide the home page modules
|
|
2737
2849
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
2738
2850
|
*
|
|
2739
|
-
*
|
|
2740
|
-
*
|
|
2741
2851
|
* **Note**: This option does not apply to the classic homepage.
|
|
2742
2852
|
* To access the updated modular homepage, set
|
|
2743
2853
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -2750,13 +2860,13 @@ export interface ViewConfig {
|
|
|
2750
2860
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2751
2861
|
* })
|
|
2752
2862
|
* ```
|
|
2863
|
+
*
|
|
2753
2864
|
*/
|
|
2754
2865
|
hiddenHomepageModules?: HomepageModule[];
|
|
2755
2866
|
/**
|
|
2756
2867
|
* reordering the home page modules
|
|
2757
2868
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
2758
2869
|
*
|
|
2759
|
-
*
|
|
2760
2870
|
* **Note**: This option does not apply to the classic homepage.
|
|
2761
2871
|
* To access the updated modular homepage, set
|
|
2762
2872
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -2779,6 +2889,7 @@ export interface ViewConfig {
|
|
|
2779
2889
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2780
2890
|
*
|
|
2781
2891
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2892
|
+
*
|
|
2782
2893
|
* @example
|
|
2783
2894
|
* ```js
|
|
2784
2895
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2804,8 +2915,6 @@ export interface ViewConfig {
|
|
|
2804
2915
|
* })
|
|
2805
2916
|
* ```
|
|
2806
2917
|
*
|
|
2807
|
-
*
|
|
2808
|
-
*
|
|
2809
2918
|
* **Note**: This option does not apply to the classic homepage.
|
|
2810
2919
|
* To access the updated modular homepage, set
|
|
2811
2920
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -2838,6 +2947,7 @@ export interface ViewConfig {
|
|
|
2838
2947
|
* @type {boolean}
|
|
2839
2948
|
* @default false
|
|
2840
2949
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2950
|
+
*
|
|
2841
2951
|
* @example
|
|
2842
2952
|
* ```js
|
|
2843
2953
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -3019,7 +3129,7 @@ export interface RuntimeFilter {
|
|
|
3019
3129
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
3020
3130
|
* operands.
|
|
3021
3131
|
*/
|
|
3022
|
-
values: (number | boolean | string)[];
|
|
3132
|
+
values: (number | boolean | string | bigint)[];
|
|
3023
3133
|
}
|
|
3024
3134
|
/**
|
|
3025
3135
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -3252,19 +3362,14 @@ export declare enum EmbedEvent {
|
|
|
3252
3362
|
/**
|
|
3253
3363
|
* An error has occurred. This event is fired for the following error types:
|
|
3254
3364
|
*
|
|
3255
|
-
*
|
|
3256
|
-
*
|
|
3257
|
-
*
|
|
3258
|
-
*
|
|
3259
|
-
*
|
|
3365
|
+
* `API` - API call failure error.
|
|
3366
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
|
|
3367
|
+
* `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
|
|
3368
|
+
* `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
3369
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
3370
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
3260
3371
|
*
|
|
3261
|
-
*
|
|
3262
|
-
*
|
|
3263
|
-
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
3264
|
-
*
|
|
3265
|
-
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
3266
|
-
*
|
|
3267
|
-
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
3372
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
3268
3373
|
*
|
|
3269
3374
|
* @returns error - An error object or message
|
|
3270
3375
|
*
|
|
@@ -3378,7 +3483,7 @@ export declare enum EmbedEvent {
|
|
|
3378
3483
|
/**
|
|
3379
3484
|
* Emitted when the embed does not have cookie access. This happens
|
|
3380
3485
|
* when Safari and other Web browsers block third-party cookies
|
|
3381
|
-
* are blocked by default.
|
|
3486
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
3382
3487
|
*
|
|
3383
3488
|
* @example
|
|
3384
3489
|
*```js
|
|
@@ -3421,7 +3526,7 @@ export declare enum EmbedEvent {
|
|
|
3421
3526
|
/**
|
|
3422
3527
|
* Emitted when the Liveboard shell loads.
|
|
3423
3528
|
* You can use this event as a hook to trigger
|
|
3424
|
-
*
|
|
3529
|
+
* other events on the rendered Liveboard.
|
|
3425
3530
|
*
|
|
3426
3531
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3427
3532
|
* @example
|
|
@@ -3475,7 +3580,7 @@ export declare enum EmbedEvent {
|
|
|
3475
3580
|
/**
|
|
3476
3581
|
* Emitted when the download action is triggered on an answer
|
|
3477
3582
|
*
|
|
3478
|
-
*
|
|
3583
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
3479
3584
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3480
3585
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3481
3586
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
@@ -3558,7 +3663,7 @@ export declare enum EmbedEvent {
|
|
|
3558
3663
|
* //emit when action starts
|
|
3559
3664
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3560
3665
|
* console.log('delete answer', payload)}, {start: true })
|
|
3561
|
-
* //
|
|
3666
|
+
* //trigger when action is completed
|
|
3562
3667
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3563
3668
|
* console.log('delete answer', payload)})
|
|
3564
3669
|
*```
|
|
@@ -3890,7 +3995,7 @@ export declare enum EmbedEvent {
|
|
|
3890
3995
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3891
3996
|
* @example
|
|
3892
3997
|
*```js
|
|
3893
|
-
* liveboardEmbed.
|
|
3998
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
3894
3999
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3895
4000
|
*```
|
|
3896
4001
|
*/
|
|
@@ -3918,14 +4023,14 @@ export declare enum EmbedEvent {
|
|
|
3918
4023
|
* Returns filter type and name, column name and ID, and runtime
|
|
3919
4024
|
* filter details.
|
|
3920
4025
|
*
|
|
3921
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3922
4026
|
* @example
|
|
3923
4027
|
*
|
|
3924
4028
|
*```js
|
|
3925
4029
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3926
4030
|
* console.log('payload', payload);
|
|
3927
4031
|
* })
|
|
3928
|
-
|
|
4032
|
+
*
|
|
4033
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3929
4034
|
*/
|
|
3930
4035
|
FilterChanged = "filterChanged",
|
|
3931
4036
|
/**
|
|
@@ -4012,7 +4117,25 @@ export declare enum EmbedEvent {
|
|
|
4012
4117
|
*
|
|
4013
4118
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
4014
4119
|
*/
|
|
4015
|
-
Rename = "rename"
|
|
4120
|
+
Rename = "rename",
|
|
4121
|
+
/**
|
|
4122
|
+
* Emitted when user wants to intercept the search execution
|
|
4123
|
+
*
|
|
4124
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
4125
|
+
* event
|
|
4126
|
+
*
|
|
4127
|
+
*```js
|
|
4128
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
4129
|
+
* responder({
|
|
4130
|
+
* data: {
|
|
4131
|
+
* execute: true,
|
|
4132
|
+
* error: {errorText: "My own customised error"}
|
|
4133
|
+
* }})
|
|
4134
|
+
* })
|
|
4135
|
+
*```
|
|
4136
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
4137
|
+
*/
|
|
4138
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept"
|
|
4016
4139
|
}
|
|
4017
4140
|
/**
|
|
4018
4141
|
* Event types that can be triggered by the host application
|
|
@@ -4815,7 +4938,17 @@ export declare enum HostEvent {
|
|
|
4815
4938
|
* ```
|
|
4816
4939
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4817
4940
|
*/
|
|
4818
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
4941
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4942
|
+
/**
|
|
4943
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4944
|
+
*
|
|
4945
|
+
* @example
|
|
4946
|
+
* ```js
|
|
4947
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
4948
|
+
*
|
|
4949
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4950
|
+
*/
|
|
4951
|
+
CreateLiveboard = "CreateLiveboard"
|
|
4819
4952
|
}
|
|
4820
4953
|
/**
|
|
4821
4954
|
* The different visual modes that the data sources panel within
|
|
@@ -4913,12 +5046,14 @@ export declare enum Param {
|
|
|
4913
5046
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
4914
5047
|
enableAskSage = "enableAskSage",
|
|
4915
5048
|
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
5049
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
4916
5050
|
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
4917
5051
|
DateFormatLocale = "dateFormatLocale",
|
|
4918
5052
|
NumberFormatLocale = "numberFormatLocale",
|
|
4919
5053
|
CurrencyFormat = "currencyFormat",
|
|
4920
5054
|
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4921
|
-
IsFullAppEmbed = "isFullAppEmbed"
|
|
5055
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
5056
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4922
5057
|
}
|
|
4923
5058
|
/**
|
|
4924
5059
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -6415,6 +6550,16 @@ export interface UnderlyingDataPoint {
|
|
|
6415
6550
|
* const data = await underlying.fetchData(0, 100);
|
|
6416
6551
|
* })
|
|
6417
6552
|
* ```
|
|
6553
|
+
* @example
|
|
6554
|
+
* ```js
|
|
6555
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6556
|
+
* const service = await embed.getAnswerService();
|
|
6557
|
+
* await service.addColumns([
|
|
6558
|
+
* "<column guid>"
|
|
6559
|
+
* ]);
|
|
6560
|
+
* console.log(await service.fetchData());
|
|
6561
|
+
* });
|
|
6562
|
+
* ```
|
|
6418
6563
|
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
6419
6564
|
* @group Events
|
|
6420
6565
|
*/
|
|
@@ -6447,6 +6592,32 @@ export declare class AnswerService {
|
|
|
6447
6592
|
* @returns
|
|
6448
6593
|
*/
|
|
6449
6594
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6595
|
+
/**
|
|
6596
|
+
* Add columns by names and return updated answer session.
|
|
6597
|
+
*
|
|
6598
|
+
* @param columnNames
|
|
6599
|
+
* @returns
|
|
6600
|
+
* @example
|
|
6601
|
+
* ```js
|
|
6602
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6603
|
+
* const service = await embed.getAnswerService();
|
|
6604
|
+
* await service.addColumnsByNames([
|
|
6605
|
+
* "col name 1",
|
|
6606
|
+
* "col name 2"
|
|
6607
|
+
* ]);
|
|
6608
|
+
* console.log(await service.fetchData());
|
|
6609
|
+
* });
|
|
6610
|
+
*/
|
|
6611
|
+
addColumnsByNames(columnNames: string[]): Promise<any>;
|
|
6612
|
+
/**
|
|
6613
|
+
* Add a filter to the answer.
|
|
6614
|
+
*
|
|
6615
|
+
* @param columnName
|
|
6616
|
+
* @param operator
|
|
6617
|
+
* @param values
|
|
6618
|
+
* @returns
|
|
6619
|
+
*/
|
|
6620
|
+
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6450
6621
|
/**
|
|
6451
6622
|
* Fetch data from the answer.
|
|
6452
6623
|
*
|
|
@@ -6509,6 +6680,7 @@ export declare class AnswerService {
|
|
|
6509
6680
|
* @returns
|
|
6510
6681
|
*/
|
|
6511
6682
|
getSession(): SessionInterface;
|
|
6683
|
+
getAnswer(): Promise<any>;
|
|
6512
6684
|
}
|
|
6513
6685
|
|
|
6514
6686
|
/**
|
|
@@ -6579,7 +6751,7 @@ export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promi
|
|
|
6579
6751
|
* ```js
|
|
6580
6752
|
* resetCachedAuthToken();
|
|
6581
6753
|
* ```
|
|
6582
|
-
* @version SDK: 1.28.
|
|
6754
|
+
* @version SDK: 1.28.0 | ThoughtSpot: *
|
|
6583
6755
|
* @group Authentication / Init
|
|
6584
6756
|
*/
|
|
6585
6757
|
export declare const resetCachedAuthToken: () => void;
|