@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.47.0
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 +4 -4
- package/cjs/src/css-variables.d.ts +36 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +41 -17
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +26 -47
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +36 -79
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +24 -2
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +18 -33
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +129 -97
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +31 -0
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +2 -0
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +18 -0
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +69 -9
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +185 -19
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.d.ts +22 -0
- package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -0
- package/cjs/src/embed/hostEventClient/utils.js +57 -0
- package/cjs/src/embed/hostEventClient/utils.js.map +1 -0
- package/cjs/src/embed/hostEventClient/utils.spec.d.ts +2 -0
- package/cjs/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js +190 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -0
- package/cjs/src/embed/liveboard.d.ts +18 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +9 -11
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +29 -71
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +20 -0
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -0
- package/cjs/src/embed/spotter-utils.js +52 -0
- package/cjs/src/embed/spotter-utils.js.map +1 -0
- package/cjs/src/embed/spotter-utils.spec.d.ts +2 -0
- package/cjs/src/embed/spotter-utils.spec.d.ts.map +1 -0
- package/cjs/src/embed/spotter-utils.spec.js +54 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -0
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +25 -5
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +28 -67
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +2 -1
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +2 -1
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +1 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -4
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +2 -2
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +1 -3
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -36
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -34
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/types.d.ts +143 -76
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +118 -47
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils.d.ts +0 -9
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +1 -10
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-DW2wEHqy.js → index-Bm2Hck8q.js} +1 -1
- package/dist/src/css-variables.d.ts +36 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +41 -17
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +24 -2
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +31 -0
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +18 -0
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/utils.d.ts +22 -0
- package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -0
- package/dist/src/embed/hostEventClient/utils.spec.d.ts +2 -0
- package/dist/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
- package/dist/src/embed/liveboard.d.ts +18 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +20 -0
- package/dist/src/embed/spotter-utils.d.ts.map +1 -0
- package/dist/src/embed/spotter-utils.spec.d.ts +2 -0
- package/dist/src/embed/spotter-utils.spec.d.ts.map +1 -0
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/dist/src/errors.d.ts +2 -1
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +1 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +2 -2
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -36
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +143 -76
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils.d.ts +0 -9
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +378 -304
- package/dist/tsembed-react.js +366 -294
- package/dist/tsembed.es.js +393 -285
- package/dist/tsembed.js +30798 -30691
- package/dist/visual-embed-sdk-react-full.d.ts +310 -273
- package/dist/visual-embed-sdk-react.d.ts +310 -273
- package/dist/visual-embed-sdk.d.ts +308 -243
- package/lib/package.json +4 -4
- package/lib/src/css-variables.d.ts +36 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +41 -17
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +28 -49
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +36 -79
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +24 -2
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +19 -34
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +131 -99
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +31 -0
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +2 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +18 -0
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +69 -9
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +185 -19
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.d.ts +22 -0
- package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -0
- package/lib/src/embed/hostEventClient/utils.js +49 -0
- package/lib/src/embed/hostEventClient/utils.js.map +1 -0
- package/lib/src/embed/hostEventClient/utils.spec.d.ts +2 -0
- package/lib/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
- package/lib/src/embed/hostEventClient/utils.spec.js +188 -0
- package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -0
- package/lib/src/embed/liveboard.d.ts +18 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +9 -11
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +29 -71
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +20 -0
- package/lib/src/embed/spotter-utils.d.ts.map +1 -0
- package/lib/src/embed/spotter-utils.js +47 -0
- package/lib/src/embed/spotter-utils.js.map +1 -0
- package/lib/src/embed/spotter-utils.spec.d.ts +2 -0
- package/lib/src/embed/spotter-utils.spec.d.ts.map +1 -0
- package/lib/src/embed/spotter-utils.spec.js +52 -0
- package/lib/src/embed/spotter-utils.spec.js.map +1 -0
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +25 -5
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +30 -69
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +2 -1
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +2 -1
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +1 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +2 -2
- 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 -36
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +0 -33
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/types.d.ts +143 -76
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +118 -47
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils.d.ts +0 -9
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +0 -8
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +308 -243
- package/package.json +4 -4
- package/src/css-variables.ts +45 -0
- package/src/embed/app.spec.ts +51 -107
- package/src/embed/app.ts +60 -82
- package/src/embed/conversation.spec.ts +150 -119
- package/src/embed/conversation.ts +34 -58
- package/src/embed/hostEventClient/contracts.ts +31 -0
- package/src/embed/hostEventClient/host-event-client.spec.ts +260 -19
- package/src/embed/hostEventClient/host-event-client.ts +87 -11
- package/src/embed/hostEventClient/utils.spec.ts +225 -0
- package/src/embed/hostEventClient/utils.ts +74 -0
- package/src/embed/liveboard.spec.ts +38 -93
- package/src/embed/liveboard.ts +28 -10
- package/src/embed/spotter-utils.spec.ts +56 -0
- package/src/embed/spotter-utils.ts +65 -0
- package/src/embed/ts-embed.spec.ts +56 -108
- package/src/embed/ts-embed.ts +25 -4
- package/src/errors.ts +2 -1
- package/src/index.ts +2 -5
- package/src/react/all-types-export.ts +0 -3
- package/src/react/index.tsx +15 -59
- package/src/types.ts +206 -138
- package/src/utils.ts +0 -14
- package/cjs/src/embed/sage.d.ts +0 -164
- package/cjs/src/embed/sage.d.ts.map +0 -1
- package/cjs/src/embed/sage.js +0 -88
- package/cjs/src/embed/sage.js.map +0 -1
- package/cjs/src/embed/sage.spec.d.ts +0 -2
- package/cjs/src/embed/sage.spec.d.ts.map +0 -1
- package/cjs/src/embed/sage.spec.js +0 -151
- package/cjs/src/embed/sage.spec.js.map +0 -1
- package/dist/src/embed/sage.d.ts +0 -164
- package/dist/src/embed/sage.d.ts.map +0 -1
- package/dist/src/embed/sage.spec.d.ts +0 -2
- package/dist/src/embed/sage.spec.d.ts.map +0 -1
- package/lib/src/embed/sage.d.ts +0 -164
- package/lib/src/embed/sage.d.ts.map +0 -1
- package/lib/src/embed/sage.js +0 -84
- package/lib/src/embed/sage.js.map +0 -1
- package/lib/src/embed/sage.spec.d.ts +0 -2
- package/lib/src/embed/sage.spec.d.ts.map +0 -1
- package/lib/src/embed/sage.spec.js +0 -148
- package/lib/src/embed/sage.spec.js.map +0 -1
- package/src/embed/sage.spec.ts +0 -206
- package/src/embed/sage.ts +0 -231
|
@@ -783,6 +783,42 @@ export interface CustomCssVariables {
|
|
|
783
783
|
* Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
|
|
784
784
|
*/
|
|
785
785
|
"--ts-var-saved-chats-section-title-color"?: string;
|
|
786
|
+
/**
|
|
787
|
+
* Text color of the styling panel in the Liveboard.
|
|
788
|
+
*/
|
|
789
|
+
"--ts-var-liveboard-styling-panel-text-color"?: string;
|
|
790
|
+
/**
|
|
791
|
+
* Border color of the styling panel in the Liveboard.
|
|
792
|
+
*/
|
|
793
|
+
"--ts-var-liveboard-styling-panel-border-color"?: string;
|
|
794
|
+
/**
|
|
795
|
+
* Background color of the styling button in the Liveboard.
|
|
796
|
+
*/
|
|
797
|
+
"--ts-var-liveboard-styling-button-background"?: string;
|
|
798
|
+
/**
|
|
799
|
+
* Text color of the styling button in the Liveboard.
|
|
800
|
+
*/
|
|
801
|
+
"--ts-var-liveboard-styling-button-text-color"?: string;
|
|
802
|
+
/**
|
|
803
|
+
* Background color of the styling button in the Liveboard on hover.
|
|
804
|
+
*/
|
|
805
|
+
"--ts-var-liveboard-styling-button-hover-background"?: string;
|
|
806
|
+
/**
|
|
807
|
+
* Background color of the styling button in the Liveboard when active.
|
|
808
|
+
*/
|
|
809
|
+
"--ts-var-liveboard-styling-button-active-background"?: string;
|
|
810
|
+
/**
|
|
811
|
+
* Text color of the styling button in the Liveboard on hover.
|
|
812
|
+
*/
|
|
813
|
+
"--ts-var-liveboard-styling-button-hover-text-color"?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Box shadow of the styling button in the Liveboard.
|
|
816
|
+
*/
|
|
817
|
+
"--ts-var-liveboard-styling-button-shadow"?: string;
|
|
818
|
+
/**
|
|
819
|
+
* Background color of the color palette in the Liveboard styling panel.
|
|
820
|
+
*/
|
|
821
|
+
"--ts-var-liveboard-styling-color-palette-background"?: string;
|
|
786
822
|
}
|
|
787
823
|
export interface SessionInterface {
|
|
788
824
|
sessionId: string;
|
|
@@ -1456,11 +1492,6 @@ export interface EmbedConfig {
|
|
|
1456
1492
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1457
1493
|
*/
|
|
1458
1494
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1459
|
-
/**
|
|
1460
|
-
* Hide `beta` alert warning message for SageEmbed.
|
|
1461
|
-
*
|
|
1462
|
-
*/
|
|
1463
|
-
suppressSageEmbedBetaWarning?: boolean;
|
|
1464
1495
|
/**
|
|
1465
1496
|
* Custom style params for embed Config.
|
|
1466
1497
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
@@ -1542,6 +1573,7 @@ export interface EmbedConfig {
|
|
|
1542
1573
|
/**
|
|
1543
1574
|
* Disables the Mixpanel tracking from the SDK.
|
|
1544
1575
|
* @version SDK: 1.27.9
|
|
1576
|
+
* @hidden
|
|
1545
1577
|
*/
|
|
1546
1578
|
disableSDKTracking?: boolean;
|
|
1547
1579
|
/**
|
|
@@ -1844,7 +1876,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1844
1876
|
* The width and height dimensions to render an embedded
|
|
1845
1877
|
* object inside your app. Specify the values in pixels or percentage.
|
|
1846
1878
|
*
|
|
1847
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1879
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1848
1880
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1849
1881
|
* @example
|
|
1850
1882
|
* ```js
|
|
@@ -1873,7 +1905,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1873
1905
|
* for the user.
|
|
1874
1906
|
* Use this to disable actions.
|
|
1875
1907
|
*
|
|
1876
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1908
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1877
1909
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1878
1910
|
* @example
|
|
1879
1911
|
* ```js
|
|
@@ -1888,7 +1920,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1888
1920
|
/**
|
|
1889
1921
|
* The tooltip to display for disabled actions.
|
|
1890
1922
|
*
|
|
1891
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1923
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1892
1924
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1893
1925
|
* @example
|
|
1894
1926
|
* ```js
|
|
@@ -1906,7 +1938,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1906
1938
|
* These actions will be hidden from the user.
|
|
1907
1939
|
* Use this to hide an action.
|
|
1908
1940
|
*
|
|
1909
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1941
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1910
1942
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1911
1943
|
* @example
|
|
1912
1944
|
* ```js
|
|
@@ -1927,7 +1959,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1927
1959
|
*
|
|
1928
1960
|
* Use either this or hiddenActions.
|
|
1929
1961
|
*
|
|
1930
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1962
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1931
1963
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1932
1964
|
* @important
|
|
1933
1965
|
* @example
|
|
@@ -1943,7 +1975,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1943
1975
|
/**
|
|
1944
1976
|
* The locale settings to apply to the embedded view.
|
|
1945
1977
|
*
|
|
1946
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1978
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1947
1979
|
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1948
1980
|
* @example
|
|
1949
1981
|
* ```js
|
|
@@ -1964,7 +1996,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1964
1996
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1965
1997
|
* list of supported keys and values associated with each.
|
|
1966
1998
|
*
|
|
1967
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1999
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1968
2000
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1969
2001
|
* @example
|
|
1970
2002
|
* ```js
|
|
@@ -1992,7 +2024,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1992
2024
|
* Insert as a sibling of the target container, instead of appending to a
|
|
1993
2025
|
* child inside it.
|
|
1994
2026
|
*
|
|
1995
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2027
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1996
2028
|
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
1997
2029
|
* @example
|
|
1998
2030
|
* ```js
|
|
@@ -2018,7 +2050,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2018
2050
|
* Use PreRender to render the embed in the background and then
|
|
2019
2051
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2020
2052
|
*
|
|
2021
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2053
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2022
2054
|
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
2023
2055
|
* @example
|
|
2024
2056
|
* ```js
|
|
@@ -2055,7 +2087,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2055
2087
|
* Enable the V2 shell. This can provide performance benefits
|
|
2056
2088
|
* due to a lighter-weight shell.
|
|
2057
2089
|
*
|
|
2058
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2090
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2059
2091
|
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
2060
2092
|
* @example
|
|
2061
2093
|
* ```js
|
|
@@ -2082,7 +2114,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2082
2114
|
* This flag can be used to disable links inside the embedded app,
|
|
2083
2115
|
* and disable redirection of links in a new tab.
|
|
2084
2116
|
*
|
|
2085
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2117
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2086
2118
|
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
2087
2119
|
* @example
|
|
2088
2120
|
* ```js
|
|
@@ -2101,7 +2133,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2101
2133
|
* The `overrideOrgId` setting is honoured only if the
|
|
2102
2134
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
2103
2135
|
*
|
|
2104
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2136
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2105
2137
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
2106
2138
|
* @example
|
|
2107
2139
|
* ```js
|
|
@@ -2121,7 +2153,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2121
2153
|
* {@link enableLinkOverridesV2} instead.
|
|
2122
2154
|
*
|
|
2123
2155
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2124
|
-
* `
|
|
2156
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2125
2157
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2126
2158
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2127
2159
|
* @example
|
|
@@ -2145,7 +2177,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2145
2177
|
* older ThoughtSpot versions.
|
|
2146
2178
|
*
|
|
2147
2179
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
2148
|
-
* `
|
|
2180
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
2149
2181
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
2150
2182
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
2151
2183
|
* @example
|
|
@@ -2204,7 +2236,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2204
2236
|
* external app, calling an API, or opening a modal — based on the data context of
|
|
2205
2237
|
* what they clicked can be used to trigger custom logic when the action is clicked.
|
|
2206
2238
|
*
|
|
2207
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
2239
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterEmbed`
|
|
2208
2240
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
|
|
2209
2241
|
* @example
|
|
2210
2242
|
* ```ts
|
|
@@ -2558,11 +2590,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2558
2590
|
/**
|
|
2559
2591
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2560
2592
|
*
|
|
2561
|
-
* Supported embed types: `AppEmbed`, `
|
|
2593
|
+
* Supported embed types: `AppEmbed`, `SearchEmbed`
|
|
2562
2594
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2563
2595
|
* @example
|
|
2564
2596
|
* ```js
|
|
2565
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed,
|
|
2597
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchEmbed
|
|
2566
2598
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2567
2599
|
* ... // other embed view config
|
|
2568
2600
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
@@ -2599,12 +2631,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2599
2631
|
/**
|
|
2600
2632
|
* To set the initial state of the search bar in case of saved Answers.
|
|
2601
2633
|
*
|
|
2602
|
-
* Supported embed types: `
|
|
2634
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`
|
|
2603
2635
|
* @default true
|
|
2604
2636
|
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
2605
2637
|
* @example
|
|
2606
2638
|
* ```js
|
|
2607
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
2639
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
2608
2640
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2609
2641
|
* ... // other embed view config
|
|
2610
2642
|
* collapseSearchBar: true,
|
|
@@ -2615,12 +2647,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2615
2647
|
/**
|
|
2616
2648
|
* Flag to control Data panel experience
|
|
2617
2649
|
*
|
|
2618
|
-
* Supported embed types: `
|
|
2650
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2619
2651
|
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
2620
2652
|
* @default true
|
|
2621
2653
|
* @example
|
|
2622
2654
|
* ```js
|
|
2623
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
2655
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
2624
2656
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2625
2657
|
* ... // other embed view config
|
|
2626
2658
|
* dataPanelV2: true,
|
|
@@ -2631,12 +2663,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
2631
2663
|
/**
|
|
2632
2664
|
* To enable custom column groups in data panel v2
|
|
2633
2665
|
*
|
|
2634
|
-
* Supported embed types: `
|
|
2666
|
+
* Supported embed types: `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
2635
2667
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
2636
2668
|
* @default false
|
|
2637
2669
|
* @example
|
|
2638
2670
|
* ```js
|
|
2639
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
2671
|
+
* // Replace <EmbedComponent> with embed component name. For example, SearchBarEmbed, or LiveboardEmbed
|
|
2640
2672
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2641
2673
|
* ... // other embed view config
|
|
2642
2674
|
* enableCustomColumnGroups: true,
|
|
@@ -3629,6 +3661,17 @@ export declare enum EmbedEvent {
|
|
|
3629
3661
|
* ```
|
|
3630
3662
|
*/
|
|
3631
3663
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3664
|
+
/**
|
|
3665
|
+
* Emitted when the Download Liveboard as Continuous PDF action is triggered
|
|
3666
|
+
* on a Liveboard.
|
|
3667
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
3668
|
+
* @example
|
|
3669
|
+
* ```js
|
|
3670
|
+
* liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
|
|
3671
|
+
* console.log('download liveboard as continuous PDF', payload)})
|
|
3672
|
+
* ```
|
|
3673
|
+
*/
|
|
3674
|
+
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
3632
3675
|
/**
|
|
3633
3676
|
* Emitted when an Answer is deleted in the app
|
|
3634
3677
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe
|
|
@@ -4006,19 +4049,6 @@ export declare enum EmbedEvent {
|
|
|
4006
4049
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
4007
4050
|
*/
|
|
4008
4051
|
FilterChanged = "filterChanged",
|
|
4009
|
-
/**
|
|
4010
|
-
* Emitted when a user clicks the **Go** button to initiate
|
|
4011
|
-
* a Natural Language Search query
|
|
4012
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4013
|
-
*/
|
|
4014
|
-
SageEmbedQuery = "sageEmbedQuery",
|
|
4015
|
-
/**
|
|
4016
|
-
* Emitted when a user selects a data source on the embedded
|
|
4017
|
-
* Natural Language Search interface.
|
|
4018
|
-
*
|
|
4019
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4020
|
-
*/
|
|
4021
|
-
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
4022
4052
|
/**
|
|
4023
4053
|
* Emitted when a user updates a connection on the **Data** page
|
|
4024
4054
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
@@ -5156,6 +5186,18 @@ export declare enum HostEvent {
|
|
|
5156
5186
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5157
5187
|
*/
|
|
5158
5188
|
DownloadAsPdf = "downloadAsPdf",
|
|
5189
|
+
/**
|
|
5190
|
+
* Trigger the **Download Liveboard as Continuous PDF** action on an
|
|
5191
|
+
* embedded Liveboard.
|
|
5192
|
+
*
|
|
5193
|
+
* @example
|
|
5194
|
+
* ```js
|
|
5195
|
+
* liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
|
|
5196
|
+
* ```
|
|
5197
|
+
*
|
|
5198
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5199
|
+
*/
|
|
5200
|
+
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
5159
5201
|
/**
|
|
5160
5202
|
* Trigger the **AI Highlights** action on an embedded Liveboard
|
|
5161
5203
|
*
|
|
@@ -5382,6 +5424,20 @@ export declare enum HostEvent {
|
|
|
5382
5424
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
5383
5425
|
* }, ContextType.Liveboard);
|
|
5384
5426
|
* ```
|
|
5427
|
+
* @example
|
|
5428
|
+
* ```js
|
|
5429
|
+
* // Copy link from liveboard context
|
|
5430
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5431
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
|
|
5432
|
+
* ```
|
|
5433
|
+
* @example
|
|
5434
|
+
* ```js
|
|
5435
|
+
* // Copy link from liveboard visualization context
|
|
5436
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5437
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
5438
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
5439
|
+
* }, ContextType.Liveboard);
|
|
5440
|
+
* ```
|
|
5385
5441
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5386
5442
|
*/
|
|
5387
5443
|
CopyLink = "embedDocument",
|
|
@@ -5413,6 +5469,20 @@ export declare enum HostEvent {
|
|
|
5413
5469
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5414
5470
|
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
5415
5471
|
* ```
|
|
5472
|
+
* @example
|
|
5473
|
+
* ```js
|
|
5474
|
+
* // Present from liveboard visualization context
|
|
5475
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5476
|
+
* liveboardEmbed.trigger(HostEvent.Present, {
|
|
5477
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
5478
|
+
* }, ContextType.Liveboard);
|
|
5479
|
+
* ```
|
|
5480
|
+
* @example
|
|
5481
|
+
* ```js
|
|
5482
|
+
* // Present from liveboard context
|
|
5483
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5484
|
+
* liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
|
|
5485
|
+
* ```
|
|
5416
5486
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5417
5487
|
*/
|
|
5418
5488
|
Present = "present",
|
|
@@ -5441,7 +5511,7 @@ export declare enum HostEvent {
|
|
|
5441
5511
|
* tml.answer.search_query // TML representation of the search query
|
|
5442
5512
|
* );
|
|
5443
5513
|
* })
|
|
5444
|
-
|
|
5514
|
+
* ```
|
|
5445
5515
|
* @example
|
|
5446
5516
|
* ```js
|
|
5447
5517
|
* // Get TML from search context
|
|
@@ -6064,21 +6134,6 @@ export declare enum HostEvent {
|
|
|
6064
6134
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
6065
6135
|
*/
|
|
6066
6136
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
6067
|
-
/**
|
|
6068
|
-
* Updates the search query string for Natural Language Search operations.
|
|
6069
|
-
* @param - Includes the following keys:
|
|
6070
|
-
* - `queryString`: Text string in Natural Language format.
|
|
6071
|
-
* - `executeSearch`: Boolean to execute search and update search query.
|
|
6072
|
-
* @example
|
|
6073
|
-
* ```js
|
|
6074
|
-
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
6075
|
-
* queryString: 'revenue per year',
|
|
6076
|
-
* executeSearch: true,
|
|
6077
|
-
* })
|
|
6078
|
-
* ```
|
|
6079
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
6080
|
-
*/
|
|
6081
|
-
UpdateSageQuery = "updateSageQuery",
|
|
6082
6137
|
/**
|
|
6083
6138
|
* Get the Answer session for a Search or
|
|
6084
6139
|
* Liveboard visualization.
|
|
@@ -6898,6 +6953,16 @@ export declare enum Action {
|
|
|
6898
6953
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
6899
6954
|
*/
|
|
6900
6955
|
DownloadLiveboard = "downloadLiveboard",
|
|
6956
|
+
/**
|
|
6957
|
+
* The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
|
|
6958
|
+
* Allows downloading the entire Liveboard as a continuous PDF.
|
|
6959
|
+
* @example
|
|
6960
|
+
* ```js
|
|
6961
|
+
* disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
|
|
6962
|
+
* ```
|
|
6963
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
6964
|
+
*/
|
|
6965
|
+
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
6901
6966
|
/**
|
|
6902
6967
|
* @hidden
|
|
6903
6968
|
*/
|
|
@@ -7854,11 +7919,11 @@ export declare enum Action {
|
|
|
7854
7919
|
*/
|
|
7855
7920
|
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
7856
7921
|
/**
|
|
7857
|
-
|
|
7858
|
-
|
|
7859
|
-
|
|
7860
|
-
|
|
7861
|
-
|
|
7922
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
7923
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
7924
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
7925
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
7926
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
7862
7927
|
* @example
|
|
7863
7928
|
* ```js
|
|
7864
7929
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -7935,17 +8000,17 @@ export declare enum Action {
|
|
|
7935
8000
|
*/
|
|
7936
8001
|
LiveboardStylePanel = "liveboardStylePanel",
|
|
7937
8002
|
/**
|
|
7938
|
-
|
|
7939
|
-
|
|
7940
|
-
|
|
7941
|
-
|
|
7942
|
-
|
|
7943
|
-
|
|
7944
|
-
|
|
7945
|
-
|
|
7946
|
-
|
|
7947
|
-
|
|
7948
|
-
|
|
8003
|
+
* The **Publish** action for Liveboards, Answers and Models.
|
|
8004
|
+
* Opens the publishing modal. It's a parent action for the
|
|
8005
|
+
* **Manage Publishing** and **Unpublish** actions if the object
|
|
8006
|
+
* is already published, otherwise appears standalone.
|
|
8007
|
+
* @example
|
|
8008
|
+
* ```js
|
|
8009
|
+
* hiddenActions: [Action.Publish]
|
|
8010
|
+
* disabledActions: [Action.Publish]
|
|
8011
|
+
* ```
|
|
8012
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
8013
|
+
*/
|
|
7949
8014
|
Publish = "publish",
|
|
7950
8015
|
/**
|
|
7951
8016
|
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
@@ -8113,6 +8178,39 @@ export declare enum Action {
|
|
|
8113
8178
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8114
8179
|
*/
|
|
8115
8180
|
SpotterDocs = "spotterDocs",
|
|
8181
|
+
/**
|
|
8182
|
+
* Controls visibility and disable state of the connector resources
|
|
8183
|
+
* section in the Spotter chat interface.
|
|
8184
|
+
* @example
|
|
8185
|
+
* ```js
|
|
8186
|
+
* hiddenActions: [Action.SpotterChatConnectorResources]
|
|
8187
|
+
* disabledActions: [Action.SpotterChatConnectorResources]
|
|
8188
|
+
* ```
|
|
8189
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8190
|
+
*/
|
|
8191
|
+
SpotterChatConnectorResources = "spotterChatConnectorResources",
|
|
8192
|
+
/**
|
|
8193
|
+
* Controls visibility and disable state of the connectors
|
|
8194
|
+
* in the Spotter chat interface.
|
|
8195
|
+
* @example
|
|
8196
|
+
* ```js
|
|
8197
|
+
* hiddenActions: [Action.SpotterChatConnectors]
|
|
8198
|
+
* disabledActions: [Action.SpotterChatConnectors]
|
|
8199
|
+
* ```
|
|
8200
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8201
|
+
*/
|
|
8202
|
+
SpotterChatConnectors = "spotterChatConnectors",
|
|
8203
|
+
/**
|
|
8204
|
+
* Controls visibility and disable state of the mode switcher
|
|
8205
|
+
* in the Spotter chat interface.
|
|
8206
|
+
* @example
|
|
8207
|
+
* ```js
|
|
8208
|
+
* hiddenActions: [Action.SpotterChatModeSwitcher]
|
|
8209
|
+
* disabledActions: [Action.SpotterChatModeSwitcher]
|
|
8210
|
+
* ```
|
|
8211
|
+
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8212
|
+
*/
|
|
8213
|
+
SpotterChatModeSwitcher = "spotterChatModeSwitcher",
|
|
8116
8214
|
/**
|
|
8117
8215
|
* The **Include current period** checkbox for date filters.
|
|
8118
8216
|
* Controls the visibility and availability of the option to include
|
|
@@ -8456,7 +8554,13 @@ export declare enum EmbedErrorCodes {
|
|
|
8456
8554
|
/** Failed to update embed parameters during pre-render */
|
|
8457
8555
|
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
|
|
8458
8556
|
/** Invalid URL provided in configuration */
|
|
8459
|
-
INVALID_URL = "INVALID_URL"
|
|
8557
|
+
INVALID_URL = "INVALID_URL",
|
|
8558
|
+
/** Host event payload validation failed */
|
|
8559
|
+
HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
|
|
8560
|
+
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
8561
|
+
UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
|
|
8562
|
+
/** DrillDown payload is invalid - missing or malformed points */
|
|
8563
|
+
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
|
|
8460
8564
|
}
|
|
8461
8565
|
/**
|
|
8462
8566
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -8700,6 +8804,8 @@ export declare enum UIPassthroughEvent {
|
|
|
8700
8804
|
GetAnswerConfig = "getAnswerPageConfig",
|
|
8701
8805
|
GetLiveboardConfig = "getPinboardPageConfig",
|
|
8702
8806
|
GetUnsavedAnswerTML = "getUnsavedAnswerTML",
|
|
8807
|
+
UpdateFilters = "updateFilters",
|
|
8808
|
+
Drilldown = "drillDown",
|
|
8703
8809
|
GetAnswerSession = "getAnswerSession",
|
|
8704
8810
|
GetFilters = "getFilters",
|
|
8705
8811
|
GetIframeUrl = "getIframeUrl",
|
|
@@ -8821,6 +8927,35 @@ export type UIPassthroughContractBase = {
|
|
|
8821
8927
|
v2Content: string;
|
|
8822
8928
|
};
|
|
8823
8929
|
};
|
|
8930
|
+
[UIPassthroughEvent.UpdateFilters]: {
|
|
8931
|
+
request: {
|
|
8932
|
+
filter?: {
|
|
8933
|
+
column: string;
|
|
8934
|
+
oper: string;
|
|
8935
|
+
values: string[];
|
|
8936
|
+
type?: string;
|
|
8937
|
+
};
|
|
8938
|
+
filters?: {
|
|
8939
|
+
column: string;
|
|
8940
|
+
oper: string;
|
|
8941
|
+
values: string[];
|
|
8942
|
+
type?: string;
|
|
8943
|
+
}[];
|
|
8944
|
+
};
|
|
8945
|
+
response: unknown;
|
|
8946
|
+
};
|
|
8947
|
+
[UIPassthroughEvent.Drilldown]: {
|
|
8948
|
+
request: {
|
|
8949
|
+
points: {
|
|
8950
|
+
selectedPoints?: string[];
|
|
8951
|
+
clickedPoint?: string;
|
|
8952
|
+
};
|
|
8953
|
+
columnGuid?: string;
|
|
8954
|
+
autoDrillDown?: boolean;
|
|
8955
|
+
vizId?: string;
|
|
8956
|
+
};
|
|
8957
|
+
response: unknown;
|
|
8958
|
+
};
|
|
8824
8959
|
};
|
|
8825
8960
|
export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["request"];
|
|
8826
8961
|
export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]["response"];
|
|
@@ -8846,6 +8981,8 @@ export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT |
|
|
|
8846
8981
|
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
8847
8982
|
declare class HostEventClient {
|
|
8848
8983
|
iFrame: HTMLIFrameElement;
|
|
8984
|
+
/** Cached list of available UI passthrough keys from the embedded app */
|
|
8985
|
+
private availablePassthroughKeysCache;
|
|
8849
8986
|
/** Host events with custom handlers
|
|
8850
8987
|
* (setters or special logic) -
|
|
8851
8988
|
* bound to instance for protected method access */
|
|
@@ -8871,9 +9008,25 @@ declare class HostEventClient {
|
|
|
8871
9008
|
* @param {HTMLIFrameElement} iFrame - the iframe element to set
|
|
8872
9009
|
*/
|
|
8873
9010
|
setIframeElement(iFrame: HTMLIFrameElement): void;
|
|
9011
|
+
/**
|
|
9012
|
+
* Fetches the list of available UI passthrough keys from the embedded app.
|
|
9013
|
+
* Result is cached for the session. Returns empty array on failure.
|
|
9014
|
+
*/
|
|
9015
|
+
private getAvailableUIPassthroughKeys;
|
|
8874
9016
|
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
|
|
8875
9017
|
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
8876
9018
|
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
9019
|
+
protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
|
|
9020
|
+
protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
|
|
9021
|
+
/**
|
|
9022
|
+
* Dispatches a host event using the appropriate channel:
|
|
9023
|
+
* 1. If the embedded app supports UI passthrough for this event, use it (custom handler or getter).
|
|
9024
|
+
* 2. Otherwise fall back to the legacy host event channel.
|
|
9025
|
+
*
|
|
9026
|
+
* @param hostEvent - The host event to trigger
|
|
9027
|
+
* @param payload - Optional payload for the event
|
|
9028
|
+
* @param context - Optional context (e.g. vizId) for scoped operations
|
|
9029
|
+
*/
|
|
8877
9030
|
triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
8878
9031
|
}
|
|
8879
9032
|
declare class TsEmbed {
|
|
@@ -9544,7 +9697,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9544
9697
|
* @default true
|
|
9545
9698
|
* @example
|
|
9546
9699
|
* ```js
|
|
9547
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
9700
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
9548
9701
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9549
9702
|
* ... // other embed view config
|
|
9550
9703
|
* dataPanelV2: true,
|
|
@@ -9720,6 +9873,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
9720
9873
|
*/
|
|
9721
9874
|
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
9722
9875
|
}
|
|
9876
|
+
/**
|
|
9877
|
+
* APP_INIT data shape for SpotterEmbed.
|
|
9878
|
+
* @internal
|
|
9879
|
+
*/
|
|
9880
|
+
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
9881
|
+
embedParams?: {
|
|
9882
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9883
|
+
};
|
|
9884
|
+
}
|
|
9723
9885
|
/**
|
|
9724
9886
|
* Embed ThoughtSpot AI Conversation.
|
|
9725
9887
|
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
@@ -9738,6 +9900,19 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
9738
9900
|
export declare class SpotterEmbed extends TsEmbed {
|
|
9739
9901
|
protected viewConfig: SpotterEmbedViewConfig;
|
|
9740
9902
|
constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
|
|
9903
|
+
/**
|
|
9904
|
+
* Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
|
|
9905
|
+
* so the conv-assist app can read sidebar configuration on initialisation.
|
|
9906
|
+
*
|
|
9907
|
+
* Precedence for `enablePastConversationsSidebar`:
|
|
9908
|
+
* `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
|
|
9909
|
+
* deprecated top-level `enablePastConversationsSidebar` flag; if the former
|
|
9910
|
+
* is absent the latter is used as a fallback.
|
|
9911
|
+
*
|
|
9912
|
+
* An invalid `spotterDocumentationUrl` triggers a validation error and is
|
|
9913
|
+
* excluded from the payload rather than forwarded to the app.
|
|
9914
|
+
*/
|
|
9915
|
+
protected getAppInitData(): Promise<SpotterAppInitData>;
|
|
9741
9916
|
protected getEmbedParamsObject(): Record<any, any>;
|
|
9742
9917
|
getIframeSrc(): string;
|
|
9743
9918
|
render(): Promise<SpotterEmbed>;
|
|
@@ -10266,21 +10441,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10266
10441
|
* @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
10267
10442
|
*/
|
|
10268
10443
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
10269
|
-
/**
|
|
10270
|
-
* This flag is used to enable unified search experience for full app embed.
|
|
10271
|
-
*
|
|
10272
|
-
* Supported embed types: `AppEmbed`
|
|
10273
|
-
* @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
|
|
10274
|
-
* @default true
|
|
10275
|
-
* @example
|
|
10276
|
-
* ```js
|
|
10277
|
-
* const embed = new AppEmbed('#tsEmbed', {
|
|
10278
|
-
* ... // other embed view config
|
|
10279
|
-
* isUnifiedSearchExperienceEnabled: true,
|
|
10280
|
-
* })
|
|
10281
|
-
* ```
|
|
10282
|
-
*/
|
|
10283
|
-
isUnifiedSearchExperienceEnabled?: boolean;
|
|
10284
10444
|
/**
|
|
10285
10445
|
* This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
|
|
10286
10446
|
* @deprecated This flag is deprecated.
|
|
@@ -10315,6 +10475,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10315
10475
|
* ```
|
|
10316
10476
|
*/
|
|
10317
10477
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
10478
|
+
/**
|
|
10479
|
+
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
10480
|
+
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
10481
|
+
* This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
|
|
10482
|
+
*
|
|
10483
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
10484
|
+
* @type {boolean}
|
|
10485
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
10486
|
+
* @example
|
|
10487
|
+
* ```js
|
|
10488
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
10489
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
10490
|
+
* ... // other embed view config
|
|
10491
|
+
* isContinuousLiveboardPDFEnabled: true,
|
|
10492
|
+
* })
|
|
10493
|
+
* ```
|
|
10494
|
+
*/
|
|
10495
|
+
isContinuousLiveboardPDFEnabled?: boolean;
|
|
10318
10496
|
/**
|
|
10319
10497
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
10320
10498
|
*
|
|
@@ -10483,6 +10661,15 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
10483
10661
|
*/
|
|
10484
10662
|
enableHomepageAnnouncement?: boolean;
|
|
10485
10663
|
}
|
|
10664
|
+
/**
|
|
10665
|
+
* APP_INIT data shape for AppEmbed.
|
|
10666
|
+
* @internal
|
|
10667
|
+
*/
|
|
10668
|
+
export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
10669
|
+
embedParams?: {
|
|
10670
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
10671
|
+
};
|
|
10672
|
+
}
|
|
10486
10673
|
/**
|
|
10487
10674
|
* Embeds full ThoughtSpot experience in a host application.
|
|
10488
10675
|
* @group Embed components
|
|
@@ -10491,6 +10678,19 @@ export declare class AppEmbed extends V1Embed {
|
|
|
10491
10678
|
protected viewConfig: AppViewConfig;
|
|
10492
10679
|
private defaultHeight;
|
|
10493
10680
|
constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
|
|
10681
|
+
/**
|
|
10682
|
+
* Extends the default APP_INIT payload with `embedParams.spotterSidebarConfig`
|
|
10683
|
+
* so the conv-assist app can read sidebar configuration on initialisation.
|
|
10684
|
+
*
|
|
10685
|
+
* Precedence for `enablePastConversationsSidebar`:
|
|
10686
|
+
* `spotterSidebarConfig.enablePastConversationsSidebar` wins over the
|
|
10687
|
+
* deprecated top-level `enablePastConversationsSidebar` flag; if the former
|
|
10688
|
+
* is absent the latter is used as a fallback.
|
|
10689
|
+
*
|
|
10690
|
+
* An invalid `spotterDocumentationUrl` triggers a validation error and is
|
|
10691
|
+
* excluded from the payload rather than forwarded to the app.
|
|
10692
|
+
*/
|
|
10693
|
+
protected getAppInitData(): Promise<AppEmbedAppInitData>;
|
|
10494
10694
|
/**
|
|
10495
10695
|
* Constructs a map of parameters to be passed on to the
|
|
10496
10696
|
* embedded Liveboard or visualization.
|
|
@@ -10509,7 +10709,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
10509
10709
|
* @param pageId The ID of the page to be embedded.
|
|
10510
10710
|
*/
|
|
10511
10711
|
getIFrameSrc(): string;
|
|
10512
|
-
private HEIGHT_CHANAGE_THRESHOLD;
|
|
10513
10712
|
/**
|
|
10514
10713
|
* Set the iframe height as per the computed height received
|
|
10515
10714
|
* from the ThoughtSpot app.
|
|
@@ -11192,6 +11391,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
11192
11391
|
* ```
|
|
11193
11392
|
*/
|
|
11194
11393
|
isPNGInScheduledEmailsEnabled?: boolean;
|
|
11394
|
+
/**
|
|
11395
|
+
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
11396
|
+
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
11397
|
+
* This feature is GA from version 26.5.0.cl and is enabled by default on embed deployments.
|
|
11398
|
+
*
|
|
11399
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
11400
|
+
* @type {boolean}
|
|
11401
|
+
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
11402
|
+
* @example
|
|
11403
|
+
* ```js
|
|
11404
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
11405
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
11406
|
+
* ... // other embed view config
|
|
11407
|
+
* isContinuousLiveboardPDFEnabled: true,
|
|
11408
|
+
* })
|
|
11409
|
+
* ```
|
|
11410
|
+
*/
|
|
11411
|
+
isContinuousLiveboardPDFEnabled?: boolean;
|
|
11195
11412
|
/**
|
|
11196
11413
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
11197
11414
|
*
|
|
@@ -11352,7 +11569,6 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
11352
11569
|
* to be loaded within the iFrame.
|
|
11353
11570
|
*/
|
|
11354
11571
|
private getIFrameSrc;
|
|
11355
|
-
private HEIGHT_CHANAGE_THRESHOLD;
|
|
11356
11572
|
/**
|
|
11357
11573
|
* Set the iframe height as per the computed height received
|
|
11358
11574
|
* from the ThoughtSpot app.
|
|
@@ -11981,157 +12197,6 @@ export type SessionInfo = {
|
|
|
11981
12197
|
* @returns {Promise<SessionInfo>} The session info object.
|
|
11982
12198
|
*/
|
|
11983
12199
|
export declare function getSessionInfo(): Promise<SessionInfo>;
|
|
11984
|
-
interface SearchOptions$2 {
|
|
11985
|
-
/**
|
|
11986
|
-
* The query string to pass for Natural Language Search.
|
|
11987
|
-
*/
|
|
11988
|
-
searchQuery: string;
|
|
11989
|
-
/**
|
|
11990
|
-
* Boolean to define if the search should be executed or not.
|
|
11991
|
-
* If it is executed, the focus is placed on the results.
|
|
11992
|
-
* If it’s not executed, the focus is placed at the end of
|
|
11993
|
-
* the token string in the search bar.
|
|
11994
|
-
*/
|
|
11995
|
-
executeSearch?: boolean;
|
|
11996
|
-
}
|
|
11997
|
-
/**
|
|
11998
|
-
* The configuration attributes for the embedded Natural language search view. Based on
|
|
11999
|
-
* GPT and LLM.
|
|
12000
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12001
|
-
*
|
|
12002
|
-
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
12003
|
-
* @group Embed components
|
|
12004
|
-
*/
|
|
12005
|
-
export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, "primaryAction" | "runtimeFilters" | "runtimeParameters" | "excludeRuntimeFiltersfromURL" | "excludeRuntimeParametersfromURL"> {
|
|
12006
|
-
/**
|
|
12007
|
-
* If set to true, a list of Liveboard and Answers related
|
|
12008
|
-
* to the natural language search will be shown below the
|
|
12009
|
-
* AI generated answer.
|
|
12010
|
-
* @deprecated Currently Liveboard and Answers related
|
|
12011
|
-
* to the natural language search will not be shown for sage
|
|
12012
|
-
* embed
|
|
12013
|
-
*/
|
|
12014
|
-
showObjectResults?: boolean;
|
|
12015
|
-
/**
|
|
12016
|
-
* flag used by the TS product tour page to show the blue search bar
|
|
12017
|
-
* even after the search is completed. This is different from ThoughtSpot Embedded
|
|
12018
|
-
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
12019
|
-
* The Sample questions container is collapsed when this value is set after
|
|
12020
|
-
* does a search.
|
|
12021
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
|
|
12022
|
-
* @hidden
|
|
12023
|
-
*/
|
|
12024
|
-
isProductTour?: boolean;
|
|
12025
|
-
/**
|
|
12026
|
-
* Show or hide the search bar title.
|
|
12027
|
-
* @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12028
|
-
* @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
12029
|
-
*/
|
|
12030
|
-
hideSearchBarTitle?: boolean;
|
|
12031
|
-
/**
|
|
12032
|
-
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
12033
|
-
* at the top of the Answer page.
|
|
12034
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
|
|
12035
|
-
*/
|
|
12036
|
-
hideSageAnswerHeader?: boolean;
|
|
12037
|
-
/**
|
|
12038
|
-
* Disable the data source selection option.
|
|
12039
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12040
|
-
*/
|
|
12041
|
-
disableWorksheetChange?: boolean;
|
|
12042
|
-
/**
|
|
12043
|
-
* Hide the data source selection panel.
|
|
12044
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12045
|
-
*/
|
|
12046
|
-
hideWorksheetSelector?: boolean;
|
|
12047
|
-
/**
|
|
12048
|
-
* Show or hide autocomplete suggestions for the search query string.
|
|
12049
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12050
|
-
*/
|
|
12051
|
-
hideAutocompleteSuggestions?: boolean;
|
|
12052
|
-
/**
|
|
12053
|
-
* Show or hide autocomplete suggestions for the search query string.
|
|
12054
|
-
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
12055
|
-
* @deprecated
|
|
12056
|
-
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
12057
|
-
*/
|
|
12058
|
-
showObjectSuggestions?: boolean;
|
|
12059
|
-
/**
|
|
12060
|
-
* Show or hide sample questions.
|
|
12061
|
-
* The sample questions are autogenerated based on the data model
|
|
12062
|
-
* selected for the search operation.
|
|
12063
|
-
*
|
|
12064
|
-
* Supported embed types: `SageEmbed`
|
|
12065
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12066
|
-
* @example
|
|
12067
|
-
* ```js
|
|
12068
|
-
* const embed = new SageEmbed('#tsEmbed', {
|
|
12069
|
-
* ... //other embed view config
|
|
12070
|
-
* hideSampleQuestions : true,
|
|
12071
|
-
* })
|
|
12072
|
-
* ```
|
|
12073
|
-
*/
|
|
12074
|
-
hideSampleQuestions?: boolean;
|
|
12075
|
-
/**
|
|
12076
|
-
* The data source GUID (Model GUID) to set on load.
|
|
12077
|
-
*/
|
|
12078
|
-
dataSource?: string;
|
|
12079
|
-
/**
|
|
12080
|
-
* Includes the following properties:
|
|
12081
|
-
*
|
|
12082
|
-
* `searchQuery`: The search query string to pass in the search bar.
|
|
12083
|
-
* Supports Natural Language Search queries.
|
|
12084
|
-
*
|
|
12085
|
-
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
12086
|
-
* If it is executed, the focus is placed on the results.
|
|
12087
|
-
* If it’s not executed, the focus is placed at the end of
|
|
12088
|
-
* the token string in the search bar.
|
|
12089
|
-
*
|
|
12090
|
-
* Supported embed types: `SageEmbed`
|
|
12091
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
12092
|
-
* @example
|
|
12093
|
-
* ```js
|
|
12094
|
-
* searchOptions: {
|
|
12095
|
-
* searchQuery: 'average sales by country and product type',
|
|
12096
|
-
* executeSearch: true,
|
|
12097
|
-
* }
|
|
12098
|
-
* ```
|
|
12099
|
-
*/
|
|
12100
|
-
searchOptions?: SearchOptions$2;
|
|
12101
|
-
}
|
|
12102
|
-
/**
|
|
12103
|
-
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
12104
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
12105
|
-
*
|
|
12106
|
-
* Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
|
|
12107
|
-
* @group Embed components
|
|
12108
|
-
*/
|
|
12109
|
-
export declare class SageEmbed extends V1Embed {
|
|
12110
|
-
/**
|
|
12111
|
-
* The view configuration for the embedded ThoughtSpot sage.
|
|
12112
|
-
*
|
|
12113
|
-
*/
|
|
12114
|
-
protected viewConfig: SageViewConfig;
|
|
12115
|
-
constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
|
|
12116
|
-
protected getEmbedParamsObject(): Record<any, any>;
|
|
12117
|
-
/**
|
|
12118
|
-
* Constructs a map of parameters to be passed on to the
|
|
12119
|
-
* embedded Eureka or Sage search page.
|
|
12120
|
-
* @returns {string} query string
|
|
12121
|
-
*/
|
|
12122
|
-
protected getEmbedParams(): string;
|
|
12123
|
-
/**
|
|
12124
|
-
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
12125
|
-
* loaded in the iframe
|
|
12126
|
-
* @returns {string} iframe url
|
|
12127
|
-
*/
|
|
12128
|
-
getIFrameSrc(): string;
|
|
12129
|
-
/**
|
|
12130
|
-
* Render the embedded ThoughtSpot Sage
|
|
12131
|
-
* @returns {SageEmbed} Eureka/Sage embed
|
|
12132
|
-
*/
|
|
12133
|
-
render(): Promise<SageEmbed>;
|
|
12134
|
-
}
|
|
12135
12200
|
/**
|
|
12136
12201
|
* Gets the embed configuration settings that were used to
|
|
12137
12202
|
* initialize the SDK.
|