@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.2-alpha.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 +13 -13
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +2 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +18 -8
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +64 -6
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +9 -1
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +130 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +49 -4
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +49 -4
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +2 -19
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +3 -5
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +12 -11
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +10 -10
- package/cjs/src/embed/search.d.ts +4 -4
- package/cjs/src/embed/ts-embed.d.ts +5 -0
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +16 -1
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +164 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +41 -8
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +23 -6
- package/cjs/src/types.js.map +1 -1
- package/dist/{index-sSREbWM-.js → index-CmEQfuE3.js} +1 -1
- package/dist/index-DeFzsyFF.js +7371 -0
- package/dist/index-Dpf0rd6w.js +7371 -0
- package/dist/index-UuEbsISo.js +7447 -0
- package/dist/src/embed/app.d.ts +13 -13
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +64 -6
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +49 -4
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +2 -19
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +10 -10
- package/dist/src/embed/search.d.ts +4 -4
- package/dist/src/embed/ts-embed.d.ts +5 -0
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +41 -8
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +105 -21
- package/dist/tsembed-react.js +104 -20
- package/dist/tsembed.es.js +105 -21
- package/dist/tsembed.js +104 -20
- package/dist/visual-embed-sdk-react-full.d.ts +182 -63
- package/dist/visual-embed-sdk-react.d.ts +182 -63
- package/dist/visual-embed-sdk.d.ts +182 -63
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +13 -13
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +2 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +19 -9
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +64 -6
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +10 -2
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +133 -3
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +49 -4
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +49 -4
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +2 -19
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +3 -5
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +12 -11
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +10 -10
- package/lib/src/embed/search.d.ts +4 -4
- package/lib/src/embed/ts-embed.d.ts +5 -0
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +16 -1
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +164 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +41 -8
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +23 -6
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +183 -64
- package/package.json +1 -1
- package/src/embed/app.spec.ts +36 -23
- package/src/embed/app.ts +15 -13
- package/src/embed/conversation.spec.ts +170 -6
- package/src/embed/conversation.ts +86 -14
- package/src/embed/embedConfig.ts +50 -5
- package/src/embed/liveboard.spec.ts +5 -4
- package/src/embed/liveboard.ts +4 -24
- package/src/embed/sage.ts +10 -10
- package/src/embed/search.ts +4 -4
- package/src/embed/ts-embed.spec.ts +225 -0
- package/src/embed/ts-embed.ts +19 -0
- package/src/types.ts +82 -49
|
@@ -652,39 +652,39 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
652
652
|
showObjectResults?: boolean;
|
|
653
653
|
/**
|
|
654
654
|
* flag used by the TS product tour page to show the blue search bar
|
|
655
|
-
* even after the search is completed. This is different from
|
|
655
|
+
* even after the search is completed. This is different from ThoughtSpot Embedded
|
|
656
656
|
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
657
657
|
* The Sample questions container is collapsed when this value is set after
|
|
658
658
|
* does a search.
|
|
659
|
-
* @version SDK: 1.26.0 |
|
|
659
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
|
|
660
660
|
* @hidden
|
|
661
661
|
*/
|
|
662
662
|
isProductTour?: boolean;
|
|
663
663
|
/**
|
|
664
664
|
* Show or hide the search bar title.
|
|
665
|
-
* @version SDK: 1.29.0 |
|
|
666
|
-
* @deprecated
|
|
665
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
666
|
+
* @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
667
667
|
*/
|
|
668
668
|
hideSearchBarTitle?: boolean;
|
|
669
669
|
/**
|
|
670
670
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
671
671
|
* at the top of the Answer page.
|
|
672
|
-
* @version SDK: 1.26.0 |
|
|
672
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
|
|
673
673
|
*/
|
|
674
674
|
hideSageAnswerHeader?: boolean;
|
|
675
675
|
/**
|
|
676
676
|
* Disable the worksheet selection option.
|
|
677
|
-
* @version SDK: 1.26.0 |
|
|
677
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
678
678
|
*/
|
|
679
679
|
disableWorksheetChange?: boolean;
|
|
680
680
|
/**
|
|
681
681
|
* Hide the worksheet selection panel.
|
|
682
|
-
* @version SDK: 1.26.0 |
|
|
682
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
683
683
|
*/
|
|
684
684
|
hideWorksheetSelector?: boolean;
|
|
685
685
|
/**
|
|
686
686
|
* Show or hide autocomplete suggestions for the search query string.
|
|
687
|
-
* @version SDK: 1.26.0 |
|
|
687
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
688
688
|
*/
|
|
689
689
|
hideAutocompleteSuggestions?: boolean;
|
|
690
690
|
/**
|
|
@@ -700,7 +700,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
700
700
|
* selected for the search operation.
|
|
701
701
|
*
|
|
702
702
|
* Supported embed types: `SageEmbed`
|
|
703
|
-
* @version SDK: 1.26.0 |
|
|
703
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
704
704
|
* @example
|
|
705
705
|
* ```js
|
|
706
706
|
* const embed = new SageEmbed('#tsEmbed', {
|
|
@@ -733,7 +733,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
733
733
|
* executeSearch: true,
|
|
734
734
|
* }
|
|
735
735
|
* ```
|
|
736
|
-
* @version SDK: 1.26.0 |
|
|
736
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
737
737
|
*/
|
|
738
738
|
searchOptions?: SearchOptions;
|
|
739
739
|
}
|
|
@@ -1019,7 +1019,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1019
1019
|
/**
|
|
1020
1020
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1021
1021
|
* @default false
|
|
1022
|
-
* @version SDK: 1.32.0 |
|
|
1022
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1023
1023
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
1024
1024
|
*/
|
|
1025
1025
|
collapseSearchBarInitially?: boolean;
|
|
@@ -1027,7 +1027,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1027
1027
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1028
1028
|
*
|
|
1029
1029
|
* Supported embed types: `SearchEmbed`
|
|
1030
|
-
* @version: SDK: 1.29.0 |
|
|
1030
|
+
* @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1031
1031
|
*/
|
|
1032
1032
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1033
1033
|
/**
|
|
@@ -1039,7 +1039,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1039
1039
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1040
1040
|
*
|
|
1041
1041
|
* Supported embed types: `SearchEmbed`
|
|
1042
|
-
* @version SDK: 1.32.0 |
|
|
1042
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1043
1043
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1044
1044
|
* @example
|
|
1045
1045
|
* ```js
|
|
@@ -1056,7 +1056,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1056
1056
|
* lands on search embed page.
|
|
1057
1057
|
*
|
|
1058
1058
|
* Supported embed types: `SearchEmbed`
|
|
1059
|
-
* @version SDK: 1.32.0 |
|
|
1059
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl
|
|
1060
1060
|
* @default true
|
|
1061
1061
|
* @example
|
|
1062
1062
|
* ```js
|
|
@@ -1220,7 +1220,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1220
1220
|
*
|
|
1221
1221
|
* Supported embed types: `AppEmbed`
|
|
1222
1222
|
* @default true
|
|
1223
|
-
* @version SDK: 1.2.0 |
|
|
1223
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
1224
1224
|
* @example
|
|
1225
1225
|
* ```js
|
|
1226
1226
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1242,7 +1242,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1242
1242
|
*
|
|
1243
1243
|
* Supported embed types: `AppEmbed`
|
|
1244
1244
|
* @default false
|
|
1245
|
-
* @version SDK: 1.28.0 |
|
|
1245
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1246
1246
|
* @example
|
|
1247
1247
|
* ```js
|
|
1248
1248
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1258,7 +1258,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1258
1258
|
*
|
|
1259
1259
|
* Supported embed types: `AppEmbed`
|
|
1260
1260
|
* @default false
|
|
1261
|
-
* @version SDK: 1.2.0 |
|
|
1261
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
1262
1262
|
* @example
|
|
1263
1263
|
* ```js
|
|
1264
1264
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1341,7 +1341,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1341
1341
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1342
1342
|
*
|
|
1343
1343
|
* Supported embed types: `AppEmbed`
|
|
1344
|
-
* @version SDK: 1.28.0 |
|
|
1344
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1345
1345
|
* @default false
|
|
1346
1346
|
* @example
|
|
1347
1347
|
* ```js
|
|
@@ -1361,7 +1361,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1361
1361
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1362
1362
|
*
|
|
1363
1363
|
* Supported embed types: `AppEmbed`
|
|
1364
|
-
* @version SDK: 1.28.0 |
|
|
1364
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1365
1365
|
* @default true
|
|
1366
1366
|
* @example
|
|
1367
1367
|
* ```js
|
|
@@ -1382,7 +1382,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1382
1382
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
1383
1383
|
*
|
|
1384
1384
|
* Supported embed types: `AppEmbed`
|
|
1385
|
-
* @version SDK: 1.1.0 |
|
|
1385
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1386
1386
|
* @example
|
|
1387
1387
|
* ```js
|
|
1388
1388
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1400,7 +1400,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1400
1400
|
* path within the app, use the `path` attribute which is more flexible.
|
|
1401
1401
|
*
|
|
1402
1402
|
* Supported embed types: `AppEmbed`
|
|
1403
|
-
* @version SDK: 1.1.0 |
|
|
1403
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1404
1404
|
* @example
|
|
1405
1405
|
* ```js
|
|
1406
1406
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1416,7 +1416,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1416
1416
|
* tag.
|
|
1417
1417
|
*
|
|
1418
1418
|
* Supported embed types: `AppEmbed`
|
|
1419
|
-
* @version SDK: 1.1.0 |
|
|
1419
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1420
1420
|
* @example
|
|
1421
1421
|
* ```js
|
|
1422
1422
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1495,7 +1495,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1495
1495
|
*
|
|
1496
1496
|
* Supported embed types: `AppEmbed`
|
|
1497
1497
|
* @default false
|
|
1498
|
-
* @version SDK: 1.28.0 |
|
|
1498
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1499
1499
|
* @example
|
|
1500
1500
|
* ```js
|
|
1501
1501
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1525,7 +1525,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1525
1525
|
discoveryExperience?: DiscoveryExperience;
|
|
1526
1526
|
/**
|
|
1527
1527
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1528
|
-
* @version SDK: 1.32.0 |
|
|
1528
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1529
1529
|
* @default false
|
|
1530
1530
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
1531
1531
|
*/
|
|
@@ -1539,7 +1539,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1539
1539
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1540
1540
|
*
|
|
1541
1541
|
* Supported embed types: `AppEmbed`
|
|
1542
|
-
* @version SDK: 1.32.0 |
|
|
1542
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1543
1543
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1544
1544
|
* @example
|
|
1545
1545
|
* ```js
|
|
@@ -1553,14 +1553,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1553
1553
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1554
1554
|
/**
|
|
1555
1555
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
1556
|
-
* @version SDK : 1.29.0 |
|
|
1556
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1557
1557
|
*/
|
|
1558
1558
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1559
1559
|
/**
|
|
1560
1560
|
* Flag to use home page search bar mode
|
|
1561
1561
|
*
|
|
1562
1562
|
* Supported embed types: `AppEmbed`
|
|
1563
|
-
* @version SDK : 1.33.0 |
|
|
1563
|
+
* @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
1564
1564
|
*/
|
|
1565
1565
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
1566
1566
|
/**
|
|
@@ -1825,7 +1825,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1825
1825
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1826
1826
|
*
|
|
1827
1827
|
* Supported embed types: `LiveboardEmbed`
|
|
1828
|
-
* @version SDK: 1.25.0 |
|
|
1828
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1829
1829
|
* @example
|
|
1830
1830
|
* ```js
|
|
1831
1831
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1900,23 +1900,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1900
1900
|
* })
|
|
1901
1901
|
*/
|
|
1902
1902
|
dataSourceId?: string;
|
|
1903
|
-
/**
|
|
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`
|
|
1911
|
-
* @example
|
|
1912
|
-
* ```js
|
|
1913
|
-
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1914
|
-
* ... //other embed view config
|
|
1915
|
-
* coverAndFilterOptionInPDF: false,
|
|
1916
|
-
* })
|
|
1917
|
-
* ```
|
|
1918
|
-
*/
|
|
1919
|
-
coverAndFilterOptionInPDF?: boolean;
|
|
1920
1903
|
/**
|
|
1921
1904
|
* The list of tab IDs to hide from the embedded.
|
|
1922
1905
|
* This Tabs will be hidden from their respective LBs.
|
|
@@ -2014,7 +1997,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
2014
1997
|
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
2015
1998
|
/**
|
|
2016
1999
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
2017
|
-
* this Liveboard inside the full
|
|
2000
|
+
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
2018
2001
|
* @returns url string
|
|
2019
2002
|
*/
|
|
2020
2003
|
getLiveboardUrl(): string;
|
|
@@ -2383,7 +2366,7 @@ export interface CustomStyles {
|
|
|
2383
2366
|
* Configuration to define the customization on the Embedded
|
|
2384
2367
|
* ThoughtSpot components.
|
|
2385
2368
|
* You can customize styles, text strings, and icons.
|
|
2386
|
-
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2369
|
+
* For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework].
|
|
2387
2370
|
* @example
|
|
2388
2371
|
* ```js
|
|
2389
2372
|
* init({
|
|
@@ -3470,6 +3453,22 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3470
3453
|
* ```
|
|
3471
3454
|
*/
|
|
3472
3455
|
enableAskSage?: boolean;
|
|
3456
|
+
/**
|
|
3457
|
+
* This flag is used to show or hide checkboxes for including or excluding
|
|
3458
|
+
* the cover and filters pages in the Liveboard PDF.
|
|
3459
|
+
*
|
|
3460
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3461
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
3462
|
+
* @example
|
|
3463
|
+
* ```js
|
|
3464
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3465
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3466
|
+
* ... // other embed view config
|
|
3467
|
+
* coverAndFilterOptionInPDF: false,
|
|
3468
|
+
* })
|
|
3469
|
+
* ```
|
|
3470
|
+
*/
|
|
3471
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
3473
3472
|
}
|
|
3474
3473
|
export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
|
|
3475
3474
|
}
|
|
@@ -4613,7 +4612,7 @@ export declare enum EmbedEvent {
|
|
|
4613
4612
|
*
|
|
4614
4613
|
* error: Developers can customize the error message text when `execute`
|
|
4615
4614
|
* returns `false` using the error parameter in responder.
|
|
4616
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
4615
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4617
4616
|
* @example
|
|
4618
4617
|
*```js
|
|
4619
4618
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4660,7 +4659,7 @@ export declare enum EmbedEvent {
|
|
|
4660
4659
|
* console.log('payload', payload);
|
|
4661
4660
|
* })
|
|
4662
4661
|
*```
|
|
4663
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
4662
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4664
4663
|
*/
|
|
4665
4664
|
ParameterChanged = "parameterChanged",
|
|
4666
4665
|
/**
|
|
@@ -4716,18 +4715,18 @@ export declare enum EmbedEvent {
|
|
|
4716
4715
|
* console.log('payload', payload);
|
|
4717
4716
|
* })
|
|
4718
4717
|
*```
|
|
4719
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
4718
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4720
4719
|
*/
|
|
4721
4720
|
CreateLiveboard = "createLiveboard",
|
|
4722
4721
|
/**
|
|
4723
4722
|
* Emitted when a user creates a Model.
|
|
4724
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
4723
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4725
4724
|
*/
|
|
4726
4725
|
CreateModel = "createModel",
|
|
4727
4726
|
/**
|
|
4728
4727
|
* @hidden
|
|
4729
4728
|
* Emitted when a user exits present mode.
|
|
4730
|
-
* @version SDK : 1.40.0 | ThoughtSpot
|
|
4729
|
+
* @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4731
4730
|
*/
|
|
4732
4731
|
ExitPresentMode = "exitPresentMode"
|
|
4733
4732
|
}
|
|
@@ -5941,7 +5940,7 @@ export declare enum Param {
|
|
|
5941
5940
|
DataSourceId = "dataSourceId",
|
|
5942
5941
|
preAuthCache = "preAuthCache",
|
|
5943
5942
|
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5944
|
-
CoverAndFilterOptionInPDF = "
|
|
5943
|
+
CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
|
|
5945
5944
|
PrimaryAction = "primaryAction",
|
|
5946
5945
|
isSpotterAgentEmbed = "isSpotterAgentEmbed",
|
|
5947
5946
|
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
|
|
@@ -5971,6 +5970,7 @@ export declare enum Param {
|
|
|
5971
5970
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
5972
5971
|
* })
|
|
5973
5972
|
* ```
|
|
5973
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
|
|
5974
5974
|
*/
|
|
5975
5975
|
export declare enum Action {
|
|
5976
5976
|
/**
|
|
@@ -7163,7 +7163,23 @@ export declare enum Action {
|
|
|
7163
7163
|
* ```
|
|
7164
7164
|
* @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
7165
7165
|
*/
|
|
7166
|
-
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
|
|
7166
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
7167
|
+
/**
|
|
7168
|
+
* Action ID for hide or disable the
|
|
7169
|
+
* Spotter in conversation training widget.
|
|
7170
|
+
* The Add to Coaching feature is currently in beta
|
|
7171
|
+
* and is disabled by default on embed deployments.
|
|
7172
|
+
* To enable this feature on your instance,
|
|
7173
|
+
* contact ThoughtSpot Support.
|
|
7174
|
+
* @example
|
|
7175
|
+
* ```js
|
|
7176
|
+
* hiddenAction: [Action.InConversationTraining]
|
|
7177
|
+
* disabledActions: [Action.InConversationTraining]
|
|
7178
|
+
*
|
|
7179
|
+
* ```
|
|
7180
|
+
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
7181
|
+
*/
|
|
7182
|
+
InConversationTraining = "InConversationTraining"
|
|
7167
7183
|
}
|
|
7168
7184
|
export interface AnswerServiceType {
|
|
7169
7185
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -7357,7 +7373,8 @@ export interface SearchOptions {
|
|
|
7357
7373
|
*/
|
|
7358
7374
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
7359
7375
|
/**
|
|
7360
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7376
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7377
|
+
* this object to query data and generate Answers.
|
|
7361
7378
|
*/
|
|
7362
7379
|
worksheetId: string;
|
|
7363
7380
|
/**
|
|
@@ -7376,7 +7393,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7376
7393
|
* disableSourceSelection : true,
|
|
7377
7394
|
* })
|
|
7378
7395
|
* ```
|
|
7379
|
-
* @version SDK: 1.36.0 |
|
|
7396
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7380
7397
|
*/
|
|
7381
7398
|
disableSourceSelection?: boolean;
|
|
7382
7399
|
/**
|
|
@@ -7390,7 +7407,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7390
7407
|
* hideSourceSelection : true,
|
|
7391
7408
|
* })
|
|
7392
7409
|
* ```
|
|
7393
|
-
* @version SDK: 1.36.0 |
|
|
7410
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7394
7411
|
*/
|
|
7395
7412
|
hideSourceSelection?: boolean;
|
|
7396
7413
|
/**
|
|
@@ -7422,7 +7439,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7422
7439
|
* showSpotterLimitations : true,
|
|
7423
7440
|
* })
|
|
7424
7441
|
* ```
|
|
7425
|
-
* @version SDK: 1.36.0 |
|
|
7442
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
7426
7443
|
*/
|
|
7427
7444
|
showSpotterLimitations?: boolean;
|
|
7428
7445
|
/**
|
|
@@ -7437,9 +7454,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7437
7454
|
* hideSampleQuestions : true,
|
|
7438
7455
|
* })
|
|
7439
7456
|
* ```
|
|
7440
|
-
* @version SDK: 1.36.0 |
|
|
7457
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7441
7458
|
*/
|
|
7442
7459
|
hideSampleQuestions?: boolean;
|
|
7460
|
+
/**
|
|
7461
|
+
* The list of runtime filters to apply to a search Answer,
|
|
7462
|
+
* visualization, or Liveboard.
|
|
7463
|
+
*
|
|
7464
|
+
* Supported embed types: `SpotterEmbed`
|
|
7465
|
+
* @example
|
|
7466
|
+
* ```js
|
|
7467
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7468
|
+
* ... // other embed view config
|
|
7469
|
+
* runtimeFilters: [
|
|
7470
|
+
* {
|
|
7471
|
+
* columnName: 'value',
|
|
7472
|
+
* operator: RuntimeFilterOp.EQ,
|
|
7473
|
+
* values: ['string' | 123 | true],
|
|
7474
|
+
* },
|
|
7475
|
+
* ],
|
|
7476
|
+
* })
|
|
7477
|
+
* ```
|
|
7478
|
+
*/
|
|
7479
|
+
runtimeFilters?: RuntimeFilter[];
|
|
7480
|
+
/**
|
|
7481
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
7482
|
+
* If true, filters will be passed via app initialization payload instead.
|
|
7483
|
+
* If false/undefined, filters will be added to URL (default behavior).
|
|
7484
|
+
*
|
|
7485
|
+
* Supported embed types: `SpotterEmbed`
|
|
7486
|
+
* @default false
|
|
7487
|
+
*/
|
|
7488
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
7489
|
+
/**
|
|
7490
|
+
* The list of runtime parameters to apply to the conversation.
|
|
7491
|
+
*
|
|
7492
|
+
* Supported embed types: `SpotterEmbed`
|
|
7493
|
+
* @example
|
|
7494
|
+
* ```js
|
|
7495
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7496
|
+
* ... // other embed view config
|
|
7497
|
+
* runtimeParameters: [
|
|
7498
|
+
* {
|
|
7499
|
+
* name: 'Parameter Name',
|
|
7500
|
+
* value: 'Parameter Value',
|
|
7501
|
+
* },
|
|
7502
|
+
* ],
|
|
7503
|
+
* })
|
|
7504
|
+
* ```
|
|
7505
|
+
*/
|
|
7506
|
+
runtimeParameters?: RuntimeParameter[];
|
|
7507
|
+
/**
|
|
7508
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
7509
|
+
* If true, parameters will be passed via app initialization payload instead.
|
|
7510
|
+
* If false/undefined, parameters will be added to URL (default behavior).
|
|
7511
|
+
*
|
|
7512
|
+
* Supported embed types: `SpotterEmbed`
|
|
7513
|
+
* @default false
|
|
7514
|
+
*
|
|
7515
|
+
*/
|
|
7516
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
7443
7517
|
}
|
|
7444
7518
|
/**
|
|
7445
7519
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -8726,9 +8800,54 @@ export declare function resetCachedSessionInfo(): void;
|
|
|
8726
8800
|
export declare function resetCachedPreauthInfo(): void;
|
|
8727
8801
|
|
|
8728
8802
|
/**
|
|
8729
|
-
* Gets the configuration
|
|
8730
|
-
*
|
|
8731
|
-
* @
|
|
8803
|
+
* Gets the embed configuration settings that were used to
|
|
8804
|
+
* initialize the SDK.
|
|
8805
|
+
* @returns {@link EmbedConfig}
|
|
8806
|
+
*
|
|
8807
|
+
* @example
|
|
8808
|
+
* ```js
|
|
8809
|
+
* import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
|
|
8810
|
+
* // Call the getInitConfig method to retrieve the embed configuration
|
|
8811
|
+
* const config = getInitConfig();
|
|
8812
|
+
* // Log the configuration settings
|
|
8813
|
+
* console.log(config);
|
|
8814
|
+
* ```
|
|
8815
|
+
* Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
|
|
8816
|
+
* object, which contains the configuration settings used to
|
|
8817
|
+
* initialize the SDK, including the following:
|
|
8818
|
+
*
|
|
8819
|
+
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
8820
|
+
* - `authType`: The authentication method used. For example,
|
|
8821
|
+
* `AuthServerCookieless` for `AuthType.TrustedAuthTokenCookieless`
|
|
8822
|
+
* - `customizations` - Style, text, and icon customization settings
|
|
8823
|
+
* that were applied during the SDK initialization.
|
|
8824
|
+
*
|
|
8825
|
+
* The following JSON output shows the embed configuration
|
|
8826
|
+
* settings returned from the code in the previous example:
|
|
8827
|
+
*
|
|
8828
|
+
* @example
|
|
8829
|
+
* ```json
|
|
8830
|
+
* {
|
|
8831
|
+
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
8832
|
+
* "authType": "AuthServerCookieless",
|
|
8833
|
+
* "customizations": {
|
|
8834
|
+
* "style": {
|
|
8835
|
+
* "customCSS": {
|
|
8836
|
+
* "variables": {
|
|
8837
|
+
* "--ts-var-button--secondary-background": "#7492d5",
|
|
8838
|
+
* "--ts-var-button--secondary--hovers-background": "#aac2f8",
|
|
8839
|
+
* "--ts-var-root-background": "#f1f4f8"
|
|
8840
|
+
* }
|
|
8841
|
+
* }
|
|
8842
|
+
* }
|
|
8843
|
+
* },
|
|
8844
|
+
* "loginFailedMessage": "Login failed, please try again",
|
|
8845
|
+
* "authTriggerText": "Authorize",
|
|
8846
|
+
* "disableTokenVerification": true,
|
|
8847
|
+
* "authTriggerContainer": "#your-own-div"
|
|
8848
|
+
* }
|
|
8849
|
+
* ```
|
|
8850
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
|
|
8732
8851
|
* @group Global methods
|
|
8733
8852
|
*/
|
|
8734
8853
|
export declare const getEmbedConfig: () => EmbedConfig;
|
|
@@ -8736,7 +8855,7 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
8736
8855
|
* Sets the configuration embed was initialized with.
|
|
8737
8856
|
* And returns the new configuration.
|
|
8738
8857
|
* @param newConfig The configuration to set.
|
|
8739
|
-
* @version SDK: 1.27.0 | ThoughtSpot:
|
|
8858
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.1.sw, and later
|
|
8740
8859
|
* @group Global methods
|
|
8741
8860
|
*/
|
|
8742
8861
|
export declare const setEmbedConfig: (newConfig: EmbedConfig) => any;
|