@thoughtspot/visual-embed-sdk 1.29.1 → 1.30.0-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/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +15 -0
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +13 -2
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +2 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +2 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/config.d.ts +1 -0
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +2 -0
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/embed/app.d.ts +50 -4
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +7 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +13 -6
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -1
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +2 -0
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +2 -0
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +30 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +5 -0
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +18 -2
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +5 -0
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +11 -0
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +2 -0
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +34 -5
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +7 -4
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +31 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +37 -6
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +9 -18
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +1 -0
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +1 -0
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +1 -0
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +1 -0
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/index.d.ts +12 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +11 -1
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +2 -14
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/test/test-utils.d.ts +2 -0
- package/cjs/src/test/test-utils.d.ts.map +1 -1
- package/cjs/src/test/test-utils.js +2 -0
- package/cjs/src/test/test-utils.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +1 -0
- package/cjs/src/tokenizedFetch.d.ts.map +1 -1
- package/cjs/src/tokenizedFetch.js +1 -0
- package/cjs/src/tokenizedFetch.js.map +1 -1
- package/cjs/src/types.d.ts +372 -59
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +297 -51
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +1 -0
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +1 -0
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +12 -0
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +12 -0
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +1 -0
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +2 -0
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +11 -0
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +15 -0
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +2 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/config.d.ts +1 -0
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +50 -4
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +7 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +2 -0
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +30 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +18 -2
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +11 -0
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +34 -5
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +31 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +1 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +1 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +12 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +2 -0
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/tokenizedFetch.d.ts +1 -0
- package/dist/src/tokenizedFetch.d.ts.map +1 -1
- package/dist/src/types.d.ts +372 -59
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +1 -0
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +12 -0
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +1 -0
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +7426 -7073
- package/dist/tsembed-react.js +7441 -7092
- package/dist/tsembed.es.js +8781 -8431
- package/dist/tsembed.js +12901 -12559
- package/dist/visual-embed-sdk-react-full.d.ts +584 -70
- package/dist/visual-embed-sdk-react.d.ts +584 -70
- package/dist/visual-embed-sdk.d.ts +572 -69
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +15 -0
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +14 -3
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +2 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +2 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/config.d.ts +1 -0
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +2 -0
- package/lib/src/config.js.map +1 -1
- package/lib/src/embed/app.d.ts +50 -4
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +10 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +7 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +12 -5
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +2 -0
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +2 -0
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +30 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +6 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/sage.d.ts +18 -2
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +5 -0
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +11 -0
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +2 -0
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +34 -5
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +8 -5
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +31 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +40 -9
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +9 -18
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +1 -0
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -0
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +1 -0
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +1 -0
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/index.d.ts +12 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +11 -1
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +3 -15
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +2 -0
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +2 -0
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +1 -0
- package/lib/src/tokenizedFetch.d.ts.map +1 -1
- package/lib/src/tokenizedFetch.js +1 -0
- package/lib/src/tokenizedFetch.js.map +1 -1
- package/lib/src/types.d.ts +372 -59
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +297 -51
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +1 -0
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +1 -0
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +1 -1
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +12 -0
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +12 -0
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +1 -0
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +2 -0
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +11 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +576 -73
- package/package.json +1 -1
- package/src/auth.ts +23 -6
- package/src/authToken.ts +2 -1
- package/src/config.ts +2 -0
- package/src/embed/app.ts +63 -16
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +21 -15
- package/src/embed/embedConfig.ts +2 -0
- package/src/embed/liveboard.ts +38 -1
- package/src/embed/sage.ts +18 -2
- package/src/embed/search-bar.tsx +11 -0
- package/src/embed/search.spec.ts +1 -2
- package/src/embed/search.ts +48 -21
- package/src/embed/ts-embed.spec.ts +24 -37
- package/src/embed/ts-embed.ts +72 -38
- package/src/index.ts +1 -0
- package/src/mixpanel-service.ts +1 -0
- package/src/react/index.spec.tsx +59 -47
- package/src/react/index.tsx +12 -1
- package/src/test/test-utils.ts +2 -0
- package/src/tokenizedFetch.ts +1 -0
- package/src/types.ts +377 -65
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/authService/authService.ts +1 -0
- package/src/utils/graphql/answerService/answerService.ts +12 -0
- package/src/utils/processTrigger.ts +2 -0
- package/src/utils.ts +11 -0
|
@@ -13,6 +13,7 @@ interface PreRenderProps {
|
|
|
13
13
|
* PreRender id to be used for PreRendering the embed.
|
|
14
14
|
* Use PreRender to render the embed in the background and then
|
|
15
15
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
16
|
+
*
|
|
16
17
|
* @example
|
|
17
18
|
* ```js
|
|
18
19
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -39,6 +40,7 @@ interface PreRenderProps {
|
|
|
39
40
|
}
|
|
40
41
|
/**
|
|
41
42
|
* React component for Search Embed.
|
|
43
|
+
*
|
|
42
44
|
* @example
|
|
43
45
|
* ```tsx
|
|
44
46
|
* function Search() {
|
|
@@ -55,6 +57,7 @@ interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
55
57
|
}
|
|
56
58
|
/**
|
|
57
59
|
* React component for Full app Embed.
|
|
60
|
+
*
|
|
58
61
|
* @example
|
|
59
62
|
* ```tsx
|
|
60
63
|
* function Search() {
|
|
@@ -74,6 +77,7 @@ export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttri
|
|
|
74
77
|
* default.
|
|
75
78
|
*
|
|
76
79
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
80
|
+
*
|
|
77
81
|
* @example
|
|
78
82
|
* ```tsx
|
|
79
83
|
* function LandingPageComponent() {
|
|
@@ -90,6 +94,7 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
|
|
|
90
94
|
}
|
|
91
95
|
/**
|
|
92
96
|
* React component for Liveboard embed.
|
|
97
|
+
*
|
|
93
98
|
* @example
|
|
94
99
|
* ```tsx
|
|
95
100
|
* function Liveboard() {
|
|
@@ -107,13 +112,14 @@ export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & Rea
|
|
|
107
112
|
/**
|
|
108
113
|
* React component for PreRendered Liveboard embed.
|
|
109
114
|
*
|
|
110
|
-
*
|
|
115
|
+
* PreRenderedLiveboardEmbed will preRender the liveboard and will be hidden by default.
|
|
111
116
|
*
|
|
112
117
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
113
118
|
*
|
|
114
119
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
115
120
|
* tries to preRender the LiveboardEmbed, so it is recommended to use pass the
|
|
116
121
|
* liveboardId to both the components.
|
|
122
|
+
*
|
|
117
123
|
* @example
|
|
118
124
|
* ```tsx
|
|
119
125
|
* function LandingPageComponent() {
|
|
@@ -131,6 +137,7 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
131
137
|
}
|
|
132
138
|
/**
|
|
133
139
|
* React component for Search bar embed.
|
|
140
|
+
*
|
|
134
141
|
* @example
|
|
135
142
|
* ```tsx
|
|
136
143
|
* function SearchBar() {
|
|
@@ -149,6 +156,7 @@ export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps
|
|
|
149
156
|
* default.
|
|
150
157
|
*
|
|
151
158
|
* SearchBarEmbed with preRenderId passed will call showPreRender on the embed.
|
|
159
|
+
*
|
|
152
160
|
* @example
|
|
153
161
|
* ```tsx
|
|
154
162
|
* function LandingPageComponent() {
|
|
@@ -165,6 +173,7 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
165
173
|
}
|
|
166
174
|
/**
|
|
167
175
|
* React component for LLM based search Sage embed.
|
|
176
|
+
*
|
|
168
177
|
* @example
|
|
169
178
|
* ```tsx
|
|
170
179
|
* function Sage() {
|
|
@@ -183,6 +192,7 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
|
|
|
183
192
|
* default.
|
|
184
193
|
*
|
|
185
194
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
195
|
+
*
|
|
186
196
|
* @example
|
|
187
197
|
* ```tsx
|
|
188
198
|
* function LandingPageComponent() {
|
|
@@ -198,6 +208,7 @@ export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProp
|
|
|
198
208
|
type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
|
|
199
209
|
/**
|
|
200
210
|
* Get a reference to the embed component to trigger events on the component.
|
|
211
|
+
*
|
|
201
212
|
* @example
|
|
202
213
|
* ```
|
|
203
214
|
* function Component() {
|
|
@@ -219,6 +230,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
|
|
|
219
230
|
*
|
|
220
231
|
* ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
|
|
221
232
|
* in other web applications.
|
|
233
|
+
*
|
|
222
234
|
* @summary ThoughtSpot Visual Embed SDK
|
|
223
235
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
224
236
|
*/
|
|
@@ -231,8 +243,11 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
231
243
|
/**
|
|
232
244
|
* The array of data source GUIDs to set on load.
|
|
233
245
|
* Only a single data source is supported currently.
|
|
246
|
+
*
|
|
234
247
|
* @deprecated Use `dataSource` instead
|
|
248
|
+
*
|
|
235
249
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
250
|
+
*
|
|
236
251
|
* @example
|
|
237
252
|
* ```js
|
|
238
253
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -244,7 +259,9 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
244
259
|
dataSources?: string[];
|
|
245
260
|
/**
|
|
246
261
|
* Pass the ID of the source to be selected.
|
|
262
|
+
*
|
|
247
263
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
264
|
+
*
|
|
248
265
|
* @example
|
|
249
266
|
* ```js
|
|
250
267
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -256,7 +273,9 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
256
273
|
dataSource?: string;
|
|
257
274
|
/**
|
|
258
275
|
* Boolean to define if the last selected data source should be used
|
|
276
|
+
*
|
|
259
277
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
278
|
+
*
|
|
260
279
|
* @example
|
|
261
280
|
* ```js
|
|
262
281
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -276,7 +295,9 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
276
295
|
* If it is executed, the focus is placed on the results.
|
|
277
296
|
* If it’s not executed, the focus is placed at the end of
|
|
278
297
|
* the token string in the search bar.
|
|
298
|
+
*
|
|
279
299
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
300
|
+
*
|
|
280
301
|
* @example
|
|
281
302
|
* ```js
|
|
282
303
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -292,6 +313,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
292
313
|
}
|
|
293
314
|
/**
|
|
294
315
|
* Embed ThoughtSpot search bar
|
|
316
|
+
*
|
|
295
317
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
296
318
|
* @group Embed components
|
|
297
319
|
*/
|
|
@@ -312,6 +334,7 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
312
334
|
* Copyright (c) 2023
|
|
313
335
|
*
|
|
314
336
|
* Embed ThoughtSpot Sage
|
|
337
|
+
*
|
|
315
338
|
* @summary TS Sage embed
|
|
316
339
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
317
340
|
*/
|
|
@@ -334,6 +357,7 @@ export interface SearchOptions {
|
|
|
334
357
|
/**
|
|
335
358
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
336
359
|
* GPT and LLM.
|
|
360
|
+
*
|
|
337
361
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
338
362
|
* @group Embed components
|
|
339
363
|
*/
|
|
@@ -342,6 +366,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
342
366
|
* If set to true, a list of Liveboard and Answers related
|
|
343
367
|
* to the natural language search will be shown below the
|
|
344
368
|
* AI generated answer.
|
|
369
|
+
*
|
|
345
370
|
* @deprecated Currently Liveboard and Answers related
|
|
346
371
|
* to the natural language search will not be shown for sage
|
|
347
372
|
* embed
|
|
@@ -349,10 +374,11 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
349
374
|
showObjectResults?: boolean;
|
|
350
375
|
/**
|
|
351
376
|
* flag used by the TS product tour page to show the blue search bar
|
|
352
|
-
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
353
|
-
*
|
|
377
|
+
* even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
|
|
378
|
+
* experience where it mimics closer to the non-embed case.
|
|
354
379
|
* The Sample questions container is collapsed when this value is set after
|
|
355
380
|
* does a search.
|
|
381
|
+
*
|
|
356
382
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
357
383
|
* @hidden
|
|
358
384
|
*/
|
|
@@ -360,32 +386,38 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
360
386
|
/**
|
|
361
387
|
* Show or hide the search bar title.
|
|
362
388
|
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
389
|
+
*
|
|
363
390
|
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
364
391
|
*/
|
|
365
392
|
hideSearchBarTitle?: boolean;
|
|
366
393
|
/**
|
|
367
394
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
368
395
|
* at the top of the Answer page.
|
|
396
|
+
*
|
|
369
397
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
370
398
|
*/
|
|
371
399
|
hideSageAnswerHeader?: boolean;
|
|
372
400
|
/**
|
|
373
401
|
* Disable the worksheet selection option.
|
|
402
|
+
*
|
|
374
403
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
375
404
|
*/
|
|
376
405
|
disableWorksheetChange?: boolean;
|
|
377
406
|
/**
|
|
378
407
|
* Hide the worksheet selection panel.
|
|
408
|
+
*
|
|
379
409
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
380
410
|
*/
|
|
381
411
|
hideWorksheetSelector?: boolean;
|
|
382
412
|
/**
|
|
383
413
|
* Show or hide autocomplete suggestions for the search query string.
|
|
414
|
+
*
|
|
384
415
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
385
416
|
*/
|
|
386
417
|
hideAutocompleteSuggestions?: boolean;
|
|
387
418
|
/**
|
|
388
419
|
* Show or hide autocomplete suggestions for the search query string.
|
|
420
|
+
*
|
|
389
421
|
* @deprecated
|
|
390
422
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
391
423
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -395,6 +427,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
395
427
|
* Show or hide sample questions.
|
|
396
428
|
* The sample questions are autogenerated based on the worksheet
|
|
397
429
|
* selected for the search operation.
|
|
430
|
+
*
|
|
398
431
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
399
432
|
*/
|
|
400
433
|
hideSampleQuestions?: boolean;
|
|
@@ -412,6 +445,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
412
445
|
* If it is executed, the focus is placed on the results.
|
|
413
446
|
* If it’s not executed, the focus is placed at the end of
|
|
414
447
|
* the token string in the search bar.
|
|
448
|
+
*
|
|
415
449
|
* @example
|
|
416
450
|
* ```js
|
|
417
451
|
* searchOptions: {
|
|
@@ -425,6 +459,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
425
459
|
}
|
|
426
460
|
/**
|
|
427
461
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
462
|
+
*
|
|
428
463
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
429
464
|
* @group Embed components
|
|
430
465
|
*/
|
|
@@ -438,17 +473,20 @@ export declare class SageEmbed extends V1Embed {
|
|
|
438
473
|
/**
|
|
439
474
|
* Constructs a map of parameters to be passed on to the
|
|
440
475
|
* embedded Eureka or Sage search page.
|
|
476
|
+
*
|
|
441
477
|
* @returns {string} query string
|
|
442
478
|
*/
|
|
443
479
|
protected getEmbedParams(): string;
|
|
444
480
|
/**
|
|
445
481
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
446
482
|
* loaded in the iframe
|
|
483
|
+
*
|
|
447
484
|
* @returns {string} iframe url
|
|
448
485
|
*/
|
|
449
486
|
getIFrameSrc(): string;
|
|
450
487
|
/**
|
|
451
488
|
* Render the embedded ThoughtSpot Sage
|
|
489
|
+
*
|
|
452
490
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
453
491
|
*/
|
|
454
492
|
render(): Promise<SageEmbed>;
|
|
@@ -458,6 +496,7 @@ export declare class SageEmbed extends V1Embed {
|
|
|
458
496
|
* Copyright (c) 2022
|
|
459
497
|
*
|
|
460
498
|
* Embed ThoughtSpot search or a saved answer
|
|
499
|
+
*
|
|
461
500
|
* @summary Search embed
|
|
462
501
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
463
502
|
*/
|
|
@@ -498,13 +537,16 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
498
537
|
}
|
|
499
538
|
/**
|
|
500
539
|
* The configuration attributes for the embedded search view.
|
|
540
|
+
*
|
|
501
541
|
* @group Embed components
|
|
502
542
|
*/
|
|
503
543
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
504
544
|
/**
|
|
505
545
|
* If set to true, the data sources panel is collapsed on load,
|
|
506
546
|
* but can be expanded manually.
|
|
547
|
+
*
|
|
507
548
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
549
|
+
*
|
|
508
550
|
* @example
|
|
509
551
|
* ```js
|
|
510
552
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -516,7 +558,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
516
558
|
collapseDataSources?: boolean;
|
|
517
559
|
/**
|
|
518
560
|
* Show or hide the data sources panel.
|
|
561
|
+
*
|
|
519
562
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
563
|
+
*
|
|
520
564
|
* @example
|
|
521
565
|
* ```js
|
|
522
566
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -530,7 +574,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
530
574
|
* Show or hide the charts and tables in search answers.
|
|
531
575
|
* This attribute can be used to create a custom visualization
|
|
532
576
|
* using raw answer data.
|
|
577
|
+
*
|
|
533
578
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
579
|
+
*
|
|
534
580
|
* @example
|
|
535
581
|
* ```js
|
|
536
582
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -540,13 +586,11 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
540
586
|
* ```
|
|
541
587
|
*/
|
|
542
588
|
hideResults?: boolean;
|
|
543
|
-
/**
|
|
544
|
-
* If set to true, expands all the data sources panel.
|
|
545
|
-
*/
|
|
546
|
-
expandAllDataSource?: boolean;
|
|
547
589
|
/**
|
|
548
590
|
* If set to true, the Search Assist feature is enabled.
|
|
591
|
+
*
|
|
549
592
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
593
|
+
*
|
|
550
594
|
* @example
|
|
551
595
|
* ```js
|
|
552
596
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -559,7 +603,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
559
603
|
/**
|
|
560
604
|
* If set to true, the tabular view is set as the default
|
|
561
605
|
* format for presenting search data.
|
|
606
|
+
*
|
|
562
607
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
608
|
+
*
|
|
563
609
|
* @example
|
|
564
610
|
* ```js
|
|
565
611
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -571,7 +617,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
571
617
|
/**
|
|
572
618
|
* The array of data source GUIDs to set on load.
|
|
573
619
|
* Only a single data source is supported currently.
|
|
620
|
+
*
|
|
574
621
|
* @deprecated Use `dataSource` instead.
|
|
622
|
+
*
|
|
575
623
|
* @example
|
|
576
624
|
* ```js
|
|
577
625
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -583,7 +631,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
583
631
|
dataSources?: string[];
|
|
584
632
|
/**
|
|
585
633
|
* The array of data source GUIDs to set on load.
|
|
634
|
+
*
|
|
586
635
|
* @version: SDK: 1.19.0
|
|
636
|
+
*
|
|
587
637
|
* @example
|
|
588
638
|
* ```js
|
|
589
639
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -595,6 +645,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
595
645
|
dataSource?: string;
|
|
596
646
|
/**
|
|
597
647
|
* The initial search query to load the answer with.
|
|
648
|
+
*
|
|
598
649
|
* @deprecated
|
|
599
650
|
*
|
|
600
651
|
* Use {@link searchOptions} instead.
|
|
@@ -610,6 +661,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
610
661
|
* If it is executed, the focus is placed on the results.
|
|
611
662
|
* If it’s not executed, the focus is placed at the end of
|
|
612
663
|
* the token string in the search bar.
|
|
664
|
+
*
|
|
613
665
|
* @example
|
|
614
666
|
* ```js
|
|
615
667
|
* searchOptions: {
|
|
@@ -621,7 +673,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
621
673
|
searchOptions?: SearchOptions;
|
|
622
674
|
/**
|
|
623
675
|
* The GUID of a saved answer to load initially.
|
|
676
|
+
*
|
|
624
677
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
678
|
+
*
|
|
625
679
|
* @example
|
|
626
680
|
* ```js
|
|
627
681
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -634,7 +688,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
634
688
|
/**
|
|
635
689
|
* If set to true, the search page will render without the Search Bar
|
|
636
690
|
* The chart/table should still be visible.
|
|
691
|
+
*
|
|
637
692
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
693
|
+
*
|
|
638
694
|
* @example
|
|
639
695
|
* ```js
|
|
640
696
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -646,8 +702,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
646
702
|
hideSearchBar?: boolean;
|
|
647
703
|
/**
|
|
648
704
|
* Flag to control Data panel experience
|
|
705
|
+
*
|
|
649
706
|
* @default false
|
|
650
707
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
708
|
+
*
|
|
651
709
|
* @example
|
|
652
710
|
* ```js
|
|
653
711
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -659,19 +717,23 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
659
717
|
dataPanelV2?: boolean;
|
|
660
718
|
/**
|
|
661
719
|
* Flag to set if last selected dataSource should be used
|
|
720
|
+
*
|
|
662
721
|
* @version: SDK: 1.24.0
|
|
663
722
|
*/
|
|
664
723
|
useLastSelectedSources?: boolean;
|
|
665
724
|
/**
|
|
666
725
|
* To set the initial state of the search bar in case of saved-answers.
|
|
726
|
+
*
|
|
667
727
|
* @default false
|
|
668
728
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
669
729
|
*/
|
|
670
730
|
collapseSearchBarInitially?: boolean;
|
|
671
731
|
/**
|
|
672
732
|
* To enable custom column groups in data panel v2
|
|
733
|
+
*
|
|
673
734
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
674
735
|
* @default false
|
|
736
|
+
*
|
|
675
737
|
* @example
|
|
676
738
|
* ```js
|
|
677
739
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -683,6 +745,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
683
745
|
enableCustomColumnGroups?: boolean;
|
|
684
746
|
/**
|
|
685
747
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
748
|
+
*
|
|
686
749
|
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
687
750
|
*/
|
|
688
751
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
@@ -693,8 +756,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
693
756
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
694
757
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
695
758
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
759
|
+
*
|
|
696
760
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
697
761
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
762
|
+
*
|
|
698
763
|
* @example
|
|
699
764
|
* ```js
|
|
700
765
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -709,6 +774,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
709
774
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
710
775
|
/**
|
|
711
776
|
* Embed ThoughtSpot search
|
|
777
|
+
*
|
|
712
778
|
* @group Embed components
|
|
713
779
|
*/
|
|
714
780
|
export declare class SearchEmbed extends TsEmbed {
|
|
@@ -721,6 +787,7 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
721
787
|
/**
|
|
722
788
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
723
789
|
* loaded in the iframe
|
|
790
|
+
*
|
|
724
791
|
* @param answerId The GUID of a saved answer
|
|
725
792
|
* @param dataSources A list of data source GUIDs
|
|
726
793
|
*/
|
|
@@ -736,6 +803,7 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
736
803
|
*
|
|
737
804
|
* Full application embedding
|
|
738
805
|
* https://developers.thoughtspot.com/docs/?pageid=full-embed
|
|
806
|
+
*
|
|
739
807
|
* @summary Full app embed
|
|
740
808
|
* @module
|
|
741
809
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
@@ -793,6 +861,7 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
793
861
|
}
|
|
794
862
|
/**
|
|
795
863
|
* The view configuration for full app embedding.
|
|
864
|
+
*
|
|
796
865
|
* @group Embed components
|
|
797
866
|
*/
|
|
798
867
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
@@ -800,8 +869,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
800
869
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
801
870
|
* is displayed. By default, the navigation bar is hidden.
|
|
802
871
|
* This flag also controls the homepage left navigation bar.
|
|
872
|
+
*
|
|
803
873
|
* @default true
|
|
804
874
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
875
|
+
*
|
|
805
876
|
* @example
|
|
806
877
|
* ```js
|
|
807
878
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -817,12 +888,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
817
888
|
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
818
889
|
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
819
890
|
*
|
|
820
|
-
*
|
|
821
891
|
* **Note**: This option does not apply to the classic homepage.
|
|
822
892
|
* To access the updated modular homepage, set
|
|
823
893
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
894
|
+
*
|
|
824
895
|
* @default false
|
|
825
896
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
897
|
+
*
|
|
826
898
|
* @example
|
|
827
899
|
* ```js
|
|
828
900
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -837,6 +909,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
837
909
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
838
910
|
* @default false
|
|
839
911
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
912
|
+
*
|
|
840
913
|
* @example
|
|
841
914
|
* ```js
|
|
842
915
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -850,12 +923,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
850
923
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
851
924
|
* By default, the application switcher is shown.
|
|
852
925
|
*
|
|
853
|
-
*
|
|
854
926
|
* **Note**: This option does not apply to the classic homepage.
|
|
855
927
|
* To access the updated modular homepage, set
|
|
856
928
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
929
|
+
*
|
|
857
930
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
858
931
|
* @default false
|
|
932
|
+
*
|
|
859
933
|
* @example
|
|
860
934
|
* ```js
|
|
861
935
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -869,12 +943,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
869
943
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
870
944
|
* By default, the Org switcher button is shown.
|
|
871
945
|
*
|
|
872
|
-
*
|
|
873
946
|
* **Note**: This option does not apply to the classic homepage.
|
|
874
947
|
* To access the updated modular homepage, set
|
|
875
948
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
949
|
+
*
|
|
876
950
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
877
951
|
* @default true
|
|
952
|
+
*
|
|
878
953
|
* @example
|
|
879
954
|
* ```js
|
|
880
955
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -892,7 +967,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
892
967
|
*
|
|
893
968
|
* For eg, if you want the component to open to a specific Liveboard
|
|
894
969
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
970
|
+
*
|
|
895
971
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
972
|
+
*
|
|
896
973
|
* @example
|
|
897
974
|
* ```js
|
|
898
975
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -908,7 +985,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
908
985
|
*
|
|
909
986
|
* Use this to open to particular page in the app. To open to a specific
|
|
910
987
|
* path within the app, use the `path` attribute which is more flexible.
|
|
988
|
+
*
|
|
911
989
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
990
|
+
*
|
|
912
991
|
* @example
|
|
913
992
|
* ```js
|
|
914
993
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -922,6 +1001,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
922
1001
|
* This puts a filter tag on the application. All metadata lists in the
|
|
923
1002
|
* application, such as Liveboards and answers, would be filtered by this
|
|
924
1003
|
* tag.
|
|
1004
|
+
*
|
|
925
1005
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
926
1006
|
* @example
|
|
927
1007
|
* ```js
|
|
@@ -934,7 +1014,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
934
1014
|
tag?: string;
|
|
935
1015
|
/**
|
|
936
1016
|
* The array of GUIDs to be hidden
|
|
1017
|
+
*
|
|
937
1018
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1019
|
+
*
|
|
938
1020
|
* @example
|
|
939
1021
|
* ```js
|
|
940
1022
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -950,6 +1032,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
950
1032
|
/**
|
|
951
1033
|
* Render liveboards using the new v2 rendering mode
|
|
952
1034
|
* This is a transient flag which is primarily meant for internal use
|
|
1035
|
+
*
|
|
953
1036
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
954
1037
|
* @hidden
|
|
955
1038
|
*/
|
|
@@ -957,7 +1040,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
957
1040
|
/**
|
|
958
1041
|
* If set to true, the Search Assist feature is enabled.
|
|
959
1042
|
* @default true
|
|
1043
|
+
*
|
|
960
1044
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
1045
|
+
*
|
|
961
1046
|
* @example
|
|
962
1047
|
* ```js
|
|
963
1048
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -970,7 +1055,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
970
1055
|
/**
|
|
971
1056
|
* If set to true, the embedded object container dynamically resizes
|
|
972
1057
|
* according to the height of the pages which support fullHeight mode.
|
|
1058
|
+
*
|
|
973
1059
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
1060
|
+
*
|
|
974
1061
|
* @example
|
|
975
1062
|
* ```js
|
|
976
1063
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -982,6 +1069,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
982
1069
|
fullHeight?: boolean;
|
|
983
1070
|
/**
|
|
984
1071
|
* Flag to control Data panel experience
|
|
1072
|
+
*
|
|
985
1073
|
* @default false
|
|
986
1074
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
987
1075
|
* @hidden
|
|
@@ -989,8 +1077,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
989
1077
|
dataPanelV2?: boolean;
|
|
990
1078
|
/**
|
|
991
1079
|
* Show or hide Liveboard header
|
|
1080
|
+
*
|
|
992
1081
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
993
1082
|
* @default false
|
|
1083
|
+
*
|
|
994
1084
|
* @example
|
|
995
1085
|
* ```js
|
|
996
1086
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1002,8 +1092,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1002
1092
|
hideLiveboardHeader?: boolean;
|
|
1003
1093
|
/**
|
|
1004
1094
|
* Show or hide Liveboard title
|
|
1095
|
+
*
|
|
1005
1096
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1006
1097
|
* @default false
|
|
1098
|
+
*
|
|
1007
1099
|
* @example
|
|
1008
1100
|
* ```js
|
|
1009
1101
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1015,8 +1107,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1015
1107
|
showLiveboardTitle?: boolean;
|
|
1016
1108
|
/**
|
|
1017
1109
|
* Show or hide Liveboard description
|
|
1110
|
+
*
|
|
1018
1111
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1019
1112
|
* @default false
|
|
1113
|
+
*
|
|
1020
1114
|
* @example
|
|
1021
1115
|
* ```js
|
|
1022
1116
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1028,8 +1122,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1028
1122
|
showLiveboardDescription?: boolean;
|
|
1029
1123
|
/**
|
|
1030
1124
|
* Flag to control new Modular Home experience.
|
|
1125
|
+
*
|
|
1031
1126
|
* @default false
|
|
1032
1127
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1128
|
+
*
|
|
1033
1129
|
* @example
|
|
1034
1130
|
* ```js
|
|
1035
1131
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1041,6 +1137,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1041
1137
|
modularHomeExperience?: boolean;
|
|
1042
1138
|
/**
|
|
1043
1139
|
* Boolean to control if Liveboard header is sticky or not.
|
|
1140
|
+
*
|
|
1044
1141
|
* @example
|
|
1045
1142
|
* ```js
|
|
1046
1143
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1053,20 +1150,24 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1053
1150
|
isLiveboardHeaderSticky?: boolean;
|
|
1054
1151
|
/**
|
|
1055
1152
|
* enable or disable ask sage
|
|
1153
|
+
*
|
|
1056
1154
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1057
1155
|
* @default false
|
|
1058
1156
|
*/
|
|
1059
1157
|
enableAskSage?: boolean;
|
|
1060
1158
|
/**
|
|
1061
1159
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1160
|
+
*
|
|
1062
1161
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1063
1162
|
* @default false
|
|
1064
1163
|
*/
|
|
1065
1164
|
collapseSearchBarInitially?: boolean;
|
|
1066
1165
|
/**
|
|
1067
1166
|
* To enable custom column groups in data panel v2.
|
|
1167
|
+
*
|
|
1068
1168
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1069
1169
|
* @default false
|
|
1170
|
+
*
|
|
1070
1171
|
* @example
|
|
1071
1172
|
* ```js
|
|
1072
1173
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1083,8 +1184,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1083
1184
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1084
1185
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1085
1186
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1187
|
+
*
|
|
1086
1188
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1087
1189
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1190
|
+
*
|
|
1088
1191
|
* @example
|
|
1089
1192
|
* ```js
|
|
1090
1193
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1097,9 +1200,11 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1097
1200
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1098
1201
|
/**
|
|
1099
1202
|
* This flag is used to enable the 2 column layout in liveboard
|
|
1203
|
+
*
|
|
1100
1204
|
* @type {boolean}
|
|
1101
1205
|
* @default false
|
|
1102
1206
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1207
|
+
*
|
|
1103
1208
|
* @example
|
|
1104
1209
|
* ```js
|
|
1105
1210
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1111,12 +1216,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1111
1216
|
enable2ColumnLayout?: boolean;
|
|
1112
1217
|
/**
|
|
1113
1218
|
* Flag to use OnBeforeSearchExecute embed event
|
|
1219
|
+
*
|
|
1114
1220
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
1115
1221
|
*/
|
|
1116
1222
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1117
1223
|
}
|
|
1118
1224
|
/**
|
|
1119
1225
|
* Embeds full ThoughtSpot experience in a host application.
|
|
1226
|
+
*
|
|
1120
1227
|
* @group Embed components
|
|
1121
1228
|
*/
|
|
1122
1229
|
export declare class AppEmbed extends V1Embed {
|
|
@@ -1129,12 +1236,14 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1129
1236
|
protected getEmbedParams(): string;
|
|
1130
1237
|
/**
|
|
1131
1238
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
1239
|
+
*
|
|
1132
1240
|
* @param pageId The ID of the page to be embedded.
|
|
1133
1241
|
*/
|
|
1134
1242
|
getIFrameSrc(): string;
|
|
1135
1243
|
/**
|
|
1136
1244
|
* Set the iframe height as per the computed height received
|
|
1137
1245
|
* from the ThoughtSpot app.
|
|
1246
|
+
*
|
|
1138
1247
|
* @param data The event payload
|
|
1139
1248
|
*/
|
|
1140
1249
|
protected updateIFrameHeight: (data: MessagePayload) => void;
|
|
@@ -1142,6 +1251,7 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1142
1251
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
1143
1252
|
* This is used for embedding answers, pinboards, visualizations and full application
|
|
1144
1253
|
* only.
|
|
1254
|
+
*
|
|
1145
1255
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
1146
1256
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
1147
1257
|
* When used with `noReload` (default: true) this can also be a number
|
|
@@ -1152,6 +1262,7 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1152
1262
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
1153
1263
|
/**
|
|
1154
1264
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
1265
|
+
*
|
|
1155
1266
|
* @param renderOptions An object containing the page ID
|
|
1156
1267
|
* to be embedded.
|
|
1157
1268
|
*/
|
|
@@ -1164,11 +1275,13 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1164
1275
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
1165
1276
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
1166
1277
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
1278
|
+
*
|
|
1167
1279
|
* @summary Liveboard & visualization embed
|
|
1168
1280
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1169
1281
|
*/
|
|
1170
1282
|
/**
|
|
1171
1283
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
1284
|
+
*
|
|
1172
1285
|
* @group Embed components
|
|
1173
1286
|
*/
|
|
1174
1287
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -1181,7 +1294,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1181
1294
|
* visualizations to display on the screen.
|
|
1182
1295
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
1183
1296
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1297
|
+
*
|
|
1184
1298
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1299
|
+
*
|
|
1185
1300
|
* @example
|
|
1186
1301
|
* ```js
|
|
1187
1302
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1195,6 +1310,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1195
1310
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
1196
1311
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
1197
1312
|
* other screens navigable from a Liveboard.
|
|
1313
|
+
*
|
|
1198
1314
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1199
1315
|
* @default 500
|
|
1200
1316
|
* @example
|
|
@@ -1209,6 +1325,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1209
1325
|
defaultHeight?: number;
|
|
1210
1326
|
/**
|
|
1211
1327
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
1328
|
+
*
|
|
1212
1329
|
* @example
|
|
1213
1330
|
* ```js
|
|
1214
1331
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1216,12 +1333,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1216
1333
|
* enableVizTransformations:true,
|
|
1217
1334
|
* })
|
|
1218
1335
|
* ```
|
|
1336
|
+
*
|
|
1219
1337
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1220
1338
|
*/
|
|
1221
1339
|
enableVizTransformations?: boolean;
|
|
1222
1340
|
/**
|
|
1223
1341
|
* The Liveboard to display in the embedded view.
|
|
1224
1342
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
1343
|
+
*
|
|
1225
1344
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
1226
1345
|
* @example
|
|
1227
1346
|
* ```js
|
|
@@ -1233,12 +1352,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1233
1352
|
liveboardId?: string;
|
|
1234
1353
|
/**
|
|
1235
1354
|
* To support backward compatibility
|
|
1355
|
+
*
|
|
1236
1356
|
* @hidden
|
|
1237
1357
|
*/
|
|
1238
1358
|
pinboardId?: string;
|
|
1239
1359
|
/**
|
|
1240
1360
|
* The visualization within the Liveboard to display.
|
|
1361
|
+
*
|
|
1241
1362
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1363
|
+
*
|
|
1242
1364
|
* @example
|
|
1243
1365
|
* ```js
|
|
1244
1366
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1251,6 +1373,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1251
1373
|
/**
|
|
1252
1374
|
* If set to true, all filter chips from a
|
|
1253
1375
|
* Liveboard page will be read-only (no X buttons)
|
|
1376
|
+
*
|
|
1254
1377
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
1255
1378
|
* @example
|
|
1256
1379
|
* ```js
|
|
@@ -1265,7 +1388,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1265
1388
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
1266
1389
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
1267
1390
|
* event.
|
|
1391
|
+
*
|
|
1268
1392
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1393
|
+
*
|
|
1269
1394
|
* @example
|
|
1270
1395
|
* ```js
|
|
1271
1396
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1279,12 +1404,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1279
1404
|
visibleVizs?: string[];
|
|
1280
1405
|
/**
|
|
1281
1406
|
* To support backward compatibility
|
|
1407
|
+
*
|
|
1282
1408
|
* @hidden
|
|
1283
1409
|
*/
|
|
1284
1410
|
preventPinboardFilterRemoval?: boolean;
|
|
1285
1411
|
/**
|
|
1286
1412
|
* Render embedded Liveboards and visualizations in the
|
|
1287
1413
|
* new Liveboard experience mode.
|
|
1414
|
+
*
|
|
1288
1415
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
1289
1416
|
* @example
|
|
1290
1417
|
* ```js
|
|
@@ -1298,6 +1425,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1298
1425
|
/**
|
|
1299
1426
|
* Set a Liveboard tab as an active tab.
|
|
1300
1427
|
* Specify the tab ID.
|
|
1428
|
+
*
|
|
1301
1429
|
* @example
|
|
1302
1430
|
* ```js
|
|
1303
1431
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1310,7 +1438,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1310
1438
|
activeTabId?: string;
|
|
1311
1439
|
/**
|
|
1312
1440
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1441
|
+
*
|
|
1313
1442
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1443
|
+
*
|
|
1314
1444
|
* @example
|
|
1315
1445
|
* ```js
|
|
1316
1446
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1322,6 +1452,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1322
1452
|
hideTabPanel?: boolean;
|
|
1323
1453
|
/**
|
|
1324
1454
|
* Show or hide the Liveboard header.
|
|
1455
|
+
*
|
|
1325
1456
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1326
1457
|
* @default false
|
|
1327
1458
|
* @example
|
|
@@ -1337,6 +1468,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1337
1468
|
* Show or hide the Liveboard title.
|
|
1338
1469
|
* @default false
|
|
1339
1470
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1471
|
+
*
|
|
1340
1472
|
* @example
|
|
1341
1473
|
* ```js
|
|
1342
1474
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1350,6 +1482,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1350
1482
|
* Show or hide the Liveboard description.
|
|
1351
1483
|
* @default false
|
|
1352
1484
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1485
|
+
*
|
|
1353
1486
|
* @example
|
|
1354
1487
|
* ```js
|
|
1355
1488
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1363,6 +1496,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1363
1496
|
* Control the position and visibility of
|
|
1364
1497
|
* the Liveboard header as the users scroll down the
|
|
1365
1498
|
* embedded Liveboard page.
|
|
1499
|
+
*
|
|
1366
1500
|
* @example
|
|
1367
1501
|
* ```js
|
|
1368
1502
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1375,6 +1509,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1375
1509
|
isLiveboardHeaderSticky?: boolean;
|
|
1376
1510
|
/**
|
|
1377
1511
|
* enable or disable ask sage
|
|
1512
|
+
*
|
|
1378
1513
|
* @default false
|
|
1379
1514
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1380
1515
|
* @example
|
|
@@ -1388,9 +1523,11 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1388
1523
|
enableAskSage?: boolean;
|
|
1389
1524
|
/**
|
|
1390
1525
|
* This flag is used to enable the 2 column layout in liveboard
|
|
1526
|
+
*
|
|
1391
1527
|
* @type {boolean}
|
|
1392
1528
|
* @default false
|
|
1393
1529
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1530
|
+
*
|
|
1394
1531
|
* @example
|
|
1395
1532
|
* ```js
|
|
1396
1533
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1405,6 +1542,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1405
1542
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
1406
1543
|
* waits for the authentication to complete, so you need not wait for
|
|
1407
1544
|
* `AuthStatus.SUCCESS`.
|
|
1545
|
+
*
|
|
1408
1546
|
* @example
|
|
1409
1547
|
* ```js
|
|
1410
1548
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1428,12 +1566,14 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
1428
1566
|
protected handleRenderForPrerender(): void;
|
|
1429
1567
|
/**
|
|
1430
1568
|
* Triggers an event to the embedded app
|
|
1569
|
+
*
|
|
1431
1570
|
* @param messageType The event type
|
|
1432
1571
|
* @param data The payload to send with the message
|
|
1433
1572
|
*/
|
|
1434
1573
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
1435
1574
|
/**
|
|
1436
1575
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
1576
|
+
*
|
|
1437
1577
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
1438
1578
|
* visualization ID and the runtime filters.
|
|
1439
1579
|
*/
|
|
@@ -1489,6 +1629,7 @@ export declare const handleAuth: () => Promise<boolean>;
|
|
|
1489
1629
|
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
1490
1630
|
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
1491
1631
|
* to your app.
|
|
1632
|
+
*
|
|
1492
1633
|
* @param url The URL provided for prefetch
|
|
1493
1634
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
1494
1635
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -1500,6 +1641,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
|
|
|
1500
1641
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
1501
1642
|
* component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
|
|
1502
1643
|
* to actually embed. That is handled internally.
|
|
1644
|
+
*
|
|
1503
1645
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
1504
1646
|
* authentication mechanism and so on.
|
|
1505
1647
|
* @example
|
|
@@ -1526,6 +1668,7 @@ export declare function disableAutoLogin(): void;
|
|
|
1526
1668
|
*
|
|
1527
1669
|
* You can call the `init` method again to re login, if autoLogin is set to
|
|
1528
1670
|
* true in this second call it will be honored.
|
|
1671
|
+
*
|
|
1529
1672
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
1530
1673
|
* @returns Promise which resolves when logout completes.
|
|
1531
1674
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
@@ -1535,11 +1678,13 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
1535
1678
|
/**
|
|
1536
1679
|
* Renders functions in a queue, resolves to next function only after the callback next
|
|
1537
1680
|
* is called
|
|
1681
|
+
*
|
|
1538
1682
|
* @param fn The function being registered
|
|
1539
1683
|
*/
|
|
1540
1684
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
1541
1685
|
/**
|
|
1542
1686
|
* Imports TML representation of the metadata objects into ThoughtSpot.
|
|
1687
|
+
*
|
|
1543
1688
|
* @param data
|
|
1544
1689
|
* @example
|
|
1545
1690
|
* ```js
|
|
@@ -1564,6 +1709,7 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
1564
1709
|
/**
|
|
1565
1710
|
* Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
|
|
1566
1711
|
* format.
|
|
1712
|
+
*
|
|
1567
1713
|
* @param data
|
|
1568
1714
|
* @example
|
|
1569
1715
|
* ```js
|
|
@@ -1609,6 +1755,7 @@ interface sessionInfoInterface {
|
|
|
1609
1755
|
/**
|
|
1610
1756
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
1611
1757
|
* of {@link AuthStatus.FAILURE}.
|
|
1758
|
+
*
|
|
1612
1759
|
* @group Authentication / Init
|
|
1613
1760
|
*/
|
|
1614
1761
|
export declare enum AuthFailureType {
|
|
@@ -1619,6 +1766,7 @@ export declare enum AuthFailureType {
|
|
|
1619
1766
|
}
|
|
1620
1767
|
/**
|
|
1621
1768
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
1769
|
+
*
|
|
1622
1770
|
* @group Authentication / Init
|
|
1623
1771
|
*/
|
|
1624
1772
|
export declare enum AuthStatus {
|
|
@@ -1642,23 +1790,27 @@ export declare enum AuthStatus {
|
|
|
1642
1790
|
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
1643
1791
|
* popup is waiting to be triggered either programmatically
|
|
1644
1792
|
* or by the trigger button.
|
|
1793
|
+
*
|
|
1645
1794
|
* @version SDK: 1.19.0
|
|
1646
1795
|
*/
|
|
1647
1796
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
1648
1797
|
}
|
|
1649
1798
|
/**
|
|
1650
1799
|
* Event emitter returned from {@link init}.
|
|
1800
|
+
*
|
|
1651
1801
|
* @group Authentication / Init
|
|
1652
1802
|
*/
|
|
1653
1803
|
export interface AuthEventEmitter {
|
|
1654
1804
|
/**
|
|
1655
1805
|
* Register a listener on Auth failure.
|
|
1806
|
+
*
|
|
1656
1807
|
* @param event
|
|
1657
1808
|
* @param listener
|
|
1658
1809
|
*/
|
|
1659
1810
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
1660
1811
|
/**
|
|
1661
1812
|
* Register a listener on Auth SDK success.
|
|
1813
|
+
*
|
|
1662
1814
|
* @param event
|
|
1663
1815
|
* @param listener
|
|
1664
1816
|
*/
|
|
@@ -1669,11 +1821,13 @@ export interface AuthEventEmitter {
|
|
|
1669
1821
|
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
1670
1822
|
/**
|
|
1671
1823
|
* Trigger an event on the emitter returned from init.
|
|
1824
|
+
*
|
|
1672
1825
|
* @param {@link AuthEvent}
|
|
1673
1826
|
*/
|
|
1674
1827
|
emit(event: AuthEvent, ...args: any[]): boolean;
|
|
1675
1828
|
/**
|
|
1676
1829
|
* Remove listener from the emitter returned from init.
|
|
1830
|
+
*
|
|
1677
1831
|
* @param event
|
|
1678
1832
|
* @param listener
|
|
1679
1833
|
* @param context
|
|
@@ -1682,12 +1836,14 @@ export interface AuthEventEmitter {
|
|
|
1682
1836
|
off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
|
|
1683
1837
|
/**
|
|
1684
1838
|
* Remove all the event listeners
|
|
1839
|
+
*
|
|
1685
1840
|
* @param event
|
|
1686
1841
|
*/
|
|
1687
1842
|
removeAllListeners(event: AuthStatus): this;
|
|
1688
1843
|
}
|
|
1689
1844
|
/**
|
|
1690
1845
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
1846
|
+
*
|
|
1691
1847
|
* @group Authentication / Init
|
|
1692
1848
|
*/
|
|
1693
1849
|
export declare enum AuthEvent {
|
|
@@ -1732,16 +1888,19 @@ export declare function getReleaseVersion(): string;
|
|
|
1732
1888
|
/**
|
|
1733
1889
|
* Return a promise that resolves with the session information when
|
|
1734
1890
|
* authentication is successful. And info is available.
|
|
1891
|
+
*
|
|
1735
1892
|
* @group Global methods
|
|
1736
1893
|
*/
|
|
1737
1894
|
export declare function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
1738
1895
|
/**
|
|
1739
1896
|
* Perform token based authentication
|
|
1897
|
+
*
|
|
1740
1898
|
* @param embedConfig The embed configuration
|
|
1741
1899
|
*/
|
|
1742
1900
|
export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1743
1901
|
/**
|
|
1744
1902
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
1903
|
+
*
|
|
1745
1904
|
* @param embedConfig The embed configuration
|
|
1746
1905
|
*/
|
|
1747
1906
|
export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1751,6 +1910,7 @@ export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promis
|
|
|
1751
1910
|
*
|
|
1752
1911
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1753
1912
|
* strongly advised not to use this authentication method in production.
|
|
1913
|
+
*
|
|
1754
1914
|
* @param embedConfig The embed configuration
|
|
1755
1915
|
*/
|
|
1756
1916
|
export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1759,6 +1919,7 @@ export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
1759
1919
|
export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1760
1920
|
/**
|
|
1761
1921
|
* Perform authentication on the ThoughtSpot cluster
|
|
1922
|
+
*
|
|
1762
1923
|
* @param embedConfig The embed configuration
|
|
1763
1924
|
*/
|
|
1764
1925
|
export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1772,18 +1933,21 @@ export {};
|
|
|
1772
1933
|
* Copyright (c) 2023
|
|
1773
1934
|
*
|
|
1774
1935
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
1936
|
+
*
|
|
1775
1937
|
* @summary Type definitions for Embed SDK
|
|
1776
1938
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1777
1939
|
*/
|
|
1778
1940
|
/**
|
|
1779
1941
|
* The authentication mechanism for allowing access to the
|
|
1780
1942
|
* the embedded app
|
|
1943
|
+
*
|
|
1781
1944
|
* @group Authentication / Init
|
|
1782
1945
|
*/
|
|
1783
1946
|
export declare enum AuthType {
|
|
1784
1947
|
/**
|
|
1785
1948
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
1786
1949
|
* `Passthrough`.
|
|
1950
|
+
*
|
|
1787
1951
|
* @example
|
|
1788
1952
|
* ```js
|
|
1789
1953
|
* init({
|
|
@@ -1801,6 +1965,7 @@ export declare enum AuthType {
|
|
|
1801
1965
|
* To use this:
|
|
1802
1966
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1803
1967
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1968
|
+
*
|
|
1804
1969
|
* @example
|
|
1805
1970
|
* ```js
|
|
1806
1971
|
* init({
|
|
@@ -1813,12 +1978,14 @@ export declare enum AuthType {
|
|
|
1813
1978
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1814
1979
|
/**
|
|
1815
1980
|
* SSO using SAML
|
|
1981
|
+
*
|
|
1816
1982
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1817
1983
|
* @hidden
|
|
1818
1984
|
*/
|
|
1819
1985
|
SSO = "SSO_SAML",
|
|
1820
1986
|
/**
|
|
1821
1987
|
* SSO using SAML
|
|
1988
|
+
*
|
|
1822
1989
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1823
1990
|
* @hidden
|
|
1824
1991
|
*/
|
|
@@ -1830,6 +1997,7 @@ export declare enum AuthType {
|
|
|
1830
1997
|
*
|
|
1831
1998
|
* This redirects the host application to the SAML IdP. The host application
|
|
1832
1999
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
2000
|
+
*
|
|
1833
2001
|
* @example
|
|
1834
2002
|
* ```js
|
|
1835
2003
|
* init({
|
|
@@ -1870,6 +2038,7 @@ export declare enum AuthType {
|
|
|
1870
2038
|
SAMLRedirect = "SSO_SAML",
|
|
1871
2039
|
/**
|
|
1872
2040
|
* SSO using OIDC
|
|
2041
|
+
*
|
|
1873
2042
|
* @hidden
|
|
1874
2043
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
1875
2044
|
*/
|
|
@@ -1882,6 +2051,7 @@ export declare enum AuthType {
|
|
|
1882
2051
|
OIDCRedirect = "SSO_OIDC",
|
|
1883
2052
|
/**
|
|
1884
2053
|
* Trusted authentication server
|
|
2054
|
+
*
|
|
1885
2055
|
* @hidden
|
|
1886
2056
|
* @deprecated Use {@link TrustedAuth} instead
|
|
1887
2057
|
*/
|
|
@@ -1890,6 +2060,7 @@ export declare enum AuthType {
|
|
|
1890
2060
|
* Trusted authentication server. Use your own authentication server
|
|
1891
2061
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1892
2062
|
* from ThoughtSpot.
|
|
2063
|
+
*
|
|
1893
2064
|
* @example
|
|
1894
2065
|
* ```js
|
|
1895
2066
|
* init({
|
|
@@ -1901,7 +2072,6 @@ export declare enum AuthType {
|
|
|
1901
2072
|
* .then((data) => data.token);
|
|
1902
2073
|
* }
|
|
1903
2074
|
* });
|
|
1904
|
-
* });
|
|
1905
2075
|
* ```
|
|
1906
2076
|
*/
|
|
1907
2077
|
TrustedAuthToken = "AuthServer",
|
|
@@ -1911,6 +2081,7 @@ export declare enum AuthType {
|
|
|
1911
2081
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1912
2082
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1913
2083
|
* implemented by some browsers.
|
|
2084
|
+
*
|
|
1914
2085
|
* @example
|
|
1915
2086
|
* ```js
|
|
1916
2087
|
* init({
|
|
@@ -1983,6 +2154,7 @@ export interface customCssInterface {
|
|
|
1983
2154
|
/**
|
|
1984
2155
|
* Can be used to define a custom font face
|
|
1985
2156
|
* like:
|
|
2157
|
+
*
|
|
1986
2158
|
* @example
|
|
1987
2159
|
* ```js
|
|
1988
2160
|
* rules_UNSTABLE?: {
|
|
@@ -2022,6 +2194,7 @@ export interface CustomStyles {
|
|
|
2022
2194
|
* Thoughtspot components.
|
|
2023
2195
|
* You can customize styles, text strings, and icons.
|
|
2024
2196
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2197
|
+
*
|
|
2025
2198
|
* @example
|
|
2026
2199
|
* ```js
|
|
2027
2200
|
* init({
|
|
@@ -2064,6 +2237,7 @@ export interface CustomisationsInterface {
|
|
|
2064
2237
|
* It includes the ThoughtSpot hostname or IP address,
|
|
2065
2238
|
* the type of authentication, and the authentication endpoint
|
|
2066
2239
|
* if a trusted authentication server is used.
|
|
2240
|
+
*
|
|
2067
2241
|
* @group Authentication / Init
|
|
2068
2242
|
*/
|
|
2069
2243
|
export interface EmbedConfig {
|
|
@@ -2111,6 +2285,7 @@ export interface EmbedConfig {
|
|
|
2111
2285
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
2112
2286
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
2113
2287
|
* place.
|
|
2288
|
+
*
|
|
2114
2289
|
* @default false
|
|
2115
2290
|
* @deprecated
|
|
2116
2291
|
*/
|
|
@@ -2121,6 +2296,7 @@ export interface EmbedConfig {
|
|
|
2121
2296
|
*
|
|
2122
2297
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
2123
2298
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
2299
|
+
*
|
|
2124
2300
|
* @default false
|
|
2125
2301
|
* @version SDK: 1.18.0
|
|
2126
2302
|
*/
|
|
@@ -2131,6 +2307,7 @@ export interface EmbedConfig {
|
|
|
2131
2307
|
* terminated.
|
|
2132
2308
|
*
|
|
2133
2309
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
2310
|
+
*
|
|
2134
2311
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
2135
2312
|
*/
|
|
2136
2313
|
redirectPath?: string;
|
|
@@ -2140,6 +2317,7 @@ export interface EmbedConfig {
|
|
|
2140
2317
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
2141
2318
|
* should be encoded in base64. This provides additional security to
|
|
2142
2319
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
2320
|
+
*
|
|
2143
2321
|
* @default false
|
|
2144
2322
|
*/
|
|
2145
2323
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2149,6 +2327,7 @@ export interface EmbedConfig {
|
|
|
2149
2327
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
2150
2328
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
2151
2329
|
* in this case.
|
|
2330
|
+
*
|
|
2152
2331
|
* @default false
|
|
2153
2332
|
*/
|
|
2154
2333
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -2156,12 +2335,14 @@ export interface EmbedConfig {
|
|
|
2156
2335
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
2157
2336
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
2158
2337
|
* persists even in the case of a non-logged-in user.
|
|
2338
|
+
*
|
|
2159
2339
|
* @default false
|
|
2160
2340
|
*/
|
|
2161
2341
|
ignoreNoCookieAccess?: boolean;
|
|
2162
2342
|
/**
|
|
2163
2343
|
* Re-login a user with the previous login options
|
|
2164
2344
|
* when a user session expires.
|
|
2345
|
+
*
|
|
2165
2346
|
* @default false
|
|
2166
2347
|
*/
|
|
2167
2348
|
autoLogin?: boolean;
|
|
@@ -2170,17 +2351,20 @@ export interface EmbedConfig {
|
|
|
2170
2351
|
* This flag is typically used alongside the combination of authentication modes such
|
|
2171
2352
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
2172
2353
|
* EmbedConfig.autoLogin}
|
|
2354
|
+
*
|
|
2173
2355
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2174
2356
|
* @default false
|
|
2175
2357
|
*/
|
|
2176
2358
|
disableLoginRedirect?: boolean;
|
|
2177
2359
|
/**
|
|
2178
2360
|
* This message is displayed in the embedded view when a user login fails.
|
|
2361
|
+
*
|
|
2179
2362
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2180
2363
|
*/
|
|
2181
2364
|
loginFailedMessage?: string;
|
|
2182
2365
|
/**
|
|
2183
2366
|
* Calls the prefetch method internally when set to `true`
|
|
2367
|
+
*
|
|
2184
2368
|
* @default false
|
|
2185
2369
|
*/
|
|
2186
2370
|
callPrefetch?: boolean;
|
|
@@ -2188,6 +2372,7 @@ export interface EmbedConfig {
|
|
|
2188
2372
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
2189
2373
|
* to start after the previous embed's render is complete. This helps improve
|
|
2190
2374
|
* performance by decreasing the load on the browser.
|
|
2375
|
+
*
|
|
2191
2376
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2192
2377
|
* @default false
|
|
2193
2378
|
*/
|
|
@@ -2195,6 +2380,7 @@ export interface EmbedConfig {
|
|
|
2195
2380
|
/**
|
|
2196
2381
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
2197
2382
|
* You would also need to set `style-src` in the CSP settings.
|
|
2383
|
+
*
|
|
2198
2384
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2199
2385
|
* @default ''
|
|
2200
2386
|
*/
|
|
@@ -2206,11 +2392,13 @@ export interface EmbedConfig {
|
|
|
2206
2392
|
*
|
|
2207
2393
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
2208
2394
|
* involves an extra network call.
|
|
2395
|
+
*
|
|
2209
2396
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2210
2397
|
*/
|
|
2211
2398
|
detectCookieAccessSlow?: boolean;
|
|
2212
2399
|
/**
|
|
2213
2400
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
2401
|
+
*
|
|
2214
2402
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
2215
2403
|
*/
|
|
2216
2404
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -2221,6 +2409,7 @@ export interface EmbedConfig {
|
|
|
2221
2409
|
suppressSageEmbedBetaWarning?: boolean;
|
|
2222
2410
|
/**
|
|
2223
2411
|
* Custom style params for embed Config.
|
|
2412
|
+
*
|
|
2224
2413
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2225
2414
|
*/
|
|
2226
2415
|
customizations?: CustomisationsInterface;
|
|
@@ -2228,6 +2417,7 @@ export interface EmbedConfig {
|
|
|
2228
2417
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
2229
2418
|
* button that the user can click to trigger the flow.
|
|
2230
2419
|
* This attribute sets a containing element for that button.
|
|
2420
|
+
*
|
|
2231
2421
|
* @example
|
|
2232
2422
|
* ```js
|
|
2233
2423
|
* init({
|
|
@@ -2249,6 +2439,7 @@ export interface EmbedConfig {
|
|
|
2249
2439
|
/**
|
|
2250
2440
|
* Text to show in the button which triggers the popup auth flow.
|
|
2251
2441
|
* Default: `Authorize`.
|
|
2442
|
+
*
|
|
2252
2443
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2253
2444
|
*/
|
|
2254
2445
|
authTriggerText?: string;
|
|
@@ -2256,12 +2447,14 @@ export interface EmbedConfig {
|
|
|
2256
2447
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
2257
2448
|
* access to the embedded application users
|
|
2258
2449
|
* outside of the iframe.
|
|
2450
|
+
*
|
|
2259
2451
|
* @default true
|
|
2260
2452
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
2261
2453
|
*/
|
|
2262
2454
|
blockNonEmbedFullAppAccess?: boolean;
|
|
2263
2455
|
/**
|
|
2264
2456
|
* Host config in case embedded app is inside TS app itself
|
|
2457
|
+
*
|
|
2265
2458
|
* @hidden
|
|
2266
2459
|
*/
|
|
2267
2460
|
hostConfig?: {
|
|
@@ -2271,17 +2464,20 @@ export interface EmbedConfig {
|
|
|
2271
2464
|
};
|
|
2272
2465
|
/**
|
|
2273
2466
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
2274
|
-
* is added as an additional key to the embed, as per this
|
|
2467
|
+
* is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
|
|
2468
|
+
*
|
|
2275
2469
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
2276
2470
|
*/
|
|
2277
2471
|
pendoTrackingKey?: string;
|
|
2278
2472
|
/**
|
|
2279
2473
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
2474
|
+
*
|
|
2280
2475
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
2281
2476
|
*/
|
|
2282
2477
|
suppressErrorAlerts?: boolean;
|
|
2283
2478
|
/**
|
|
2284
2479
|
* Log level for the SDK.
|
|
2480
|
+
*
|
|
2285
2481
|
* @default LogLevel.ERROR
|
|
2286
2482
|
* @example
|
|
2287
2483
|
* ```js
|
|
@@ -2295,28 +2491,34 @@ export interface EmbedConfig {
|
|
|
2295
2491
|
logLevel?: LogLevel;
|
|
2296
2492
|
/**
|
|
2297
2493
|
* Disables the Mixpanel tracking from the SDK.
|
|
2494
|
+
*
|
|
2298
2495
|
* @version SDK: 1.27.9
|
|
2299
2496
|
*/
|
|
2300
2497
|
disableSDKTracking?: boolean;
|
|
2301
2498
|
/**
|
|
2302
2499
|
* Overrides default/user preffered locale for date formatting
|
|
2500
|
+
*
|
|
2303
2501
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2304
2502
|
*/
|
|
2305
2503
|
dateFormatLocale?: string;
|
|
2306
2504
|
/**
|
|
2307
2505
|
* Overrides default/user preffered locale for number formatting
|
|
2506
|
+
*
|
|
2308
2507
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2309
2508
|
*/
|
|
2310
2509
|
numberFormatLocale?: string;
|
|
2311
2510
|
/**
|
|
2312
2511
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2512
|
+
*
|
|
2313
2513
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2314
2514
|
*/
|
|
2315
2515
|
currencyFormat?: string;
|
|
2316
2516
|
/**
|
|
2317
2517
|
* This flag is used to disable the token verification in the SDK.
|
|
2318
2518
|
* Enabling this flag will also disable the caching of the token.
|
|
2519
|
+
*
|
|
2319
2520
|
* @hidden
|
|
2521
|
+
*
|
|
2320
2522
|
* @example
|
|
2321
2523
|
* ```js
|
|
2322
2524
|
* init({
|
|
@@ -2324,6 +2526,7 @@ export interface EmbedConfig {
|
|
|
2324
2526
|
* disableTokenVerification : true
|
|
2325
2527
|
* })
|
|
2326
2528
|
* ```
|
|
2529
|
+
*
|
|
2327
2530
|
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
2328
2531
|
*/
|
|
2329
2532
|
disableTokenVerification?: boolean;
|
|
@@ -2332,6 +2535,7 @@ export interface LayoutConfig {
|
|
|
2332
2535
|
}
|
|
2333
2536
|
/**
|
|
2334
2537
|
* Embedded iframe configuration
|
|
2538
|
+
*
|
|
2335
2539
|
* @group Embed components
|
|
2336
2540
|
*/
|
|
2337
2541
|
export interface FrameParams {
|
|
@@ -2366,7 +2570,9 @@ export interface ViewConfig {
|
|
|
2366
2570
|
/**
|
|
2367
2571
|
* The width and height dimensions to render an embedded
|
|
2368
2572
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2573
|
+
*
|
|
2369
2574
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2575
|
+
*
|
|
2370
2576
|
* @example
|
|
2371
2577
|
* ```js
|
|
2372
2578
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2392,6 +2598,7 @@ export interface ViewConfig {
|
|
|
2392
2598
|
* (...), and the contextual menu. These actions will be disabled
|
|
2393
2599
|
* for the user.
|
|
2394
2600
|
* Use this to disable actions.
|
|
2601
|
+
*
|
|
2395
2602
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2396
2603
|
* @example
|
|
2397
2604
|
* ```js
|
|
@@ -2419,7 +2626,9 @@ export interface ViewConfig {
|
|
|
2419
2626
|
* The list of actions to hide from the embedded.
|
|
2420
2627
|
* This actions will be hidden from the user.
|
|
2421
2628
|
* Use this to hide an action.
|
|
2629
|
+
*
|
|
2422
2630
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2631
|
+
*
|
|
2423
2632
|
* @example
|
|
2424
2633
|
* ```js
|
|
2425
2634
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2437,8 +2646,10 @@ export interface ViewConfig {
|
|
|
2437
2646
|
* Use this to hide all actions except the ones you want to show.
|
|
2438
2647
|
*
|
|
2439
2648
|
* Use either this or hiddenActions.
|
|
2649
|
+
*
|
|
2440
2650
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2441
2651
|
* @important
|
|
2652
|
+
*
|
|
2442
2653
|
* @example
|
|
2443
2654
|
* ```js
|
|
2444
2655
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2450,7 +2661,9 @@ export interface ViewConfig {
|
|
|
2450
2661
|
visibleActions?: Action[];
|
|
2451
2662
|
/**
|
|
2452
2663
|
* Show alert messages and toast messages in the embedded view.
|
|
2664
|
+
*
|
|
2453
2665
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2666
|
+
*
|
|
2454
2667
|
* @example
|
|
2455
2668
|
* ```js
|
|
2456
2669
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2463,7 +2676,9 @@ export interface ViewConfig {
|
|
|
2463
2676
|
/**
|
|
2464
2677
|
* The list of runtime filters to apply to a search answer,
|
|
2465
2678
|
* visualization, or Liveboard.
|
|
2679
|
+
*
|
|
2466
2680
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2681
|
+
*
|
|
2467
2682
|
* @example
|
|
2468
2683
|
* ```js
|
|
2469
2684
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2482,7 +2697,9 @@ export interface ViewConfig {
|
|
|
2482
2697
|
/**
|
|
2483
2698
|
* The list of parameter override to apply to a search answer,
|
|
2484
2699
|
* visualization, or Liveboard.
|
|
2700
|
+
*
|
|
2485
2701
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2702
|
+
*
|
|
2486
2703
|
* @example
|
|
2487
2704
|
* ```js
|
|
2488
2705
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2499,6 +2716,7 @@ export interface ViewConfig {
|
|
|
2499
2716
|
runtimeParameters?: RuntimeParameter[];
|
|
2500
2717
|
/**
|
|
2501
2718
|
* The locale/language to use for the embedded view.
|
|
2719
|
+
*
|
|
2502
2720
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2503
2721
|
* @example
|
|
2504
2722
|
* ```js
|
|
@@ -2534,6 +2752,7 @@ export interface ViewConfig {
|
|
|
2534
2752
|
/**
|
|
2535
2753
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
2536
2754
|
* You would also need to set `style-src` in the CSP settings.
|
|
2755
|
+
*
|
|
2537
2756
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
2538
2757
|
* @default ''
|
|
2539
2758
|
*/
|
|
@@ -2541,7 +2760,9 @@ export interface ViewConfig {
|
|
|
2541
2760
|
/**
|
|
2542
2761
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2543
2762
|
* child inside it.
|
|
2763
|
+
*
|
|
2544
2764
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2765
|
+
*
|
|
2545
2766
|
* @example
|
|
2546
2767
|
* ```js
|
|
2547
2768
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2553,6 +2774,7 @@ export interface ViewConfig {
|
|
|
2553
2774
|
insertAsSibling?: boolean;
|
|
2554
2775
|
/**
|
|
2555
2776
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2777
|
+
*
|
|
2556
2778
|
* @example
|
|
2557
2779
|
* ```js
|
|
2558
2780
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2565,6 +2787,7 @@ export interface ViewConfig {
|
|
|
2565
2787
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2566
2788
|
/**
|
|
2567
2789
|
* Flag to override openNew tab context menu link
|
|
2790
|
+
*
|
|
2568
2791
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2569
2792
|
* @example
|
|
2570
2793
|
* ```js
|
|
@@ -2577,6 +2800,7 @@ export interface ViewConfig {
|
|
|
2577
2800
|
linkOverride?: boolean;
|
|
2578
2801
|
/**
|
|
2579
2802
|
* flag to enable insert into slides action
|
|
2803
|
+
*
|
|
2580
2804
|
* @hidden
|
|
2581
2805
|
* @private
|
|
2582
2806
|
*/
|
|
@@ -2584,6 +2808,7 @@ export interface ViewConfig {
|
|
|
2584
2808
|
/**
|
|
2585
2809
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2586
2810
|
* if available and matches the configuration.
|
|
2811
|
+
*
|
|
2587
2812
|
* @version SDK: 1.22.0
|
|
2588
2813
|
* @hidden
|
|
2589
2814
|
*
|
|
@@ -2597,6 +2822,7 @@ export interface ViewConfig {
|
|
|
2597
2822
|
*
|
|
2598
2823
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2599
2824
|
* embedded view.
|
|
2825
|
+
*
|
|
2600
2826
|
* @default false
|
|
2601
2827
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2602
2828
|
*/
|
|
@@ -2605,6 +2831,7 @@ export interface ViewConfig {
|
|
|
2605
2831
|
* The list of tab IDs to hide from the embedded.
|
|
2606
2832
|
* This Tabs will be hidden from their respective LBs.
|
|
2607
2833
|
* Use this to hide an tabID.
|
|
2834
|
+
*
|
|
2608
2835
|
* @example
|
|
2609
2836
|
* ```js
|
|
2610
2837
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2621,11 +2848,10 @@ export interface ViewConfig {
|
|
|
2621
2848
|
* Hide the home page modules
|
|
2622
2849
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
2623
2850
|
*
|
|
2624
|
-
*
|
|
2625
|
-
*
|
|
2626
2851
|
* **Note**: This option does not apply to the classic homepage.
|
|
2627
2852
|
* To access the updated modular homepage, set
|
|
2628
2853
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2854
|
+
*
|
|
2629
2855
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2630
2856
|
* @example
|
|
2631
2857
|
* ```js
|
|
@@ -2634,17 +2860,19 @@ export interface ViewConfig {
|
|
|
2634
2860
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2635
2861
|
* })
|
|
2636
2862
|
* ```
|
|
2863
|
+
*
|
|
2637
2864
|
*/
|
|
2638
2865
|
hiddenHomepageModules?: HomepageModule[];
|
|
2639
2866
|
/**
|
|
2640
2867
|
* reordering the home page modules
|
|
2641
2868
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
2642
2869
|
*
|
|
2643
|
-
*
|
|
2644
2870
|
* **Note**: This option does not apply to the classic homepage.
|
|
2645
2871
|
* To access the updated modular homepage, set
|
|
2646
2872
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2873
|
+
*
|
|
2647
2874
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
2875
|
+
*
|
|
2648
2876
|
* @example
|
|
2649
2877
|
* ```js
|
|
2650
2878
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2659,7 +2887,9 @@ export interface ViewConfig {
|
|
|
2659
2887
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2660
2888
|
*
|
|
2661
2889
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2890
|
+
*
|
|
2662
2891
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2892
|
+
*
|
|
2663
2893
|
* @example
|
|
2664
2894
|
* ```js
|
|
2665
2895
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2676,7 +2906,8 @@ export interface ViewConfig {
|
|
|
2676
2906
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2677
2907
|
* There are 8 eight home navigation list items.
|
|
2678
2908
|
* To hide these items, specify the string in the array.
|
|
2679
|
-
*
|
|
2909
|
+
*
|
|
2910
|
+
* * @example
|
|
2680
2911
|
* ```js
|
|
2681
2912
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2682
2913
|
* ... // other options
|
|
@@ -2684,11 +2915,10 @@ export interface ViewConfig {
|
|
|
2684
2915
|
* })
|
|
2685
2916
|
* ```
|
|
2686
2917
|
*
|
|
2687
|
-
*
|
|
2688
|
-
*
|
|
2689
2918
|
* **Note**: This option does not apply to the classic homepage.
|
|
2690
2919
|
* To access the updated modular homepage, set
|
|
2691
2920
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2921
|
+
*
|
|
2692
2922
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2693
2923
|
*/
|
|
2694
2924
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2696,6 +2926,7 @@ export interface ViewConfig {
|
|
|
2696
2926
|
* PreRender id to be used for PreRendering the embed.
|
|
2697
2927
|
* Use PreRender to render the embed in the background and then
|
|
2698
2928
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2929
|
+
*
|
|
2699
2930
|
* @example
|
|
2700
2931
|
* ```js
|
|
2701
2932
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2712,9 +2943,11 @@ export interface ViewConfig {
|
|
|
2712
2943
|
* of its embedding element and adjust its own size accordingly.
|
|
2713
2944
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2714
2945
|
* its dimensions based on changes to the size of the embedding element.
|
|
2946
|
+
*
|
|
2715
2947
|
* @type {boolean}
|
|
2716
2948
|
* @default false
|
|
2717
2949
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2950
|
+
*
|
|
2718
2951
|
* @example
|
|
2719
2952
|
* ```js
|
|
2720
2953
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2729,6 +2962,7 @@ export interface ViewConfig {
|
|
|
2729
2962
|
doNotTrackPreRenderSize?: boolean;
|
|
2730
2963
|
/**
|
|
2731
2964
|
* For internal tracking of the embed component type.
|
|
2965
|
+
*
|
|
2732
2966
|
* @hidden
|
|
2733
2967
|
*/
|
|
2734
2968
|
embedComponentType?: string;
|
|
@@ -2738,6 +2972,7 @@ export interface ViewConfig {
|
|
|
2738
2972
|
*
|
|
2739
2973
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2740
2974
|
* embedded view.
|
|
2975
|
+
*
|
|
2741
2976
|
* @default false
|
|
2742
2977
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2743
2978
|
*/
|
|
@@ -2745,6 +2980,7 @@ export interface ViewConfig {
|
|
|
2745
2980
|
}
|
|
2746
2981
|
/**
|
|
2747
2982
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
2983
|
+
*
|
|
2748
2984
|
* @group Events
|
|
2749
2985
|
*/
|
|
2750
2986
|
export type MessagePayload = {
|
|
@@ -2755,6 +2991,7 @@ export type MessagePayload = {
|
|
|
2755
2991
|
/**
|
|
2756
2992
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2757
2993
|
* option
|
|
2994
|
+
*
|
|
2758
2995
|
* @group Events
|
|
2759
2996
|
*/
|
|
2760
2997
|
export type MessageOptions = {
|
|
@@ -2766,6 +3003,7 @@ export type MessageOptions = {
|
|
|
2766
3003
|
};
|
|
2767
3004
|
/**
|
|
2768
3005
|
* MessageCallback: Embed event message callback
|
|
3006
|
+
*
|
|
2769
3007
|
* @group Events
|
|
2770
3008
|
*/
|
|
2771
3009
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -2848,13 +3086,18 @@ export declare enum RuntimeFilterOp {
|
|
|
2848
3086
|
/**
|
|
2849
3087
|
* Is included in this list of values
|
|
2850
3088
|
*/
|
|
2851
|
-
IN = "IN"
|
|
3089
|
+
IN = "IN",
|
|
3090
|
+
/**
|
|
3091
|
+
* Is not included in this list of values
|
|
3092
|
+
*/
|
|
3093
|
+
NOT_IN = "NOT_IN"
|
|
2852
3094
|
}
|
|
2853
3095
|
/**
|
|
2854
3096
|
* Home page module that can be hidden.
|
|
2855
3097
|
* **Note**: This option does not apply to the classic homepage.
|
|
2856
3098
|
* To access the updated modular homepage, set
|
|
2857
3099
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3100
|
+
*
|
|
2858
3101
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2859
3102
|
*/
|
|
2860
3103
|
export declare enum HomepageModule {
|
|
@@ -2922,6 +3165,7 @@ export interface RuntimeParameter {
|
|
|
2922
3165
|
*
|
|
2923
3166
|
* To add an event listener use the corresponding
|
|
2924
3167
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
3168
|
+
*
|
|
2925
3169
|
* @example
|
|
2926
3170
|
* ```js
|
|
2927
3171
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2939,6 +3183,7 @@ export interface RuntimeParameter {
|
|
|
2939
3183
|
export declare enum EmbedEvent {
|
|
2940
3184
|
/**
|
|
2941
3185
|
* Rendering has initialized.
|
|
3186
|
+
*
|
|
2942
3187
|
* @example
|
|
2943
3188
|
*```js
|
|
2944
3189
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -2952,7 +3197,9 @@ export declare enum EmbedEvent {
|
|
|
2952
3197
|
Init = "init",
|
|
2953
3198
|
/**
|
|
2954
3199
|
* Authentication has either succeeded or failed.
|
|
3200
|
+
*
|
|
2955
3201
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3202
|
+
*
|
|
2956
3203
|
* @example
|
|
2957
3204
|
*```js
|
|
2958
3205
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -2964,7 +3211,9 @@ export declare enum EmbedEvent {
|
|
|
2964
3211
|
AuthInit = "authInit",
|
|
2965
3212
|
/**
|
|
2966
3213
|
* The embed object container has loaded.
|
|
3214
|
+
*
|
|
2967
3215
|
* @returns timestamp - The timestamp when the event was generated.
|
|
3216
|
+
*
|
|
2968
3217
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2969
3218
|
* @example
|
|
2970
3219
|
*```js
|
|
@@ -2978,7 +3227,9 @@ export declare enum EmbedEvent {
|
|
|
2978
3227
|
Load = "load",
|
|
2979
3228
|
/**
|
|
2980
3229
|
* Data pertaining to answer or Liveboard is received
|
|
3230
|
+
*
|
|
2981
3231
|
* @return data - The answer or Liveboard data
|
|
3232
|
+
*
|
|
2982
3233
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2983
3234
|
* @example
|
|
2984
3235
|
*```js
|
|
@@ -2991,11 +3242,13 @@ export declare enum EmbedEvent {
|
|
|
2991
3242
|
Data = "data",
|
|
2992
3243
|
/**
|
|
2993
3244
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
3245
|
+
*
|
|
2994
3246
|
* @hidden
|
|
2995
3247
|
*/
|
|
2996
3248
|
FiltersChanged = "filtersChanged",
|
|
2997
3249
|
/**
|
|
2998
3250
|
* Search query has been updated by the user.
|
|
3251
|
+
*
|
|
2999
3252
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3000
3253
|
* @example
|
|
3001
3254
|
*```js
|
|
@@ -3005,7 +3258,9 @@ export declare enum EmbedEvent {
|
|
|
3005
3258
|
QueryChanged = "queryChanged",
|
|
3006
3259
|
/**
|
|
3007
3260
|
* A drill-down operation has been performed.
|
|
3261
|
+
*
|
|
3008
3262
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3263
|
+
*
|
|
3009
3264
|
* @returns additionalFilters - Any additional filters applied
|
|
3010
3265
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
3011
3266
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
@@ -3042,7 +3297,9 @@ export declare enum EmbedEvent {
|
|
|
3042
3297
|
Drilldown = "drillDown",
|
|
3043
3298
|
/**
|
|
3044
3299
|
* One or more data sources have been selected.
|
|
3300
|
+
*
|
|
3045
3301
|
* @returns dataSourceIds - the list of data sources
|
|
3302
|
+
*
|
|
3046
3303
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3047
3304
|
* @example
|
|
3048
3305
|
* ```js
|
|
@@ -3054,6 +3311,7 @@ export declare enum EmbedEvent {
|
|
|
3054
3311
|
DataSourceSelected = "dataSourceSelected",
|
|
3055
3312
|
/**
|
|
3056
3313
|
* One or more data columns have been selected.
|
|
3314
|
+
*
|
|
3057
3315
|
* @returns columnIds - the list of columns
|
|
3058
3316
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3059
3317
|
* @example
|
|
@@ -3066,9 +3324,11 @@ export declare enum EmbedEvent {
|
|
|
3066
3324
|
AddRemoveColumns = "addRemoveColumns",
|
|
3067
3325
|
/**
|
|
3068
3326
|
* A custom action has been triggered.
|
|
3327
|
+
*
|
|
3069
3328
|
* @returns actionId - ID of the custom action
|
|
3070
3329
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
3071
3330
|
* Answer or Liveboard data
|
|
3331
|
+
*
|
|
3072
3332
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3073
3333
|
* @example
|
|
3074
3334
|
* ```js
|
|
@@ -3083,6 +3343,7 @@ export declare enum EmbedEvent {
|
|
|
3083
3343
|
CustomAction = "customAction",
|
|
3084
3344
|
/**
|
|
3085
3345
|
* Listen to double click actions on a visualization.
|
|
3346
|
+
*
|
|
3086
3347
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
3087
3348
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
3088
3349
|
* @example
|
|
@@ -3095,6 +3356,7 @@ export declare enum EmbedEvent {
|
|
|
3095
3356
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
3096
3357
|
/**
|
|
3097
3358
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
3359
|
+
*
|
|
3098
3360
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
3099
3361
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3100
3362
|
* @important
|
|
@@ -3115,21 +3377,17 @@ export declare enum EmbedEvent {
|
|
|
3115
3377
|
/**
|
|
3116
3378
|
* An error has occurred. This event is fired for the following error types:
|
|
3117
3379
|
*
|
|
3118
|
-
*
|
|
3380
|
+
* `API` - API call failure error.
|
|
3381
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
|
|
3382
|
+
* `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
|
|
3383
|
+
* `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
3384
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
3385
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
3119
3386
|
*
|
|
3120
|
-
*
|
|
3121
|
-
* mode.
|
|
3387
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
3122
3388
|
*
|
|
3123
|
-
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
3124
|
-
*
|
|
3125
|
-
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
3126
|
-
*
|
|
3127
|
-
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
3128
|
-
*
|
|
3129
|
-
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
3130
|
-
*
|
|
3131
|
-
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
3132
3389
|
* @returns error - An error object or message
|
|
3390
|
+
*
|
|
3133
3391
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3134
3392
|
* @example
|
|
3135
3393
|
* ```js
|
|
@@ -3154,8 +3412,11 @@ export declare enum EmbedEvent {
|
|
|
3154
3412
|
Error = "Error",
|
|
3155
3413
|
/**
|
|
3156
3414
|
* The embedded object has sent an alert.
|
|
3415
|
+
*
|
|
3157
3416
|
* @returns alert - An alert object
|
|
3417
|
+
*
|
|
3158
3418
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3419
|
+
*
|
|
3159
3420
|
* @example
|
|
3160
3421
|
* ```js
|
|
3161
3422
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -3164,7 +3425,9 @@ export declare enum EmbedEvent {
|
|
|
3164
3425
|
Alert = "alert",
|
|
3165
3426
|
/**
|
|
3166
3427
|
* The ThoughtSpot auth session has expired.
|
|
3428
|
+
*
|
|
3167
3429
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3430
|
+
*
|
|
3168
3431
|
* @example
|
|
3169
3432
|
*```js
|
|
3170
3433
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -3177,22 +3440,26 @@ export declare enum EmbedEvent {
|
|
|
3177
3440
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3178
3441
|
/**
|
|
3179
3442
|
* ThoughtSpot failed to validate the auth session.
|
|
3443
|
+
*
|
|
3180
3444
|
* @hidden
|
|
3181
3445
|
*/
|
|
3182
3446
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
3183
3447
|
/**
|
|
3184
3448
|
* ThoughtSpot failed to validate the auth session.
|
|
3449
|
+
*
|
|
3185
3450
|
* @hidden
|
|
3186
3451
|
*/
|
|
3187
3452
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
3188
3453
|
/**
|
|
3189
3454
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
3455
|
+
*
|
|
3190
3456
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
3191
3457
|
* @hidden
|
|
3192
3458
|
*/
|
|
3193
3459
|
EmbedHeight = "EMBED_HEIGHT",
|
|
3194
3460
|
/**
|
|
3195
3461
|
* The center of visible iframe viewport is calculated.
|
|
3462
|
+
*
|
|
3196
3463
|
* @returns data - The center of the visible Iframe viewport.
|
|
3197
3464
|
* @hidden
|
|
3198
3465
|
*/
|
|
@@ -3200,6 +3467,7 @@ export declare enum EmbedEvent {
|
|
|
3200
3467
|
/**
|
|
3201
3468
|
* Emitted when the **Get Data** action is initiated.
|
|
3202
3469
|
* Applicable to `SearchBarEmbed` only.
|
|
3470
|
+
*
|
|
3203
3471
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3204
3472
|
* @example
|
|
3205
3473
|
*```js
|
|
@@ -3212,6 +3480,7 @@ export declare enum EmbedEvent {
|
|
|
3212
3480
|
GetDataClick = "getDataClick",
|
|
3213
3481
|
/**
|
|
3214
3482
|
* Detects the route change.
|
|
3483
|
+
*
|
|
3215
3484
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3216
3485
|
* @example
|
|
3217
3486
|
*```js
|
|
@@ -3222,13 +3491,15 @@ export declare enum EmbedEvent {
|
|
|
3222
3491
|
RouteChange = "ROUTE_CHANGE",
|
|
3223
3492
|
/**
|
|
3224
3493
|
* The v1 event type for Data
|
|
3494
|
+
*
|
|
3225
3495
|
* @hidden
|
|
3226
3496
|
*/
|
|
3227
3497
|
V1Data = "exportVizDataToParent",
|
|
3228
3498
|
/**
|
|
3229
3499
|
* Emitted when the embed does not have cookie access. This happens
|
|
3230
3500
|
* when Safari and other Web browsers block third-party cookies
|
|
3231
|
-
* are blocked by default.
|
|
3501
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
3502
|
+
*
|
|
3232
3503
|
* @example
|
|
3233
3504
|
*```js
|
|
3234
3505
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -3238,12 +3509,14 @@ export declare enum EmbedEvent {
|
|
|
3238
3509
|
NoCookieAccess = "noCookieAccess",
|
|
3239
3510
|
/**
|
|
3240
3511
|
* Emitted when SAML is complete
|
|
3512
|
+
*
|
|
3241
3513
|
* @private
|
|
3242
3514
|
* @hidden
|
|
3243
3515
|
*/
|
|
3244
3516
|
SAMLComplete = "samlComplete",
|
|
3245
3517
|
/**
|
|
3246
3518
|
* Emitted when any modal is opened in the app
|
|
3519
|
+
*
|
|
3247
3520
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3248
3521
|
* @example
|
|
3249
3522
|
*```js
|
|
@@ -3255,6 +3528,7 @@ export declare enum EmbedEvent {
|
|
|
3255
3528
|
DialogOpen = "dialog-open",
|
|
3256
3529
|
/**
|
|
3257
3530
|
* Emitted when any modal is closed in the app
|
|
3531
|
+
*
|
|
3258
3532
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3259
3533
|
* @example
|
|
3260
3534
|
*```js
|
|
@@ -3267,7 +3541,8 @@ export declare enum EmbedEvent {
|
|
|
3267
3541
|
/**
|
|
3268
3542
|
* Emitted when the Liveboard shell loads.
|
|
3269
3543
|
* You can use this event as a hook to trigger
|
|
3270
|
-
*
|
|
3544
|
+
* other events on the rendered Liveboard.
|
|
3545
|
+
*
|
|
3271
3546
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3272
3547
|
* @example
|
|
3273
3548
|
*```js
|
|
@@ -3288,6 +3563,7 @@ export declare enum EmbedEvent {
|
|
|
3288
3563
|
LiveboardRendered = "PinboardRendered",
|
|
3289
3564
|
/**
|
|
3290
3565
|
* Emits all events.
|
|
3566
|
+
*
|
|
3291
3567
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3292
3568
|
* @example
|
|
3293
3569
|
*```js
|
|
@@ -3299,6 +3575,7 @@ export declare enum EmbedEvent {
|
|
|
3299
3575
|
ALL = "*",
|
|
3300
3576
|
/**
|
|
3301
3577
|
* Emitted when an Answer is saved in the app
|
|
3578
|
+
*
|
|
3302
3579
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3303
3580
|
* @example
|
|
3304
3581
|
*```js
|
|
@@ -3318,10 +3595,11 @@ export declare enum EmbedEvent {
|
|
|
3318
3595
|
/**
|
|
3319
3596
|
* Emitted when the download action is triggered on an answer
|
|
3320
3597
|
*
|
|
3321
|
-
* **Note**:
|
|
3598
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
3322
3599
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3323
3600
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3324
3601
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
3602
|
+
*
|
|
3325
3603
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3326
3604
|
* @example
|
|
3327
3605
|
*```js
|
|
@@ -3333,6 +3611,7 @@ export declare enum EmbedEvent {
|
|
|
3333
3611
|
Download = "download",
|
|
3334
3612
|
/**
|
|
3335
3613
|
* Emitted when the download action is triggered on an answer
|
|
3614
|
+
*
|
|
3336
3615
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3337
3616
|
* @example
|
|
3338
3617
|
*```js
|
|
@@ -3347,6 +3626,7 @@ export declare enum EmbedEvent {
|
|
|
3347
3626
|
DownloadAsPng = "downloadAsPng",
|
|
3348
3627
|
/**
|
|
3349
3628
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
3629
|
+
*
|
|
3350
3630
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3351
3631
|
* @example
|
|
3352
3632
|
*```js
|
|
@@ -3361,6 +3641,7 @@ export declare enum EmbedEvent {
|
|
|
3361
3641
|
DownloadAsPdf = "downloadAsPdf",
|
|
3362
3642
|
/**
|
|
3363
3643
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
3644
|
+
*
|
|
3364
3645
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3365
3646
|
* @example
|
|
3366
3647
|
*```js
|
|
@@ -3375,6 +3656,7 @@ export declare enum EmbedEvent {
|
|
|
3375
3656
|
DownloadAsCsv = "downloadAsCsv",
|
|
3376
3657
|
/**
|
|
3377
3658
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
3659
|
+
*
|
|
3378
3660
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3379
3661
|
* @example
|
|
3380
3662
|
*```js
|
|
@@ -3389,13 +3671,14 @@ export declare enum EmbedEvent {
|
|
|
3389
3671
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3390
3672
|
/**
|
|
3391
3673
|
* Emitted when an Answer is deleted in the app
|
|
3674
|
+
*
|
|
3392
3675
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3393
3676
|
* @example
|
|
3394
3677
|
*```js
|
|
3395
3678
|
* //emit when action starts
|
|
3396
3679
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3397
3680
|
* console.log('delete answer', payload)}, {start: true })
|
|
3398
|
-
* //
|
|
3681
|
+
* //trigger when action is completed
|
|
3399
3682
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3400
3683
|
* console.log('delete answer', payload)})
|
|
3401
3684
|
*```
|
|
@@ -3403,6 +3686,7 @@ export declare enum EmbedEvent {
|
|
|
3403
3686
|
AnswerDelete = "answerDelete",
|
|
3404
3687
|
/**
|
|
3405
3688
|
* Emitted when an answer is pinned to a Liveboard
|
|
3689
|
+
*
|
|
3406
3690
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3407
3691
|
* @example
|
|
3408
3692
|
*```js
|
|
@@ -3421,6 +3705,7 @@ export declare enum EmbedEvent {
|
|
|
3421
3705
|
Pin = "pin",
|
|
3422
3706
|
/**
|
|
3423
3707
|
* Emitted when SpotIQ analysis is triggered
|
|
3708
|
+
*
|
|
3424
3709
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3425
3710
|
* @example
|
|
3426
3711
|
*```js
|
|
@@ -3439,6 +3724,7 @@ export declare enum EmbedEvent {
|
|
|
3439
3724
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3440
3725
|
/**
|
|
3441
3726
|
* Emitted when a user shares an object with another user or group
|
|
3727
|
+
*
|
|
3442
3728
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3443
3729
|
* @example
|
|
3444
3730
|
*```js
|
|
@@ -3458,6 +3744,7 @@ export declare enum EmbedEvent {
|
|
|
3458
3744
|
/**
|
|
3459
3745
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
3460
3746
|
* data on a chart or table.
|
|
3747
|
+
*
|
|
3461
3748
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3462
3749
|
* @example
|
|
3463
3750
|
*```js
|
|
@@ -3470,6 +3757,7 @@ export declare enum EmbedEvent {
|
|
|
3470
3757
|
/**
|
|
3471
3758
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
3472
3759
|
* data on a chart or table
|
|
3760
|
+
*
|
|
3473
3761
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3474
3762
|
* @example
|
|
3475
3763
|
*```js
|
|
@@ -3481,6 +3769,7 @@ export declare enum EmbedEvent {
|
|
|
3481
3769
|
DrillExclude = "context-menu-item-exclude",
|
|
3482
3770
|
/**
|
|
3483
3771
|
* Emitted when a column value is copied in the embedded app.
|
|
3772
|
+
*
|
|
3484
3773
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3485
3774
|
* @example
|
|
3486
3775
|
*```js
|
|
@@ -3491,7 +3780,9 @@ export declare enum EmbedEvent {
|
|
|
3491
3780
|
*/
|
|
3492
3781
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3493
3782
|
/**
|
|
3494
|
-
* Emitted when a user clicks the **Update TML** action
|
|
3783
|
+
* Emitted when a user clicks the **Update TML** action on
|
|
3784
|
+
* embedded Liveboard.
|
|
3785
|
+
*
|
|
3495
3786
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3496
3787
|
* @example
|
|
3497
3788
|
*```js
|
|
@@ -3502,6 +3793,8 @@ export declare enum EmbedEvent {
|
|
|
3502
3793
|
UpdateTML = "updateTSL",
|
|
3503
3794
|
/**
|
|
3504
3795
|
* Emitted when a user clicks the **Edit TML** action
|
|
3796
|
+
* on an embedded Liveboard.
|
|
3797
|
+
*
|
|
3505
3798
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3506
3799
|
* @example
|
|
3507
3800
|
*```js
|
|
@@ -3514,6 +3807,7 @@ export declare enum EmbedEvent {
|
|
|
3514
3807
|
/**
|
|
3515
3808
|
* Emitted when the **Export TML** action is triggered on an
|
|
3516
3809
|
* an embedded object in the app
|
|
3810
|
+
*
|
|
3517
3811
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3518
3812
|
* @example
|
|
3519
3813
|
*```js
|
|
@@ -3528,6 +3822,7 @@ export declare enum EmbedEvent {
|
|
|
3528
3822
|
ExportTML = "exportTSL",
|
|
3529
3823
|
/**
|
|
3530
3824
|
* Emitted when an Answer is saved as a View.
|
|
3825
|
+
*
|
|
3531
3826
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3532
3827
|
* @example
|
|
3533
3828
|
*```js
|
|
@@ -3539,6 +3834,7 @@ export declare enum EmbedEvent {
|
|
|
3539
3834
|
SaveAsView = "saveAsView",
|
|
3540
3835
|
/**
|
|
3541
3836
|
* Emitted when the user creates a copy of an Answer
|
|
3837
|
+
*
|
|
3542
3838
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3543
3839
|
* @example
|
|
3544
3840
|
*```js
|
|
@@ -3553,6 +3849,7 @@ export declare enum EmbedEvent {
|
|
|
3553
3849
|
CopyAEdit = "copyAEdit",
|
|
3554
3850
|
/**
|
|
3555
3851
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
3852
|
+
*
|
|
3556
3853
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3557
3854
|
* @example
|
|
3558
3855
|
*```js
|
|
@@ -3564,6 +3861,7 @@ export declare enum EmbedEvent {
|
|
|
3564
3861
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3565
3862
|
/**
|
|
3566
3863
|
* Emitted when an answer is switched to a chart or table view.
|
|
3864
|
+
*
|
|
3567
3865
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3568
3866
|
* @example
|
|
3569
3867
|
*```js
|
|
@@ -3575,11 +3873,13 @@ export declare enum EmbedEvent {
|
|
|
3575
3873
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3576
3874
|
/**
|
|
3577
3875
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
3876
|
+
*
|
|
3578
3877
|
* @hidden
|
|
3579
3878
|
*/
|
|
3580
3879
|
APP_INIT = "appInit",
|
|
3581
3880
|
/**
|
|
3582
3881
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3882
|
+
*
|
|
3583
3883
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3584
3884
|
* @example
|
|
3585
3885
|
*```js
|
|
@@ -3591,6 +3891,7 @@ export declare enum EmbedEvent {
|
|
|
3591
3891
|
LiveboardInfo = "pinboardInfo",
|
|
3592
3892
|
/**
|
|
3593
3893
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3894
|
+
*
|
|
3594
3895
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3595
3896
|
* @example
|
|
3596
3897
|
*```js
|
|
@@ -3602,6 +3903,7 @@ export declare enum EmbedEvent {
|
|
|
3602
3903
|
AddToFavorites = "addToFavorites",
|
|
3603
3904
|
/**
|
|
3604
3905
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3906
|
+
*
|
|
3605
3907
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3606
3908
|
* @example
|
|
3607
3909
|
*```js
|
|
@@ -3613,6 +3915,7 @@ export declare enum EmbedEvent {
|
|
|
3613
3915
|
Schedule = "subscription",
|
|
3614
3916
|
/**
|
|
3615
3917
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3918
|
+
*
|
|
3616
3919
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3617
3920
|
* @example
|
|
3618
3921
|
*```js
|
|
@@ -3624,6 +3927,7 @@ export declare enum EmbedEvent {
|
|
|
3624
3927
|
Edit = "edit",
|
|
3625
3928
|
/**
|
|
3626
3929
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3930
|
+
*
|
|
3627
3931
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3628
3932
|
* @example
|
|
3629
3933
|
*```js
|
|
@@ -3635,6 +3939,7 @@ export declare enum EmbedEvent {
|
|
|
3635
3939
|
MakeACopy = "makeACopy",
|
|
3636
3940
|
/**
|
|
3637
3941
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3942
|
+
*
|
|
3638
3943
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3639
3944
|
* @example
|
|
3640
3945
|
*```js
|
|
@@ -3650,6 +3955,7 @@ export declare enum EmbedEvent {
|
|
|
3650
3955
|
Present = "present",
|
|
3651
3956
|
/**
|
|
3652
3957
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3958
|
+
*
|
|
3653
3959
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3654
3960
|
* @example
|
|
3655
3961
|
*```js
|
|
@@ -3660,6 +3966,7 @@ export declare enum EmbedEvent {
|
|
|
3660
3966
|
Delete = "delete",
|
|
3661
3967
|
/**
|
|
3662
3968
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3969
|
+
*
|
|
3663
3970
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3664
3971
|
* @example
|
|
3665
3972
|
*```js
|
|
@@ -3669,6 +3976,7 @@ export declare enum EmbedEvent {
|
|
|
3669
3976
|
SchedulesList = "schedule-list",
|
|
3670
3977
|
/**
|
|
3671
3978
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3979
|
+
*
|
|
3672
3980
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3673
3981
|
* @example
|
|
3674
3982
|
*```js
|
|
@@ -3678,6 +3986,7 @@ export declare enum EmbedEvent {
|
|
|
3678
3986
|
Cancel = "cancel",
|
|
3679
3987
|
/**
|
|
3680
3988
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3989
|
+
*
|
|
3681
3990
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3682
3991
|
* @example
|
|
3683
3992
|
*```js
|
|
@@ -3688,6 +3997,7 @@ export declare enum EmbedEvent {
|
|
|
3688
3997
|
Explore = "explore",
|
|
3689
3998
|
/**
|
|
3690
3999
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
4000
|
+
*
|
|
3691
4001
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3692
4002
|
* @example
|
|
3693
4003
|
*```js
|
|
@@ -3698,16 +4008,18 @@ export declare enum EmbedEvent {
|
|
|
3698
4008
|
CopyLink = "embedDocument",
|
|
3699
4009
|
/**
|
|
3700
4010
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
4011
|
+
*
|
|
3701
4012
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3702
4013
|
* @example
|
|
3703
4014
|
*```js
|
|
3704
|
-
* liveboardEmbed.
|
|
4015
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
3705
4016
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3706
4017
|
*```
|
|
3707
4018
|
*/
|
|
3708
4019
|
CrossFilterChanged = "cross-filter-changed",
|
|
3709
4020
|
/**
|
|
3710
4021
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
4022
|
+
*
|
|
3711
4023
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3712
4024
|
* @example
|
|
3713
4025
|
*```js
|
|
@@ -3719,6 +4031,7 @@ export declare enum EmbedEvent {
|
|
|
3719
4031
|
VizPointRightClick = "vizPointRightClick",
|
|
3720
4032
|
/**
|
|
3721
4033
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
4034
|
+
*
|
|
3722
4035
|
* @hidden
|
|
3723
4036
|
*/
|
|
3724
4037
|
InsertIntoSlide = "insertInToSlide",
|
|
@@ -3726,6 +4039,7 @@ export declare enum EmbedEvent {
|
|
|
3726
4039
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3727
4040
|
* Returns filter type and name, column name and ID, and runtime
|
|
3728
4041
|
* filter details.
|
|
4042
|
+
*
|
|
3729
4043
|
* @example
|
|
3730
4044
|
*
|
|
3731
4045
|
*```js
|
|
@@ -3734,38 +4048,36 @@ export declare enum EmbedEvent {
|
|
|
3734
4048
|
* })
|
|
3735
4049
|
*
|
|
3736
4050
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3737
|
-
* @example
|
|
3738
|
-
*
|
|
3739
|
-
*```js
|
|
3740
|
-
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3741
|
-
* console.log('payload', payload);
|
|
3742
|
-
* })
|
|
3743
|
-
*```
|
|
3744
4051
|
*/
|
|
3745
4052
|
FilterChanged = "filterChanged",
|
|
3746
4053
|
/**
|
|
3747
4054
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
4055
|
+
*
|
|
3748
4056
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3749
4057
|
*/
|
|
3750
4058
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3751
4059
|
/**
|
|
3752
4060
|
* Emitted when a user selects a data source.
|
|
4061
|
+
*
|
|
3753
4062
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3754
4063
|
*/
|
|
3755
4064
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3756
4065
|
/**
|
|
3757
4066
|
* Emitted when a user updates a connection on the **Data** page
|
|
4067
|
+
*
|
|
3758
4068
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3759
4069
|
*/
|
|
3760
4070
|
UpdateConnection = "updateConnection",
|
|
3761
4071
|
/**
|
|
3762
4072
|
* Emitted when a user updates a connection on the **Data** page
|
|
4073
|
+
*
|
|
3763
4074
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3764
4075
|
*/
|
|
3765
4076
|
CreateConnection = "createConnection",
|
|
3766
4077
|
/**
|
|
3767
4078
|
* Emitted when name, status (private or public) or filter values of a
|
|
3768
4079
|
* Personalised view is updated.
|
|
4080
|
+
*
|
|
3769
4081
|
* @returns viewName: string
|
|
3770
4082
|
* @returns viewId: string
|
|
3771
4083
|
* @returns liveboardId: string
|
|
@@ -3775,6 +4087,7 @@ export declare enum EmbedEvent {
|
|
|
3775
4087
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3776
4088
|
/**
|
|
3777
4089
|
* Emitted when a Personalised view is saved.
|
|
4090
|
+
*
|
|
3778
4091
|
* @returns viewName: string
|
|
3779
4092
|
* @returns viewId: string
|
|
3780
4093
|
* @returns liveboardId: string
|
|
@@ -3784,6 +4097,7 @@ export declare enum EmbedEvent {
|
|
|
3784
4097
|
SavePersonalisedView = "savePersonalisedView",
|
|
3785
4098
|
/**
|
|
3786
4099
|
* Emitted when a Liveboard is reset.
|
|
4100
|
+
*
|
|
3787
4101
|
* @returns viewName: string
|
|
3788
4102
|
* @returns viewId: string
|
|
3789
4103
|
* @returns liveboardId: string
|
|
@@ -3793,6 +4107,7 @@ export declare enum EmbedEvent {
|
|
|
3793
4107
|
ResetLiveboard = "resetLiveboard",
|
|
3794
4108
|
/**
|
|
3795
4109
|
* Emitted when a PersonalisedView is deleted.
|
|
4110
|
+
*
|
|
3796
4111
|
* @returns views: string[]
|
|
3797
4112
|
* @returns liveboardId: string
|
|
3798
4113
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -3800,11 +4115,13 @@ export declare enum EmbedEvent {
|
|
|
3800
4115
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3801
4116
|
/**
|
|
3802
4117
|
* Emitted when a user creates a new worksheet
|
|
4118
|
+
*
|
|
3803
4119
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3804
4120
|
*/
|
|
3805
4121
|
CreateWorksheet = "createWorksheet",
|
|
3806
4122
|
/**
|
|
3807
4123
|
* Emitted when Ask Sage is initialized.
|
|
4124
|
+
*
|
|
3808
4125
|
* @returns viewName: string
|
|
3809
4126
|
* @returns viewId: string
|
|
3810
4127
|
* @returns liveboardId: string
|
|
@@ -3814,6 +4131,7 @@ export declare enum EmbedEvent {
|
|
|
3814
4131
|
AskSageInit = "AskSageInit",
|
|
3815
4132
|
/**
|
|
3816
4133
|
* Emitted when a LB/viz is renamed
|
|
4134
|
+
*
|
|
3817
4135
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3818
4136
|
*/
|
|
3819
4137
|
Rename = "rename",
|
|
@@ -3837,6 +4155,7 @@ export declare enum EmbedEvent {
|
|
|
3837
4155
|
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
3838
4156
|
/**
|
|
3839
4157
|
* Emitted when runtime parameters changes
|
|
4158
|
+
*
|
|
3840
4159
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3841
4160
|
*/
|
|
3842
4161
|
ParameterChanged = "ParameterChanged"
|
|
@@ -3848,6 +4167,7 @@ export declare enum EmbedEvent {
|
|
|
3848
4167
|
* To trigger an event use the corresponding
|
|
3849
4168
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
3850
4169
|
* SearchEmbed.trigger} method.
|
|
4170
|
+
*
|
|
3851
4171
|
* @example
|
|
3852
4172
|
* ```js
|
|
3853
4173
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3868,6 +4188,7 @@ export declare enum HostEvent {
|
|
|
3868
4188
|
* the search query string.
|
|
3869
4189
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3870
4190
|
* Includes the following properties:
|
|
4191
|
+
*
|
|
3871
4192
|
* @param - `searchQuery` - query string with search tokens
|
|
3872
4193
|
* @param - `dataSources` - Data source GUID to Search on
|
|
3873
4194
|
* - Although an array, only a single source
|
|
@@ -3886,6 +4207,7 @@ export declare enum HostEvent {
|
|
|
3886
4207
|
/**
|
|
3887
4208
|
* Triggers a drill on certain points of the specified column
|
|
3888
4209
|
* Includes the following properties:
|
|
4210
|
+
*
|
|
3889
4211
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
3890
4212
|
* to drill to. For example, { selectedPoints: []}
|
|
3891
4213
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -3935,16 +4257,19 @@ export declare enum HostEvent {
|
|
|
3935
4257
|
DrillDown = "triggerDrillDown",
|
|
3936
4258
|
/**
|
|
3937
4259
|
* Apply filters
|
|
4260
|
+
*
|
|
3938
4261
|
* @hidden
|
|
3939
4262
|
*/
|
|
3940
4263
|
Filter = "filter",
|
|
3941
4264
|
/**
|
|
3942
4265
|
* Reload the answer or visualization
|
|
4266
|
+
*
|
|
3943
4267
|
* @hidden
|
|
3944
4268
|
*/
|
|
3945
4269
|
Reload = "reload",
|
|
3946
4270
|
/**
|
|
3947
4271
|
* Display specific visualizations on a Liveboard.
|
|
4272
|
+
*
|
|
3948
4273
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
3949
4274
|
* in this parameter will be hidden.
|
|
3950
4275
|
* @example
|
|
@@ -3958,6 +4283,7 @@ export declare enum HostEvent {
|
|
|
3958
4283
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
3959
4284
|
/**
|
|
3960
4285
|
* Set a Liveboard tab as an active tab.
|
|
4286
|
+
*
|
|
3961
4287
|
* @param - tabId - string of id of Tab to show
|
|
3962
4288
|
* @example
|
|
3963
4289
|
* ```js
|
|
@@ -3978,16 +4304,17 @@ export declare enum HostEvent {
|
|
|
3978
4304
|
* _String_. The name of the column to filter on.
|
|
3979
4305
|
*
|
|
3980
4306
|
* `operator`
|
|
3981
|
-
*
|
|
3982
|
-
*
|
|
4307
|
+
* Runtime filter operator to apply. For information,
|
|
4308
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
3983
4309
|
*
|
|
3984
4310
|
* `values`
|
|
3985
|
-
*
|
|
3986
|
-
*
|
|
4311
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
4312
|
+
* operators such as BW and IN accept multiple operands.
|
|
4313
|
+
*
|
|
4314
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
4315
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
4316
|
+
* embedding (SageEmbed).
|
|
3987
4317
|
*
|
|
3988
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3989
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3990
|
-
* embedding (SageEmbed).
|
|
3991
4318
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
3992
4319
|
* @example
|
|
3993
4320
|
* ```js
|
|
@@ -4003,6 +4330,7 @@ export declare enum HostEvent {
|
|
|
4003
4330
|
/**
|
|
4004
4331
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4005
4332
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
4333
|
+
*
|
|
4006
4334
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4007
4335
|
* be a number; for example, `1`, `-1`.
|
|
4008
4336
|
* @example
|
|
@@ -4015,6 +4343,7 @@ export declare enum HostEvent {
|
|
|
4015
4343
|
/**
|
|
4016
4344
|
* Open the filter panel for a particular column.
|
|
4017
4345
|
* Works with Search and Liveboard embed.
|
|
4346
|
+
*
|
|
4018
4347
|
* @param - { columnId: string,
|
|
4019
4348
|
* name: string,
|
|
4020
4349
|
* type: INT64/CHAR/DATE,
|
|
@@ -4031,6 +4360,7 @@ export declare enum HostEvent {
|
|
|
4031
4360
|
OpenFilter = "openFilter",
|
|
4032
4361
|
/**
|
|
4033
4362
|
* Add columns to the current search query.
|
|
4363
|
+
*
|
|
4034
4364
|
* @param - { columnIds: string[] }
|
|
4035
4365
|
* @example
|
|
4036
4366
|
* ```js
|
|
@@ -4041,6 +4371,7 @@ export declare enum HostEvent {
|
|
|
4041
4371
|
AddColumns = "addColumns",
|
|
4042
4372
|
/**
|
|
4043
4373
|
* Remove a column from the current search query.
|
|
4374
|
+
*
|
|
4044
4375
|
* @param - { columnId: string }
|
|
4045
4376
|
* @example
|
|
4046
4377
|
* ```js
|
|
@@ -4055,6 +4386,7 @@ export declare enum HostEvent {
|
|
|
4055
4386
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
4056
4387
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
4057
4388
|
* sorting, toggling of legends, and data drill down.
|
|
4389
|
+
*
|
|
4058
4390
|
* @example
|
|
4059
4391
|
* ```js
|
|
4060
4392
|
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
@@ -4065,6 +4397,7 @@ export declare enum HostEvent {
|
|
|
4065
4397
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
4066
4398
|
/**
|
|
4067
4399
|
* Trigger the **Pin** action on an embedded object
|
|
4400
|
+
*
|
|
4068
4401
|
* @param - Liveboard embed takes the `vizId` as a
|
|
4069
4402
|
* key. Can be left undefined when embedding Search, full app, or
|
|
4070
4403
|
* a visualization.
|
|
@@ -4081,6 +4414,7 @@ export declare enum HostEvent {
|
|
|
4081
4414
|
/**
|
|
4082
4415
|
* Trigger the **Show Liveboard details** action
|
|
4083
4416
|
* on an embedded Liveboard.
|
|
4417
|
+
*
|
|
4084
4418
|
* @example
|
|
4085
4419
|
*```js
|
|
4086
4420
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -4090,6 +4424,7 @@ export declare enum HostEvent {
|
|
|
4090
4424
|
LiveboardInfo = "pinboardInfo",
|
|
4091
4425
|
/**
|
|
4092
4426
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
4427
|
+
*
|
|
4093
4428
|
* @example
|
|
4094
4429
|
* ```js
|
|
4095
4430
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -4099,6 +4434,7 @@ export declare enum HostEvent {
|
|
|
4099
4434
|
Schedule = "subscription",
|
|
4100
4435
|
/**
|
|
4101
4436
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
4437
|
+
*
|
|
4102
4438
|
* @example
|
|
4103
4439
|
* ```js
|
|
4104
4440
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -4107,16 +4443,22 @@ export declare enum HostEvent {
|
|
|
4107
4443
|
*/
|
|
4108
4444
|
SchedulesList = "schedule-list",
|
|
4109
4445
|
/**
|
|
4110
|
-
* Trigger the **Export TML** action on an embedded Liveboard
|
|
4446
|
+
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
4447
|
+
* Answer.
|
|
4448
|
+
*
|
|
4111
4449
|
* @example
|
|
4112
4450
|
* ```js
|
|
4113
4451
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
4114
4452
|
* ```
|
|
4453
|
+
*
|
|
4115
4454
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4116
4455
|
*/
|
|
4117
4456
|
ExportTML = "exportTSL",
|
|
4118
4457
|
/**
|
|
4119
|
-
* Trigger the **Edit TML** action on an embedded Liveboard
|
|
4458
|
+
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
4459
|
+
* saved Answers in the full application embedding.
|
|
4460
|
+
*
|
|
4461
|
+
*
|
|
4120
4462
|
* @example
|
|
4121
4463
|
* ```js
|
|
4122
4464
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -4126,6 +4468,7 @@ export declare enum HostEvent {
|
|
|
4126
4468
|
EditTML = "editTSL",
|
|
4127
4469
|
/**
|
|
4128
4470
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
4471
|
+
*
|
|
4129
4472
|
* @example
|
|
4130
4473
|
* ```js
|
|
4131
4474
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -4134,7 +4477,12 @@ export declare enum HostEvent {
|
|
|
4134
4477
|
*/
|
|
4135
4478
|
UpdateTML = "updateTSL",
|
|
4136
4479
|
/**
|
|
4137
|
-
* Trigger the **Download PDF** action on an embedded Liveboard
|
|
4480
|
+
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
4481
|
+
* visualization or Answer.
|
|
4482
|
+
*
|
|
4483
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
4484
|
+
* visualizations and Answers if the data is in tabular format.
|
|
4485
|
+
*
|
|
4138
4486
|
* @example
|
|
4139
4487
|
* ```js
|
|
4140
4488
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -4145,6 +4493,7 @@ export declare enum HostEvent {
|
|
|
4145
4493
|
/**
|
|
4146
4494
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
4147
4495
|
* visualization page.
|
|
4496
|
+
*
|
|
4148
4497
|
* @example
|
|
4149
4498
|
* ```js
|
|
4150
4499
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -4160,6 +4509,7 @@ export declare enum HostEvent {
|
|
|
4160
4509
|
MakeACopy = "makeACopy",
|
|
4161
4510
|
/**
|
|
4162
4511
|
* Trigger the **Delete** action for a Liveboard.
|
|
4512
|
+
*
|
|
4163
4513
|
* @example
|
|
4164
4514
|
* ```js
|
|
4165
4515
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -4169,6 +4519,7 @@ export declare enum HostEvent {
|
|
|
4169
4519
|
Remove = "delete",
|
|
4170
4520
|
/**
|
|
4171
4521
|
* Trigger the **Explore** action on a visualization.
|
|
4522
|
+
*
|
|
4172
4523
|
* @param - an object with `vizId` as a key
|
|
4173
4524
|
* @example
|
|
4174
4525
|
* ```js
|
|
@@ -4179,6 +4530,7 @@ export declare enum HostEvent {
|
|
|
4179
4530
|
Explore = "explore",
|
|
4180
4531
|
/**
|
|
4181
4532
|
* Trigger the **Create alert** action on a visualization
|
|
4533
|
+
*
|
|
4182
4534
|
* @param - an object with `vizId` as a key
|
|
4183
4535
|
* @example
|
|
4184
4536
|
* ```js
|
|
@@ -4191,6 +4543,7 @@ export declare enum HostEvent {
|
|
|
4191
4543
|
CreateMonitor = "createMonitor",
|
|
4192
4544
|
/**
|
|
4193
4545
|
* Trigger the **Manage alerts** action on a visualization
|
|
4546
|
+
*
|
|
4194
4547
|
* @param - an object with `vizId` as a key
|
|
4195
4548
|
* @example
|
|
4196
4549
|
* ```js
|
|
@@ -4202,11 +4555,14 @@ export declare enum HostEvent {
|
|
|
4202
4555
|
*/
|
|
4203
4556
|
ManageMonitor = "manageMonitor",
|
|
4204
4557
|
/**
|
|
4205
|
-
* Trigger the **Edit** action on a Liveboard or visualization
|
|
4558
|
+
* Trigger the **Edit** action on a Liveboard or a visualization
|
|
4559
|
+
* on a Liveboard.
|
|
4560
|
+
*
|
|
4561
|
+
* This event is not supported in visualization embed and search embed.
|
|
4562
|
+
*
|
|
4206
4563
|
* @param - object - To trigger the action for a specific visualization
|
|
4207
4564
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
4208
|
-
*
|
|
4209
|
-
* a visualization.
|
|
4565
|
+
*
|
|
4210
4566
|
* @example
|
|
4211
4567
|
* ```js
|
|
4212
4568
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
@@ -4215,14 +4571,12 @@ export declare enum HostEvent {
|
|
|
4215
4571
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
4216
4572
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
4217
4573
|
* ```
|
|
4218
|
-
* ```js
|
|
4219
|
-
* vizEmbed.trigger((HostEvent.Edit)
|
|
4220
|
-
* ```
|
|
4221
4574
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4222
4575
|
*/
|
|
4223
4576
|
Edit = "edit",
|
|
4224
4577
|
/**
|
|
4225
4578
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
4579
|
+
*
|
|
4226
4580
|
* @param - object - to trigger the action for a
|
|
4227
4581
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
4228
4582
|
* @example
|
|
@@ -4240,6 +4594,7 @@ export declare enum HostEvent {
|
|
|
4240
4594
|
CopyLink = "embedDocument",
|
|
4241
4595
|
/**
|
|
4242
4596
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
4597
|
+
*
|
|
4243
4598
|
* @param - object - to trigger the action for a specific visualization
|
|
4244
4599
|
* in Liveboard embed, pass in `vizId` as a key
|
|
4245
4600
|
* @example
|
|
@@ -4257,6 +4612,7 @@ export declare enum HostEvent {
|
|
|
4257
4612
|
Present = "present",
|
|
4258
4613
|
/**
|
|
4259
4614
|
* Get TML for the current search.
|
|
4615
|
+
*
|
|
4260
4616
|
* @example
|
|
4261
4617
|
* ```js
|
|
4262
4618
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
@@ -4271,6 +4627,7 @@ export declare enum HostEvent {
|
|
|
4271
4627
|
GetTML = "getTML",
|
|
4272
4628
|
/**
|
|
4273
4629
|
* Trigger the **Show underlying data** action on visualization or search
|
|
4630
|
+
*
|
|
4274
4631
|
* @param - an object with vizId as a key
|
|
4275
4632
|
* @example
|
|
4276
4633
|
* ```js
|
|
@@ -4290,6 +4647,7 @@ export declare enum HostEvent {
|
|
|
4290
4647
|
* Trigger the **Delete** action for a visualization
|
|
4291
4648
|
* in an embedded Liveboard, or a chart or table
|
|
4292
4649
|
* generated from Search.
|
|
4650
|
+
*
|
|
4293
4651
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
4294
4652
|
* Can be left empty if embedding Search or visualization.
|
|
4295
4653
|
* @example
|
|
@@ -4306,6 +4664,7 @@ export declare enum HostEvent {
|
|
|
4306
4664
|
/**
|
|
4307
4665
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
4308
4666
|
* or search.
|
|
4667
|
+
*
|
|
4309
4668
|
* @param - Liveboard embed takes `vizId` as a
|
|
4310
4669
|
* key. Can be left undefined when embedding Search or
|
|
4311
4670
|
* visualization.
|
|
@@ -4326,6 +4685,7 @@ export declare enum HostEvent {
|
|
|
4326
4685
|
/**
|
|
4327
4686
|
* Trigger the **Download** action on charts in
|
|
4328
4687
|
* the embedded view.
|
|
4688
|
+
*
|
|
4329
4689
|
* @example
|
|
4330
4690
|
* ```js
|
|
4331
4691
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -4342,6 +4702,7 @@ export declare enum HostEvent {
|
|
|
4342
4702
|
/**
|
|
4343
4703
|
* Trigger the **Download** > **PNG** action on
|
|
4344
4704
|
* charts in the embedded view.
|
|
4705
|
+
*
|
|
4345
4706
|
* @example
|
|
4346
4707
|
* ```js
|
|
4347
4708
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -4357,6 +4718,7 @@ export declare enum HostEvent {
|
|
|
4357
4718
|
/**
|
|
4358
4719
|
* Trigger the **Download** > **CSV** action on tables in
|
|
4359
4720
|
* the embedded view.
|
|
4721
|
+
*
|
|
4360
4722
|
* @example
|
|
4361
4723
|
* ```js
|
|
4362
4724
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -4374,6 +4736,7 @@ export declare enum HostEvent {
|
|
|
4374
4736
|
/**
|
|
4375
4737
|
* Trigger the **Download** > **XLSX** action on tables
|
|
4376
4738
|
* in the embedded view.
|
|
4739
|
+
*
|
|
4377
4740
|
* @example
|
|
4378
4741
|
* ```js
|
|
4379
4742
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -4391,6 +4754,7 @@ export declare enum HostEvent {
|
|
|
4391
4754
|
/**
|
|
4392
4755
|
* Trigger the **Share** action on an embedded
|
|
4393
4756
|
* Liveboard or Answer.
|
|
4757
|
+
*
|
|
4394
4758
|
* @example
|
|
4395
4759
|
* ```js
|
|
4396
4760
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -4404,6 +4768,7 @@ export declare enum HostEvent {
|
|
|
4404
4768
|
/**
|
|
4405
4769
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
4406
4770
|
* Saves the changes.
|
|
4771
|
+
*
|
|
4407
4772
|
* @example
|
|
4408
4773
|
* ```js
|
|
4409
4774
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -4417,6 +4782,7 @@ export declare enum HostEvent {
|
|
|
4417
4782
|
/**
|
|
4418
4783
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
4419
4784
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
4785
|
+
*
|
|
4420
4786
|
* @param - an object with `vizId` as a key
|
|
4421
4787
|
* @example
|
|
4422
4788
|
* ```js
|
|
@@ -4433,6 +4799,7 @@ export declare enum HostEvent {
|
|
|
4433
4799
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
4434
4800
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
4435
4801
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
4802
|
+
*
|
|
4436
4803
|
* @param - an object with vizId as a key
|
|
4437
4804
|
* @example
|
|
4438
4805
|
* ```js
|
|
@@ -4449,6 +4816,7 @@ export declare enum HostEvent {
|
|
|
4449
4816
|
* Trigger the **Manage pipelines** action on an embedded
|
|
4450
4817
|
* visualization or Answer.
|
|
4451
4818
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
4819
|
+
*
|
|
4452
4820
|
* @param - an object with `vizId` as a key
|
|
4453
4821
|
* @example
|
|
4454
4822
|
* ```js
|
|
@@ -4463,6 +4831,7 @@ export declare enum HostEvent {
|
|
|
4463
4831
|
ManagePipelines = "manage-pipeline",
|
|
4464
4832
|
/**
|
|
4465
4833
|
* Reset search operation on the Search or Answer page.
|
|
4834
|
+
*
|
|
4466
4835
|
* @example
|
|
4467
4836
|
* ```js
|
|
4468
4837
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -4474,17 +4843,21 @@ export declare enum HostEvent {
|
|
|
4474
4843
|
*/
|
|
4475
4844
|
ResetSearch = "resetSearch",
|
|
4476
4845
|
/**
|
|
4477
|
-
* Get details of
|
|
4846
|
+
* Get details of filters applied on the Liveboard.
|
|
4847
|
+
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
4848
|
+
*
|
|
4478
4849
|
* @example
|
|
4479
4850
|
* ```js
|
|
4480
4851
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
4481
4852
|
* console.log('data', data);
|
|
4482
4853
|
* ```
|
|
4854
|
+
*
|
|
4483
4855
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4484
4856
|
*/
|
|
4485
4857
|
GetFilters = "getFilters",
|
|
4486
4858
|
/**
|
|
4487
4859
|
* Update one or several filters applied on a Liveboard.
|
|
4860
|
+
*
|
|
4488
4861
|
* @param - `filter`: a single filter object containing column name,
|
|
4489
4862
|
* filter operator, and values.
|
|
4490
4863
|
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
@@ -4496,11 +4869,12 @@ export declare enum HostEvent {
|
|
|
4496
4869
|
*
|
|
4497
4870
|
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
4498
4871
|
* For information about the supported filter operators,
|
|
4499
|
-
* see
|
|
4872
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4500
4873
|
*
|
|
4501
4874
|
* `values` - An array of one or several values. The value definition on the
|
|
4502
4875
|
* data type you choose to filter on. For a complete list of supported data types,
|
|
4503
|
-
* see
|
|
4876
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
4877
|
+
*
|
|
4504
4878
|
* @example
|
|
4505
4879
|
* ```js
|
|
4506
4880
|
*
|
|
@@ -4512,6 +4886,7 @@ export declare enum HostEvent {
|
|
|
4512
4886
|
* }
|
|
4513
4887
|
* });
|
|
4514
4888
|
* ```
|
|
4889
|
+
*
|
|
4515
4890
|
* @example
|
|
4516
4891
|
*
|
|
4517
4892
|
* ```js
|
|
@@ -4533,11 +4908,13 @@ export declare enum HostEvent {
|
|
|
4533
4908
|
* }]
|
|
4534
4909
|
* });
|
|
4535
4910
|
* ```
|
|
4911
|
+
*
|
|
4536
4912
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4537
4913
|
*/
|
|
4538
4914
|
UpdateFilters = "updateFilters",
|
|
4539
4915
|
/**
|
|
4540
4916
|
* Get tab details for the current Liveboard.
|
|
4917
|
+
*
|
|
4541
4918
|
* @example
|
|
4542
4919
|
* ```js
|
|
4543
4920
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -4551,6 +4928,7 @@ export declare enum HostEvent {
|
|
|
4551
4928
|
GetTabs = "getTabs",
|
|
4552
4929
|
/**
|
|
4553
4930
|
* Set the visible tabs on a Liveboard.
|
|
4931
|
+
*
|
|
4554
4932
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
4555
4933
|
* will be hidden.
|
|
4556
4934
|
* @example
|
|
@@ -4564,6 +4942,7 @@ export declare enum HostEvent {
|
|
|
4564
4942
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4565
4943
|
/**
|
|
4566
4944
|
* Set the hidden tabs on a Liveboard.
|
|
4945
|
+
*
|
|
4567
4946
|
* @param - an array of the IDs of the tabs to hide.
|
|
4568
4947
|
* The IDs not passed will be shown.
|
|
4569
4948
|
* @example
|
|
@@ -4577,6 +4956,7 @@ export declare enum HostEvent {
|
|
|
4577
4956
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4578
4957
|
/**
|
|
4579
4958
|
* Updates the search query string for Natural Language Search operations.
|
|
4959
|
+
*
|
|
4580
4960
|
* @param - `queryString`: Text string in Natural Language format
|
|
4581
4961
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
4582
4962
|
* @example
|
|
@@ -4591,6 +4971,7 @@ export declare enum HostEvent {
|
|
|
4591
4971
|
UpdateSageQuery = "updateSageQuery",
|
|
4592
4972
|
/**
|
|
4593
4973
|
* Get the answer session for a Search / Visualization.
|
|
4974
|
+
*
|
|
4594
4975
|
* @example
|
|
4595
4976
|
* ```js
|
|
4596
4977
|
* const {session} = await embed.trigger(
|
|
@@ -4603,6 +4984,7 @@ export declare enum HostEvent {
|
|
|
4603
4984
|
GetAnswerSession = "getAnswerSession",
|
|
4604
4985
|
/**
|
|
4605
4986
|
* Trigger Ask Sage for viz
|
|
4987
|
+
*
|
|
4606
4988
|
* @example
|
|
4607
4989
|
* ```js
|
|
4608
4990
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -4613,6 +4995,7 @@ export declare enum HostEvent {
|
|
|
4613
4995
|
AskSage = "AskSage",
|
|
4614
4996
|
/**
|
|
4615
4997
|
* Trigger UpdateCrossFilter for Liveboard
|
|
4998
|
+
*
|
|
4616
4999
|
* @example
|
|
4617
5000
|
* ```js
|
|
4618
5001
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4628,6 +5011,7 @@ export declare enum HostEvent {
|
|
|
4628
5011
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4629
5012
|
/**
|
|
4630
5013
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
5014
|
+
*
|
|
4631
5015
|
* @example
|
|
4632
5016
|
* ```js
|
|
4633
5017
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
@@ -4637,6 +5021,7 @@ export declare enum HostEvent {
|
|
|
4637
5021
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4638
5022
|
/**
|
|
4639
5023
|
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
5024
|
+
*
|
|
4640
5025
|
* @example
|
|
4641
5026
|
* ```js
|
|
4642
5027
|
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
@@ -4777,6 +5162,7 @@ export declare enum Param {
|
|
|
4777
5162
|
* specific actions in the embedded view, define the Action
|
|
4778
5163
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
4779
5164
|
* or `hiddenActions` array.
|
|
5165
|
+
*
|
|
4780
5166
|
* @example
|
|
4781
5167
|
* ```js
|
|
4782
5168
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -4800,6 +5186,7 @@ export declare enum Action {
|
|
|
4800
5186
|
/**
|
|
4801
5187
|
* The **Save** action on an Answer or Liveboard.
|
|
4802
5188
|
* Allows users to save the changes.
|
|
5189
|
+
*
|
|
4803
5190
|
* @example
|
|
4804
5191
|
* ```js
|
|
4805
5192
|
* disabledActions: [Action.Save]
|
|
@@ -4816,7 +5203,9 @@ export declare enum Action {
|
|
|
4816
5203
|
SaveUntitled = "saveUntitled",
|
|
4817
5204
|
/**
|
|
4818
5205
|
* The **Save as View** action on the Answer
|
|
4819
|
-
* page. Saves an Answer as a View object
|
|
5206
|
+
* page. Saves an Answer as a View object in the full
|
|
5207
|
+
* application embedding mode.
|
|
5208
|
+
*
|
|
4820
5209
|
* @example
|
|
4821
5210
|
* ```js
|
|
4822
5211
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -4830,6 +5219,7 @@ export declare enum Action {
|
|
|
4830
5219
|
* visualizations in the embedded Liveboard view.
|
|
4831
5220
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
4832
5221
|
* Liveboards and visualizations.
|
|
5222
|
+
*
|
|
4833
5223
|
* @example
|
|
4834
5224
|
* ```js
|
|
4835
5225
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -4839,6 +5229,7 @@ export declare enum Action {
|
|
|
4839
5229
|
/**
|
|
4840
5230
|
* The **Copy and Edit** action on a Liveboard.
|
|
4841
5231
|
* This action is now replaced with `Action.MakeACopy`.
|
|
5232
|
+
*
|
|
4842
5233
|
* @example
|
|
4843
5234
|
* ```js
|
|
4844
5235
|
* disabledActions: [Action.EditACopy]
|
|
@@ -4848,6 +5239,7 @@ export declare enum Action {
|
|
|
4848
5239
|
/**
|
|
4849
5240
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
4850
5241
|
* Copies the visualization URL
|
|
5242
|
+
*
|
|
4851
5243
|
* @example
|
|
4852
5244
|
* ```js
|
|
4853
5245
|
* disabledActions: [Action.CopyLink]
|
|
@@ -4861,6 +5253,7 @@ export declare enum Action {
|
|
|
4861
5253
|
/**
|
|
4862
5254
|
* The **Schedule** menu action on a Liveboard.
|
|
4863
5255
|
* Allows scheduling a Liveboard notification.
|
|
5256
|
+
*
|
|
4864
5257
|
* @example
|
|
4865
5258
|
* ```js
|
|
4866
5259
|
* disabledActions: [Action.Schedule]
|
|
@@ -4870,6 +5263,7 @@ export declare enum Action {
|
|
|
4870
5263
|
/**
|
|
4871
5264
|
* The **Manage schedules** menu action on a Liveboard.
|
|
4872
5265
|
* Allows users to manage scheduled Liveboard jobs.
|
|
5266
|
+
*
|
|
4873
5267
|
* @example
|
|
4874
5268
|
* ```js
|
|
4875
5269
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -4879,6 +5273,7 @@ export declare enum Action {
|
|
|
4879
5273
|
/**
|
|
4880
5274
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
4881
5275
|
* Allows users to share an object with other users and groups.
|
|
5276
|
+
*
|
|
4882
5277
|
* @example
|
|
4883
5278
|
* ```js
|
|
4884
5279
|
* disabledActions: [Action.Share]
|
|
@@ -4888,6 +5283,7 @@ export declare enum Action {
|
|
|
4888
5283
|
/**
|
|
4889
5284
|
* The **Add filter** action on a Liveboard and Search page.
|
|
4890
5285
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
5286
|
+
*
|
|
4891
5287
|
* @example
|
|
4892
5288
|
* ```js
|
|
4893
5289
|
* disabledActions: [Action.AddFilter]
|
|
@@ -4898,6 +5294,7 @@ export declare enum Action {
|
|
|
4898
5294
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
4899
5295
|
* Allows to show action menu to add different objects (like
|
|
4900
5296
|
* formulas, parameters) in data panel v2.
|
|
5297
|
+
*
|
|
4901
5298
|
* @example
|
|
4902
5299
|
* ```js
|
|
4903
5300
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -4909,6 +5306,7 @@ export declare enum Action {
|
|
|
4909
5306
|
* Filter configuration options on a Liveboard and Search page.
|
|
4910
5307
|
* Allows configuring filter options when adding filters to a
|
|
4911
5308
|
* Liveboard or Answer.
|
|
5309
|
+
*
|
|
4912
5310
|
* @example
|
|
4913
5311
|
* ```js
|
|
4914
5312
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -4919,6 +5317,7 @@ export declare enum Action {
|
|
|
4919
5317
|
/**
|
|
4920
5318
|
* The **Choose sources** button on Search page.
|
|
4921
5319
|
* Allows selecting data sources for search queries.
|
|
5320
|
+
*
|
|
4922
5321
|
* @example
|
|
4923
5322
|
* ```js
|
|
4924
5323
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -4928,6 +5327,7 @@ export declare enum Action {
|
|
|
4928
5327
|
/**
|
|
4929
5328
|
* The **Create formula** action on a Search or Answer page.
|
|
4930
5329
|
* Allows adding formulas to an Answer.
|
|
5330
|
+
*
|
|
4931
5331
|
* @example
|
|
4932
5332
|
* ```js
|
|
4933
5333
|
* disabledActions: [Action.AddFormula]
|
|
@@ -4937,6 +5337,7 @@ export declare enum Action {
|
|
|
4937
5337
|
/**
|
|
4938
5338
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
4939
5339
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
5340
|
+
*
|
|
4940
5341
|
* @example
|
|
4941
5342
|
* ```js
|
|
4942
5343
|
* disabledActions: [Action.AddParameter]
|
|
@@ -4946,6 +5347,7 @@ export declare enum Action {
|
|
|
4946
5347
|
/**
|
|
4947
5348
|
* The **Add Column Set** action on a Answer.
|
|
4948
5349
|
* Allows adding column sets to a Answer.
|
|
5350
|
+
*
|
|
4949
5351
|
* @example
|
|
4950
5352
|
* ```js
|
|
4951
5353
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -4956,6 +5358,7 @@ export declare enum Action {
|
|
|
4956
5358
|
/**
|
|
4957
5359
|
* The **Add Query Set** action on a Answer.
|
|
4958
5360
|
* Allows adding query sets to a Answer.
|
|
5361
|
+
*
|
|
4959
5362
|
* @example
|
|
4960
5363
|
* ```js
|
|
4961
5364
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -4970,6 +5373,7 @@ export declare enum Action {
|
|
|
4970
5373
|
/**
|
|
4971
5374
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
4972
5375
|
* Answer page.
|
|
5376
|
+
*
|
|
4973
5377
|
* @example
|
|
4974
5378
|
* ```js
|
|
4975
5379
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -4992,6 +5396,7 @@ export declare enum Action {
|
|
|
4992
5396
|
/**
|
|
4993
5397
|
* The **Show underlying data** menu action on a visualization or
|
|
4994
5398
|
* Answer page.
|
|
5399
|
+
*
|
|
4995
5400
|
* @example
|
|
4996
5401
|
* ```js
|
|
4997
5402
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5002,6 +5407,7 @@ export declare enum Action {
|
|
|
5002
5407
|
* The **Download** menu action on Liveboard visualizations
|
|
5003
5408
|
* and Answers.
|
|
5004
5409
|
* Allows downloading a visualization or Answer.
|
|
5410
|
+
*
|
|
5005
5411
|
* @example
|
|
5006
5412
|
* ```js
|
|
5007
5413
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5012,6 +5418,7 @@ export declare enum Action {
|
|
|
5012
5418
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
5013
5419
|
* or Answer page.
|
|
5014
5420
|
* Downloads a visualization or Answer as a PNG file.
|
|
5421
|
+
*
|
|
5015
5422
|
* @example
|
|
5016
5423
|
* ```js
|
|
5017
5424
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5020,11 +5427,13 @@ export declare enum Action {
|
|
|
5020
5427
|
DownloadAsPng = "downloadAsPng",
|
|
5021
5428
|
/**
|
|
5022
5429
|
*
|
|
5023
|
-
*The **Download PDF** action that downloads a Liveboard,
|
|
5024
|
-
*visualization, or Answer as a PDF file.
|
|
5430
|
+
* The **Download PDF** action that downloads a Liveboard,
|
|
5431
|
+
* visualization, or Answer as a PDF file.
|
|
5432
|
+
*
|
|
5433
|
+
*
|
|
5434
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
5435
|
+
* visualizations and Answers if the data is in tabular format.
|
|
5025
5436
|
*
|
|
5026
|
-
***NOTE**: The **Download** > **PDF** action is available on
|
|
5027
|
-
*visualizations and Answers if the data is in tabular format.
|
|
5028
5437
|
* @example
|
|
5029
5438
|
* ```js
|
|
5030
5439
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -5035,6 +5444,7 @@ export declare enum Action {
|
|
|
5035
5444
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
5036
5445
|
* or Answer page.
|
|
5037
5446
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5447
|
+
*
|
|
5038
5448
|
* @example
|
|
5039
5449
|
* ```js
|
|
5040
5450
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -5045,6 +5455,7 @@ export declare enum Action {
|
|
|
5045
5455
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
5046
5456
|
* or Answer page.
|
|
5047
5457
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5458
|
+
*
|
|
5048
5459
|
* @example
|
|
5049
5460
|
* ```js
|
|
5050
5461
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -5059,6 +5470,7 @@ export declare enum Action {
|
|
|
5059
5470
|
* The **Export TML** menu action on Liveboard, Answers
|
|
5060
5471
|
* Worksheets and Data Connections page.
|
|
5061
5472
|
* Exports an object as a TML file.
|
|
5473
|
+
*
|
|
5062
5474
|
* @example
|
|
5063
5475
|
* ```js
|
|
5064
5476
|
* disabledActions: [Action.ExportTML]
|
|
@@ -5068,6 +5480,7 @@ export declare enum Action {
|
|
|
5068
5480
|
/**
|
|
5069
5481
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
5070
5482
|
* Imports TML representation of ThoughtSpot objects.
|
|
5483
|
+
*
|
|
5071
5484
|
* @example
|
|
5072
5485
|
* ```js
|
|
5073
5486
|
* disabledActions: [Action.ImportTML]
|
|
@@ -5077,6 +5490,7 @@ export declare enum Action {
|
|
|
5077
5490
|
/**
|
|
5078
5491
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
5079
5492
|
* Update TML representation of ThoughtSpot objects.
|
|
5493
|
+
*
|
|
5080
5494
|
* @example
|
|
5081
5495
|
* ```js
|
|
5082
5496
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -5086,6 +5500,7 @@ export declare enum Action {
|
|
|
5086
5500
|
/**
|
|
5087
5501
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
5088
5502
|
* Opens the TML editor.
|
|
5503
|
+
*
|
|
5089
5504
|
* @example
|
|
5090
5505
|
* ```js
|
|
5091
5506
|
* disabledActions: [Action.EditTML]
|
|
@@ -5096,6 +5511,7 @@ export declare enum Action {
|
|
|
5096
5511
|
* The **Present** menu action for Liveboards and Answers.
|
|
5097
5512
|
* Allows presenting a Liveboard or visualization in
|
|
5098
5513
|
* slideshow mode.
|
|
5514
|
+
*
|
|
5099
5515
|
* @example
|
|
5100
5516
|
* ```js
|
|
5101
5517
|
* disabledActions: [Action.Present]
|
|
@@ -5105,6 +5521,7 @@ export declare enum Action {
|
|
|
5105
5521
|
/**
|
|
5106
5522
|
* The tile resize options in the visualization menu.
|
|
5107
5523
|
* Allows switching between different preset layouts.
|
|
5524
|
+
*
|
|
5108
5525
|
* @example
|
|
5109
5526
|
* ```js
|
|
5110
5527
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -5115,6 +5532,7 @@ export declare enum Action {
|
|
|
5115
5532
|
* The *Edit* action on the Liveboard page and in the
|
|
5116
5533
|
* visualization menu.
|
|
5117
5534
|
* Opens a Liveboard or visualization in edit mode.
|
|
5535
|
+
*
|
|
5118
5536
|
* @example
|
|
5119
5537
|
* ```js
|
|
5120
5538
|
* disabledActions: [Action.Edit]
|
|
@@ -5123,6 +5541,7 @@ export declare enum Action {
|
|
|
5123
5541
|
Edit = "edit",
|
|
5124
5542
|
/**
|
|
5125
5543
|
* The text edit option for Liveboard and visualization titles.
|
|
5544
|
+
*
|
|
5126
5545
|
* @example
|
|
5127
5546
|
* ```js
|
|
5128
5547
|
* disabledActions: [Action.EditTitle]
|
|
@@ -5132,6 +5551,7 @@ export declare enum Action {
|
|
|
5132
5551
|
/**
|
|
5133
5552
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
5134
5553
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
5554
|
+
*
|
|
5135
5555
|
* @example
|
|
5136
5556
|
* ```js
|
|
5137
5557
|
* disabledActions: [Action.Remove]
|
|
@@ -5163,6 +5583,7 @@ export declare enum Action {
|
|
|
5163
5583
|
* Displays details such as the name, description, and
|
|
5164
5584
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
5165
5585
|
* and update.
|
|
5586
|
+
*
|
|
5166
5587
|
* @example
|
|
5167
5588
|
* ```js
|
|
5168
5589
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -5180,6 +5601,7 @@ export declare enum Action {
|
|
|
5180
5601
|
/**
|
|
5181
5602
|
* The **Pin** menu action on an Answer or
|
|
5182
5603
|
* Search results page.
|
|
5604
|
+
*
|
|
5183
5605
|
* @example
|
|
5184
5606
|
* ```js
|
|
5185
5607
|
* disabledActions: [Action.Pin]
|
|
@@ -5192,6 +5614,7 @@ export declare enum Action {
|
|
|
5192
5614
|
AnalysisInfo = "analysisInfo",
|
|
5193
5615
|
/**
|
|
5194
5616
|
* The **Schedule** menu action on a Liveboard.
|
|
5617
|
+
*
|
|
5195
5618
|
* @example
|
|
5196
5619
|
* ```js
|
|
5197
5620
|
* disabledActions: [Action.Subscription]
|
|
@@ -5200,6 +5623,7 @@ export declare enum Action {
|
|
|
5200
5623
|
Subscription = "subscription",
|
|
5201
5624
|
/**
|
|
5202
5625
|
* The **Explore** action on Liveboard visualizations
|
|
5626
|
+
*
|
|
5203
5627
|
* @example
|
|
5204
5628
|
* ```js
|
|
5205
5629
|
* disabledActions: [Action.Explore]
|
|
@@ -5209,6 +5633,7 @@ export declare enum Action {
|
|
|
5209
5633
|
/**
|
|
5210
5634
|
* The action to include data points on a drilled-down Answer
|
|
5211
5635
|
* or visualization
|
|
5636
|
+
*
|
|
5212
5637
|
* @example
|
|
5213
5638
|
* ```js
|
|
5214
5639
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5218,6 +5643,7 @@ export declare enum Action {
|
|
|
5218
5643
|
/**
|
|
5219
5644
|
* The action to exclude data points on a drilled-down Answer
|
|
5220
5645
|
* or visualization
|
|
5646
|
+
*
|
|
5221
5647
|
* @example
|
|
5222
5648
|
* ```js
|
|
5223
5649
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5228,6 +5654,7 @@ export declare enum Action {
|
|
|
5228
5654
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
5229
5655
|
* or Liveboard.
|
|
5230
5656
|
* Copies the selected data point.
|
|
5657
|
+
*
|
|
5231
5658
|
* @example
|
|
5232
5659
|
* ```js
|
|
5233
5660
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -5245,6 +5672,7 @@ export declare enum Action {
|
|
|
5245
5672
|
* The **Drill down** menu action on Answers and Liveboard
|
|
5246
5673
|
* visualizations.
|
|
5247
5674
|
* Allows drilling down to a specific data point on a chart or table.
|
|
5675
|
+
*
|
|
5248
5676
|
* @example
|
|
5249
5677
|
* ```js
|
|
5250
5678
|
* disabledActions: [Action.DrillDown]
|
|
@@ -5254,6 +5682,7 @@ export declare enum Action {
|
|
|
5254
5682
|
/**
|
|
5255
5683
|
* The request access action on Liveboards.
|
|
5256
5684
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
5685
|
+
*
|
|
5257
5686
|
* @example
|
|
5258
5687
|
* ```js
|
|
5259
5688
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -5263,6 +5692,7 @@ export declare enum Action {
|
|
|
5263
5692
|
/**
|
|
5264
5693
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
5265
5694
|
* of the Answer page
|
|
5695
|
+
*
|
|
5266
5696
|
* @example
|
|
5267
5697
|
* ```js
|
|
5268
5698
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5270,7 +5700,9 @@ export declare enum Action {
|
|
|
5270
5700
|
*/
|
|
5271
5701
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
5272
5702
|
/**
|
|
5273
|
-
* The **Delete** action for Answers
|
|
5703
|
+
* The **Delete** action for Answers in the full application
|
|
5704
|
+
* embedding mode.
|
|
5705
|
+
*
|
|
5274
5706
|
* @example
|
|
5275
5707
|
* ```js
|
|
5276
5708
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -5280,6 +5712,7 @@ export declare enum Action {
|
|
|
5280
5712
|
AnswerDelete = "onDeleteAnswer",
|
|
5281
5713
|
/**
|
|
5282
5714
|
* The Chart switcher icon on Answer and visualization pages.
|
|
5715
|
+
*
|
|
5283
5716
|
* @example
|
|
5284
5717
|
* ```js
|
|
5285
5718
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5289,6 +5722,7 @@ export declare enum Action {
|
|
|
5289
5722
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5290
5723
|
/**
|
|
5291
5724
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
5725
|
+
*
|
|
5292
5726
|
* @example
|
|
5293
5727
|
* ```js
|
|
5294
5728
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5298,6 +5732,7 @@ export declare enum Action {
|
|
|
5298
5732
|
AddToFavorites = "addToFavorites",
|
|
5299
5733
|
/**
|
|
5300
5734
|
* The edit icon on Liveboards (Classic experience).
|
|
5735
|
+
*
|
|
5301
5736
|
* @example
|
|
5302
5737
|
* ```js
|
|
5303
5738
|
* disabledActions: [Action.EditDetails]
|
|
@@ -5307,6 +5742,7 @@ export declare enum Action {
|
|
|
5307
5742
|
EditDetails = "editDetails",
|
|
5308
5743
|
/**
|
|
5309
5744
|
* The Create alert action on KPI charts.
|
|
5745
|
+
*
|
|
5310
5746
|
* @example
|
|
5311
5747
|
* ```js
|
|
5312
5748
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -5325,6 +5761,7 @@ export declare enum Action {
|
|
|
5325
5761
|
/**
|
|
5326
5762
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
5327
5763
|
* Allows sending data to a Google Sheet.
|
|
5764
|
+
*
|
|
5328
5765
|
* @example
|
|
5329
5766
|
* ```js
|
|
5330
5767
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -5336,6 +5773,7 @@ export declare enum Action {
|
|
|
5336
5773
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
5337
5774
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
5338
5775
|
* Microsoft Teams, and so on.
|
|
5776
|
+
*
|
|
5339
5777
|
* @example
|
|
5340
5778
|
* ```js
|
|
5341
5779
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5346,6 +5784,7 @@ export declare enum Action {
|
|
|
5346
5784
|
/**
|
|
5347
5785
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
5348
5786
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5787
|
+
*
|
|
5349
5788
|
* @example
|
|
5350
5789
|
* ```js
|
|
5351
5790
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5356,6 +5795,7 @@ export declare enum Action {
|
|
|
5356
5795
|
/**
|
|
5357
5796
|
* The **Filter** action on Liveboard visualizations.
|
|
5358
5797
|
* Allows users to apply cross-filters on a Liveboard.
|
|
5798
|
+
*
|
|
5359
5799
|
* @example
|
|
5360
5800
|
* ```js
|
|
5361
5801
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -5366,6 +5806,7 @@ export declare enum Action {
|
|
|
5366
5806
|
/**
|
|
5367
5807
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5368
5808
|
* Allows sending data to third-party apps Slack
|
|
5809
|
+
*
|
|
5369
5810
|
* @example
|
|
5370
5811
|
* ```js
|
|
5371
5812
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -5376,6 +5817,7 @@ export declare enum Action {
|
|
|
5376
5817
|
/**
|
|
5377
5818
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5378
5819
|
* Allows sending data to third-party apps Team
|
|
5820
|
+
*
|
|
5379
5821
|
* @example
|
|
5380
5822
|
* ```js
|
|
5381
5823
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -5387,6 +5829,7 @@ export declare enum Action {
|
|
|
5387
5829
|
* The **Remove** action that appears when cross filters are applied
|
|
5388
5830
|
* on a Liveboard.
|
|
5389
5831
|
* Removes filters applied o a visualization.
|
|
5832
|
+
*
|
|
5390
5833
|
* @example
|
|
5391
5834
|
* ```js
|
|
5392
5835
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5398,6 +5841,7 @@ export declare enum Action {
|
|
|
5398
5841
|
* The **Aggregate** option in the chart axis or the
|
|
5399
5842
|
* table column customization menu.
|
|
5400
5843
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
5844
|
+
*
|
|
5401
5845
|
* @example
|
|
5402
5846
|
* ```js
|
|
5403
5847
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -5409,6 +5853,7 @@ export declare enum Action {
|
|
|
5409
5853
|
* The **Time bucket** option in the chart axis or table column
|
|
5410
5854
|
* customization menu.
|
|
5411
5855
|
* Allows defining time metric for date comparison.
|
|
5856
|
+
*
|
|
5412
5857
|
* @example
|
|
5413
5858
|
* ```js
|
|
5414
5859
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -5419,6 +5864,7 @@ export declare enum Action {
|
|
|
5419
5864
|
/**
|
|
5420
5865
|
* The **Filter** action in the chart axis or table column
|
|
5421
5866
|
* customization menu.
|
|
5867
|
+
*
|
|
5422
5868
|
* @example
|
|
5423
5869
|
* ```js
|
|
5424
5870
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -5430,6 +5876,7 @@ export declare enum Action {
|
|
|
5430
5876
|
* The **Conditional formatting** action on chart or table.
|
|
5431
5877
|
* Allows adding rules for conditional formatting of data
|
|
5432
5878
|
* points on a chart or table.
|
|
5879
|
+
*
|
|
5433
5880
|
* @example
|
|
5434
5881
|
* ```js
|
|
5435
5882
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5441,6 +5888,7 @@ export declare enum Action {
|
|
|
5441
5888
|
* The **Sort** menu action on a table or chart axis
|
|
5442
5889
|
* Sorts data in ascending or descending order.
|
|
5443
5890
|
* Allows adding, editing, or removing filters.
|
|
5891
|
+
*
|
|
5444
5892
|
* @example
|
|
5445
5893
|
* ```js
|
|
5446
5894
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5453,6 +5901,7 @@ export declare enum Action {
|
|
|
5453
5901
|
* customization menu.
|
|
5454
5902
|
* Allows grouping data points if the axes use the same
|
|
5455
5903
|
* unit of measurement and a similar scale.
|
|
5904
|
+
*
|
|
5456
5905
|
* @example
|
|
5457
5906
|
* ```js
|
|
5458
5907
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -5464,6 +5913,7 @@ export declare enum Action {
|
|
|
5464
5913
|
* The **Position** option in the axis customization menu.
|
|
5465
5914
|
* Allows changing the position of the axis to the
|
|
5466
5915
|
* left or right side of the chart.
|
|
5916
|
+
*
|
|
5467
5917
|
* @example
|
|
5468
5918
|
* ```js
|
|
5469
5919
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -5474,6 +5924,7 @@ export declare enum Action {
|
|
|
5474
5924
|
/**
|
|
5475
5925
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
5476
5926
|
* Renames the axis label on a chart or the column header on a table.
|
|
5927
|
+
*
|
|
5477
5928
|
* @example
|
|
5478
5929
|
* ```js
|
|
5479
5930
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -5485,6 +5936,7 @@ export declare enum Action {
|
|
|
5485
5936
|
* The **Edit** action in the axis customization menu.
|
|
5486
5937
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
5487
5938
|
* and format of a column.
|
|
5939
|
+
*
|
|
5488
5940
|
* @example
|
|
5489
5941
|
* ```js
|
|
5490
5942
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -5495,6 +5947,7 @@ export declare enum Action {
|
|
|
5495
5947
|
/**
|
|
5496
5948
|
* The **Number format** action to customize the format of
|
|
5497
5949
|
* the data labels on a chart or table.
|
|
5950
|
+
*
|
|
5498
5951
|
* @example
|
|
5499
5952
|
* ```js
|
|
5500
5953
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -5505,6 +5958,7 @@ export declare enum Action {
|
|
|
5505
5958
|
/**
|
|
5506
5959
|
* The **Text wrapping** action on a table.
|
|
5507
5960
|
* Wraps or clips column text on a table.
|
|
5961
|
+
*
|
|
5508
5962
|
* @example
|
|
5509
5963
|
* ```js
|
|
5510
5964
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -5517,6 +5971,7 @@ export declare enum Action {
|
|
|
5517
5971
|
* customization menu.
|
|
5518
5972
|
* Removes the data labels from a chart or the column of a
|
|
5519
5973
|
* table visualization.
|
|
5974
|
+
*
|
|
5520
5975
|
* @example
|
|
5521
5976
|
* ```js
|
|
5522
5977
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -5531,6 +5986,7 @@ export declare enum Action {
|
|
|
5531
5986
|
/**
|
|
5532
5987
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
5533
5988
|
* Allows renaming a Liveboard or visualization.
|
|
5989
|
+
*
|
|
5534
5990
|
* @example
|
|
5535
5991
|
* ```js
|
|
5536
5992
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -5574,6 +6030,7 @@ export declare enum Action {
|
|
|
5574
6030
|
/**
|
|
5575
6031
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
5576
6032
|
* Allows moving a visualization to a different tab.
|
|
6033
|
+
*
|
|
5577
6034
|
* @example
|
|
5578
6035
|
* ```js
|
|
5579
6036
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -5582,6 +6039,7 @@ export declare enum Action {
|
|
|
5582
6039
|
MoveToTab = "onContainerMove",
|
|
5583
6040
|
/**
|
|
5584
6041
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
6042
|
+
*
|
|
5585
6043
|
* @example
|
|
5586
6044
|
* ```js
|
|
5587
6045
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5590,6 +6048,7 @@ export declare enum Action {
|
|
|
5590
6048
|
ManageMonitor = "ManageMonitor",
|
|
5591
6049
|
/**
|
|
5592
6050
|
* Action ID for Liveboard Personalised Views dropdown
|
|
6051
|
+
*
|
|
5593
6052
|
* @example
|
|
5594
6053
|
* ```js
|
|
5595
6054
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -5599,6 +6058,7 @@ export declare enum Action {
|
|
|
5599
6058
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5600
6059
|
/**
|
|
5601
6060
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
6061
|
+
*
|
|
5602
6062
|
* @example
|
|
5603
6063
|
* ```js
|
|
5604
6064
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -5610,6 +6070,7 @@ export declare enum Action {
|
|
|
5610
6070
|
* Action ID for the Parent TML action
|
|
5611
6071
|
* The parent action **TML** must be included to access TML-related options
|
|
5612
6072
|
* within the cascading menu (specific to the answer page)
|
|
6073
|
+
*
|
|
5613
6074
|
* @example
|
|
5614
6075
|
* ```js
|
|
5615
6076
|
* // to include specific TML actions
|
|
@@ -5621,11 +6082,13 @@ export declare enum Action {
|
|
|
5621
6082
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5622
6083
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5623
6084
|
* ```
|
|
6085
|
+
*
|
|
5624
6086
|
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5625
6087
|
*/
|
|
5626
6088
|
TML = "tml",
|
|
5627
6089
|
/**
|
|
5628
6090
|
* Action ID for to hide Verified Liveboard Banner
|
|
6091
|
+
*
|
|
5629
6092
|
* @example
|
|
5630
6093
|
* ```js
|
|
5631
6094
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -5635,6 +6098,7 @@ export declare enum Action {
|
|
|
5635
6098
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
5636
6099
|
/**
|
|
5637
6100
|
* Action ID for ask sage button
|
|
6101
|
+
*
|
|
5638
6102
|
* @example
|
|
5639
6103
|
* ```js
|
|
5640
6104
|
* hiddenAction: [Action.AskAi]
|
|
@@ -5644,6 +6108,7 @@ export declare enum Action {
|
|
|
5644
6108
|
AskAi = "AskAi",
|
|
5645
6109
|
/**
|
|
5646
6110
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
6111
|
+
*
|
|
5647
6112
|
* @example
|
|
5648
6113
|
* ```js
|
|
5649
6114
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -5653,6 +6118,7 @@ export declare enum Action {
|
|
|
5653
6118
|
AddToWatchlist = "addToWatchlist",
|
|
5654
6119
|
/**
|
|
5655
6120
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
6121
|
+
*
|
|
5656
6122
|
* @example
|
|
5657
6123
|
* ```js
|
|
5658
6124
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -5662,6 +6128,7 @@ export declare enum Action {
|
|
|
5662
6128
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
5663
6129
|
/**
|
|
5664
6130
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
6131
|
+
*
|
|
5665
6132
|
* @example
|
|
5666
6133
|
* ```js
|
|
5667
6134
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -5671,6 +6138,7 @@ export declare enum Action {
|
|
|
5671
6138
|
OrganiseFavourites = "organiseFavourites",
|
|
5672
6139
|
/**
|
|
5673
6140
|
* Action ID for AI Highlights button
|
|
6141
|
+
*
|
|
5674
6142
|
* @example
|
|
5675
6143
|
* ```js
|
|
5676
6144
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -5739,6 +6207,7 @@ export interface CustomActionPayload {
|
|
|
5739
6207
|
export declare enum LogLevel {
|
|
5740
6208
|
/**
|
|
5741
6209
|
* No logs will be logged in the console.
|
|
6210
|
+
*
|
|
5742
6211
|
* @example
|
|
5743
6212
|
* ```js
|
|
5744
6213
|
* init({
|
|
@@ -5751,6 +6220,7 @@ export declare enum LogLevel {
|
|
|
5751
6220
|
SILENT = "SILENT",
|
|
5752
6221
|
/**
|
|
5753
6222
|
* Only ERROR logs will be logged in the console.
|
|
6223
|
+
*
|
|
5754
6224
|
* @example
|
|
5755
6225
|
* ```js
|
|
5756
6226
|
* init({
|
|
@@ -5763,6 +6233,7 @@ export declare enum LogLevel {
|
|
|
5763
6233
|
ERROR = "ERROR",
|
|
5764
6234
|
/**
|
|
5765
6235
|
* Only WARN and ERROR logs will be logged in the console.
|
|
6236
|
+
*
|
|
5766
6237
|
* @example
|
|
5767
6238
|
* ```js
|
|
5768
6239
|
* init({
|
|
@@ -5775,6 +6246,7 @@ export declare enum LogLevel {
|
|
|
5775
6246
|
WARN = "WARN",
|
|
5776
6247
|
/**
|
|
5777
6248
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
6249
|
+
*
|
|
5778
6250
|
* @example
|
|
5779
6251
|
* ```js
|
|
5780
6252
|
* init({
|
|
@@ -5787,6 +6259,7 @@ export declare enum LogLevel {
|
|
|
5787
6259
|
INFO = "INFO",
|
|
5788
6260
|
/**
|
|
5789
6261
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
6262
|
+
*
|
|
5790
6263
|
* @example
|
|
5791
6264
|
* ```js
|
|
5792
6265
|
* init({
|
|
@@ -5799,6 +6272,7 @@ export declare enum LogLevel {
|
|
|
5799
6272
|
DEBUG = "DEBUG",
|
|
5800
6273
|
/**
|
|
5801
6274
|
* All logs will be logged in the console.
|
|
6275
|
+
*
|
|
5802
6276
|
* @example
|
|
5803
6277
|
* ```js
|
|
5804
6278
|
* init({
|
|
@@ -6173,6 +6647,7 @@ export interface UnderlyingDataPoint {
|
|
|
6173
6647
|
* custom action payload. This service could be used to run
|
|
6174
6648
|
* graphql queries in the context of the answer on which the
|
|
6175
6649
|
* custom action was triggered.
|
|
6650
|
+
*
|
|
6176
6651
|
* @example
|
|
6177
6652
|
* ```js
|
|
6178
6653
|
* embed.on(EmbedEvent.CustomAction, e => {
|
|
@@ -6198,6 +6673,7 @@ export interface UnderlyingDataPoint {
|
|
|
6198
6673
|
export declare class AnswerService {
|
|
6199
6674
|
/**
|
|
6200
6675
|
* Should not need to be called directly.
|
|
6676
|
+
*
|
|
6201
6677
|
* @param session
|
|
6202
6678
|
* @param answer
|
|
6203
6679
|
* @param thoughtSpotHost
|
|
@@ -6211,18 +6687,21 @@ export declare class AnswerService {
|
|
|
6211
6687
|
getSourceDetail(): Promise<any>;
|
|
6212
6688
|
/**
|
|
6213
6689
|
* Remove columnIds and return updated answer session.
|
|
6690
|
+
*
|
|
6214
6691
|
* @param columnIds
|
|
6215
6692
|
* @returns
|
|
6216
6693
|
*/
|
|
6217
6694
|
removeColumns(columnIds: string[]): Promise<any>;
|
|
6218
6695
|
/**
|
|
6219
6696
|
* Add columnIds and return updated answer session.
|
|
6697
|
+
*
|
|
6220
6698
|
* @param columnIds
|
|
6221
6699
|
* @returns
|
|
6222
6700
|
*/
|
|
6223
6701
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6224
6702
|
/**
|
|
6225
6703
|
* Add columns by names and return updated answer session.
|
|
6704
|
+
*
|
|
6226
6705
|
* @param columnNames
|
|
6227
6706
|
* @returns
|
|
6228
6707
|
* @example
|
|
@@ -6239,6 +6718,7 @@ export declare class AnswerService {
|
|
|
6239
6718
|
addColumnsByNames(columnNames: string[]): Promise<any>;
|
|
6240
6719
|
/**
|
|
6241
6720
|
* Add a filter to the answer.
|
|
6721
|
+
*
|
|
6242
6722
|
* @param columnName
|
|
6243
6723
|
* @param operator
|
|
6244
6724
|
* @param values
|
|
@@ -6247,6 +6727,7 @@ export declare class AnswerService {
|
|
|
6247
6727
|
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6248
6728
|
/**
|
|
6249
6729
|
* Fetch data from the answer.
|
|
6730
|
+
*
|
|
6250
6731
|
* @param offset
|
|
6251
6732
|
* @param size
|
|
6252
6733
|
* @returns
|
|
@@ -6258,6 +6739,7 @@ export declare class AnswerService {
|
|
|
6258
6739
|
/**
|
|
6259
6740
|
* Fetch the data for the answer as a CSV blob. This might be
|
|
6260
6741
|
* quicker for larger data.
|
|
6742
|
+
*
|
|
6261
6743
|
* @param userLocale
|
|
6262
6744
|
* @param includeInfo Include the CSV header in the output
|
|
6263
6745
|
* @returns Response
|
|
@@ -6266,6 +6748,7 @@ export declare class AnswerService {
|
|
|
6266
6748
|
/**
|
|
6267
6749
|
* Just get the internal URL for this answer's data
|
|
6268
6750
|
* as a CSV blob.
|
|
6751
|
+
*
|
|
6269
6752
|
* @param userLocale
|
|
6270
6753
|
* @param includeInfo
|
|
6271
6754
|
* @returns
|
|
@@ -6275,6 +6758,7 @@ export declare class AnswerService {
|
|
|
6275
6758
|
* Get underlying data given a point and the output column names.
|
|
6276
6759
|
* In case of a context menu action, the selectedPoints are
|
|
6277
6760
|
* automatically passed.
|
|
6761
|
+
*
|
|
6278
6762
|
* @param outputColumnNames
|
|
6279
6763
|
* @param selectedPoints
|
|
6280
6764
|
* @example
|
|
@@ -6291,6 +6775,7 @@ export declare class AnswerService {
|
|
|
6291
6775
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
6292
6776
|
/**
|
|
6293
6777
|
* Execute a custom graphql query in the context of the answer.
|
|
6778
|
+
*
|
|
6294
6779
|
* @param query graphql query
|
|
6295
6780
|
* @param variables graphql variables
|
|
6296
6781
|
* @returns
|
|
@@ -6298,6 +6783,7 @@ export declare class AnswerService {
|
|
|
6298
6783
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
6299
6784
|
/**
|
|
6300
6785
|
* Get the internal session details for the answer.
|
|
6786
|
+
*
|
|
6301
6787
|
* @returns
|
|
6302
6788
|
*/
|
|
6303
6789
|
getSession(): SessionInterface;
|
|
@@ -6306,6 +6792,7 @@ export declare class AnswerService {
|
|
|
6306
6792
|
|
|
6307
6793
|
/**
|
|
6308
6794
|
* Gets the configuration embed was initialized with.
|
|
6795
|
+
*
|
|
6309
6796
|
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
6310
6797
|
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
6311
6798
|
* @group Global methods
|
|
@@ -6314,6 +6801,7 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
6314
6801
|
/**
|
|
6315
6802
|
* Sets the configuration embed was initialized with.
|
|
6316
6803
|
* And returns the new configuration.
|
|
6804
|
+
*
|
|
6317
6805
|
* @param newConfig The configuration to set.
|
|
6318
6806
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
6319
6807
|
* @group Global methods
|
|
@@ -6336,6 +6824,7 @@ export declare const MIXPANEL_EVENT: {
|
|
|
6336
6824
|
};
|
|
6337
6825
|
/**
|
|
6338
6826
|
* Pushes the event with its Property key-value map to mixpanel.
|
|
6827
|
+
*
|
|
6339
6828
|
* @param eventId
|
|
6340
6829
|
* @param eventProps
|
|
6341
6830
|
*/
|
|
@@ -6353,6 +6842,7 @@ export declare function testResetMixpanel(): void;
|
|
|
6353
6842
|
/**
|
|
6354
6843
|
* Fetch wrapper that adds the authentication token to the request.
|
|
6355
6844
|
* Use this to call the ThoughtSpot APIs when using the visual embed sdk.
|
|
6845
|
+
*
|
|
6356
6846
|
* @param input
|
|
6357
6847
|
* @param init
|
|
6358
6848
|
* @version SDK: 1.28.0
|
|
@@ -6363,11 +6853,12 @@ export declare const tokenizedFetch: typeof fetch;
|
|
|
6363
6853
|
export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
|
|
6364
6854
|
/**
|
|
6365
6855
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
6856
|
+
*
|
|
6366
6857
|
* @example
|
|
6367
6858
|
* ```js
|
|
6368
6859
|
* resetCachedAuthToken();
|
|
6369
6860
|
* ```
|
|
6370
|
-
* @version SDK: 1.28.
|
|
6861
|
+
* @version SDK: 1.28.0 | ThoughtSpot: *
|
|
6371
6862
|
* @group Authentication / Init
|
|
6372
6863
|
*/
|
|
6373
6864
|
export declare const resetCachedAuthToken: () => void;
|
|
@@ -6376,6 +6867,7 @@ export declare const resetCachedAuthToken: () => void;
|
|
|
6376
6867
|
* Copyright (c) 2022
|
|
6377
6868
|
*
|
|
6378
6869
|
* Base classes
|
|
6870
|
+
*
|
|
6379
6871
|
* @summary Base classes
|
|
6380
6872
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
6381
6873
|
*/
|
|
@@ -6424,16 +6916,19 @@ export declare class TsEmbed {
|
|
|
6424
6916
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
6425
6917
|
/**
|
|
6426
6918
|
* Handles errors within the SDK
|
|
6919
|
+
*
|
|
6427
6920
|
* @param error The error message or object
|
|
6428
6921
|
*/
|
|
6429
6922
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
6430
6923
|
/**
|
|
6431
6924
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
6925
|
+
*
|
|
6432
6926
|
* @param query
|
|
6433
6927
|
*/
|
|
6434
6928
|
protected getEmbedBasePath(query: string): string;
|
|
6435
6929
|
/**
|
|
6436
6930
|
* Common query params set for all the embed modes.
|
|
6931
|
+
*
|
|
6437
6932
|
* @param queryParams
|
|
6438
6933
|
* @returns queryParams
|
|
6439
6934
|
*/
|
|
@@ -6441,6 +6936,7 @@ export declare class TsEmbed {
|
|
|
6441
6936
|
/**
|
|
6442
6937
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
6443
6938
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
6939
|
+
*
|
|
6444
6940
|
* @param queryString The query string to append to the URL.
|
|
6445
6941
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
6446
6942
|
* the full application.
|
|
@@ -6453,6 +6949,7 @@ export declare class TsEmbed {
|
|
|
6453
6949
|
/**
|
|
6454
6950
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
6455
6951
|
* event listeners.
|
|
6952
|
+
*
|
|
6456
6953
|
* @param url - The URL of the embedded ThoughtSpot app.
|
|
6457
6954
|
*/
|
|
6458
6955
|
protected renderIFrame(url: string): Promise<any>;
|
|
@@ -6466,11 +6963,13 @@ export declare class TsEmbed {
|
|
|
6466
6963
|
protected insertIntoDOM(child: string | Node): void;
|
|
6467
6964
|
/**
|
|
6468
6965
|
* Sets the height of the iframe
|
|
6966
|
+
*
|
|
6469
6967
|
* @param height The height in pixels
|
|
6470
6968
|
*/
|
|
6471
6969
|
protected setIFrameHeight(height: number | string): void;
|
|
6472
6970
|
/**
|
|
6473
6971
|
* Executes all registered event handlers for a particular event type
|
|
6972
|
+
*
|
|
6474
6973
|
* @param eventType The event type
|
|
6475
6974
|
* @param data The payload invoked with the event handler
|
|
6476
6975
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -6482,6 +6981,7 @@ export declare class TsEmbed {
|
|
|
6482
6981
|
protected getThoughtSpotHost(): string;
|
|
6483
6982
|
/**
|
|
6484
6983
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
6984
|
+
*
|
|
6485
6985
|
* @param eventType The v2 event type
|
|
6486
6986
|
* @returns The corresponding v1 event type if one exists
|
|
6487
6987
|
* or else the v2 event type itself
|
|
@@ -6491,6 +6991,7 @@ export declare class TsEmbed {
|
|
|
6491
6991
|
* Calculates the iframe center for the current visible viewPort
|
|
6492
6992
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
6493
6993
|
* in Host app. ViewPort height of the tab.
|
|
6994
|
+
*
|
|
6494
6995
|
* @returns iframe Center in visible viewport,
|
|
6495
6996
|
* Iframe height,
|
|
6496
6997
|
* View port height.
|
|
@@ -6505,6 +7006,7 @@ export declare class TsEmbed {
|
|
|
6505
7006
|
/**
|
|
6506
7007
|
* Registers an event listener to trigger an alert when the ThoughtSpot app
|
|
6507
7008
|
* sends an event of a particular message type to the host application.
|
|
7009
|
+
*
|
|
6508
7010
|
* @param messageType The message type
|
|
6509
7011
|
* @param callback A callback as a function
|
|
6510
7012
|
* @param options The message options
|
|
@@ -6528,6 +7030,7 @@ export declare class TsEmbed {
|
|
|
6528
7030
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
|
|
6529
7031
|
/**
|
|
6530
7032
|
* Removes an event listener for a particular event type.
|
|
7033
|
+
*
|
|
6531
7034
|
* @param messageType The message type
|
|
6532
7035
|
* @param callback The callback to remove
|
|
6533
7036
|
* @example
|
|
@@ -6540,6 +7043,7 @@ export declare class TsEmbed {
|
|
|
6540
7043
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
6541
7044
|
/**
|
|
6542
7045
|
* Triggers an event to the embedded app
|
|
7046
|
+
*
|
|
6543
7047
|
* @param messageType The event type
|
|
6544
7048
|
* @param data The payload to send with the message
|
|
6545
7049
|
*/
|
|
@@ -6548,6 +7052,7 @@ export declare class TsEmbed {
|
|
|
6548
7052
|
* Marks the ThoughtSpot object to have been rendered
|
|
6549
7053
|
* Needs to be overridden by subclasses to do the actual
|
|
6550
7054
|
* rendering of the iframe.
|
|
7055
|
+
*
|
|
6551
7056
|
* @param args
|
|
6552
7057
|
*/
|
|
6553
7058
|
render(): Promise<TsEmbed>;
|
|
@@ -6555,6 +7060,7 @@ export declare class TsEmbed {
|
|
|
6555
7060
|
protected handleRenderForPrerender(): void;
|
|
6556
7061
|
/**
|
|
6557
7062
|
* Creates the preRender shell
|
|
7063
|
+
*
|
|
6558
7064
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
6559
7065
|
*/
|
|
6560
7066
|
preRender(showPreRenderByDefault?: boolean): TsEmbed;
|
|
@@ -6562,11 +7068,13 @@ export declare class TsEmbed {
|
|
|
6562
7068
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
6563
7069
|
* host app URL.
|
|
6564
7070
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
7071
|
+
*
|
|
6565
7072
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
6566
7073
|
*/
|
|
6567
7074
|
getThoughtSpotPostUrlParams(): string;
|
|
6568
7075
|
/**
|
|
6569
7076
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
7077
|
+
*
|
|
6570
7078
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
6571
7079
|
*/
|
|
6572
7080
|
destroy(): void;
|
|
@@ -6575,6 +7083,7 @@ export declare class TsEmbed {
|
|
|
6575
7083
|
* Prerenders a generic instance of the TS component.
|
|
6576
7084
|
* This means without the path but with the flags already applied.
|
|
6577
7085
|
* This is useful for prerendering the component in the background.
|
|
7086
|
+
*
|
|
6578
7087
|
* @version SDK: 1.22.0
|
|
6579
7088
|
* @returns
|
|
6580
7089
|
*/
|
|
@@ -6592,6 +7101,7 @@ export declare class TsEmbed {
|
|
|
6592
7101
|
* element. This function adjusts the position, width, and height of the PreRender
|
|
6593
7102
|
* component
|
|
6594
7103
|
* to match the dimensions and position of the embedding element.
|
|
7104
|
+
*
|
|
6595
7105
|
* @throws {Error} Throws an error if the embedding element (passed as domSelector)
|
|
6596
7106
|
* is not defined or not found.
|
|
6597
7107
|
*/
|
|
@@ -6604,6 +7114,7 @@ export declare class TsEmbed {
|
|
|
6604
7114
|
/**
|
|
6605
7115
|
* Retrieves unique HTML element IDs for PreRender-related elements.
|
|
6606
7116
|
* These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
|
|
7117
|
+
*
|
|
6607
7118
|
* @returns {object} An object containing the IDs for the PreRender elements.
|
|
6608
7119
|
* @property {string} wrapper - The HTML element ID for the PreRender wrapper.
|
|
6609
7120
|
* @property {string} child - The HTML element ID for the PreRender child.
|
|
@@ -6615,6 +7126,7 @@ export declare class TsEmbed {
|
|
|
6615
7126
|
/**
|
|
6616
7127
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
6617
7128
|
* session.
|
|
7129
|
+
*
|
|
6618
7130
|
* @param vizId [Optional] to get for a specific viz in case of a liveboard.
|
|
6619
7131
|
* @version SDK: 1.25.0 / ThoughtSpot 9.10.0
|
|
6620
7132
|
*/
|
|
@@ -6624,6 +7136,7 @@ export declare class TsEmbed {
|
|
|
6624
7136
|
* Base class for embedding v1 experience
|
|
6625
7137
|
* Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
|
|
6626
7138
|
* which is currently under migration to v2
|
|
7139
|
+
*
|
|
6627
7140
|
* @inheritdoc
|
|
6628
7141
|
*/
|
|
6629
7142
|
export declare class V1Embed extends TsEmbed {
|
|
@@ -6631,6 +7144,7 @@ export declare class V1Embed extends TsEmbed {
|
|
|
6631
7144
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
6632
7145
|
/**
|
|
6633
7146
|
* Render the app in an iframe and set up event handlers
|
|
7147
|
+
*
|
|
6634
7148
|
* @param iframeSrc
|
|
6635
7149
|
*/
|
|
6636
7150
|
protected renderV1Embed(iframeSrc: string): Promise<any>;
|