@thoughtspot/visual-embed-sdk 1.38.0-alpha.1 → 1.38.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/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +96 -156
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +6 -3
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +10 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.d.ts +4 -4
- package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/cjs/src/embed/bodyless-conversation.js +1 -1
- package/cjs/src/embed/bodyless-conversation.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +22 -11
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +1 -1
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +110 -167
- 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 +11 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +17 -2
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +2 -0
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +16 -6
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +46 -14
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +19 -2
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +49 -0
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +45 -4
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +2 -1
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -1
- package/cjs/src/react/util.d.ts +7 -4
- package/cjs/src/react/util.d.ts.map +1 -1
- package/cjs/src/react/util.js.map +1 -1
- package/cjs/src/types.d.ts +482 -251
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +31 -14
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +2 -1
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/processData.d.ts.map +1 -1
- package/cjs/src/utils/processData.js +15 -0
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +15 -0
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +14 -0
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils/processTrigger.spec.js +54 -0
- package/cjs/src/utils/processTrigger.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +11 -2
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +70 -1
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +85 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-DeFzsyFF.js → index-BKIWUvTr.js} +1 -1
- package/dist/src/embed/app.d.ts +96 -156
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/bodyless-conversation.d.ts +4 -4
- package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +22 -11
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +110 -167
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +17 -2
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +16 -6
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +46 -14
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +19 -2
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/react/util.d.ts +7 -4
- package/dist/src/react/util.d.ts.map +1 -1
- package/dist/src/types.d.ts +482 -251
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/processData.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +11 -2
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +3477 -3311
- package/dist/tsembed-react.js +3476 -3310
- package/dist/tsembed.es.js +192 -26
- package/dist/tsembed.js +195 -29
- package/dist/visual-embed-sdk-react-full.d.ts +845 -655
- package/dist/visual-embed-sdk-react.d.ts +845 -655
- package/dist/visual-embed-sdk.d.ts +827 -640
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +96 -156
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +6 -3
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +10 -0
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.d.ts +4 -4
- package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/lib/src/embed/bodyless-conversation.js +1 -1
- package/lib/src/embed/bodyless-conversation.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +22 -11
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +1 -1
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +110 -167
- 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 +11 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +17 -2
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +2 -0
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +16 -6
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +46 -14
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +19 -2
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +49 -0
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +45 -4
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +1 -1
- package/lib/src/react/util.d.ts +7 -4
- package/lib/src/react/util.d.ts.map +1 -1
- package/lib/src/react/util.js.map +1 -1
- package/lib/src/types.d.ts +482 -251
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +31 -14
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +2 -1
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/processData.d.ts.map +1 -1
- package/lib/src/utils/processData.js +15 -0
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +15 -0
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +14 -0
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js +54 -0
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/lib/src/utils.d.ts +11 -2
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +67 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +86 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +836 -649
- package/package.json +1 -1
- package/src/embed/app.spec.ts +14 -0
- package/src/embed/app.ts +97 -152
- package/src/embed/bodyless-conversation.ts +4 -4
- package/src/embed/conversation.ts +23 -12
- package/src/embed/liveboard.spec.ts +15 -0
- package/src/embed/liveboard.ts +117 -172
- package/src/embed/sage.ts +17 -5
- package/src/embed/search-bar.tsx +16 -17
- package/src/embed/search.ts +47 -21
- package/src/embed/ts-embed.spec.ts +52 -4
- package/src/embed/ts-embed.ts +61 -6
- package/src/index.ts +2 -0
- package/src/react/all-types-export.ts +1 -0
- package/src/react/index.tsx +3 -3
- package/src/react/util.ts +6 -4
- package/src/types.ts +488 -253
- package/src/utils/graphql/answerService/answerService.ts +5 -4
- package/src/utils/processData.spec.ts +28 -0
- package/src/utils/processData.ts +17 -0
- package/src/utils/processTrigger.spec.ts +90 -0
- package/src/utils/processTrigger.ts +16 -1
- package/src/utils.spec.ts +113 -0
- package/src/utils.ts +78 -2
- package/dist/index-NZYq1Tu3.js +0 -7370
|
@@ -217,7 +217,7 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
|
|
|
217
217
|
export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & React.RefAttributes<_SpotterEmbed>>;
|
|
218
218
|
/**
|
|
219
219
|
* React component for LLM based conversation BI.
|
|
220
|
-
* @deprecated from SDK: 1.
|
|
220
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
221
221
|
* Use {@link SpotterEmbed} instead
|
|
222
222
|
* @example
|
|
223
223
|
* ```tsx
|
|
@@ -495,16 +495,18 @@ export declare const isAuthenticated: () => boolean;
|
|
|
495
495
|
/**
|
|
496
496
|
* @group Embed components
|
|
497
497
|
*/
|
|
498
|
-
export interface SearchBarViewConfig extends
|
|
498
|
+
export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig {
|
|
499
499
|
/**
|
|
500
500
|
* The array of data source GUIDs to set on load.
|
|
501
501
|
* Only a single data source is supported currently.
|
|
502
|
+
*
|
|
503
|
+
* Supported embed types: `SearchBarEmbed`
|
|
502
504
|
* @deprecated Use `dataSource` instead
|
|
503
505
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
504
506
|
* @example
|
|
505
507
|
* ```js
|
|
506
508
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
507
|
-
* ... //
|
|
509
|
+
* ... //other embed view config
|
|
508
510
|
* dataSources:['id-2345','id-2345'],
|
|
509
511
|
* })
|
|
510
512
|
* ```
|
|
@@ -512,11 +514,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
512
514
|
dataSources?: string[];
|
|
513
515
|
/**
|
|
514
516
|
* Pass the ID of the source to be selected.
|
|
517
|
+
*
|
|
518
|
+
* Supported embed types: `SearchBarEmbed`
|
|
515
519
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
516
520
|
* @example
|
|
517
521
|
* ```js
|
|
518
522
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
519
|
-
* ... //
|
|
523
|
+
* ... //other embed view config
|
|
520
524
|
* dataSource:'id-2345',
|
|
521
525
|
* })
|
|
522
526
|
* ```
|
|
@@ -524,11 +528,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
524
528
|
dataSource?: string;
|
|
525
529
|
/**
|
|
526
530
|
* Boolean to define if the last selected data source should be used
|
|
531
|
+
*
|
|
532
|
+
* Supported embed types: `SearchBarEmbed`
|
|
527
533
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
528
534
|
* @example
|
|
529
535
|
* ```js
|
|
530
536
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
531
|
-
* ... //
|
|
537
|
+
* ... //other embed view config
|
|
532
538
|
* useLastSelectedSources:false,
|
|
533
539
|
* })
|
|
534
540
|
* ```
|
|
@@ -544,11 +550,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
544
550
|
* If it is executed, the focus is placed on the results.
|
|
545
551
|
* If it’s not executed, the focus is placed at the end of
|
|
546
552
|
* the token string in the search bar.
|
|
553
|
+
*
|
|
554
|
+
* Supported embed types: `SearchBarEmbed`
|
|
547
555
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
548
556
|
* @example
|
|
549
557
|
* ```js
|
|
550
558
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
551
|
-
* ... //
|
|
559
|
+
* ... //other embed view config
|
|
552
560
|
* searchOptions: {
|
|
553
561
|
* searchTokenString: '[quantity purchased] [region]',
|
|
554
562
|
* executeSearch: true,
|
|
@@ -560,6 +568,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
560
568
|
/**
|
|
561
569
|
* Exclude the search token string from the URL.
|
|
562
570
|
* If set to true, the search token string is not appended to the URL.
|
|
571
|
+
*
|
|
572
|
+
* Supported embed types: `SearchBarEmbed`
|
|
563
573
|
* @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
564
574
|
* @example
|
|
565
575
|
* ```js
|
|
@@ -626,9 +636,11 @@ export interface SearchOptions {
|
|
|
626
636
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
627
637
|
* GPT and LLM.
|
|
628
638
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
639
|
+
*
|
|
640
|
+
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
629
641
|
* @group Embed components
|
|
630
642
|
*/
|
|
631
|
-
export interface SageViewConfig extends Omit<
|
|
643
|
+
export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction' | 'runtimeFilters' | 'runtimeParameters' | 'excludeRuntimeFiltersfromURL' | 'excludeRuntimeParametersfromURL'> {
|
|
632
644
|
/**
|
|
633
645
|
* If set to true, a list of Liveboard and Answers related
|
|
634
646
|
* to the natural language search will be shown below the
|
|
@@ -686,7 +698,16 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
686
698
|
* Show or hide sample questions.
|
|
687
699
|
* The sample questions are autogenerated based on the worksheet
|
|
688
700
|
* selected for the search operation.
|
|
701
|
+
*
|
|
702
|
+
* Supported embed types: `SageEmbed`
|
|
689
703
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
704
|
+
* @example
|
|
705
|
+
* ```js
|
|
706
|
+
* const embed = new SageEmbed('#tsEmbed', {
|
|
707
|
+
* ... //other embed view config
|
|
708
|
+
* hideSampleQuestions : true,
|
|
709
|
+
* })
|
|
710
|
+
* ```
|
|
690
711
|
*/
|
|
691
712
|
hideSampleQuestions?: boolean;
|
|
692
713
|
/**
|
|
@@ -703,6 +724,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
703
724
|
* If it is executed, the focus is placed on the results.
|
|
704
725
|
* If it’s not executed, the focus is placed at the end of
|
|
705
726
|
* the token string in the search bar.
|
|
727
|
+
*
|
|
728
|
+
* Supported embed types: `SageEmbed`
|
|
706
729
|
* @example
|
|
707
730
|
* ```js
|
|
708
731
|
* searchOptions: {
|
|
@@ -717,6 +740,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
717
740
|
/**
|
|
718
741
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
719
742
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
743
|
+
*
|
|
744
|
+
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
720
745
|
* @group Embed components
|
|
721
746
|
*/
|
|
722
747
|
export declare class SageEmbed extends V1Embed {
|
|
@@ -791,15 +816,17 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
791
816
|
* The configuration attributes for the embedded search view.
|
|
792
817
|
* @group Embed components
|
|
793
818
|
*/
|
|
794
|
-
export interface SearchViewConfig extends Omit<
|
|
819
|
+
export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction'> {
|
|
795
820
|
/**
|
|
796
821
|
* If set to true, the data sources panel is collapsed on load,
|
|
797
822
|
* but can be expanded manually.
|
|
823
|
+
*
|
|
824
|
+
* Supported embed types: `SearchEmbed`
|
|
798
825
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
799
826
|
* @example
|
|
800
827
|
* ```js
|
|
801
828
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
802
|
-
* ... // other
|
|
829
|
+
* ... // other embed view config
|
|
803
830
|
* collapseDataSources:true,
|
|
804
831
|
* })
|
|
805
832
|
* ```
|
|
@@ -808,11 +835,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
808
835
|
/**
|
|
809
836
|
* If set to true, the data panel is collapsed on load,
|
|
810
837
|
* but can be expanded manually.
|
|
838
|
+
*
|
|
839
|
+
* Supported embed types: `SearchEmbed`
|
|
811
840
|
* @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
812
841
|
* @example
|
|
813
842
|
* ```js
|
|
814
843
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
815
|
-
* ... // other
|
|
844
|
+
* ... // other embed view config
|
|
816
845
|
* collapseDataPanel:true,
|
|
817
846
|
* })
|
|
818
847
|
* ```
|
|
@@ -820,11 +849,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
820
849
|
collapseDataPanel?: boolean;
|
|
821
850
|
/**
|
|
822
851
|
* Show or hide the data sources panel.
|
|
852
|
+
*
|
|
853
|
+
* Supported embed types: `SearchEmbed`
|
|
823
854
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
824
855
|
* @example
|
|
825
856
|
* ```js
|
|
826
857
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
827
|
-
* ... // other
|
|
858
|
+
* ... // other embed view config
|
|
828
859
|
* hideDataSources:true,
|
|
829
860
|
* })
|
|
830
861
|
* ```
|
|
@@ -834,11 +865,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
834
865
|
* Show or hide the charts and tables in search answers.
|
|
835
866
|
* This attribute can be used to create a custom visualization
|
|
836
867
|
* using raw answer data.
|
|
868
|
+
*
|
|
869
|
+
* Supported embed types: `SearchEmbed`
|
|
837
870
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
838
871
|
* @example
|
|
839
872
|
* ```js
|
|
840
873
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
841
|
-
* ... // other
|
|
874
|
+
* ... // other embed view config
|
|
842
875
|
* hideResults:true,
|
|
843
876
|
* })
|
|
844
877
|
* ```
|
|
@@ -846,11 +879,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
846
879
|
hideResults?: boolean;
|
|
847
880
|
/**
|
|
848
881
|
* If set to true, the Search Assist feature is enabled.
|
|
882
|
+
*
|
|
883
|
+
* Supported embed types: `SearchEmbed`
|
|
849
884
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
850
885
|
* @example
|
|
851
886
|
* ```js
|
|
852
887
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
853
|
-
* ... // other
|
|
888
|
+
* ... // other embed view config
|
|
854
889
|
* enableSearchAssist:true,
|
|
855
890
|
* })
|
|
856
891
|
* ```
|
|
@@ -859,11 +894,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
859
894
|
/**
|
|
860
895
|
* If set to true, the tabular view is set as the default
|
|
861
896
|
* format for presenting search data.
|
|
897
|
+
*
|
|
898
|
+
* Supported embed types: `SearchEmbed`
|
|
862
899
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
863
900
|
* @example
|
|
864
901
|
* ```js
|
|
865
902
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
866
|
-
* ... // other
|
|
903
|
+
* ... // other embed view config
|
|
867
904
|
* forceTable:true,
|
|
868
905
|
* })
|
|
869
906
|
*/
|
|
@@ -872,10 +909,12 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
872
909
|
* The array of data source GUIDs to set on load.
|
|
873
910
|
* Only a single data source is supported currently.
|
|
874
911
|
* @deprecated Use `dataSource` instead.
|
|
912
|
+
*
|
|
913
|
+
* Supported embed types: `SearchEmbed`
|
|
875
914
|
* @example
|
|
876
915
|
* ```js
|
|
877
916
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
878
|
-
* ... // other
|
|
917
|
+
* ... // other embed view config
|
|
879
918
|
* dataSources:['id-234','id-456'],
|
|
880
919
|
* })
|
|
881
920
|
* ```
|
|
@@ -883,11 +922,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
883
922
|
dataSources?: string[];
|
|
884
923
|
/**
|
|
885
924
|
* The array of data source GUIDs to set on load.
|
|
925
|
+
*
|
|
926
|
+
* Supported embed types: `SearchEmbed`
|
|
886
927
|
* @version: SDK: 1.19.0
|
|
887
928
|
* @example
|
|
888
929
|
* ```js
|
|
889
930
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
890
|
-
* ... // other
|
|
931
|
+
* ... // other embed view config
|
|
891
932
|
* dataSource:'id-234',
|
|
892
933
|
* })
|
|
893
934
|
* ```
|
|
@@ -910,6 +951,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
910
951
|
* If it is executed, the focus is placed on the results.
|
|
911
952
|
* If it’s not executed, the focus is placed at the end of
|
|
912
953
|
* the token string in the search bar.
|
|
954
|
+
*
|
|
955
|
+
* Supported embed types: `SearchEmbed`
|
|
913
956
|
* @example
|
|
914
957
|
* ```js
|
|
915
958
|
* searchOptions: {
|
|
@@ -922,6 +965,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
922
965
|
/**
|
|
923
966
|
* Exclude the search token string from the URL.
|
|
924
967
|
* If set to true, the search token string is not appended to the URL.
|
|
968
|
+
*
|
|
969
|
+
* Supported embed types: `SearchEmbed`
|
|
925
970
|
* @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
926
971
|
* @example
|
|
927
972
|
* ```js
|
|
@@ -937,11 +982,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
937
982
|
excludeSearchTokenStringFromURL?: boolean;
|
|
938
983
|
/**
|
|
939
984
|
* The GUID of a saved answer to load initially.
|
|
985
|
+
*
|
|
986
|
+
* Supported embed types: `SearchEmbed`
|
|
940
987
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
941
988
|
* @example
|
|
942
989
|
* ```js
|
|
943
990
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
944
|
-
* ... // other
|
|
991
|
+
* ... // other embed view config
|
|
945
992
|
* answerId:'sed-1234',
|
|
946
993
|
* })
|
|
947
994
|
* ```
|
|
@@ -950,11 +997,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
950
997
|
/**
|
|
951
998
|
* If set to true, the search page will render without the Search Bar
|
|
952
999
|
* The chart/table should still be visible.
|
|
1000
|
+
*
|
|
1001
|
+
* Supported embed types: `SearchEmbed`
|
|
953
1002
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
954
1003
|
* @example
|
|
955
1004
|
* ```js
|
|
956
1005
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
957
|
-
* ... // other
|
|
1006
|
+
* ... // other embed view config
|
|
958
1007
|
* hideSearchBar:true,
|
|
959
1008
|
* })
|
|
960
1009
|
* ```
|
|
@@ -962,6 +1011,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
962
1011
|
hideSearchBar?: boolean;
|
|
963
1012
|
/**
|
|
964
1013
|
* Flag to set if last selected dataSource should be used
|
|
1014
|
+
*
|
|
1015
|
+
* Supported embed types: `SearchEmbed`
|
|
965
1016
|
* @version: SDK: 1.24.0
|
|
966
1017
|
*/
|
|
967
1018
|
useLastSelectedSources?: boolean;
|
|
@@ -974,6 +1025,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
974
1025
|
collapseSearchBarInitially?: boolean;
|
|
975
1026
|
/**
|
|
976
1027
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1028
|
+
*
|
|
1029
|
+
* Supported embed types: `SearchEmbed`
|
|
977
1030
|
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
978
1031
|
*/
|
|
979
1032
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
@@ -984,12 +1037,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
984
1037
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
985
1038
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
986
1039
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1040
|
+
*
|
|
1041
|
+
* Supported embed types: `SearchEmbed`
|
|
987
1042
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
988
1043
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
989
1044
|
* @example
|
|
990
1045
|
* ```js
|
|
991
1046
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
992
|
-
* ... // other
|
|
1047
|
+
* ... // other embed view config
|
|
993
1048
|
* dataPanelCustomGroupsAccordionInitialState:
|
|
994
1049
|
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
995
1050
|
* });
|
|
@@ -999,12 +1054,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
999
1054
|
/**
|
|
1000
1055
|
* Flag to remove focus from search bar initially when user
|
|
1001
1056
|
* lands on search embed page.
|
|
1057
|
+
*
|
|
1058
|
+
* Supported embed types: `SearchEmbed`
|
|
1002
1059
|
* @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
|
|
1003
1060
|
* @default true
|
|
1004
1061
|
* @example
|
|
1005
1062
|
* ```js
|
|
1006
1063
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
1007
|
-
* ... // other
|
|
1064
|
+
* ... // other embed view config
|
|
1008
1065
|
* focusSearchBarOnRender: false,
|
|
1009
1066
|
* });
|
|
1010
1067
|
* ```
|
|
@@ -1116,7 +1173,7 @@ export declare enum HomePageSearchBarMode {
|
|
|
1116
1173
|
}
|
|
1117
1174
|
/**
|
|
1118
1175
|
* Define the version of the primary navbar
|
|
1119
|
-
* @version SDK: 1.
|
|
1176
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1120
1177
|
*/
|
|
1121
1178
|
export declare enum PrimaryNavbarVersion {
|
|
1122
1179
|
/**
|
|
@@ -1128,7 +1185,7 @@ export declare enum PrimaryNavbarVersion {
|
|
|
1128
1185
|
}
|
|
1129
1186
|
/**
|
|
1130
1187
|
* Define the version of the home page
|
|
1131
|
-
* @version SDK: 1.
|
|
1188
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1132
1189
|
*/
|
|
1133
1190
|
export declare enum HomePage {
|
|
1134
1191
|
/**
|
|
@@ -1139,7 +1196,7 @@ export declare enum HomePage {
|
|
|
1139
1196
|
}
|
|
1140
1197
|
/**
|
|
1141
1198
|
* Define the discovery experience
|
|
1142
|
-
* @version SDK: 1.
|
|
1199
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1143
1200
|
*/
|
|
1144
1201
|
export interface DiscoveryExperience {
|
|
1145
1202
|
/**
|
|
@@ -1155,17 +1212,19 @@ export interface DiscoveryExperience {
|
|
|
1155
1212
|
* The view configuration for full app embedding.
|
|
1156
1213
|
* @group Embed components
|
|
1157
1214
|
*/
|
|
1158
|
-
export interface AppViewConfig extends
|
|
1215
|
+
export interface AppViewConfig extends AllEmbedViewConfig {
|
|
1159
1216
|
/**
|
|
1160
1217
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
1161
1218
|
* is displayed. By default, the navigation bar is hidden.
|
|
1162
1219
|
* This flag also controls the homepage left navigation bar.
|
|
1220
|
+
*
|
|
1221
|
+
* Supported embed types: `AppEmbed`
|
|
1163
1222
|
* @default true
|
|
1164
1223
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
1165
1224
|
* @example
|
|
1166
1225
|
* ```js
|
|
1167
1226
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1168
|
-
* ... // other
|
|
1227
|
+
* ... // other embed view config
|
|
1169
1228
|
* showPrimaryNavbar:true,
|
|
1170
1229
|
* })
|
|
1171
1230
|
* ```
|
|
@@ -1180,12 +1239,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1180
1239
|
* **Note**: This option does not apply to the classic homepage.
|
|
1181
1240
|
* To access the updated modular homepage, set
|
|
1182
1241
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1242
|
+
*
|
|
1243
|
+
* Supported embed types: `AppEmbed`
|
|
1183
1244
|
* @default false
|
|
1184
1245
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1185
1246
|
* @example
|
|
1186
1247
|
* ```js
|
|
1187
1248
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1188
|
-
* ... // other
|
|
1249
|
+
* ... // other embed view config
|
|
1189
1250
|
* hideHomepageLeftNav : true,
|
|
1190
1251
|
* })
|
|
1191
1252
|
* ```
|
|
@@ -1194,12 +1255,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1194
1255
|
/**
|
|
1195
1256
|
* Control the visibility of the help (?) and profile buttons on the
|
|
1196
1257
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
1258
|
+
*
|
|
1259
|
+
* Supported embed types: `AppEmbed`
|
|
1197
1260
|
* @default false
|
|
1198
1261
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
1199
1262
|
* @example
|
|
1200
1263
|
* ```js
|
|
1201
1264
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1202
|
-
* ... // other
|
|
1265
|
+
* ... // other embed view config
|
|
1203
1266
|
* disableProfileAndHelp: true,
|
|
1204
1267
|
* })
|
|
1205
1268
|
* ```
|
|
@@ -1210,10 +1273,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1210
1273
|
* @default true
|
|
1211
1274
|
* Whether the help menu in the top nav bar should be served
|
|
1212
1275
|
* from Pendo or ThoughtSpot's internal help items.
|
|
1276
|
+
*
|
|
1277
|
+
* Supported embed types: `AppEmbed`
|
|
1213
1278
|
* @example
|
|
1214
1279
|
* ```js
|
|
1215
1280
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1216
|
-
* ... // other
|
|
1281
|
+
* ... // other embed view config
|
|
1217
1282
|
* enablePendoHelp: false,
|
|
1218
1283
|
* });
|
|
1219
1284
|
* ```
|
|
@@ -1223,12 +1288,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1223
1288
|
* Control the visibility of the hamburger icon on the top nav bar
|
|
1224
1289
|
* available when new navigation V3 is enabled.
|
|
1225
1290
|
*
|
|
1291
|
+
* Supported embed types: `AppEmbed`
|
|
1226
1292
|
* @default false
|
|
1227
|
-
* @version SDK: 1.
|
|
1293
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1228
1294
|
* @example
|
|
1229
1295
|
* ```js
|
|
1230
1296
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1231
|
-
* ... // other
|
|
1297
|
+
* ... // other embed view config
|
|
1232
1298
|
* hideHamburger : true,
|
|
1233
1299
|
* })
|
|
1234
1300
|
* ```
|
|
@@ -1238,12 +1304,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1238
1304
|
* Control the visibility of the Eureka search on the top nav bar
|
|
1239
1305
|
* this will control for both new V2 and new navigation V3.
|
|
1240
1306
|
*
|
|
1307
|
+
* Supported embed types: `AppEmbed`
|
|
1241
1308
|
* @default true
|
|
1242
|
-
* @version SDK: 1.
|
|
1309
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1243
1310
|
* @example
|
|
1244
1311
|
* ```js
|
|
1245
1312
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1246
|
-
* ... // other
|
|
1313
|
+
* ... // other embed view config
|
|
1247
1314
|
* hideObjectSearch: false,
|
|
1248
1315
|
* })
|
|
1249
1316
|
* ```
|
|
@@ -1253,12 +1320,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1253
1320
|
* Control the visibility of the notification on the top nav bar V3,
|
|
1254
1321
|
* available when new navigation V3 is enabled.
|
|
1255
1322
|
*
|
|
1323
|
+
* Supported embed types: `AppEmbed`
|
|
1256
1324
|
* @default true
|
|
1257
|
-
* @version SDK: 1.
|
|
1325
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1258
1326
|
* @example
|
|
1259
1327
|
* ```js
|
|
1260
1328
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1261
|
-
* ... // other
|
|
1329
|
+
* ... // other embed view config
|
|
1262
1330
|
* hideNotification: false,
|
|
1263
1331
|
* })
|
|
1264
1332
|
* ```
|
|
@@ -1271,12 +1339,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1271
1339
|
* **Note**: This option does not apply to the classic homepage.
|
|
1272
1340
|
* To access the updated modular homepage, set
|
|
1273
1341
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1342
|
+
*
|
|
1343
|
+
* Supported embed types: `AppEmbed`
|
|
1274
1344
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1275
1345
|
* @default false
|
|
1276
1346
|
* @example
|
|
1277
1347
|
* ```js
|
|
1278
1348
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1279
|
-
* ... // other
|
|
1349
|
+
* ... // other embed view config
|
|
1280
1350
|
* hideApplicationSwitcher : true,
|
|
1281
1351
|
* })
|
|
1282
1352
|
* ```
|
|
@@ -1289,12 +1359,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1289
1359
|
* **Note**: This option does not apply to the classic homepage.
|
|
1290
1360
|
* To access the updated modular homepage, set
|
|
1291
1361
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1362
|
+
*
|
|
1363
|
+
* Supported embed types: `AppEmbed`
|
|
1292
1364
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1293
1365
|
* @default true
|
|
1294
1366
|
* @example
|
|
1295
1367
|
* ```js
|
|
1296
1368
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1297
|
-
* ... // other
|
|
1369
|
+
* ... // other embed view config
|
|
1298
1370
|
* hideOrgSwitcher : true,
|
|
1299
1371
|
* })
|
|
1300
1372
|
* ```
|
|
@@ -1308,12 +1380,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1308
1380
|
*
|
|
1309
1381
|
* For eg, if you want the component to open to a specific Liveboard
|
|
1310
1382
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
1383
|
+
*
|
|
1384
|
+
* Supported embed types: `AppEmbed`
|
|
1311
1385
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
1312
1386
|
* @example
|
|
1313
1387
|
* ```js
|
|
1314
1388
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1315
|
-
* ... // other
|
|
1316
|
-
* path:"pinboard/1234/tab/7464"
|
|
1389
|
+
* ... // other embed view config
|
|
1390
|
+
* path:"pinboard/1234/tab/7464",
|
|
1317
1391
|
* })
|
|
1318
1392
|
* ```
|
|
1319
1393
|
*/
|
|
@@ -1324,12 +1398,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1324
1398
|
*
|
|
1325
1399
|
* Use this to open to particular page in the app. To open to a specific
|
|
1326
1400
|
* path within the app, use the `path` attribute which is more flexible.
|
|
1401
|
+
*
|
|
1402
|
+
* Supported embed types: `AppEmbed`
|
|
1327
1403
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
1328
1404
|
* @example
|
|
1329
1405
|
* ```js
|
|
1330
1406
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1331
|
-
* ... // other
|
|
1332
|
-
* pageId : Page.Answers | Page.Data
|
|
1407
|
+
* ... // other embed view config
|
|
1408
|
+
* pageId : Page.Answers | Page.Data,
|
|
1333
1409
|
* })
|
|
1334
1410
|
* ```
|
|
1335
1411
|
*/
|
|
@@ -1338,11 +1414,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1338
1414
|
* This puts a filter tag on the application. All metadata lists in the
|
|
1339
1415
|
* application, such as Liveboards and answers, would be filtered by this
|
|
1340
1416
|
* tag.
|
|
1417
|
+
*
|
|
1418
|
+
* Supported embed types: `AppEmbed`
|
|
1341
1419
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
1342
1420
|
* @example
|
|
1343
1421
|
* ```js
|
|
1344
1422
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1345
|
-
* ... // other
|
|
1423
|
+
* ... // other embed view config
|
|
1346
1424
|
* tag:'value',
|
|
1347
1425
|
* })
|
|
1348
1426
|
* ```
|
|
@@ -1350,11 +1428,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1350
1428
|
tag?: string;
|
|
1351
1429
|
/**
|
|
1352
1430
|
* The array of GUIDs to be hidden
|
|
1431
|
+
*
|
|
1432
|
+
* Supported embed types: `AppEmbed`
|
|
1353
1433
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1354
1434
|
* @example
|
|
1355
1435
|
* ```js
|
|
1356
1436
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1357
|
-
* ... // other
|
|
1437
|
+
* ... // other embed view config
|
|
1358
1438
|
* hideObjects: [
|
|
1359
1439
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1360
1440
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
@@ -1366,18 +1446,22 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1366
1446
|
/**
|
|
1367
1447
|
* Render liveboards using the new v2 rendering mode
|
|
1368
1448
|
* This is a transient flag which is primarily meant for internal use
|
|
1449
|
+
*
|
|
1450
|
+
* Supported embed types: `AppEmbed`
|
|
1369
1451
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1370
1452
|
* @hidden
|
|
1371
1453
|
*/
|
|
1372
1454
|
liveboardV2?: boolean;
|
|
1373
1455
|
/**
|
|
1374
1456
|
* If set to true, the Search Assist feature is enabled.
|
|
1457
|
+
*
|
|
1458
|
+
* Supported embed types: `AppEmbed`
|
|
1375
1459
|
* @default true
|
|
1376
1460
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
1377
1461
|
* @example
|
|
1378
1462
|
* ```js
|
|
1379
1463
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1380
|
-
* ... // other
|
|
1464
|
+
* ... // other embed view config
|
|
1381
1465
|
* enableSearchAssist: true,
|
|
1382
1466
|
* })
|
|
1383
1467
|
* ```
|
|
@@ -1395,63 +1479,27 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1395
1479
|
* `false` fetches visualizations incrementally as
|
|
1396
1480
|
* users scroll the page to view the charts and tables.
|
|
1397
1481
|
*
|
|
1482
|
+
* Supported embed types: `AppEmbed`
|
|
1398
1483
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
1399
1484
|
* @example
|
|
1400
1485
|
* ```js
|
|
1401
1486
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1402
|
-
* ... // other
|
|
1487
|
+
* ... // other embed view config
|
|
1403
1488
|
* fullHeight: true,
|
|
1404
1489
|
* })
|
|
1405
1490
|
* ```
|
|
1406
1491
|
*/
|
|
1407
1492
|
fullHeight?: boolean;
|
|
1408
|
-
/**
|
|
1409
|
-
* Show or hide Liveboard header
|
|
1410
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1411
|
-
* @default false
|
|
1412
|
-
* @example
|
|
1413
|
-
* ```js
|
|
1414
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
1415
|
-
* ... // other options
|
|
1416
|
-
* hideLiveboardHeader : true,
|
|
1417
|
-
* })
|
|
1418
|
-
* ```
|
|
1419
|
-
*/
|
|
1420
|
-
hideLiveboardHeader?: boolean;
|
|
1421
|
-
/**
|
|
1422
|
-
* Show or hide Liveboard title
|
|
1423
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1424
|
-
* @default false
|
|
1425
|
-
* @example
|
|
1426
|
-
* ```js
|
|
1427
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
1428
|
-
* ... // other options
|
|
1429
|
-
* showLiveboardTitle:true,
|
|
1430
|
-
* })
|
|
1431
|
-
* ```
|
|
1432
|
-
*/
|
|
1433
|
-
showLiveboardTitle?: boolean;
|
|
1434
|
-
/**
|
|
1435
|
-
* Show or hide Liveboard description
|
|
1436
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1437
|
-
* @default false
|
|
1438
|
-
* @example
|
|
1439
|
-
* ```js
|
|
1440
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
1441
|
-
* ... // other options
|
|
1442
|
-
* showLiveboardDescription:true,
|
|
1443
|
-
* })
|
|
1444
|
-
* ```
|
|
1445
|
-
*/
|
|
1446
|
-
showLiveboardDescription?: boolean;
|
|
1447
1493
|
/**
|
|
1448
1494
|
* Flag to control new Modular Home experience.
|
|
1495
|
+
*
|
|
1496
|
+
* Supported embed types: `AppEmbed`
|
|
1449
1497
|
* @default false
|
|
1450
1498
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1451
1499
|
* @example
|
|
1452
1500
|
* ```js
|
|
1453
1501
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1454
|
-
* ... // other
|
|
1502
|
+
* ... // other embed view config
|
|
1455
1503
|
* modularHomeExperience : true,
|
|
1456
1504
|
* })
|
|
1457
1505
|
* ```
|
|
@@ -1460,38 +1508,21 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1460
1508
|
/**
|
|
1461
1509
|
* To configure the top-left navigation and home page experience
|
|
1462
1510
|
*
|
|
1511
|
+
* Supported embed types: `AppEmbed`
|
|
1463
1512
|
* @default false
|
|
1464
|
-
* @version SDK: 1.
|
|
1513
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1465
1514
|
* @example
|
|
1466
1515
|
* ```js
|
|
1467
1516
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
1468
|
-
* ... // other
|
|
1517
|
+
* ... // other embed view config
|
|
1469
1518
|
* discoveryExperience : {
|
|
1470
1519
|
* primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
|
|
1471
|
-
* homePage:
|
|
1520
|
+
* homePage: HomePage.Modular,
|
|
1472
1521
|
* },
|
|
1473
1522
|
* })
|
|
1474
1523
|
* ```
|
|
1475
1524
|
*/
|
|
1476
1525
|
discoveryExperience?: DiscoveryExperience;
|
|
1477
|
-
/**
|
|
1478
|
-
* Boolean to control if Liveboard header is sticky or not.
|
|
1479
|
-
* @example
|
|
1480
|
-
* ```js
|
|
1481
|
-
* const embed = new AppEmbed('#embed', {
|
|
1482
|
-
* ... // other app view config
|
|
1483
|
-
* isLiveboardHeaderSticky: true,
|
|
1484
|
-
* });
|
|
1485
|
-
* ```
|
|
1486
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1487
|
-
*/
|
|
1488
|
-
isLiveboardHeaderSticky?: boolean;
|
|
1489
|
-
/**
|
|
1490
|
-
* enable or disable ask sage
|
|
1491
|
-
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1492
|
-
* @default false
|
|
1493
|
-
*/
|
|
1494
|
-
enableAskSage?: boolean;
|
|
1495
1526
|
/**
|
|
1496
1527
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1497
1528
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
@@ -1506,6 +1537,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1506
1537
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1507
1538
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1508
1539
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1540
|
+
*
|
|
1541
|
+
* Supported embed types: `AppEmbed`
|
|
1509
1542
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1510
1543
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1511
1544
|
* @example
|
|
@@ -1518,20 +1551,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1518
1551
|
* ```
|
|
1519
1552
|
*/
|
|
1520
1553
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1521
|
-
/**
|
|
1522
|
-
* This attribute can be used to enable the two-column layout on an embedded Liveboard
|
|
1523
|
-
* @type {boolean}
|
|
1524
|
-
* @default false
|
|
1525
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1526
|
-
* @example
|
|
1527
|
-
* ```js
|
|
1528
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1529
|
-
* ... // other options
|
|
1530
|
-
* enable2ColumnLayout: true,
|
|
1531
|
-
* })
|
|
1532
|
-
* ```
|
|
1533
|
-
*/
|
|
1534
|
-
enable2ColumnLayout?: boolean;
|
|
1535
1554
|
/**
|
|
1536
1555
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
1537
1556
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
@@ -1539,79 +1558,57 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1539
1558
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1540
1559
|
/**
|
|
1541
1560
|
* Flag to use home page search bar mode
|
|
1561
|
+
*
|
|
1562
|
+
* Supported embed types: `AppEmbed`
|
|
1542
1563
|
* @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
|
|
1543
1564
|
*/
|
|
1544
1565
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
1545
1566
|
/**
|
|
1546
|
-
* This flag
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1549
|
-
* @version SDK: 1.
|
|
1550
|
-
* @example
|
|
1551
|
-
* ```js
|
|
1552
|
-
* const embed = new AppEmbed('#embed-container', {
|
|
1553
|
-
* ... // other options
|
|
1554
|
-
* isLiveboardCompactHeaderEnabled: true,
|
|
1555
|
-
* })
|
|
1556
|
-
* ```
|
|
1557
|
-
*/
|
|
1558
|
-
isLiveboardCompactHeaderEnabled?: boolean;
|
|
1559
|
-
/**
|
|
1560
|
-
* This flag can be used to show or hide the Liveboard verified icon in the compact header.
|
|
1561
|
-
* @type {boolean}
|
|
1567
|
+
* This flag is used to enable unified search experience for full app embed.
|
|
1568
|
+
*
|
|
1569
|
+
* Supported embed types: `AppEmbed`
|
|
1570
|
+
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
1562
1571
|
* @default true
|
|
1563
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1564
|
-
* @example
|
|
1565
|
-
* ```js
|
|
1566
|
-
* const embed = new AppEmbed('#embed-container', {
|
|
1567
|
-
* ... // other options
|
|
1568
|
-
* showLiveboardVerifiedBadge: true,
|
|
1569
|
-
* })
|
|
1570
|
-
* ```
|
|
1571
|
-
*/
|
|
1572
|
-
showLiveboardVerifiedBadge?: boolean;
|
|
1573
|
-
/**
|
|
1574
|
-
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
1575
|
-
* @type {boolean}
|
|
1576
|
-
* @default false
|
|
1577
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
1578
1572
|
* @example
|
|
1579
1573
|
* ```js
|
|
1580
|
-
* const embed = new AppEmbed('#
|
|
1581
|
-
* ... // other
|
|
1582
|
-
*
|
|
1574
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1575
|
+
* ... // other embed view config
|
|
1576
|
+
* isUnifiedSearchExperienceEnabled: true,
|
|
1583
1577
|
* })
|
|
1584
1578
|
* ```
|
|
1585
1579
|
*/
|
|
1586
|
-
|
|
1580
|
+
isUnifiedSearchExperienceEnabled?: boolean;
|
|
1587
1581
|
/**
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1582
|
+
* Show alert messages and toast messages in the embedded
|
|
1583
|
+
* view in full app embed.
|
|
1584
|
+
*
|
|
1585
|
+
* Supported embed types: `AppEmbed`
|
|
1586
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1587
|
+
* @example
|
|
1588
|
+
* ```js
|
|
1589
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1590
|
+
* ... // other embed view config
|
|
1591
|
+
* showAlerts:true,
|
|
1592
|
+
* })
|
|
1593
|
+
* ```
|
|
1594
|
+
*/
|
|
1595
|
+
showAlerts?: boolean;
|
|
1601
1596
|
/**
|
|
1602
|
-
* This flag is used to enable
|
|
1597
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
1598
|
+
*
|
|
1599
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1603
1600
|
* @type {boolean}
|
|
1604
|
-
* @
|
|
1605
|
-
* @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
|
|
1601
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1606
1602
|
* @example
|
|
1607
1603
|
* ```js
|
|
1608
|
-
*
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1604
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
1605
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1606
|
+
* ... // other embed view config
|
|
1607
|
+
* isLiveboardStylingAndGroupingEnabled: true,
|
|
1611
1608
|
* })
|
|
1612
1609
|
* ```
|
|
1613
1610
|
*/
|
|
1614
|
-
|
|
1611
|
+
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
1615
1612
|
}
|
|
1616
1613
|
/**
|
|
1617
1614
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -1669,7 +1666,7 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1669
1666
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
1670
1667
|
* @group Embed components
|
|
1671
1668
|
*/
|
|
1672
|
-
export interface LiveboardViewConfig extends
|
|
1669
|
+
export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewConfig, LiveboardAppEmbedViewConfig {
|
|
1673
1670
|
/**
|
|
1674
1671
|
* If set to true, the embedded object container dynamically resizes
|
|
1675
1672
|
* according to the height of the Liveboard.
|
|
@@ -1682,6 +1679,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1682
1679
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1683
1680
|
*
|
|
1684
1681
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1682
|
+
*
|
|
1683
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1685
1684
|
* @example
|
|
1686
1685
|
* ```js
|
|
1687
1686
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1695,6 +1694,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1695
1694
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
1696
1695
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
1697
1696
|
* other screens navigable from a Liveboard.
|
|
1697
|
+
*
|
|
1698
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1698
1699
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1699
1700
|
* @default 500
|
|
1700
1701
|
* @example
|
|
@@ -1712,7 +1713,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1712
1713
|
* @example
|
|
1713
1714
|
* ```js
|
|
1714
1715
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1715
|
-
* ... //
|
|
1716
|
+
* ... //other embed view config
|
|
1716
1717
|
* enableVizTransformations:true,
|
|
1717
1718
|
* })
|
|
1718
1719
|
* ```
|
|
@@ -1722,11 +1723,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1722
1723
|
/**
|
|
1723
1724
|
* The Liveboard to display in the embedded view.
|
|
1724
1725
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
1726
|
+
*
|
|
1727
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1725
1728
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
1726
1729
|
* @example
|
|
1727
1730
|
* ```js
|
|
1728
|
-
* const embed = new LiveboardEmbed('#
|
|
1729
|
-
* ... //
|
|
1731
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1732
|
+
* ... //other embed view config
|
|
1730
1733
|
* liveboardId:id of liveboard,
|
|
1731
1734
|
* })
|
|
1732
1735
|
*/
|
|
@@ -1738,11 +1741,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1738
1741
|
pinboardId?: string;
|
|
1739
1742
|
/**
|
|
1740
1743
|
* The visualization within the Liveboard to display.
|
|
1744
|
+
*
|
|
1745
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1741
1746
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1742
1747
|
* @example
|
|
1743
1748
|
* ```js
|
|
1744
|
-
* const embed = new LiveboardEmbed('#
|
|
1745
|
-
* ... //
|
|
1749
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1750
|
+
* ... //other embed view config
|
|
1746
1751
|
* vizId:'430496d6-6903-4601-937e-2c691821af3c',
|
|
1747
1752
|
* })
|
|
1748
1753
|
* ```
|
|
@@ -1751,11 +1756,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1751
1756
|
/**
|
|
1752
1757
|
* If set to true, all filter chips from a
|
|
1753
1758
|
* Liveboard page will be read-only (no X buttons)
|
|
1759
|
+
*
|
|
1760
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1754
1761
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
1755
1762
|
* @example
|
|
1756
1763
|
* ```js
|
|
1757
|
-
* const embed = new LiveboardEmbed('#
|
|
1758
|
-
* ... //
|
|
1764
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1765
|
+
* ... //other embed view config
|
|
1759
1766
|
* preventLiveboardFilterRemoval:true,
|
|
1760
1767
|
* })
|
|
1761
1768
|
* ```
|
|
@@ -1765,11 +1772,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1765
1772
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
1766
1773
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
1767
1774
|
* event.
|
|
1775
|
+
*
|
|
1776
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1768
1777
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1769
1778
|
* @example
|
|
1770
1779
|
* ```js
|
|
1771
|
-
* const embed = new LiveboardEmbed('#
|
|
1772
|
-
* ... //
|
|
1780
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1781
|
+
* ... //other embed view config
|
|
1773
1782
|
* visibleVizs: [
|
|
1774
1783
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1775
1784
|
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
@@ -1785,11 +1794,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1785
1794
|
/**
|
|
1786
1795
|
* Render embedded Liveboards and visualizations in the
|
|
1787
1796
|
* new Liveboard experience mode.
|
|
1797
|
+
*
|
|
1798
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1788
1799
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
1789
1800
|
* @example
|
|
1790
1801
|
* ```js
|
|
1791
|
-
* const embed = new LiveboardEmbed('#
|
|
1792
|
-
* ... //
|
|
1802
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1803
|
+
* ... //other embed view config
|
|
1793
1804
|
* liveboardV2:true,
|
|
1794
1805
|
* })
|
|
1795
1806
|
* ```
|
|
@@ -1798,10 +1809,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1798
1809
|
/**
|
|
1799
1810
|
* Set a Liveboard tab as an active tab.
|
|
1800
1811
|
* Specify the tab ID.
|
|
1812
|
+
*
|
|
1813
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1801
1814
|
* @example
|
|
1802
1815
|
* ```js
|
|
1803
1816
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1804
|
-
* ... //
|
|
1817
|
+
* ... //other embed view config
|
|
1805
1818
|
* activeTabId:'id-1234',
|
|
1806
1819
|
* })
|
|
1807
1820
|
* ```
|
|
@@ -1810,228 +1823,155 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1810
1823
|
activeTabId?: string;
|
|
1811
1824
|
/**
|
|
1812
1825
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1826
|
+
*
|
|
1827
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1813
1828
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1814
1829
|
* @example
|
|
1815
1830
|
* ```js
|
|
1816
|
-
* const embed = new LiveboardEmbed('#
|
|
1817
|
-
* ... //
|
|
1831
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1832
|
+
* ... //other embed view config
|
|
1818
1833
|
* hideTabPanel:true,
|
|
1819
1834
|
* })
|
|
1820
1835
|
* ```
|
|
1821
1836
|
*/
|
|
1822
1837
|
hideTabPanel?: boolean;
|
|
1823
1838
|
/**
|
|
1824
|
-
* Show
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1839
|
+
* Show a preview image of the visualization before the visualization loads.
|
|
1840
|
+
* Only works for visualizations embeds with a viz id.
|
|
1841
|
+
*
|
|
1842
|
+
* Also, viz snashot should be enabled in the ThoughtSpot instance.
|
|
1843
|
+
* Contact ThoughtSpot support to enable this feature.
|
|
1844
|
+
*
|
|
1845
|
+
* Since, this will show preview images, be careful that it may show
|
|
1846
|
+
* undesired data to the user when using row level security.
|
|
1847
|
+
*
|
|
1848
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1827
1849
|
* @example
|
|
1828
1850
|
* ```js
|
|
1829
|
-
* const embed = new LiveboardEmbed('#
|
|
1830
|
-
*
|
|
1831
|
-
*
|
|
1851
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1852
|
+
* liveboardId: 'liveboard-id',
|
|
1853
|
+
* vizId: 'viz-id',
|
|
1854
|
+
* showPreviewLoader: true,
|
|
1832
1855
|
* });
|
|
1856
|
+
* embed.render();
|
|
1833
1857
|
* ```
|
|
1858
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1834
1859
|
*/
|
|
1835
|
-
|
|
1860
|
+
showPreviewLoader?: boolean;
|
|
1836
1861
|
/**
|
|
1837
|
-
*
|
|
1838
|
-
*
|
|
1839
|
-
*
|
|
1862
|
+
* The Liveboard to run on regular intervals to fetch the cdw token.
|
|
1863
|
+
*
|
|
1864
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1865
|
+
* @hidden
|
|
1866
|
+
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
1840
1867
|
* @example
|
|
1841
1868
|
* ```js
|
|
1842
|
-
* const embed = new LiveboardEmbed('#
|
|
1843
|
-
* ... //
|
|
1844
|
-
*
|
|
1869
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1870
|
+
* ... //other embed view config
|
|
1871
|
+
* oAuthPollingInterval: value in milliseconds,
|
|
1845
1872
|
* })
|
|
1846
|
-
* ```
|
|
1847
1873
|
*/
|
|
1848
|
-
|
|
1874
|
+
oAuthPollingInterval?: number;
|
|
1849
1875
|
/**
|
|
1850
|
-
*
|
|
1851
|
-
*
|
|
1852
|
-
*
|
|
1876
|
+
* The Liveboard is set to force a token fetch during the initial load.
|
|
1877
|
+
*
|
|
1878
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1879
|
+
* @hidden
|
|
1880
|
+
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
1853
1881
|
* @example
|
|
1854
1882
|
* ```js
|
|
1855
|
-
* const embed = new LiveboardEmbed('#
|
|
1856
|
-
* ... //
|
|
1857
|
-
*
|
|
1883
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1884
|
+
* ... //other embed view config
|
|
1885
|
+
* isForceRedirect: false,
|
|
1858
1886
|
* })
|
|
1859
|
-
* ```
|
|
1860
1887
|
*/
|
|
1861
|
-
|
|
1888
|
+
isForceRedirect?: boolean;
|
|
1862
1889
|
/**
|
|
1863
|
-
*
|
|
1864
|
-
*
|
|
1865
|
-
*
|
|
1890
|
+
* The source connection ID for authentication.
|
|
1891
|
+
* @hidden
|
|
1892
|
+
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
1893
|
+
*
|
|
1894
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1866
1895
|
* @example
|
|
1867
1896
|
* ```js
|
|
1868
|
-
* const embed = new LiveboardEmbed('#
|
|
1869
|
-
*
|
|
1870
|
-
*
|
|
1871
|
-
* })
|
|
1872
|
-
* ```
|
|
1873
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1897
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1898
|
+
* ... //other embed view config
|
|
1899
|
+
* dataSourceId: '',
|
|
1900
|
+
* })
|
|
1874
1901
|
*/
|
|
1875
|
-
|
|
1902
|
+
dataSourceId?: string;
|
|
1876
1903
|
/**
|
|
1877
|
-
*
|
|
1878
|
-
*
|
|
1879
|
-
*
|
|
1904
|
+
* This flag is for show/hide checkboxes for include or exclude
|
|
1905
|
+
* cover page and filters in the Liveboard PDF.
|
|
1906
|
+
*
|
|
1907
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1908
|
+
* @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
|
|
1909
|
+
* @default true
|
|
1910
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1880
1911
|
* @example
|
|
1881
1912
|
* ```js
|
|
1882
|
-
* const embed = new
|
|
1883
|
-
* ... //
|
|
1884
|
-
*
|
|
1913
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1914
|
+
* ... //other embed view config
|
|
1915
|
+
* coverAndFilterOptionInPDF: false,
|
|
1885
1916
|
* })
|
|
1886
1917
|
* ```
|
|
1887
1918
|
*/
|
|
1888
|
-
|
|
1919
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
1889
1920
|
/**
|
|
1890
|
-
*
|
|
1891
|
-
*
|
|
1892
|
-
*
|
|
1893
|
-
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1894
|
-
* @example
|
|
1895
|
-
* ```js
|
|
1896
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1897
|
-
* ... // other options
|
|
1898
|
-
* enable2ColumnLayout: true,
|
|
1899
|
-
* })
|
|
1900
|
-
* ```
|
|
1901
|
-
*/
|
|
1902
|
-
enable2ColumnLayout?: boolean;
|
|
1903
|
-
/**
|
|
1904
|
-
* Show a preview image of the visualization before the visualization loads.
|
|
1905
|
-
* Only works for visualizations embeds with a viz id.
|
|
1906
|
-
*
|
|
1907
|
-
* Also, viz snashot should be enabled in the ThoughtSpot instance.
|
|
1908
|
-
* Contact ThoughtSpot support to enable this feature.
|
|
1921
|
+
* The list of tab IDs to hide from the embedded.
|
|
1922
|
+
* This Tabs will be hidden from their respective LBs.
|
|
1923
|
+
* Use this to hide an tabID.
|
|
1909
1924
|
*
|
|
1910
|
-
*
|
|
1911
|
-
* undesired data to the user when using row level security.
|
|
1925
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1912
1926
|
* @example
|
|
1913
1927
|
* ```js
|
|
1914
|
-
* const embed = new LiveboardEmbed('#
|
|
1915
|
-
*
|
|
1916
|
-
*
|
|
1917
|
-
*
|
|
1928
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1929
|
+
* ... // other embed view config
|
|
1930
|
+
* hiddenTabs: [
|
|
1931
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1932
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
1933
|
+
* ]
|
|
1918
1934
|
* });
|
|
1919
|
-
* embed.render();
|
|
1920
1935
|
* ```
|
|
1921
|
-
* @version SDK: 1.
|
|
1936
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
1922
1937
|
*/
|
|
1923
|
-
|
|
1938
|
+
hiddenTabs?: string[];
|
|
1924
1939
|
/**
|
|
1925
|
-
*
|
|
1926
|
-
*
|
|
1927
|
-
* ThoughtSpot Embedded apps.
|
|
1940
|
+
* The list of tab IDs to show in the embedded Liveboard.
|
|
1941
|
+
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
1928
1942
|
*
|
|
1929
|
-
*
|
|
1930
|
-
*
|
|
1931
|
-
*
|
|
1932
|
-
* @
|
|
1933
|
-
* ```js
|
|
1934
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1935
|
-
* ... // other options
|
|
1936
|
-
* isLiveboardCompactHeaderEnabled: true,
|
|
1937
|
-
* })
|
|
1938
|
-
* ```
|
|
1939
|
-
*/
|
|
1940
|
-
isLiveboardCompactHeaderEnabled?: boolean;
|
|
1941
|
-
/**
|
|
1942
|
-
* This flag is used to show/hide verified icon in the Liveboard compact header
|
|
1943
|
-
* @type {boolean}
|
|
1944
|
-
* @default true
|
|
1945
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1946
|
-
* @example
|
|
1947
|
-
* ```js
|
|
1948
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1949
|
-
* ... // other options
|
|
1950
|
-
* showLiveboardVerifiedBadge: true,
|
|
1951
|
-
* })
|
|
1952
|
-
* ```
|
|
1953
|
-
*/
|
|
1954
|
-
showLiveboardVerifiedBadge?: boolean;
|
|
1955
|
-
/**
|
|
1956
|
-
* This flag is used to show/hide the re-verify banner
|
|
1957
|
-
* in Liveboard compact header
|
|
1958
|
-
* @type {boolean}
|
|
1959
|
-
* @default true
|
|
1960
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
1961
|
-
* @example
|
|
1962
|
-
* ```js
|
|
1963
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1964
|
-
* ... // other options
|
|
1965
|
-
* showLiveboardReverifyBanner: true,
|
|
1966
|
-
* })
|
|
1967
|
-
* ```
|
|
1968
|
-
*/
|
|
1969
|
-
showLiveboardReverifyBanner?: boolean;
|
|
1970
|
-
/**
|
|
1971
|
-
* This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
|
|
1972
|
-
* @type {boolean}
|
|
1973
|
-
* @default false
|
|
1974
|
-
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
1943
|
+
* Use either `visibleTabs` or `hiddenTabs`.
|
|
1944
|
+
*
|
|
1945
|
+
* Supported embed types: `LiveboardEmbed`
|
|
1946
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
1975
1947
|
* @example
|
|
1976
1948
|
* ```js
|
|
1977
|
-
* const embed = new LiveboardEmbed('#
|
|
1978
|
-
* ... // other
|
|
1979
|
-
*
|
|
1949
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1950
|
+
* ... // other embed view config
|
|
1951
|
+
* visibleTabs: [
|
|
1952
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1953
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
1954
|
+
* ]
|
|
1980
1955
|
* })
|
|
1981
1956
|
* ```
|
|
1982
1957
|
*/
|
|
1983
|
-
|
|
1984
|
-
/**
|
|
1985
|
-
* The Liveboard to run on regular intervals to fetch the cdw token.
|
|
1986
|
-
* @hidden
|
|
1987
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
1988
|
-
* @example
|
|
1989
|
-
* ```js
|
|
1990
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1991
|
-
* ... // other options
|
|
1992
|
-
* oAuthPollingInterval: value in milliseconds,
|
|
1993
|
-
* })
|
|
1994
|
-
*/
|
|
1995
|
-
oAuthPollingInterval?: number;
|
|
1996
|
-
/**
|
|
1997
|
-
* The Liveboard is set to force a token fetch during the initial load.
|
|
1998
|
-
* @hidden
|
|
1999
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
2000
|
-
* @example
|
|
2001
|
-
* ```js
|
|
2002
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
2003
|
-
* ... // other options
|
|
2004
|
-
* isForceRedirect: false,
|
|
2005
|
-
* })
|
|
2006
|
-
*/
|
|
2007
|
-
isForceRedirect?: boolean;
|
|
2008
|
-
/**
|
|
2009
|
-
* The source connection ID for authentication.
|
|
2010
|
-
* @hidden
|
|
2011
|
-
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
|
|
2012
|
-
* @example
|
|
2013
|
-
* ```js
|
|
2014
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
2015
|
-
* ... // other options
|
|
2016
|
-
* dataSourceId: '',
|
|
2017
|
-
* })
|
|
2018
|
-
*/
|
|
2019
|
-
dataSourceId?: string;
|
|
1958
|
+
visibleTabs?: string[];
|
|
2020
1959
|
/**
|
|
2021
|
-
* This flag is
|
|
2022
|
-
*
|
|
1960
|
+
* This flag is used to enable/disable the styling and grouping in a Liveboard
|
|
1961
|
+
*
|
|
1962
|
+
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
2023
1963
|
* @type {boolean}
|
|
2024
|
-
* @
|
|
2025
|
-
* @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
|
|
1964
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2026
1965
|
* @example
|
|
2027
1966
|
* ```js
|
|
2028
|
-
*
|
|
2029
|
-
*
|
|
2030
|
-
*
|
|
1967
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
1968
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1969
|
+
* ... // other embed view config
|
|
1970
|
+
* isLiveboardStylingAndGroupingEnabled: true,
|
|
2031
1971
|
* })
|
|
2032
1972
|
* ```
|
|
2033
1973
|
*/
|
|
2034
|
-
|
|
1974
|
+
isLiveboardStylingAndGroupingEnabled?: boolean;
|
|
2035
1975
|
}
|
|
2036
1976
|
/**
|
|
2037
1977
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -2089,7 +2029,7 @@ export declare class PinboardEmbed extends LiveboardEmbed {
|
|
|
2089
2029
|
* Configuration for bodyless conversation options.
|
|
2090
2030
|
* @group Embed components
|
|
2091
2031
|
*/
|
|
2092
|
-
export interface SpotterAgentEmbedViewConfig extends
|
|
2032
|
+
export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
2093
2033
|
/**
|
|
2094
2034
|
* The ID of the worksheet to use for the conversation.
|
|
2095
2035
|
*/
|
|
@@ -2101,7 +2041,7 @@ export interface SpotterAgentEmbedViewConfig extends ViewConfig {
|
|
|
2101
2041
|
}
|
|
2102
2042
|
/**
|
|
2103
2043
|
* Configuration for conversation options.
|
|
2104
|
-
* @deprecated from SDK: 1.
|
|
2044
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
2105
2045
|
* Use {@link SpotterAgentEmbedViewConfig} instead
|
|
2106
2046
|
* @group Embed components
|
|
2107
2047
|
*/
|
|
@@ -2153,7 +2093,7 @@ export declare class SpotterAgentEmbed {
|
|
|
2153
2093
|
/**
|
|
2154
2094
|
* Create a conversation embed, which can be integrated inside
|
|
2155
2095
|
* chatbots or other conversational interfaces.
|
|
2156
|
-
* @deprecated from SDK: 1.
|
|
2096
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
2157
2097
|
* Use {@link SpotterAgentEmbed} instead
|
|
2158
2098
|
* @example
|
|
2159
2099
|
* ```js
|
|
@@ -2254,7 +2194,7 @@ export declare enum AuthType {
|
|
|
2254
2194
|
* // ...
|
|
2255
2195
|
* authType: AuthType.SAMLRedirect,
|
|
2256
2196
|
* authTriggerText: 'Login with SAML',
|
|
2257
|
-
* authTriggerContainer: '#
|
|
2197
|
+
* authTriggerContainer: '#tsEmbed',
|
|
2258
2198
|
* inPopup: true,
|
|
2259
2199
|
* });
|
|
2260
2200
|
* ```
|
|
@@ -2379,13 +2319,13 @@ export declare enum HomeLeftNavItem {
|
|
|
2379
2319
|
/**
|
|
2380
2320
|
* Create new options in the insights left navigation,
|
|
2381
2321
|
* available when new navigation V3 is enabled.
|
|
2382
|
-
* @version SDK: 1.
|
|
2322
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2383
2323
|
*/
|
|
2384
2324
|
Create = "create",
|
|
2385
2325
|
/**
|
|
2386
2326
|
* Spotter option in the insights left navigation,
|
|
2387
2327
|
* available when new navigation V3 is enabled.
|
|
2388
|
-
* @version SDK: 1.
|
|
2328
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2389
2329
|
*/
|
|
2390
2330
|
Spotter = "spotter"
|
|
2391
2331
|
}
|
|
@@ -2793,6 +2733,20 @@ export interface EmbedConfig {
|
|
|
2793
2733
|
*/
|
|
2794
2734
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2795
2735
|
disablePreauthCache?: boolean;
|
|
2736
|
+
/**
|
|
2737
|
+
* Disable fullscreen presentation mode functionality. When enabled, prevents entering
|
|
2738
|
+
* and exiting fullscreen mode for embedded visualizations during presentations.
|
|
2739
|
+
* @default true (feature is disabled by default)
|
|
2740
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
2741
|
+
* @example
|
|
2742
|
+
* ```js
|
|
2743
|
+
* init({
|
|
2744
|
+
* ... // other embed config options
|
|
2745
|
+
* disableFullscreenPresentation: false, // enables the feature
|
|
2746
|
+
* })
|
|
2747
|
+
* ```
|
|
2748
|
+
*/
|
|
2749
|
+
disableFullscreenPresentation?: boolean;
|
|
2796
2750
|
}
|
|
2797
2751
|
export interface LayoutConfig {
|
|
2798
2752
|
}
|
|
@@ -2822,9 +2776,9 @@ export interface FrameParams {
|
|
|
2822
2776
|
[key: string]: string | number | boolean | undefined;
|
|
2823
2777
|
}
|
|
2824
2778
|
/**
|
|
2825
|
-
* The configuration object for an embedded view.
|
|
2779
|
+
* The common configuration object for an embedded view.
|
|
2826
2780
|
*/
|
|
2827
|
-
export interface
|
|
2781
|
+
export interface BaseViewConfig {
|
|
2828
2782
|
/**
|
|
2829
2783
|
* @hidden
|
|
2830
2784
|
*/
|
|
@@ -2832,16 +2786,19 @@ export interface ViewConfig {
|
|
|
2832
2786
|
/**
|
|
2833
2787
|
* The width and height dimensions to render an embedded
|
|
2834
2788
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2789
|
+
*
|
|
2790
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2835
2791
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2836
2792
|
* @example
|
|
2837
2793
|
* ```js
|
|
2838
|
-
*
|
|
2839
|
-
*
|
|
2840
|
-
*
|
|
2841
|
-
*
|
|
2842
|
-
*
|
|
2843
|
-
*
|
|
2844
|
-
*
|
|
2794
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2795
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2796
|
+
* ... // other embed view config
|
|
2797
|
+
* frameParams: {
|
|
2798
|
+
* width: '500px' | '50%',
|
|
2799
|
+
* height: '400px' | '60%',
|
|
2800
|
+
* },
|
|
2801
|
+
* })
|
|
2845
2802
|
* ```
|
|
2846
2803
|
*/
|
|
2847
2804
|
frameParams?: FrameParams;
|
|
@@ -2858,38 +2815,31 @@ export interface ViewConfig {
|
|
|
2858
2815
|
* (...), and the contextual menu. These actions will be disabled
|
|
2859
2816
|
* for the user.
|
|
2860
2817
|
* Use this to disable actions.
|
|
2818
|
+
*
|
|
2819
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2861
2820
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2862
2821
|
* @example
|
|
2863
2822
|
* ```js
|
|
2864
|
-
*
|
|
2865
|
-
*
|
|
2866
|
-
*
|
|
2823
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2824
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2825
|
+
* ... // other embed view config
|
|
2826
|
+
* disabledActions: [Action.Download, Action.Save],
|
|
2867
2827
|
* });
|
|
2868
2828
|
* ```
|
|
2869
2829
|
*/
|
|
2870
2830
|
disabledActions?: Action[];
|
|
2871
|
-
/**
|
|
2872
|
-
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2873
|
-
* Use this to set the primary action.
|
|
2874
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
2875
|
-
* @example
|
|
2876
|
-
* ```js
|
|
2877
|
-
* const embed = new LiveboardEmbed('#embed', {
|
|
2878
|
-
* ... // other liveboard view config
|
|
2879
|
-
* primaryAction: Action.Download
|
|
2880
|
-
* });
|
|
2881
|
-
* ```
|
|
2882
|
-
*/
|
|
2883
|
-
primaryAction?: Action | string;
|
|
2884
2831
|
/**
|
|
2885
2832
|
* The tooltip to display for disabled actions.
|
|
2833
|
+
*
|
|
2834
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2886
2835
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2887
2836
|
* @example
|
|
2888
2837
|
* ```js
|
|
2889
|
-
*
|
|
2890
|
-
*
|
|
2891
|
-
*
|
|
2892
|
-
*
|
|
2838
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2839
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2840
|
+
* ... // other embed view config
|
|
2841
|
+
* disabledActions: [Action.Download, Action.Save],
|
|
2842
|
+
* disabledActionReason: "Reason for disabling",
|
|
2893
2843
|
* });
|
|
2894
2844
|
* ```
|
|
2895
2845
|
*/
|
|
@@ -2898,12 +2848,15 @@ export interface ViewConfig {
|
|
|
2898
2848
|
* The list of actions to hide from the embedded.
|
|
2899
2849
|
* This actions will be hidden from the user.
|
|
2900
2850
|
* Use this to hide an action.
|
|
2851
|
+
*
|
|
2852
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2901
2853
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2902
2854
|
* @example
|
|
2903
2855
|
* ```js
|
|
2904
|
-
*
|
|
2905
|
-
*
|
|
2906
|
-
*
|
|
2856
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2857
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2858
|
+
* ... // other embed view config
|
|
2859
|
+
* hiddenActions: [Action.Download, Action.Export],
|
|
2907
2860
|
* });
|
|
2908
2861
|
* ```
|
|
2909
2862
|
* @important
|
|
@@ -2916,74 +2869,30 @@ export interface ViewConfig {
|
|
|
2916
2869
|
* Use this to hide all actions except the ones you want to show.
|
|
2917
2870
|
*
|
|
2918
2871
|
* Use either this or hiddenActions.
|
|
2872
|
+
*
|
|
2873
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2919
2874
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2920
2875
|
* @important
|
|
2921
2876
|
* @example
|
|
2922
2877
|
* ```js
|
|
2923
|
-
*
|
|
2924
|
-
*
|
|
2925
|
-
*
|
|
2878
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2879
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2880
|
+
* ... // other embed view config
|
|
2881
|
+
* visibleActions: [Action.Download, Action.Export],
|
|
2926
2882
|
* });
|
|
2927
2883
|
* ```
|
|
2928
2884
|
*/
|
|
2929
2885
|
visibleActions?: Action[];
|
|
2930
|
-
/**
|
|
2931
|
-
* Show alert messages and toast messages in the embedded
|
|
2932
|
-
* view in full app embed.
|
|
2933
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2934
|
-
* @example
|
|
2935
|
-
* ```js
|
|
2936
|
-
* const embed = new AppEmbed('#embed-container', {
|
|
2937
|
-
* ... // other options
|
|
2938
|
-
* showAlerts:true,
|
|
2939
|
-
* })
|
|
2940
|
-
* ```
|
|
2941
|
-
*/
|
|
2942
|
-
showAlerts?: boolean;
|
|
2943
|
-
/**
|
|
2944
|
-
* The list of runtime filters to apply to a search Answer,
|
|
2945
|
-
* visualization, or Liveboard.
|
|
2946
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2947
|
-
* @example
|
|
2948
|
-
* ```js
|
|
2949
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
2950
|
-
* ... // other options
|
|
2951
|
-
* runtimeFilters: [
|
|
2952
|
-
* {
|
|
2953
|
-
* columnName: 'value',
|
|
2954
|
-
* operator: RuntimeFilterOp.EQ,
|
|
2955
|
-
* values: ['string' | 123 | true],
|
|
2956
|
-
* },
|
|
2957
|
-
* ],
|
|
2958
|
-
* })
|
|
2959
|
-
* ```
|
|
2960
|
-
*/
|
|
2961
|
-
runtimeFilters?: RuntimeFilter[];
|
|
2962
|
-
/**
|
|
2963
|
-
* The list of parameter override to apply to a search Answer,
|
|
2964
|
-
* visualization, or Liveboard.
|
|
2965
|
-
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2966
|
-
* @example
|
|
2967
|
-
* ```js
|
|
2968
|
-
* const embed = new LiveboardEmbed('#embed-container', {
|
|
2969
|
-
* ... // other options
|
|
2970
|
-
* runtimeParameters: [
|
|
2971
|
-
* {
|
|
2972
|
-
* name: 'value',
|
|
2973
|
-
* value: 'string' | 123 | true,
|
|
2974
|
-
* },
|
|
2975
|
-
* ],
|
|
2976
|
-
* })
|
|
2977
|
-
* ```
|
|
2978
|
-
*/
|
|
2979
|
-
runtimeParameters?: RuntimeParameter[];
|
|
2980
2886
|
/**
|
|
2981
2887
|
* The locale settings to apply to the embedded view.
|
|
2888
|
+
*
|
|
2889
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2982
2890
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2983
2891
|
* @example
|
|
2984
2892
|
* ```js
|
|
2985
|
-
*
|
|
2986
|
-
*
|
|
2893
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2894
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2895
|
+
* ... // other embed view config
|
|
2987
2896
|
* locale:'en',
|
|
2988
2897
|
* })
|
|
2989
2898
|
* ```
|
|
@@ -2997,14 +2906,17 @@ export interface ViewConfig {
|
|
|
2997
2906
|
* Warning: This option is for advanced use only and is used internally
|
|
2998
2907
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
2999
2908
|
* list of supported keys and values associated with each.
|
|
2909
|
+
*
|
|
2910
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3000
2911
|
* @example
|
|
3001
2912
|
* ```js
|
|
3002
|
-
*
|
|
3003
|
-
*
|
|
2913
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2914
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2915
|
+
* ... // other embed view config
|
|
3004
2916
|
* additionalFlags: {
|
|
3005
2917
|
* flag1: 'value1',
|
|
3006
2918
|
* flag2: 'value2'
|
|
3007
|
-
* }
|
|
2919
|
+
* },
|
|
3008
2920
|
* });
|
|
3009
2921
|
* ```
|
|
3010
2922
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
@@ -3022,55 +2934,308 @@ export interface ViewConfig {
|
|
|
3022
2934
|
/**
|
|
3023
2935
|
* Insert as a sibling of the target container, instead of appending to a
|
|
3024
2936
|
* child inside it.
|
|
2937
|
+
*
|
|
2938
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3025
2939
|
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
3026
2940
|
* @example
|
|
3027
2941
|
* ```js
|
|
3028
|
-
*
|
|
3029
|
-
*
|
|
2942
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2943
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2944
|
+
* ... // other embed view config
|
|
3030
2945
|
* insertAsSibling:true,
|
|
3031
2946
|
* })
|
|
3032
2947
|
* ```
|
|
3033
2948
|
*/
|
|
3034
2949
|
insertAsSibling?: boolean;
|
|
3035
2950
|
/**
|
|
3036
|
-
*
|
|
2951
|
+
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2952
|
+
* if available and matches the configuration.
|
|
2953
|
+
* @version SDK: 1.22.0
|
|
2954
|
+
* @hidden
|
|
2955
|
+
*
|
|
2956
|
+
* See [docs]() on how to create a prerender pool.
|
|
2957
|
+
*/
|
|
2958
|
+
usePrerenderedIfAvailable?: boolean;
|
|
2959
|
+
/**
|
|
2960
|
+
* PreRender id to be used for PreRendering the embed.
|
|
2961
|
+
* Use PreRender to render the embed in the background and then
|
|
2962
|
+
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2963
|
+
*
|
|
2964
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3037
2965
|
* @example
|
|
3038
2966
|
* ```js
|
|
3039
|
-
*
|
|
3040
|
-
*
|
|
3041
|
-
*
|
|
3042
|
-
*
|
|
2967
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2968
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2969
|
+
* ... // other embed view config
|
|
2970
|
+
* preRenderId: "preRenderId-123",
|
|
2971
|
+
* });
|
|
2972
|
+
* embed.showPreRender();
|
|
3043
2973
|
* ```
|
|
3044
|
-
* @version SDK: 1.
|
|
2974
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
3045
2975
|
*/
|
|
3046
|
-
|
|
2976
|
+
preRenderId?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
* Determines if the PreRender component should dynamically track the size
|
|
2979
|
+
* of its embedding element and adjust its own size accordingly.
|
|
2980
|
+
* Enabling this option allows the PreRender component to automatically adapt
|
|
2981
|
+
* its dimensions based on changes to the size of the embedding element.
|
|
2982
|
+
* @type {boolean}
|
|
2983
|
+
* @default false
|
|
2984
|
+
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2985
|
+
* @example
|
|
2986
|
+
* ```js
|
|
2987
|
+
* // Disable tracking PreRender size in the configuration
|
|
2988
|
+
* const config = {
|
|
2989
|
+
* doNotTrackPreRenderSize: true,
|
|
2990
|
+
* };
|
|
2991
|
+
*
|
|
2992
|
+
* // Instantiate an object with the configuration
|
|
2993
|
+
* const myComponent = new MyComponent(config);
|
|
2994
|
+
* ```
|
|
2995
|
+
*/
|
|
2996
|
+
doNotTrackPreRenderSize?: boolean;
|
|
2997
|
+
/**
|
|
2998
|
+
* Enable the V2 shell. This can provide performance benefits
|
|
2999
|
+
* due to a lighterweight shell.
|
|
3000
|
+
*
|
|
3001
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3002
|
+
* @example
|
|
3003
|
+
* ```js
|
|
3004
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
3005
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3006
|
+
* ... // other embed view config
|
|
3007
|
+
* enableV2Shell_experimental: true,
|
|
3008
|
+
* });
|
|
3009
|
+
* ```
|
|
3010
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
3011
|
+
*/
|
|
3012
|
+
enableV2Shell_experimental?: boolean;
|
|
3013
|
+
/**
|
|
3014
|
+
* For internal tracking of the embed component type.
|
|
3015
|
+
* @hidden
|
|
3016
|
+
*/
|
|
3017
|
+
embedComponentType?: string;
|
|
3018
|
+
/**
|
|
3019
|
+
* This flag can be used to expose translation IDs on the embedded app.
|
|
3020
|
+
* @default false
|
|
3021
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
3022
|
+
*/
|
|
3023
|
+
exposeTranslationIDs?: boolean;
|
|
3024
|
+
/**
|
|
3025
|
+
* This flag can be used to disable links inside the embedded app,
|
|
3026
|
+
* and disable redirection of links in a new tab.
|
|
3027
|
+
*
|
|
3028
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3029
|
+
* @example
|
|
3030
|
+
* ```js
|
|
3031
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
3032
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3033
|
+
* ... // other embed view config
|
|
3034
|
+
* disableRedirectionLinksInNewTab: true,
|
|
3035
|
+
* });
|
|
3036
|
+
* ```
|
|
3037
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
3038
|
+
*/
|
|
3039
|
+
disableRedirectionLinksInNewTab?: boolean;
|
|
3040
|
+
/**
|
|
3041
|
+
* Overrides an Org context for embedding application users.
|
|
3042
|
+
* This parameter allows a user authenticated to one Org to view the
|
|
3043
|
+
* objects from another Org.
|
|
3044
|
+
* The `overrideOrgId` setting is honoured only if the
|
|
3045
|
+
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
3046
|
+
*
|
|
3047
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3048
|
+
* @example
|
|
3049
|
+
* ```js
|
|
3050
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
3051
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3052
|
+
* ... // other embed view config
|
|
3053
|
+
* overrideOrgId: 142536,
|
|
3054
|
+
* });
|
|
3055
|
+
* ```
|
|
3056
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
3057
|
+
*/
|
|
3058
|
+
overrideOrgId?: number;
|
|
3047
3059
|
/**
|
|
3048
3060
|
* Flag to override the *Open Link in New Tab* context menu option.
|
|
3061
|
+
*
|
|
3062
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
3049
3063
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3050
3064
|
* @example
|
|
3051
3065
|
* ```js
|
|
3052
|
-
*
|
|
3053
|
-
*
|
|
3066
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
3067
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3068
|
+
* ... // other embed view config
|
|
3054
3069
|
* linkOverride:false,
|
|
3055
3070
|
* })
|
|
3056
3071
|
* ```
|
|
3057
3072
|
*/
|
|
3058
3073
|
linkOverride?: boolean;
|
|
3074
|
+
/**
|
|
3075
|
+
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
3076
|
+
* Use this to set the primary action.
|
|
3077
|
+
*
|
|
3078
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3079
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
3080
|
+
* @example
|
|
3081
|
+
* ```js
|
|
3082
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3083
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3084
|
+
* ... // other embed view config
|
|
3085
|
+
* primaryAction: Action.Download
|
|
3086
|
+
* });
|
|
3087
|
+
* ```
|
|
3088
|
+
*/
|
|
3089
|
+
primaryAction?: Action | string;
|
|
3059
3090
|
/**
|
|
3060
3091
|
* flag to enable insert into slides action
|
|
3061
3092
|
* @hidden
|
|
3062
3093
|
* @private
|
|
3063
3094
|
*/
|
|
3064
3095
|
insertInToSlide?: boolean;
|
|
3096
|
+
}
|
|
3097
|
+
/**
|
|
3098
|
+
* The configuration object for Home page embeds configs.
|
|
3099
|
+
*/
|
|
3100
|
+
export interface HomePageConfig {
|
|
3065
3101
|
/**
|
|
3066
|
-
*
|
|
3067
|
-
*
|
|
3068
|
-
* @version SDK: 1.22.0
|
|
3069
|
-
* @hidden
|
|
3102
|
+
* Hide list page columns
|
|
3103
|
+
* For example: hiddenListColumns = [ListPageColumns.Author]
|
|
3070
3104
|
*
|
|
3071
|
-
*
|
|
3105
|
+
* **Note**: This option is available only in full app embedding.
|
|
3106
|
+
*
|
|
3107
|
+
* Supported embed types: `AppEmbed`
|
|
3108
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
|
|
3109
|
+
* @example
|
|
3110
|
+
* ```js
|
|
3111
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3112
|
+
* ... //other embed view config
|
|
3113
|
+
* hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
|
|
3114
|
+
* })
|
|
3115
|
+
* ```
|
|
3116
|
+
*/
|
|
3117
|
+
hiddenListColumns?: ListPageColumns[];
|
|
3118
|
+
/**
|
|
3119
|
+
* Hide the home page modules
|
|
3120
|
+
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
3121
|
+
*
|
|
3122
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
3123
|
+
* To access the updated modular homepage, set
|
|
3124
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3125
|
+
*
|
|
3126
|
+
* Supported embed types: `AppEmbed`
|
|
3127
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3128
|
+
* @example
|
|
3129
|
+
* ```js
|
|
3130
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3131
|
+
* ... //other embed view config
|
|
3132
|
+
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
3133
|
+
* })
|
|
3134
|
+
* ```
|
|
3135
|
+
*/
|
|
3136
|
+
hiddenHomepageModules?: HomepageModule[];
|
|
3137
|
+
/**
|
|
3138
|
+
* reordering the home page modules
|
|
3139
|
+
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
3140
|
+
*
|
|
3141
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
3142
|
+
* To access the updated modular homepage, set
|
|
3143
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3144
|
+
*
|
|
3145
|
+
* Supported embed types: `AppEmbed`
|
|
3146
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3147
|
+
* @example
|
|
3148
|
+
* ```js
|
|
3149
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3150
|
+
* ... //other embed view config
|
|
3151
|
+
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
3152
|
+
* })
|
|
3153
|
+
* ```
|
|
3154
|
+
*/
|
|
3155
|
+
reorderedHomepageModules?: HomepageModule[];
|
|
3156
|
+
/**
|
|
3157
|
+
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
3158
|
+
* There are 8 eight home navigation list items.
|
|
3159
|
+
* To hide these items, specify the string in the array.
|
|
3160
|
+
*
|
|
3161
|
+
* Supported embed types: `AppEmbed`
|
|
3162
|
+
* @example
|
|
3163
|
+
* ```js
|
|
3164
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3165
|
+
* ... //other embed view config
|
|
3166
|
+
* hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
|
|
3167
|
+
* })
|
|
3168
|
+
* ```
|
|
3169
|
+
*
|
|
3170
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
3171
|
+
* To access the updated modular homepage, set
|
|
3172
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3173
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3174
|
+
*/
|
|
3175
|
+
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
3176
|
+
}
|
|
3177
|
+
/**
|
|
3178
|
+
* The configuration object for common Search and Liveboard embeds configs.
|
|
3179
|
+
*/
|
|
3180
|
+
export interface SearchLiveboardCommonViewConfig {
|
|
3181
|
+
/**
|
|
3182
|
+
* The list of runtime filters to apply to a search Answer,
|
|
3183
|
+
* visualization, or Liveboard.
|
|
3184
|
+
*
|
|
3185
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
3186
|
+
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
3187
|
+
* @example
|
|
3188
|
+
* ```js
|
|
3189
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
3190
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3191
|
+
* ... // other embed view config
|
|
3192
|
+
* runtimeFilters: [
|
|
3193
|
+
* {
|
|
3194
|
+
* columnName: 'value',
|
|
3195
|
+
* operator: RuntimeFilterOp.EQ,
|
|
3196
|
+
* values: ['string' | 123 | true],
|
|
3197
|
+
* },
|
|
3198
|
+
* ],
|
|
3199
|
+
* })
|
|
3200
|
+
* ```
|
|
3201
|
+
*/
|
|
3202
|
+
runtimeFilters?: RuntimeFilter[];
|
|
3203
|
+
/**
|
|
3204
|
+
* The list of parameter override to apply to a search Answer,
|
|
3205
|
+
* visualization, or Liveboard.
|
|
3206
|
+
*
|
|
3207
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
3208
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3209
|
+
* @example
|
|
3210
|
+
* ```js
|
|
3211
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
3212
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3213
|
+
* ... // other embed view config
|
|
3214
|
+
* runtimeParameters: [
|
|
3215
|
+
* {
|
|
3216
|
+
* name: 'value',
|
|
3217
|
+
* value: 'string' | 123 | true,
|
|
3218
|
+
* },
|
|
3219
|
+
* ]
|
|
3220
|
+
* })
|
|
3221
|
+
* ```
|
|
3222
|
+
*/
|
|
3223
|
+
runtimeParameters?: RuntimeParameter[];
|
|
3224
|
+
/**
|
|
3225
|
+
* flag to set ContextMenu Trigger to either left or right click.
|
|
3226
|
+
*
|
|
3227
|
+
* Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
|
|
3228
|
+
* @example
|
|
3229
|
+
* ```js
|
|
3230
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
|
|
3231
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3232
|
+
* ... // other embed view config
|
|
3233
|
+
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
3234
|
+
* })
|
|
3235
|
+
* ```
|
|
3236
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3072
3237
|
*/
|
|
3073
|
-
|
|
3238
|
+
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
3074
3239
|
/**
|
|
3075
3240
|
* Boolean to exclude runtimeFilters in the URL
|
|
3076
3241
|
* By default it is true, this flag removes runtime filters from the URL
|
|
@@ -3083,241 +3248,230 @@ export interface ViewConfig {
|
|
|
3083
3248
|
*/
|
|
3084
3249
|
excludeRuntimeFiltersfromURL?: boolean;
|
|
3085
3250
|
/**
|
|
3086
|
-
*
|
|
3087
|
-
*
|
|
3088
|
-
*
|
|
3089
|
-
*
|
|
3090
|
-
*
|
|
3091
|
-
*
|
|
3092
|
-
*
|
|
3093
|
-
* hiddenTabs: [
|
|
3094
|
-
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3095
|
-
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
3096
|
-
* });
|
|
3097
|
-
* ```
|
|
3098
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
3251
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
3252
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
3253
|
+
*
|
|
3254
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
3255
|
+
* embedded view.
|
|
3256
|
+
* @default false
|
|
3257
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
3099
3258
|
*/
|
|
3100
|
-
|
|
3259
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
3101
3260
|
/**
|
|
3102
|
-
*
|
|
3103
|
-
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
3261
|
+
* To set the initial state of the search bar in case of saved Answers.
|
|
3104
3262
|
*
|
|
3105
|
-
*
|
|
3106
|
-
*
|
|
3107
|
-
*
|
|
3108
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3263
|
+
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
|
|
3264
|
+
* @default true
|
|
3265
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
3109
3266
|
* @example
|
|
3110
3267
|
* ```js
|
|
3111
|
-
*
|
|
3112
|
-
*
|
|
3113
|
-
*
|
|
3114
|
-
*
|
|
3115
|
-
*
|
|
3268
|
+
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
3269
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3270
|
+
* ... // other embed view config
|
|
3271
|
+
* collapseSearchBar: true,
|
|
3272
|
+
* });
|
|
3116
3273
|
*/
|
|
3117
|
-
|
|
3274
|
+
collapseSearchBar?: boolean;
|
|
3118
3275
|
/**
|
|
3119
|
-
*
|
|
3120
|
-
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
3276
|
+
* Flag to control Data panel experience
|
|
3121
3277
|
*
|
|
3122
|
-
*
|
|
3123
|
-
*
|
|
3124
|
-
*
|
|
3125
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3278
|
+
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
3279
|
+
* @default false
|
|
3280
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3126
3281
|
* @example
|
|
3127
3282
|
* ```js
|
|
3128
|
-
*
|
|
3129
|
-
*
|
|
3130
|
-
*
|
|
3283
|
+
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
3284
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3285
|
+
* ... // other embed view config
|
|
3286
|
+
* dataPanelV2: true,
|
|
3131
3287
|
* })
|
|
3132
3288
|
* ```
|
|
3133
3289
|
*/
|
|
3134
|
-
|
|
3290
|
+
dataPanelV2?: boolean;
|
|
3135
3291
|
/**
|
|
3136
|
-
*
|
|
3137
|
-
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
3292
|
+
* To enable custom column groups in data panel v2
|
|
3138
3293
|
*
|
|
3139
|
-
*
|
|
3140
|
-
* @version SDK: 1.
|
|
3294
|
+
* Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
3295
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3296
|
+
* @default false
|
|
3141
3297
|
* @example
|
|
3142
3298
|
* ```js
|
|
3143
|
-
*
|
|
3144
|
-
*
|
|
3145
|
-
*
|
|
3146
|
-
*
|
|
3147
|
-
*
|
|
3148
|
-
* ]
|
|
3149
|
-
* })
|
|
3299
|
+
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
|
|
3300
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3301
|
+
* ... // other embed view config
|
|
3302
|
+
* enableCustomColumnGroups: true,
|
|
3303
|
+
* });
|
|
3150
3304
|
* ```
|
|
3151
3305
|
*/
|
|
3152
|
-
|
|
3306
|
+
enableCustomColumnGroups?: boolean;
|
|
3307
|
+
}
|
|
3308
|
+
/**
|
|
3309
|
+
* The configuration object for common Liveboard and App embeds configs.
|
|
3310
|
+
*/
|
|
3311
|
+
export interface LiveboardAppEmbedViewConfig {
|
|
3153
3312
|
/**
|
|
3154
|
-
*
|
|
3155
|
-
*
|
|
3156
|
-
*
|
|
3313
|
+
* Show or hide Liveboard header
|
|
3314
|
+
*
|
|
3315
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3316
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3317
|
+
* @default false
|
|
3157
3318
|
* @example
|
|
3158
3319
|
* ```js
|
|
3159
|
-
*
|
|
3160
|
-
*
|
|
3161
|
-
*
|
|
3320
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3321
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3322
|
+
* ... // other embed view config
|
|
3323
|
+
* hideLiveboardHeader : true,
|
|
3162
3324
|
* })
|
|
3163
3325
|
* ```
|
|
3164
|
-
*
|
|
3165
|
-
* **Note**: This option does not apply to the classic homepage.
|
|
3166
|
-
* To access the updated modular homepage, set
|
|
3167
|
-
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3168
|
-
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3169
3326
|
*/
|
|
3170
|
-
|
|
3327
|
+
hideLiveboardHeader?: boolean;
|
|
3171
3328
|
/**
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3174
|
-
*
|
|
3329
|
+
* Show or hide Liveboard title
|
|
3330
|
+
*
|
|
3331
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3332
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3333
|
+
* @default false
|
|
3175
3334
|
* @example
|
|
3176
3335
|
* ```js
|
|
3177
|
-
*
|
|
3178
|
-
*
|
|
3179
|
-
*
|
|
3180
|
-
*
|
|
3181
|
-
*
|
|
3336
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3337
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3338
|
+
* ... // other embed view config
|
|
3339
|
+
* showLiveboardTitle:true,
|
|
3340
|
+
* })
|
|
3182
3341
|
* ```
|
|
3183
|
-
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
3184
3342
|
*/
|
|
3185
|
-
|
|
3343
|
+
showLiveboardTitle?: boolean;
|
|
3186
3344
|
/**
|
|
3187
|
-
*
|
|
3188
|
-
*
|
|
3189
|
-
*
|
|
3190
|
-
*
|
|
3191
|
-
* @type {boolean}
|
|
3345
|
+
* Show or hide Liveboard description
|
|
3346
|
+
*
|
|
3347
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3348
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3192
3349
|
* @default false
|
|
3193
|
-
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
3194
3350
|
* @example
|
|
3195
3351
|
* ```js
|
|
3196
|
-
* //
|
|
3197
|
-
* const
|
|
3198
|
-
*
|
|
3199
|
-
*
|
|
3200
|
-
*
|
|
3201
|
-
* // Instantiate an object with the configuration
|
|
3202
|
-
* const myComponent = new MyComponent(config);
|
|
3352
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3353
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3354
|
+
* ... // other embed view config
|
|
3355
|
+
* showLiveboardDescription:true,
|
|
3356
|
+
* })
|
|
3203
3357
|
* ```
|
|
3204
3358
|
*/
|
|
3205
|
-
|
|
3206
|
-
/**
|
|
3207
|
-
* For internal tracking of the embed component type.
|
|
3208
|
-
* @hidden
|
|
3209
|
-
*/
|
|
3210
|
-
embedComponentType?: string;
|
|
3359
|
+
showLiveboardDescription?: boolean;
|
|
3211
3360
|
/**
|
|
3212
|
-
* Boolean to
|
|
3213
|
-
* when set to true, this flag removes runtime parameters from the URL.
|
|
3361
|
+
* Boolean to control if Liveboard header is sticky or not.
|
|
3214
3362
|
*
|
|
3215
|
-
*
|
|
3216
|
-
* embedded view.
|
|
3217
|
-
* @default false
|
|
3218
|
-
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
3219
|
-
*/
|
|
3220
|
-
excludeRuntimeParametersfromURL?: boolean;
|
|
3221
|
-
/**
|
|
3222
|
-
* Enable the V2 shell. This can provide performance benefits
|
|
3223
|
-
* due to a lighterweight shell.
|
|
3363
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3224
3364
|
* @example
|
|
3225
3365
|
* ```js
|
|
3226
|
-
*
|
|
3227
|
-
*
|
|
3228
|
-
*
|
|
3366
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3367
|
+
* const embed = new <EmbedComponent>('#embed', {
|
|
3368
|
+
* ... // other app view config
|
|
3369
|
+
* isLiveboardHeaderSticky: true,
|
|
3229
3370
|
* });
|
|
3230
3371
|
* ```
|
|
3231
|
-
* @version SDK: 1.
|
|
3372
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3232
3373
|
*/
|
|
3233
|
-
|
|
3374
|
+
isLiveboardHeaderSticky?: boolean;
|
|
3234
3375
|
/**
|
|
3235
|
-
*
|
|
3236
|
-
*
|
|
3237
|
-
*
|
|
3376
|
+
* This attribute can be used to enable the two-column layout on an embedded Liveboard
|
|
3377
|
+
*
|
|
3378
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3379
|
+
* @type {boolean}
|
|
3380
|
+
* @default false
|
|
3381
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
3238
3382
|
* @example
|
|
3239
3383
|
* ```js
|
|
3240
|
-
*
|
|
3241
|
-
*
|
|
3242
|
-
*
|
|
3243
|
-
*
|
|
3384
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3385
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3386
|
+
* ... // other embed view config
|
|
3387
|
+
* enable2ColumnLayout: true,
|
|
3388
|
+
* })
|
|
3389
|
+
* ```
|
|
3244
3390
|
*/
|
|
3245
|
-
|
|
3391
|
+
enable2ColumnLayout?: boolean;
|
|
3246
3392
|
/**
|
|
3247
|
-
* This flag can be used to
|
|
3393
|
+
* This flag can be used to enable the compact header in Liveboard
|
|
3394
|
+
*
|
|
3395
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3396
|
+
* @type {boolean}
|
|
3248
3397
|
* @default false
|
|
3249
|
-
* @version SDK: 1.
|
|
3250
|
-
*/
|
|
3251
|
-
exposeTranslationIDs?: boolean;
|
|
3252
|
-
/**
|
|
3253
|
-
* This flag can be used to disable links inside the embedded app,
|
|
3254
|
-
* and disable redirection of links in a new tab.
|
|
3398
|
+
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
3255
3399
|
* @example
|
|
3256
3400
|
* ```js
|
|
3257
|
-
*
|
|
3258
|
-
*
|
|
3259
|
-
*
|
|
3401
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3402
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3403
|
+
* ... // other embed view config
|
|
3404
|
+
* isLiveboardCompactHeaderEnabled: true,
|
|
3405
|
+
* })
|
|
3260
3406
|
* ```
|
|
3261
|
-
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
3262
3407
|
*/
|
|
3263
|
-
|
|
3408
|
+
isLiveboardCompactHeaderEnabled?: boolean;
|
|
3264
3409
|
/**
|
|
3265
|
-
*
|
|
3266
|
-
*
|
|
3267
|
-
*
|
|
3410
|
+
* This flag can be used to show or hide the Liveboard verified icon in the compact header.
|
|
3411
|
+
*
|
|
3412
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3413
|
+
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
3414
|
+
* @default true
|
|
3268
3415
|
* @example
|
|
3269
3416
|
* ```js
|
|
3270
|
-
*
|
|
3271
|
-
*
|
|
3272
|
-
*
|
|
3417
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3418
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3419
|
+
* ... // other embed view config
|
|
3420
|
+
* showLiveboardVerifiedBadge: true,
|
|
3273
3421
|
* })
|
|
3274
3422
|
* ```
|
|
3275
3423
|
*/
|
|
3276
|
-
|
|
3424
|
+
showLiveboardVerifiedBadge?: boolean;
|
|
3277
3425
|
/**
|
|
3278
|
-
*
|
|
3279
|
-
*
|
|
3426
|
+
* This flag is used to enable/disable hide irrelevant filters in Liveboard tab
|
|
3427
|
+
*
|
|
3428
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3429
|
+
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
|
|
3280
3430
|
* @default false
|
|
3281
3431
|
* @example
|
|
3282
3432
|
* ```js
|
|
3283
|
-
*
|
|
3284
|
-
*
|
|
3285
|
-
*
|
|
3286
|
-
*
|
|
3433
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3434
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3435
|
+
* ... // other embed view config
|
|
3436
|
+
* hideIrrelevantChipsInLiveboardTabs: true,
|
|
3437
|
+
* })
|
|
3287
3438
|
* ```
|
|
3288
3439
|
*/
|
|
3289
|
-
|
|
3440
|
+
hideIrrelevantChipsInLiveboardTabs?: boolean;
|
|
3290
3441
|
/**
|
|
3291
|
-
*
|
|
3292
|
-
*
|
|
3293
|
-
*
|
|
3294
|
-
*
|
|
3295
|
-
*
|
|
3442
|
+
* This flag can be used to show or hide the re-verify banner on the Liveboard compact header
|
|
3443
|
+
*
|
|
3444
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3445
|
+
* @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
|
|
3446
|
+
* @default true
|
|
3296
3447
|
* @example
|
|
3297
3448
|
* ```js
|
|
3298
|
-
*
|
|
3299
|
-
*
|
|
3300
|
-
*
|
|
3301
|
-
*
|
|
3449
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3450
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3451
|
+
* ... // other embed view config
|
|
3452
|
+
* showLiveboardReverifyBanner: true,
|
|
3453
|
+
* })
|
|
3302
3454
|
* ```
|
|
3303
|
-
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
3304
3455
|
*/
|
|
3305
|
-
|
|
3456
|
+
showLiveboardReverifyBanner?: boolean;
|
|
3306
3457
|
/**
|
|
3307
|
-
*
|
|
3308
|
-
* For example: hiddenListColumns = [ListPageColumns.Author]
|
|
3458
|
+
* enable or disable ask sage
|
|
3309
3459
|
*
|
|
3310
|
-
*
|
|
3311
|
-
* @version SDK: 1.
|
|
3460
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3461
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
3462
|
+
* @default false
|
|
3312
3463
|
* @example
|
|
3313
3464
|
* ```js
|
|
3314
|
-
*
|
|
3315
|
-
*
|
|
3316
|
-
*
|
|
3465
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed
|
|
3466
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3467
|
+
* ... // other embed view config
|
|
3468
|
+
* enableAskSage:true,
|
|
3317
3469
|
* })
|
|
3318
3470
|
* ```
|
|
3319
3471
|
*/
|
|
3320
|
-
|
|
3472
|
+
enableAskSage?: boolean;
|
|
3473
|
+
}
|
|
3474
|
+
export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
|
|
3321
3475
|
}
|
|
3322
3476
|
/**
|
|
3323
3477
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -3710,7 +3864,7 @@ export declare enum EmbedEvent {
|
|
|
3710
3864
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
3711
3865
|
* @example
|
|
3712
3866
|
* ```js
|
|
3713
|
-
*
|
|
3867
|
+
* LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
|
|
3714
3868
|
* console.log('VizPointDoubleClick', payload);
|
|
3715
3869
|
* })
|
|
3716
3870
|
* ```
|
|
@@ -4569,7 +4723,13 @@ export declare enum EmbedEvent {
|
|
|
4569
4723
|
* Emitted when a user creates a Model.
|
|
4570
4724
|
* @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
|
|
4571
4725
|
*/
|
|
4572
|
-
CreateModel = "createModel"
|
|
4726
|
+
CreateModel = "createModel",
|
|
4727
|
+
/**
|
|
4728
|
+
* @hidden
|
|
4729
|
+
* Emitted when a user exits present mode.
|
|
4730
|
+
* @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
|
|
4731
|
+
*/
|
|
4732
|
+
ExitPresentMode = "exitPresentMode"
|
|
4573
4733
|
}
|
|
4574
4734
|
/**
|
|
4575
4735
|
* Event types that can be triggered by the host application
|
|
@@ -5641,7 +5801,17 @@ export declare enum HostEvent {
|
|
|
5641
5801
|
* ```
|
|
5642
5802
|
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
5643
5803
|
*/
|
|
5644
|
-
TransformTableVizData = "TransformTableVizData"
|
|
5804
|
+
TransformTableVizData = "TransformTableVizData",
|
|
5805
|
+
/**
|
|
5806
|
+
* @hidden
|
|
5807
|
+
* Trigger exit from presentation mode when user exits fullscreen.
|
|
5808
|
+
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
5809
|
+
* ```js
|
|
5810
|
+
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
5811
|
+
*```
|
|
5812
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5813
|
+
*/
|
|
5814
|
+
ExitPresentMode = "exitPresentMode"
|
|
5645
5815
|
}
|
|
5646
5816
|
/**
|
|
5647
5817
|
* The different visual modes that the data sources panel within
|
|
@@ -5773,7 +5943,8 @@ export declare enum Param {
|
|
|
5773
5943
|
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5774
5944
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
5775
5945
|
PrimaryAction = "primaryAction",
|
|
5776
|
-
isSpotterAgentEmbed = "isSpotterAgentEmbed"
|
|
5946
|
+
isSpotterAgentEmbed = "isSpotterAgentEmbed",
|
|
5947
|
+
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
|
|
5777
5948
|
}
|
|
5778
5949
|
/**
|
|
5779
5950
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5784,8 +5955,8 @@ export declare enum Param {
|
|
|
5784
5955
|
* or `hiddenActions` array.
|
|
5785
5956
|
* @example
|
|
5786
5957
|
* ```js
|
|
5787
|
-
* const embed = new LiveboardEmbed('#
|
|
5788
|
-
* ... //
|
|
5958
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
5959
|
+
* ... //other embed view config
|
|
5789
5960
|
* visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
|
|
5790
5961
|
* disabledActions: [Action.Download],
|
|
5791
5962
|
* //hiddenActions: [], // Set either this or visibleActions
|
|
@@ -5793,8 +5964,8 @@ export declare enum Param {
|
|
|
5793
5964
|
* ```
|
|
5794
5965
|
* @example
|
|
5795
5966
|
* ```js
|
|
5796
|
-
* const embed = new LiveboardEmbed('#
|
|
5797
|
-
* ... //
|
|
5967
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
5968
|
+
* ... //other embed view config
|
|
5798
5969
|
* //visibleActions: [],
|
|
5799
5970
|
* disabledActions: [Action.Download],
|
|
5800
5971
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
@@ -7066,7 +7237,7 @@ export declare enum LogLevel {
|
|
|
7066
7237
|
* @example
|
|
7067
7238
|
* ```js
|
|
7068
7239
|
* init({
|
|
7069
|
-
* ... //
|
|
7240
|
+
* ... //other embed view config,
|
|
7070
7241
|
* logLevel: LogLevel.SILENT,
|
|
7071
7242
|
* })
|
|
7072
7243
|
* ```
|
|
@@ -7078,7 +7249,7 @@ export declare enum LogLevel {
|
|
|
7078
7249
|
* @example
|
|
7079
7250
|
* ```js
|
|
7080
7251
|
* init({
|
|
7081
|
-
* ... //
|
|
7252
|
+
* ... //other embed view config,
|
|
7082
7253
|
* logLevel: LogLevel.ERROR,
|
|
7083
7254
|
* })
|
|
7084
7255
|
* ```
|
|
@@ -7090,7 +7261,7 @@ export declare enum LogLevel {
|
|
|
7090
7261
|
* @example
|
|
7091
7262
|
* ```js
|
|
7092
7263
|
* init({
|
|
7093
|
-
* ... //
|
|
7264
|
+
* ... //other embed view config,
|
|
7094
7265
|
* logLevel: LogLevel.WARN,
|
|
7095
7266
|
* })
|
|
7096
7267
|
* ```
|
|
@@ -7103,7 +7274,7 @@ export declare enum LogLevel {
|
|
|
7103
7274
|
* @example
|
|
7104
7275
|
* ```js
|
|
7105
7276
|
* init({
|
|
7106
|
-
* ... //
|
|
7277
|
+
* ... //other embed view config,
|
|
7107
7278
|
* logLevel: LogLevel.INFO,
|
|
7108
7279
|
* })
|
|
7109
7280
|
* ```
|
|
@@ -7116,7 +7287,7 @@ export declare enum LogLevel {
|
|
|
7116
7287
|
* @example
|
|
7117
7288
|
* ```js
|
|
7118
7289
|
* init({
|
|
7119
|
-
* ... //
|
|
7290
|
+
* ... //other embed view config,
|
|
7120
7291
|
* logLevel: LogLevel.DEBUG,
|
|
7121
7292
|
* })
|
|
7122
7293
|
* ```
|
|
@@ -7128,7 +7299,7 @@ export declare enum LogLevel {
|
|
|
7128
7299
|
* @example
|
|
7129
7300
|
* ```js
|
|
7130
7301
|
* init({
|
|
7131
|
-
* ... //
|
|
7302
|
+
* ... //other embed view config,
|
|
7132
7303
|
* logLevel: LogLevel.TRACE,
|
|
7133
7304
|
* })
|
|
7134
7305
|
* ```
|
|
@@ -7149,14 +7320,16 @@ export interface DefaultAppInitData {
|
|
|
7149
7320
|
hiddenListColumns: ListPageColumns[];
|
|
7150
7321
|
}
|
|
7151
7322
|
|
|
7323
|
+
interface EmbedViewConfig extends AllEmbedViewConfig, EmbedEventHandlers {
|
|
7324
|
+
}
|
|
7152
7325
|
export type EmbedEventHandlers = {
|
|
7153
7326
|
[key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
|
|
7154
7327
|
};
|
|
7155
|
-
export interface EmbedProps extends
|
|
7328
|
+
export interface EmbedProps extends EmbedViewConfig {
|
|
7156
7329
|
className?: string;
|
|
7157
7330
|
style?: React.CSSProperties;
|
|
7158
7331
|
}
|
|
7159
|
-
export interface ViewConfigAndListeners<T extends
|
|
7332
|
+
export interface ViewConfigAndListeners<T extends EmbedViewConfig> {
|
|
7160
7333
|
viewConfig: T;
|
|
7161
7334
|
listeners: {
|
|
7162
7335
|
[key in EmbedEvent]?: MessageCallback;
|
|
@@ -7166,7 +7339,8 @@ export interface ViewConfigAndListeners<T extends ViewConfig> {
|
|
|
7166
7339
|
*
|
|
7167
7340
|
* @param props
|
|
7168
7341
|
*/
|
|
7169
|
-
export function getViewPropsAndListeners<T extends EmbedProps, U extends
|
|
7342
|
+
export function getViewPropsAndListeners<T extends EmbedProps, U extends EmbedViewConfig>(props: T): ViewConfigAndListeners<U>;
|
|
7343
|
+
export {};
|
|
7170
7344
|
|
|
7171
7345
|
/**
|
|
7172
7346
|
* Configuration for search options
|
|
@@ -7181,9 +7355,9 @@ export interface SearchOptions {
|
|
|
7181
7355
|
* The configuration for the embedded spotterEmbed options.
|
|
7182
7356
|
* @group Embed components
|
|
7183
7357
|
*/
|
|
7184
|
-
export interface SpotterEmbedViewConfig extends
|
|
7358
|
+
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
7185
7359
|
/**
|
|
7186
|
-
* The ID of the
|
|
7360
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
|
|
7187
7361
|
*/
|
|
7188
7362
|
worksheetId: string;
|
|
7189
7363
|
/**
|
|
@@ -7193,10 +7367,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
|
|
|
7193
7367
|
/**
|
|
7194
7368
|
* disableSourceSelection : Disables data source selection
|
|
7195
7369
|
* but still display the selected data source.
|
|
7370
|
+
*
|
|
7371
|
+
* Supported embed types: `SpotterEmbed`
|
|
7196
7372
|
* @example
|
|
7197
7373
|
* ```js
|
|
7198
7374
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7199
|
-
* ... //
|
|
7375
|
+
* ... //other embed view config
|
|
7200
7376
|
* disableSourceSelection : true,
|
|
7201
7377
|
* })
|
|
7202
7378
|
* ```
|
|
@@ -7205,10 +7381,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
|
|
|
7205
7381
|
disableSourceSelection?: boolean;
|
|
7206
7382
|
/**
|
|
7207
7383
|
* hideSourceSelection : Hide data source selection
|
|
7384
|
+
*
|
|
7385
|
+
* Supported embed types: `SpotterEmbed`
|
|
7208
7386
|
* @example
|
|
7209
7387
|
* ```js
|
|
7210
7388
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7211
|
-
* ... //
|
|
7389
|
+
* ... //other embed view config
|
|
7212
7390
|
* hideSourceSelection : true,
|
|
7213
7391
|
* })
|
|
7214
7392
|
* ```
|
|
@@ -7217,12 +7395,15 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
|
|
|
7217
7395
|
hideSourceSelection?: boolean;
|
|
7218
7396
|
/**
|
|
7219
7397
|
* Flag to control Data panel experience
|
|
7398
|
+
*
|
|
7399
|
+
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
7220
7400
|
* @default false
|
|
7221
7401
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
|
|
7222
7402
|
* @example
|
|
7223
7403
|
* ```js
|
|
7224
|
-
*
|
|
7225
|
-
*
|
|
7404
|
+
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
7405
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
7406
|
+
* ... // other embed view config
|
|
7226
7407
|
* dataPanelV2: true,
|
|
7227
7408
|
* })
|
|
7228
7409
|
* ```
|
|
@@ -7232,10 +7413,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
|
|
|
7232
7413
|
* showSpotterLimitations : show limitation text
|
|
7233
7414
|
* of the spotter underneath the chat input.
|
|
7234
7415
|
* default is false.
|
|
7416
|
+
*
|
|
7417
|
+
* Supported embed types: `SpotterEmbed`
|
|
7235
7418
|
* @example
|
|
7236
7419
|
* ```js
|
|
7237
7420
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7238
|
-
* ... //
|
|
7421
|
+
* ... //other embed view config
|
|
7239
7422
|
* showSpotterLimitations : true,
|
|
7240
7423
|
* })
|
|
7241
7424
|
* ```
|
|
@@ -7245,10 +7428,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
|
|
|
7245
7428
|
/**
|
|
7246
7429
|
* hideSampleQuestions : Hide sample questions on
|
|
7247
7430
|
* the initial screen of the conversation.
|
|
7431
|
+
*
|
|
7432
|
+
* Supported embed types: `SpotterEmbed`
|
|
7248
7433
|
* @example
|
|
7249
7434
|
* ```js
|
|
7250
7435
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7251
|
-
* ... //
|
|
7436
|
+
* ... //other embed view config
|
|
7252
7437
|
* hideSampleQuestions : true,
|
|
7253
7438
|
* })
|
|
7254
7439
|
* ```
|
|
@@ -7258,7 +7443,7 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
|
|
|
7258
7443
|
}
|
|
7259
7444
|
/**
|
|
7260
7445
|
* The configuration for the embedded spotterEmbed options.
|
|
7261
|
-
* @deprecated from SDK: 1.
|
|
7446
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
7262
7447
|
* Use {@link SpotterEmbedViewConfig} instead
|
|
7263
7448
|
* @group Embed components
|
|
7264
7449
|
*/
|
|
@@ -7287,7 +7472,7 @@ export declare class SpotterEmbed extends TsEmbed {
|
|
|
7287
7472
|
}
|
|
7288
7473
|
/**
|
|
7289
7474
|
* Embed ThoughtSpot AI Conversation.
|
|
7290
|
-
* @deprecated from SDK: 1.
|
|
7475
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
7291
7476
|
* Use {@link SpotterEmbed} instead
|
|
7292
7477
|
* @group Embed components
|
|
7293
7478
|
* @example
|
|
@@ -7315,7 +7500,7 @@ export declare class ConversationEmbed extends SpotterEmbed {
|
|
|
7315
7500
|
* @summary ThoughtSpot Visual Embed SDK
|
|
7316
7501
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
7317
7502
|
*/
|
|
7318
|
-
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
|
|
7503
|
+
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
|
|
7319
7504
|
|
|
7320
7505
|
/**
|
|
7321
7506
|
* Copyright (c) 2022
|
|
@@ -7360,7 +7545,11 @@ export declare class TsEmbed {
|
|
|
7360
7545
|
* @param {HTMLIFrameElement} iFrame HTMLIFrameElement
|
|
7361
7546
|
*/
|
|
7362
7547
|
protected setIframeElement(iFrame: HTMLIFrameElement): void;
|
|
7363
|
-
protected viewConfig: ViewConfig
|
|
7548
|
+
protected viewConfig: ViewConfig & {
|
|
7549
|
+
visibleTabs?: string[];
|
|
7550
|
+
hiddenTabs?: string[];
|
|
7551
|
+
showAlerts?: boolean;
|
|
7552
|
+
};
|
|
7364
7553
|
protected embedConfig: EmbedConfig;
|
|
7365
7554
|
/**
|
|
7366
7555
|
* The ThoughtSpot hostname or IP address
|
|
@@ -8120,12 +8309,13 @@ export interface UnderlyingDataPoint {
|
|
|
8120
8309
|
* directly from your application.
|
|
8121
8310
|
*
|
|
8122
8311
|
* You can use this service to:
|
|
8312
|
+
*
|
|
8123
8313
|
* - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
|
|
8124
8314
|
* - Apply filters to Answers (`addFilter`)
|
|
8125
8315
|
* - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
|
|
8126
8316
|
* - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
|
|
8127
8317
|
* - Run custom queries (`executeQuery`)
|
|
8128
|
-
* - Add visualizations to
|
|
8318
|
+
* - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
|
|
8129
8319
|
*
|
|
8130
8320
|
* @example
|
|
8131
8321
|
* ```js
|