@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
|
@@ -662,39 +662,39 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
662
662
|
showObjectResults?: boolean;
|
|
663
663
|
/**
|
|
664
664
|
* flag used by the TS product tour page to show the blue search bar
|
|
665
|
-
* even after the search is completed. This is different from
|
|
665
|
+
* even after the search is completed. This is different from ThoughtSpot Embedded
|
|
666
666
|
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
667
667
|
* The Sample questions container is collapsed when this value is set after
|
|
668
668
|
* does a search.
|
|
669
|
-
* @version SDK: 1.26.0 |
|
|
669
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
|
|
670
670
|
* @hidden
|
|
671
671
|
*/
|
|
672
672
|
isProductTour?: boolean;
|
|
673
673
|
/**
|
|
674
674
|
* Show or hide the search bar title.
|
|
675
|
-
* @version SDK: 1.29.0 |
|
|
676
|
-
* @deprecated
|
|
675
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
676
|
+
* @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
677
677
|
*/
|
|
678
678
|
hideSearchBarTitle?: boolean;
|
|
679
679
|
/**
|
|
680
680
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
681
681
|
* at the top of the Answer page.
|
|
682
|
-
* @version SDK: 1.26.0 |
|
|
682
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
|
|
683
683
|
*/
|
|
684
684
|
hideSageAnswerHeader?: boolean;
|
|
685
685
|
/**
|
|
686
686
|
* Disable the worksheet selection option.
|
|
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
|
disableWorksheetChange?: boolean;
|
|
690
690
|
/**
|
|
691
691
|
* Hide the worksheet selection panel.
|
|
692
|
-
* @version SDK: 1.26.0 |
|
|
692
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
693
693
|
*/
|
|
694
694
|
hideWorksheetSelector?: boolean;
|
|
695
695
|
/**
|
|
696
696
|
* Show or hide autocomplete suggestions for the search query string.
|
|
697
|
-
* @version SDK: 1.26.0 |
|
|
697
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
698
698
|
*/
|
|
699
699
|
hideAutocompleteSuggestions?: boolean;
|
|
700
700
|
/**
|
|
@@ -710,7 +710,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
710
710
|
* selected for the search operation.
|
|
711
711
|
*
|
|
712
712
|
* Supported embed types: `SageEmbed`
|
|
713
|
-
* @version SDK: 1.26.0 |
|
|
713
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
714
714
|
* @example
|
|
715
715
|
* ```js
|
|
716
716
|
* const embed = new SageEmbed('#tsEmbed', {
|
|
@@ -743,7 +743,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
743
743
|
* executeSearch: true,
|
|
744
744
|
* }
|
|
745
745
|
* ```
|
|
746
|
-
* @version SDK: 1.26.0 |
|
|
746
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
747
747
|
*/
|
|
748
748
|
searchOptions?: SearchOptions;
|
|
749
749
|
}
|
|
@@ -1029,7 +1029,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1029
1029
|
/**
|
|
1030
1030
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1031
1031
|
* @default false
|
|
1032
|
-
* @version SDK: 1.32.0 |
|
|
1032
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1033
1033
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
1034
1034
|
*/
|
|
1035
1035
|
collapseSearchBarInitially?: boolean;
|
|
@@ -1037,7 +1037,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1037
1037
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1038
1038
|
*
|
|
1039
1039
|
* Supported embed types: `SearchEmbed`
|
|
1040
|
-
* @version: SDK: 1.29.0 |
|
|
1040
|
+
* @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1041
1041
|
*/
|
|
1042
1042
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1043
1043
|
/**
|
|
@@ -1049,7 +1049,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1049
1049
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1050
1050
|
*
|
|
1051
1051
|
* Supported embed types: `SearchEmbed`
|
|
1052
|
-
* @version SDK: 1.32.0 |
|
|
1052
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1053
1053
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1054
1054
|
* @example
|
|
1055
1055
|
* ```js
|
|
@@ -1066,7 +1066,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1066
1066
|
* lands on search embed page.
|
|
1067
1067
|
*
|
|
1068
1068
|
* Supported embed types: `SearchEmbed`
|
|
1069
|
-
* @version SDK: 1.32.0 |
|
|
1069
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl
|
|
1070
1070
|
* @default true
|
|
1071
1071
|
* @example
|
|
1072
1072
|
* ```js
|
|
@@ -1230,7 +1230,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1230
1230
|
*
|
|
1231
1231
|
* Supported embed types: `AppEmbed`
|
|
1232
1232
|
* @default true
|
|
1233
|
-
* @version SDK: 1.2.0 |
|
|
1233
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
1234
1234
|
* @example
|
|
1235
1235
|
* ```js
|
|
1236
1236
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1252,7 +1252,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1252
1252
|
*
|
|
1253
1253
|
* Supported embed types: `AppEmbed`
|
|
1254
1254
|
* @default false
|
|
1255
|
-
* @version SDK: 1.28.0 |
|
|
1255
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1256
1256
|
* @example
|
|
1257
1257
|
* ```js
|
|
1258
1258
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1268,7 +1268,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1268
1268
|
*
|
|
1269
1269
|
* Supported embed types: `AppEmbed`
|
|
1270
1270
|
* @default false
|
|
1271
|
-
* @version SDK: 1.2.0 |
|
|
1271
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
1272
1272
|
* @example
|
|
1273
1273
|
* ```js
|
|
1274
1274
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1351,7 +1351,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1351
1351
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1352
1352
|
*
|
|
1353
1353
|
* Supported embed types: `AppEmbed`
|
|
1354
|
-
* @version SDK: 1.28.0 |
|
|
1354
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1355
1355
|
* @default false
|
|
1356
1356
|
* @example
|
|
1357
1357
|
* ```js
|
|
@@ -1371,7 +1371,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1371
1371
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1372
1372
|
*
|
|
1373
1373
|
* Supported embed types: `AppEmbed`
|
|
1374
|
-
* @version SDK: 1.28.0 |
|
|
1374
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1375
1375
|
* @default true
|
|
1376
1376
|
* @example
|
|
1377
1377
|
* ```js
|
|
@@ -1392,7 +1392,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1392
1392
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
1393
1393
|
*
|
|
1394
1394
|
* Supported embed types: `AppEmbed`
|
|
1395
|
-
* @version SDK: 1.1.0 |
|
|
1395
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1396
1396
|
* @example
|
|
1397
1397
|
* ```js
|
|
1398
1398
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1410,7 +1410,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1410
1410
|
* path within the app, use the `path` attribute which is more flexible.
|
|
1411
1411
|
*
|
|
1412
1412
|
* Supported embed types: `AppEmbed`
|
|
1413
|
-
* @version SDK: 1.1.0 |
|
|
1413
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1414
1414
|
* @example
|
|
1415
1415
|
* ```js
|
|
1416
1416
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1426,7 +1426,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1426
1426
|
* tag.
|
|
1427
1427
|
*
|
|
1428
1428
|
* Supported embed types: `AppEmbed`
|
|
1429
|
-
* @version SDK: 1.1.0 |
|
|
1429
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1430
1430
|
* @example
|
|
1431
1431
|
* ```js
|
|
1432
1432
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1505,7 +1505,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1505
1505
|
*
|
|
1506
1506
|
* Supported embed types: `AppEmbed`
|
|
1507
1507
|
* @default false
|
|
1508
|
-
* @version SDK: 1.28.0 |
|
|
1508
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1509
1509
|
* @example
|
|
1510
1510
|
* ```js
|
|
1511
1511
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1535,7 +1535,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1535
1535
|
discoveryExperience?: DiscoveryExperience;
|
|
1536
1536
|
/**
|
|
1537
1537
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1538
|
-
* @version SDK: 1.32.0 |
|
|
1538
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1539
1539
|
* @default false
|
|
1540
1540
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
1541
1541
|
*/
|
|
@@ -1549,7 +1549,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1549
1549
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1550
1550
|
*
|
|
1551
1551
|
* Supported embed types: `AppEmbed`
|
|
1552
|
-
* @version SDK: 1.32.0 |
|
|
1552
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1553
1553
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1554
1554
|
* @example
|
|
1555
1555
|
* ```js
|
|
@@ -1563,14 +1563,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1563
1563
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1564
1564
|
/**
|
|
1565
1565
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
1566
|
-
* @version SDK : 1.29.0 |
|
|
1566
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1567
1567
|
*/
|
|
1568
1568
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1569
1569
|
/**
|
|
1570
1570
|
* Flag to use home page search bar mode
|
|
1571
1571
|
*
|
|
1572
1572
|
* Supported embed types: `AppEmbed`
|
|
1573
|
-
* @version SDK : 1.33.0 |
|
|
1573
|
+
* @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
1574
1574
|
*/
|
|
1575
1575
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
1576
1576
|
/**
|
|
@@ -1835,7 +1835,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1835
1835
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1836
1836
|
*
|
|
1837
1837
|
* Supported embed types: `LiveboardEmbed`
|
|
1838
|
-
* @version SDK: 1.25.0 |
|
|
1838
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1839
1839
|
* @example
|
|
1840
1840
|
* ```js
|
|
1841
1841
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1910,23 +1910,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1910
1910
|
* })
|
|
1911
1911
|
*/
|
|
1912
1912
|
dataSourceId?: string;
|
|
1913
|
-
/**
|
|
1914
|
-
* This flag is for show/hide checkboxes for include or exclude
|
|
1915
|
-
* cover page and filters in the Liveboard PDF.
|
|
1916
|
-
*
|
|
1917
|
-
* Supported embed types: `LiveboardEmbed`
|
|
1918
|
-
* @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
|
|
1919
|
-
* @default true
|
|
1920
|
-
* Supported embed types: `LiveboardEmbed`
|
|
1921
|
-
* @example
|
|
1922
|
-
* ```js
|
|
1923
|
-
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1924
|
-
* ... //other embed view config
|
|
1925
|
-
* coverAndFilterOptionInPDF: false,
|
|
1926
|
-
* })
|
|
1927
|
-
* ```
|
|
1928
|
-
*/
|
|
1929
|
-
coverAndFilterOptionInPDF?: boolean;
|
|
1930
1913
|
/**
|
|
1931
1914
|
* The list of tab IDs to hide from the embedded.
|
|
1932
1915
|
* This Tabs will be hidden from their respective LBs.
|
|
@@ -2024,7 +2007,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
2024
2007
|
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
2025
2008
|
/**
|
|
2026
2009
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
2027
|
-
* this Liveboard inside the full
|
|
2010
|
+
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
2028
2011
|
* @returns url string
|
|
2029
2012
|
*/
|
|
2030
2013
|
getLiveboardUrl(): string;
|
|
@@ -2393,7 +2376,7 @@ export interface CustomStyles {
|
|
|
2393
2376
|
* Configuration to define the customization on the Embedded
|
|
2394
2377
|
* ThoughtSpot components.
|
|
2395
2378
|
* You can customize styles, text strings, and icons.
|
|
2396
|
-
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2379
|
+
* For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework].
|
|
2397
2380
|
* @example
|
|
2398
2381
|
* ```js
|
|
2399
2382
|
* init({
|
|
@@ -3480,6 +3463,22 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3480
3463
|
* ```
|
|
3481
3464
|
*/
|
|
3482
3465
|
enableAskSage?: boolean;
|
|
3466
|
+
/**
|
|
3467
|
+
* This flag is used to show or hide checkboxes for including or excluding
|
|
3468
|
+
* the cover and filters pages in the Liveboard PDF.
|
|
3469
|
+
*
|
|
3470
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3471
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
3472
|
+
* @example
|
|
3473
|
+
* ```js
|
|
3474
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3475
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3476
|
+
* ... // other embed view config
|
|
3477
|
+
* coverAndFilterOptionInPDF: false,
|
|
3478
|
+
* })
|
|
3479
|
+
* ```
|
|
3480
|
+
*/
|
|
3481
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
3483
3482
|
}
|
|
3484
3483
|
export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
|
|
3485
3484
|
}
|
|
@@ -4623,7 +4622,7 @@ export declare enum EmbedEvent {
|
|
|
4623
4622
|
*
|
|
4624
4623
|
* error: Developers can customize the error message text when `execute`
|
|
4625
4624
|
* returns `false` using the error parameter in responder.
|
|
4626
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
4625
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4627
4626
|
* @example
|
|
4628
4627
|
*```js
|
|
4629
4628
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4670,7 +4669,7 @@ export declare enum EmbedEvent {
|
|
|
4670
4669
|
* console.log('payload', payload);
|
|
4671
4670
|
* })
|
|
4672
4671
|
*```
|
|
4673
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
4672
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4674
4673
|
*/
|
|
4675
4674
|
ParameterChanged = "parameterChanged",
|
|
4676
4675
|
/**
|
|
@@ -4726,18 +4725,18 @@ export declare enum EmbedEvent {
|
|
|
4726
4725
|
* console.log('payload', payload);
|
|
4727
4726
|
* })
|
|
4728
4727
|
*```
|
|
4729
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
4728
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4730
4729
|
*/
|
|
4731
4730
|
CreateLiveboard = "createLiveboard",
|
|
4732
4731
|
/**
|
|
4733
4732
|
* Emitted when a user creates a Model.
|
|
4734
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
4733
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4735
4734
|
*/
|
|
4736
4735
|
CreateModel = "createModel",
|
|
4737
4736
|
/**
|
|
4738
4737
|
* @hidden
|
|
4739
4738
|
* Emitted when a user exits present mode.
|
|
4740
|
-
* @version SDK : 1.40.0 | ThoughtSpot
|
|
4739
|
+
* @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4741
4740
|
*/
|
|
4742
4741
|
ExitPresentMode = "exitPresentMode"
|
|
4743
4742
|
}
|
|
@@ -5951,7 +5950,7 @@ export declare enum Param {
|
|
|
5951
5950
|
DataSourceId = "dataSourceId",
|
|
5952
5951
|
preAuthCache = "preAuthCache",
|
|
5953
5952
|
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5954
|
-
CoverAndFilterOptionInPDF = "
|
|
5953
|
+
CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
|
|
5955
5954
|
PrimaryAction = "primaryAction",
|
|
5956
5955
|
isSpotterAgentEmbed = "isSpotterAgentEmbed",
|
|
5957
5956
|
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
|
|
@@ -5981,6 +5980,7 @@ export declare enum Param {
|
|
|
5981
5980
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
5982
5981
|
* })
|
|
5983
5982
|
* ```
|
|
5983
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
|
|
5984
5984
|
*/
|
|
5985
5985
|
export declare enum Action {
|
|
5986
5986
|
/**
|
|
@@ -7173,7 +7173,23 @@ export declare enum Action {
|
|
|
7173
7173
|
* ```
|
|
7174
7174
|
* @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
7175
7175
|
*/
|
|
7176
|
-
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
|
|
7176
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
7177
|
+
/**
|
|
7178
|
+
* Action ID for hide or disable the
|
|
7179
|
+
* Spotter in conversation training widget.
|
|
7180
|
+
* The Add to Coaching feature is currently in beta
|
|
7181
|
+
* and is disabled by default on embed deployments.
|
|
7182
|
+
* To enable this feature on your instance,
|
|
7183
|
+
* contact ThoughtSpot Support.
|
|
7184
|
+
* @example
|
|
7185
|
+
* ```js
|
|
7186
|
+
* hiddenAction: [Action.InConversationTraining]
|
|
7187
|
+
* disabledActions: [Action.InConversationTraining]
|
|
7188
|
+
*
|
|
7189
|
+
* ```
|
|
7190
|
+
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
7191
|
+
*/
|
|
7192
|
+
InConversationTraining = "InConversationTraining"
|
|
7177
7193
|
}
|
|
7178
7194
|
export interface AnswerServiceType {
|
|
7179
7195
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -7367,7 +7383,8 @@ export interface SearchOptions {
|
|
|
7367
7383
|
*/
|
|
7368
7384
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
7369
7385
|
/**
|
|
7370
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7386
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7387
|
+
* this object to query data and generate Answers.
|
|
7371
7388
|
*/
|
|
7372
7389
|
worksheetId: string;
|
|
7373
7390
|
/**
|
|
@@ -7386,7 +7403,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7386
7403
|
* disableSourceSelection : true,
|
|
7387
7404
|
* })
|
|
7388
7405
|
* ```
|
|
7389
|
-
* @version SDK: 1.36.0 |
|
|
7406
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7390
7407
|
*/
|
|
7391
7408
|
disableSourceSelection?: boolean;
|
|
7392
7409
|
/**
|
|
@@ -7400,7 +7417,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7400
7417
|
* hideSourceSelection : true,
|
|
7401
7418
|
* })
|
|
7402
7419
|
* ```
|
|
7403
|
-
* @version SDK: 1.36.0 |
|
|
7420
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7404
7421
|
*/
|
|
7405
7422
|
hideSourceSelection?: boolean;
|
|
7406
7423
|
/**
|
|
@@ -7432,7 +7449,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7432
7449
|
* showSpotterLimitations : true,
|
|
7433
7450
|
* })
|
|
7434
7451
|
* ```
|
|
7435
|
-
* @version SDK: 1.36.0 |
|
|
7452
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
7436
7453
|
*/
|
|
7437
7454
|
showSpotterLimitations?: boolean;
|
|
7438
7455
|
/**
|
|
@@ -7447,9 +7464,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7447
7464
|
* hideSampleQuestions : true,
|
|
7448
7465
|
* })
|
|
7449
7466
|
* ```
|
|
7450
|
-
* @version SDK: 1.36.0 |
|
|
7467
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7451
7468
|
*/
|
|
7452
7469
|
hideSampleQuestions?: boolean;
|
|
7470
|
+
/**
|
|
7471
|
+
* The list of runtime filters to apply to a search Answer,
|
|
7472
|
+
* visualization, or Liveboard.
|
|
7473
|
+
*
|
|
7474
|
+
* Supported embed types: `SpotterEmbed`
|
|
7475
|
+
* @example
|
|
7476
|
+
* ```js
|
|
7477
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7478
|
+
* ... // other embed view config
|
|
7479
|
+
* runtimeFilters: [
|
|
7480
|
+
* {
|
|
7481
|
+
* columnName: 'value',
|
|
7482
|
+
* operator: RuntimeFilterOp.EQ,
|
|
7483
|
+
* values: ['string' | 123 | true],
|
|
7484
|
+
* },
|
|
7485
|
+
* ],
|
|
7486
|
+
* })
|
|
7487
|
+
* ```
|
|
7488
|
+
*/
|
|
7489
|
+
runtimeFilters?: RuntimeFilter[];
|
|
7490
|
+
/**
|
|
7491
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
7492
|
+
* If true, filters will be passed via app initialization payload instead.
|
|
7493
|
+
* If false/undefined, filters will be added to URL (default behavior).
|
|
7494
|
+
*
|
|
7495
|
+
* Supported embed types: `SpotterEmbed`
|
|
7496
|
+
* @default false
|
|
7497
|
+
*/
|
|
7498
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
7499
|
+
/**
|
|
7500
|
+
* The list of runtime parameters to apply to the conversation.
|
|
7501
|
+
*
|
|
7502
|
+
* Supported embed types: `SpotterEmbed`
|
|
7503
|
+
* @example
|
|
7504
|
+
* ```js
|
|
7505
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7506
|
+
* ... // other embed view config
|
|
7507
|
+
* runtimeParameters: [
|
|
7508
|
+
* {
|
|
7509
|
+
* name: 'Parameter Name',
|
|
7510
|
+
* value: 'Parameter Value',
|
|
7511
|
+
* },
|
|
7512
|
+
* ],
|
|
7513
|
+
* })
|
|
7514
|
+
* ```
|
|
7515
|
+
*/
|
|
7516
|
+
runtimeParameters?: RuntimeParameter[];
|
|
7517
|
+
/**
|
|
7518
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
7519
|
+
* If true, parameters will be passed via app initialization payload instead.
|
|
7520
|
+
* If false/undefined, parameters will be added to URL (default behavior).
|
|
7521
|
+
*
|
|
7522
|
+
* Supported embed types: `SpotterEmbed`
|
|
7523
|
+
* @default false
|
|
7524
|
+
*
|
|
7525
|
+
*/
|
|
7526
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
7453
7527
|
}
|
|
7454
7528
|
/**
|
|
7455
7529
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -8335,9 +8409,54 @@ export declare class AnswerService {
|
|
|
8335
8409
|
}
|
|
8336
8410
|
|
|
8337
8411
|
/**
|
|
8338
|
-
* Gets the configuration
|
|
8339
|
-
*
|
|
8340
|
-
* @
|
|
8412
|
+
* Gets the embed configuration settings that were used to
|
|
8413
|
+
* initialize the SDK.
|
|
8414
|
+
* @returns {@link EmbedConfig}
|
|
8415
|
+
*
|
|
8416
|
+
* @example
|
|
8417
|
+
* ```js
|
|
8418
|
+
* import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
|
|
8419
|
+
* // Call the getInitConfig method to retrieve the embed configuration
|
|
8420
|
+
* const config = getInitConfig();
|
|
8421
|
+
* // Log the configuration settings
|
|
8422
|
+
* console.log(config);
|
|
8423
|
+
* ```
|
|
8424
|
+
* Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
|
|
8425
|
+
* object, which contains the configuration settings used to
|
|
8426
|
+
* initialize the SDK, including the following:
|
|
8427
|
+
*
|
|
8428
|
+
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
8429
|
+
* - `authType`: The authentication method used. For example,
|
|
8430
|
+
* `AuthServerCookieless` for `AuthType.TrustedAuthTokenCookieless`
|
|
8431
|
+
* - `customizations` - Style, text, and icon customization settings
|
|
8432
|
+
* that were applied during the SDK initialization.
|
|
8433
|
+
*
|
|
8434
|
+
* The following JSON output shows the embed configuration
|
|
8435
|
+
* settings returned from the code in the previous example:
|
|
8436
|
+
*
|
|
8437
|
+
* @example
|
|
8438
|
+
* ```json
|
|
8439
|
+
* {
|
|
8440
|
+
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
8441
|
+
* "authType": "AuthServerCookieless",
|
|
8442
|
+
* "customizations": {
|
|
8443
|
+
* "style": {
|
|
8444
|
+
* "customCSS": {
|
|
8445
|
+
* "variables": {
|
|
8446
|
+
* "--ts-var-button--secondary-background": "#7492d5",
|
|
8447
|
+
* "--ts-var-button--secondary--hovers-background": "#aac2f8",
|
|
8448
|
+
* "--ts-var-root-background": "#f1f4f8"
|
|
8449
|
+
* }
|
|
8450
|
+
* }
|
|
8451
|
+
* }
|
|
8452
|
+
* },
|
|
8453
|
+
* "loginFailedMessage": "Login failed, please try again",
|
|
8454
|
+
* "authTriggerText": "Authorize",
|
|
8455
|
+
* "disableTokenVerification": true,
|
|
8456
|
+
* "authTriggerContainer": "#your-own-div"
|
|
8457
|
+
* }
|
|
8458
|
+
* ```
|
|
8459
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
|
|
8341
8460
|
* @group Global methods
|
|
8342
8461
|
*/
|
|
8343
8462
|
export declare const getEmbedConfig: () => EmbedConfig;
|
|
@@ -8345,7 +8464,7 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
8345
8464
|
* Sets the configuration embed was initialized with.
|
|
8346
8465
|
* And returns the new configuration.
|
|
8347
8466
|
* @param newConfig The configuration to set.
|
|
8348
|
-
* @version SDK: 1.27.0 | ThoughtSpot:
|
|
8467
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.1.sw, and later
|
|
8349
8468
|
* @group Global methods
|
|
8350
8469
|
*/
|
|
8351
8470
|
export declare const setEmbedConfig: (newConfig: EmbedConfig) => any;
|