@thoughtspot/visual-embed-sdk 1.30.0-alpha.1 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +0 -15
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +2 -13
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +0 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +0 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/config.d.ts +0 -1
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +0 -2
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/embed/app.d.ts +0 -49
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +0 -8
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +0 -6
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +0 -7
- 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 +0 -2
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +0 -2
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +0 -30
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +0 -5
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +2 -18
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +0 -5
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +0 -11
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +0 -2
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +0 -33
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +0 -3
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +1 -31
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +6 -37
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/index.d.ts +0 -1
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +0 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +0 -1
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +0 -1
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -12
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -11
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +14 -2
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/test/test-utils.d.ts +0 -2
- package/cjs/src/test/test-utils.d.ts.map +1 -1
- package/cjs/src/test/test-utils.js +0 -2
- package/cjs/src/test/test-utils.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +0 -1
- package/cjs/src/tokenizedFetch.d.ts.map +1 -1
- package/cjs/src/tokenizedFetch.js +0 -1
- package/cjs/src/tokenizedFetch.js.map +1 -1
- package/cjs/src/types.d.ts +19 -337
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +18 -264
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +0 -1
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +0 -1
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +19 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +2 -14
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +43 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/cjs/src/utils/graphql/graphql-request.js +2 -1
- package/cjs/src/utils/graphql/graphql-request.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +0 -1
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +0 -2
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +0 -9
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +0 -11
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +0 -15
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +0 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/config.d.ts +0 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +0 -49
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +0 -6
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +0 -2
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +0 -30
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +2 -18
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +0 -11
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +0 -33
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +1 -31
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +0 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +0 -1
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -12
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +0 -2
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/tokenizedFetch.d.ts +0 -1
- package/dist/src/tokenizedFetch.d.ts.map +1 -1
- package/dist/src/types.d.ts +19 -337
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +0 -1
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +0 -1
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +0 -9
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +2030 -2380
- package/dist/tsembed-react.js +1871 -2217
- package/dist/tsembed.es.js +3443 -3790
- package/dist/tsembed.js +6371 -6710
- package/dist/visual-embed-sdk-react-full.d.ts +24 -550
- package/dist/visual-embed-sdk-react.d.ts +24 -550
- package/dist/visual-embed-sdk.d.ts +23 -538
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +0 -15
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +3 -14
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +0 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +0 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/config.d.ts +0 -1
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +0 -2
- package/lib/src/config.js.map +1 -1
- package/lib/src/embed/app.d.ts +0 -49
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +0 -8
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +0 -6
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +0 -7
- 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 +0 -2
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +0 -2
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +0 -30
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/sage.d.ts +2 -18
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +0 -5
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +0 -11
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +0 -2
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +0 -33
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +0 -3
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -31
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +9 -40
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/index.d.ts +0 -1
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +0 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +0 -1
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +0 -1
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -12
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +1 -11
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +15 -3
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +0 -2
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +0 -2
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +0 -1
- package/lib/src/tokenizedFetch.d.ts.map +1 -1
- package/lib/src/tokenizedFetch.js +0 -1
- package/lib/src/tokenizedFetch.js.map +1 -1
- package/lib/src/types.d.ts +19 -337
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +18 -264
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +0 -1
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +0 -1
- 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/answer-queries.d.ts +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +18 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +2 -14
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +44 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/lib/src/utils/graphql/graphql-request.js +2 -1
- package/lib/src/utils/graphql/graphql-request.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +0 -1
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +0 -2
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +0 -9
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +0 -11
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +24 -539
- package/package.json +1 -1
- package/src/auth.ts +6 -23
- package/src/authToken.ts +0 -1
- package/src/config.ts +0 -2
- package/src/embed/app.ts +0 -49
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +0 -7
- package/src/embed/embedConfig.ts +0 -2
- package/src/embed/liveboard.ts +1 -38
- package/src/embed/sage.ts +2 -18
- package/src/embed/search-bar.tsx +0 -11
- package/src/embed/search.ts +0 -33
- package/src/embed/ts-embed.ts +38 -72
- package/src/index.ts +0 -1
- package/src/mixpanel-service.ts +0 -1
- package/src/react/index.spec.tsx +47 -59
- package/src/react/index.tsx +1 -12
- package/src/test/test-utils.ts +0 -2
- package/src/tokenizedFetch.ts +0 -1
- package/src/types.ts +19 -337
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/authService/authService.ts +0 -1
- package/src/utils/graphql/answerService/answer-queries.ts +19 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +53 -1
- package/src/utils/graphql/answerService/answerService.ts +2 -14
- package/src/utils/graphql/graphql-request.ts +2 -1
- package/src/utils/processTrigger.ts +0 -2
- package/src/utils.ts +0 -11
|
@@ -13,7 +13,6 @@ 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
|
-
*
|
|
17
16
|
* @example
|
|
18
17
|
* ```js
|
|
19
18
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -40,7 +39,6 @@ interface PreRenderProps {
|
|
|
40
39
|
}
|
|
41
40
|
/**
|
|
42
41
|
* React component for Search Embed.
|
|
43
|
-
*
|
|
44
42
|
* @example
|
|
45
43
|
* ```tsx
|
|
46
44
|
* function Search() {
|
|
@@ -57,7 +55,6 @@ interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
57
55
|
}
|
|
58
56
|
/**
|
|
59
57
|
* React component for Full app Embed.
|
|
60
|
-
*
|
|
61
58
|
* @example
|
|
62
59
|
* ```tsx
|
|
63
60
|
* function Search() {
|
|
@@ -77,7 +74,6 @@ export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttri
|
|
|
77
74
|
* default.
|
|
78
75
|
*
|
|
79
76
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
80
|
-
*
|
|
81
77
|
* @example
|
|
82
78
|
* ```tsx
|
|
83
79
|
* function LandingPageComponent() {
|
|
@@ -94,7 +90,6 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
|
|
|
94
90
|
}
|
|
95
91
|
/**
|
|
96
92
|
* React component for Liveboard embed.
|
|
97
|
-
*
|
|
98
93
|
* @example
|
|
99
94
|
* ```tsx
|
|
100
95
|
* function Liveboard() {
|
|
@@ -112,14 +107,13 @@ export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & Rea
|
|
|
112
107
|
/**
|
|
113
108
|
* React component for PreRendered Liveboard embed.
|
|
114
109
|
*
|
|
115
|
-
*
|
|
110
|
+
* PreRenderedLiveboardEmbed will preRender the liveboard and will be hidden by default.
|
|
116
111
|
*
|
|
117
112
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
118
113
|
*
|
|
119
114
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
120
115
|
* tries to preRender the LiveboardEmbed, so it is recommended to use pass the
|
|
121
116
|
* liveboardId to both the components.
|
|
122
|
-
*
|
|
123
117
|
* @example
|
|
124
118
|
* ```tsx
|
|
125
119
|
* function LandingPageComponent() {
|
|
@@ -137,7 +131,6 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
137
131
|
}
|
|
138
132
|
/**
|
|
139
133
|
* React component for Search bar embed.
|
|
140
|
-
*
|
|
141
134
|
* @example
|
|
142
135
|
* ```tsx
|
|
143
136
|
* function SearchBar() {
|
|
@@ -156,7 +149,6 @@ export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps
|
|
|
156
149
|
* default.
|
|
157
150
|
*
|
|
158
151
|
* SearchBarEmbed with preRenderId passed will call showPreRender on the embed.
|
|
159
|
-
*
|
|
160
152
|
* @example
|
|
161
153
|
* ```tsx
|
|
162
154
|
* function LandingPageComponent() {
|
|
@@ -173,7 +165,6 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
173
165
|
}
|
|
174
166
|
/**
|
|
175
167
|
* React component for LLM based search Sage embed.
|
|
176
|
-
*
|
|
177
168
|
* @example
|
|
178
169
|
* ```tsx
|
|
179
170
|
* function Sage() {
|
|
@@ -192,7 +183,6 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
|
|
|
192
183
|
* default.
|
|
193
184
|
*
|
|
194
185
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
195
|
-
*
|
|
196
186
|
* @example
|
|
197
187
|
* ```tsx
|
|
198
188
|
* function LandingPageComponent() {
|
|
@@ -208,7 +198,6 @@ export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProp
|
|
|
208
198
|
type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
|
|
209
199
|
/**
|
|
210
200
|
* Get a reference to the embed component to trigger events on the component.
|
|
211
|
-
*
|
|
212
201
|
* @example
|
|
213
202
|
* ```
|
|
214
203
|
* function Component() {
|
|
@@ -232,11 +221,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
232
221
|
/**
|
|
233
222
|
* The array of data source GUIDs to set on load.
|
|
234
223
|
* Only a single data source is supported currently.
|
|
235
|
-
*
|
|
236
224
|
* @deprecated Use `dataSource` instead
|
|
237
|
-
*
|
|
238
225
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
239
|
-
*
|
|
240
226
|
* @example
|
|
241
227
|
* ```js
|
|
242
228
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -248,9 +234,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
248
234
|
dataSources?: string[];
|
|
249
235
|
/**
|
|
250
236
|
* Pass the ID of the source to be selected.
|
|
251
|
-
*
|
|
252
237
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
253
|
-
*
|
|
254
238
|
* @example
|
|
255
239
|
* ```js
|
|
256
240
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -262,9 +246,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
262
246
|
dataSource?: string;
|
|
263
247
|
/**
|
|
264
248
|
* Boolean to define if the last selected data source should be used
|
|
265
|
-
*
|
|
266
249
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
267
|
-
*
|
|
268
250
|
* @example
|
|
269
251
|
* ```js
|
|
270
252
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -284,9 +266,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
284
266
|
* If it is executed, the focus is placed on the results.
|
|
285
267
|
* If it’s not executed, the focus is placed at the end of
|
|
286
268
|
* the token string in the search bar.
|
|
287
|
-
*
|
|
288
269
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
289
|
-
*
|
|
290
270
|
* @example
|
|
291
271
|
* ```js
|
|
292
272
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -302,7 +282,6 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
302
282
|
}
|
|
303
283
|
/**
|
|
304
284
|
* Embed ThoughtSpot search bar
|
|
305
|
-
*
|
|
306
285
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
307
286
|
* @group Embed components
|
|
308
287
|
*/
|
|
@@ -323,7 +302,6 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
323
302
|
* Copyright (c) 2023
|
|
324
303
|
*
|
|
325
304
|
* Embed ThoughtSpot Sage
|
|
326
|
-
*
|
|
327
305
|
* @summary TS Sage embed
|
|
328
306
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
329
307
|
*/
|
|
@@ -346,7 +324,6 @@ export interface SearchOptions {
|
|
|
346
324
|
/**
|
|
347
325
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
348
326
|
* GPT and LLM.
|
|
349
|
-
*
|
|
350
327
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
351
328
|
* @group Embed components
|
|
352
329
|
*/
|
|
@@ -355,7 +332,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
355
332
|
* If set to true, a list of Liveboard and Answers related
|
|
356
333
|
* to the natural language search will be shown below the
|
|
357
334
|
* AI generated answer.
|
|
358
|
-
*
|
|
359
335
|
* @deprecated Currently Liveboard and Answers related
|
|
360
336
|
* to the natural language search will not be shown for sage
|
|
361
337
|
* embed
|
|
@@ -363,11 +339,10 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
363
339
|
showObjectResults?: boolean;
|
|
364
340
|
/**
|
|
365
341
|
* flag used by the TS product tour page to show the blue search bar
|
|
366
|
-
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
367
|
-
* experience where it mimics closer to the non-embed case.
|
|
342
|
+
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
343
|
+
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
368
344
|
* The Sample questions container is collapsed when this value is set after
|
|
369
345
|
* does a search.
|
|
370
|
-
*
|
|
371
346
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
372
347
|
* @hidden
|
|
373
348
|
*/
|
|
@@ -375,38 +350,32 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
375
350
|
/**
|
|
376
351
|
* Show or hide the search bar title.
|
|
377
352
|
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
378
|
-
*
|
|
379
353
|
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
380
354
|
*/
|
|
381
355
|
hideSearchBarTitle?: boolean;
|
|
382
356
|
/**
|
|
383
357
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
384
358
|
* at the top of the Answer page.
|
|
385
|
-
*
|
|
386
359
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
387
360
|
*/
|
|
388
361
|
hideSageAnswerHeader?: boolean;
|
|
389
362
|
/**
|
|
390
363
|
* Disable the worksheet selection option.
|
|
391
|
-
*
|
|
392
364
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
393
365
|
*/
|
|
394
366
|
disableWorksheetChange?: boolean;
|
|
395
367
|
/**
|
|
396
368
|
* Hide the worksheet selection panel.
|
|
397
|
-
*
|
|
398
369
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
399
370
|
*/
|
|
400
371
|
hideWorksheetSelector?: boolean;
|
|
401
372
|
/**
|
|
402
373
|
* Show or hide autocomplete suggestions for the search query string.
|
|
403
|
-
*
|
|
404
374
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
405
375
|
*/
|
|
406
376
|
hideAutocompleteSuggestions?: boolean;
|
|
407
377
|
/**
|
|
408
378
|
* Show or hide autocomplete suggestions for the search query string.
|
|
409
|
-
*
|
|
410
379
|
* @deprecated
|
|
411
380
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
412
381
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -416,7 +385,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
416
385
|
* Show or hide sample questions.
|
|
417
386
|
* The sample questions are autogenerated based on the worksheet
|
|
418
387
|
* selected for the search operation.
|
|
419
|
-
*
|
|
420
388
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
421
389
|
*/
|
|
422
390
|
hideSampleQuestions?: boolean;
|
|
@@ -434,7 +402,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
434
402
|
* If it is executed, the focus is placed on the results.
|
|
435
403
|
* If it’s not executed, the focus is placed at the end of
|
|
436
404
|
* the token string in the search bar.
|
|
437
|
-
*
|
|
438
405
|
* @example
|
|
439
406
|
* ```js
|
|
440
407
|
* searchOptions: {
|
|
@@ -448,7 +415,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
448
415
|
}
|
|
449
416
|
/**
|
|
450
417
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
451
|
-
*
|
|
452
418
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
453
419
|
* @group Embed components
|
|
454
420
|
*/
|
|
@@ -462,20 +428,17 @@ export declare class SageEmbed extends V1Embed {
|
|
|
462
428
|
/**
|
|
463
429
|
* Constructs a map of parameters to be passed on to the
|
|
464
430
|
* embedded Eureka or Sage search page.
|
|
465
|
-
*
|
|
466
431
|
* @returns {string} query string
|
|
467
432
|
*/
|
|
468
433
|
protected getEmbedParams(): string;
|
|
469
434
|
/**
|
|
470
435
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
471
436
|
* loaded in the iframe
|
|
472
|
-
*
|
|
473
437
|
* @returns {string} iframe url
|
|
474
438
|
*/
|
|
475
439
|
getIFrameSrc(): string;
|
|
476
440
|
/**
|
|
477
441
|
* Render the embedded ThoughtSpot Sage
|
|
478
|
-
*
|
|
479
442
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
480
443
|
*/
|
|
481
444
|
render(): Promise<SageEmbed>;
|
|
@@ -485,7 +448,6 @@ export declare class SageEmbed extends V1Embed {
|
|
|
485
448
|
* Copyright (c) 2022
|
|
486
449
|
*
|
|
487
450
|
* Embed ThoughtSpot search or a saved answer
|
|
488
|
-
*
|
|
489
451
|
* @summary Search embed
|
|
490
452
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
491
453
|
*/
|
|
@@ -526,16 +488,13 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
526
488
|
}
|
|
527
489
|
/**
|
|
528
490
|
* The configuration attributes for the embedded search view.
|
|
529
|
-
*
|
|
530
491
|
* @group Embed components
|
|
531
492
|
*/
|
|
532
493
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
533
494
|
/**
|
|
534
495
|
* If set to true, the data sources panel is collapsed on load,
|
|
535
496
|
* but can be expanded manually.
|
|
536
|
-
*
|
|
537
497
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
538
|
-
*
|
|
539
498
|
* @example
|
|
540
499
|
* ```js
|
|
541
500
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -547,9 +506,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
547
506
|
collapseDataSources?: boolean;
|
|
548
507
|
/**
|
|
549
508
|
* Show or hide the data sources panel.
|
|
550
|
-
*
|
|
551
509
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
552
|
-
*
|
|
553
510
|
* @example
|
|
554
511
|
* ```js
|
|
555
512
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -563,9 +520,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
563
520
|
* Show or hide the charts and tables in search answers.
|
|
564
521
|
* This attribute can be used to create a custom visualization
|
|
565
522
|
* using raw answer data.
|
|
566
|
-
*
|
|
567
523
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
568
|
-
*
|
|
569
524
|
* @example
|
|
570
525
|
* ```js
|
|
571
526
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -577,9 +532,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
577
532
|
hideResults?: boolean;
|
|
578
533
|
/**
|
|
579
534
|
* If set to true, the Search Assist feature is enabled.
|
|
580
|
-
*
|
|
581
535
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
582
|
-
*
|
|
583
536
|
* @example
|
|
584
537
|
* ```js
|
|
585
538
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -592,9 +545,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
592
545
|
/**
|
|
593
546
|
* If set to true, the tabular view is set as the default
|
|
594
547
|
* format for presenting search data.
|
|
595
|
-
*
|
|
596
548
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
597
|
-
*
|
|
598
549
|
* @example
|
|
599
550
|
* ```js
|
|
600
551
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -606,9 +557,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
606
557
|
/**
|
|
607
558
|
* The array of data source GUIDs to set on load.
|
|
608
559
|
* Only a single data source is supported currently.
|
|
609
|
-
*
|
|
610
560
|
* @deprecated Use `dataSource` instead.
|
|
611
|
-
*
|
|
612
561
|
* @example
|
|
613
562
|
* ```js
|
|
614
563
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -620,9 +569,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
620
569
|
dataSources?: string[];
|
|
621
570
|
/**
|
|
622
571
|
* The array of data source GUIDs to set on load.
|
|
623
|
-
*
|
|
624
572
|
* @version: SDK: 1.19.0
|
|
625
|
-
*
|
|
626
573
|
* @example
|
|
627
574
|
* ```js
|
|
628
575
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -634,7 +581,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
634
581
|
dataSource?: string;
|
|
635
582
|
/**
|
|
636
583
|
* The initial search query to load the answer with.
|
|
637
|
-
*
|
|
638
584
|
* @deprecated
|
|
639
585
|
*
|
|
640
586
|
* Use {@link searchOptions} instead.
|
|
@@ -650,7 +596,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
650
596
|
* If it is executed, the focus is placed on the results.
|
|
651
597
|
* If it’s not executed, the focus is placed at the end of
|
|
652
598
|
* the token string in the search bar.
|
|
653
|
-
*
|
|
654
599
|
* @example
|
|
655
600
|
* ```js
|
|
656
601
|
* searchOptions: {
|
|
@@ -662,9 +607,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
662
607
|
searchOptions?: SearchOptions;
|
|
663
608
|
/**
|
|
664
609
|
* The GUID of a saved answer to load initially.
|
|
665
|
-
*
|
|
666
610
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
667
|
-
*
|
|
668
611
|
* @example
|
|
669
612
|
* ```js
|
|
670
613
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -677,9 +620,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
677
620
|
/**
|
|
678
621
|
* If set to true, the search page will render without the Search Bar
|
|
679
622
|
* The chart/table should still be visible.
|
|
680
|
-
*
|
|
681
623
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
682
|
-
*
|
|
683
624
|
* @example
|
|
684
625
|
* ```js
|
|
685
626
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -691,10 +632,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
691
632
|
hideSearchBar?: boolean;
|
|
692
633
|
/**
|
|
693
634
|
* Flag to control Data panel experience
|
|
694
|
-
*
|
|
695
635
|
* @default false
|
|
696
636
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
697
|
-
*
|
|
698
637
|
* @example
|
|
699
638
|
* ```js
|
|
700
639
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -706,23 +645,19 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
706
645
|
dataPanelV2?: boolean;
|
|
707
646
|
/**
|
|
708
647
|
* Flag to set if last selected dataSource should be used
|
|
709
|
-
*
|
|
710
648
|
* @version: SDK: 1.24.0
|
|
711
649
|
*/
|
|
712
650
|
useLastSelectedSources?: boolean;
|
|
713
651
|
/**
|
|
714
652
|
* To set the initial state of the search bar in case of saved-answers.
|
|
715
|
-
*
|
|
716
653
|
* @default false
|
|
717
654
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
718
655
|
*/
|
|
719
656
|
collapseSearchBarInitially?: boolean;
|
|
720
657
|
/**
|
|
721
658
|
* To enable custom column groups in data panel v2
|
|
722
|
-
*
|
|
723
659
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
724
660
|
* @default false
|
|
725
|
-
*
|
|
726
661
|
* @example
|
|
727
662
|
* ```js
|
|
728
663
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -734,7 +669,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
734
669
|
enableCustomColumnGroups?: boolean;
|
|
735
670
|
/**
|
|
736
671
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
737
|
-
*
|
|
738
672
|
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
739
673
|
*/
|
|
740
674
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
@@ -745,10 +679,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
745
679
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
746
680
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
747
681
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
748
|
-
*
|
|
749
682
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
750
683
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
751
|
-
*
|
|
752
684
|
* @example
|
|
753
685
|
* ```js
|
|
754
686
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -763,7 +695,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
763
695
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
764
696
|
/**
|
|
765
697
|
* Embed ThoughtSpot search
|
|
766
|
-
*
|
|
767
698
|
* @group Embed components
|
|
768
699
|
*/
|
|
769
700
|
export declare class SearchEmbed extends TsEmbed {
|
|
@@ -776,7 +707,6 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
776
707
|
/**
|
|
777
708
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
778
709
|
* loaded in the iframe
|
|
779
|
-
*
|
|
780
710
|
* @param answerId The GUID of a saved answer
|
|
781
711
|
* @param dataSources A list of data source GUIDs
|
|
782
712
|
*/
|
|
@@ -792,7 +722,6 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
792
722
|
*
|
|
793
723
|
* Full application embedding
|
|
794
724
|
* https://developers.thoughtspot.com/docs/?pageid=full-embed
|
|
795
|
-
*
|
|
796
725
|
* @summary Full app embed
|
|
797
726
|
* @module
|
|
798
727
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
@@ -850,7 +779,6 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
850
779
|
}
|
|
851
780
|
/**
|
|
852
781
|
* The view configuration for full app embedding.
|
|
853
|
-
*
|
|
854
782
|
* @group Embed components
|
|
855
783
|
*/
|
|
856
784
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
@@ -858,10 +786,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
858
786
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
859
787
|
* is displayed. By default, the navigation bar is hidden.
|
|
860
788
|
* This flag also controls the homepage left navigation bar.
|
|
861
|
-
*
|
|
862
789
|
* @default true
|
|
863
790
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
864
|
-
*
|
|
865
791
|
* @example
|
|
866
792
|
* ```js
|
|
867
793
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -880,10 +806,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
880
806
|
* **Note**: This option does not apply to the classic homepage.
|
|
881
807
|
* To access the updated modular homepage, set
|
|
882
808
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
883
|
-
*
|
|
884
809
|
* @default false
|
|
885
810
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
886
|
-
*
|
|
887
811
|
* @example
|
|
888
812
|
* ```js
|
|
889
813
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -898,7 +822,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
898
822
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
899
823
|
* @default false
|
|
900
824
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
901
|
-
*
|
|
902
825
|
* @example
|
|
903
826
|
* ```js
|
|
904
827
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -915,10 +838,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
915
838
|
* **Note**: This option does not apply to the classic homepage.
|
|
916
839
|
* To access the updated modular homepage, set
|
|
917
840
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
918
|
-
*
|
|
919
841
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
920
842
|
* @default false
|
|
921
|
-
*
|
|
922
843
|
* @example
|
|
923
844
|
* ```js
|
|
924
845
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -935,10 +856,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
935
856
|
* **Note**: This option does not apply to the classic homepage.
|
|
936
857
|
* To access the updated modular homepage, set
|
|
937
858
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
938
|
-
*
|
|
939
859
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
940
860
|
* @default true
|
|
941
|
-
*
|
|
942
861
|
* @example
|
|
943
862
|
* ```js
|
|
944
863
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -956,9 +875,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
956
875
|
*
|
|
957
876
|
* For eg, if you want the component to open to a specific Liveboard
|
|
958
877
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
959
|
-
*
|
|
960
878
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
961
|
-
*
|
|
962
879
|
* @example
|
|
963
880
|
* ```js
|
|
964
881
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -974,9 +891,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
974
891
|
*
|
|
975
892
|
* Use this to open to particular page in the app. To open to a specific
|
|
976
893
|
* path within the app, use the `path` attribute which is more flexible.
|
|
977
|
-
*
|
|
978
894
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
979
|
-
*
|
|
980
895
|
* @example
|
|
981
896
|
* ```js
|
|
982
897
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -990,7 +905,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
990
905
|
* This puts a filter tag on the application. All metadata lists in the
|
|
991
906
|
* application, such as Liveboards and answers, would be filtered by this
|
|
992
907
|
* tag.
|
|
993
|
-
*
|
|
994
908
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
995
909
|
* @example
|
|
996
910
|
* ```js
|
|
@@ -1003,9 +917,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1003
917
|
tag?: string;
|
|
1004
918
|
/**
|
|
1005
919
|
* The array of GUIDs to be hidden
|
|
1006
|
-
*
|
|
1007
920
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1008
|
-
*
|
|
1009
921
|
* @example
|
|
1010
922
|
* ```js
|
|
1011
923
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1021,7 +933,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1021
933
|
/**
|
|
1022
934
|
* Render liveboards using the new v2 rendering mode
|
|
1023
935
|
* This is a transient flag which is primarily meant for internal use
|
|
1024
|
-
*
|
|
1025
936
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1026
937
|
* @hidden
|
|
1027
938
|
*/
|
|
@@ -1029,9 +940,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1029
940
|
/**
|
|
1030
941
|
* If set to true, the Search Assist feature is enabled.
|
|
1031
942
|
* @default true
|
|
1032
|
-
*
|
|
1033
943
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
1034
|
-
*
|
|
1035
944
|
* @example
|
|
1036
945
|
* ```js
|
|
1037
946
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1044,9 +953,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1044
953
|
/**
|
|
1045
954
|
* If set to true, the embedded object container dynamically resizes
|
|
1046
955
|
* according to the height of the pages which support fullHeight mode.
|
|
1047
|
-
*
|
|
1048
956
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
1049
|
-
*
|
|
1050
957
|
* @example
|
|
1051
958
|
* ```js
|
|
1052
959
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1058,7 +965,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1058
965
|
fullHeight?: boolean;
|
|
1059
966
|
/**
|
|
1060
967
|
* Flag to control Data panel experience
|
|
1061
|
-
*
|
|
1062
968
|
* @default false
|
|
1063
969
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1064
970
|
* @hidden
|
|
@@ -1066,10 +972,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1066
972
|
dataPanelV2?: boolean;
|
|
1067
973
|
/**
|
|
1068
974
|
* Show or hide Liveboard header
|
|
1069
|
-
*
|
|
1070
975
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1071
976
|
* @default false
|
|
1072
|
-
*
|
|
1073
977
|
* @example
|
|
1074
978
|
* ```js
|
|
1075
979
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1081,10 +985,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1081
985
|
hideLiveboardHeader?: boolean;
|
|
1082
986
|
/**
|
|
1083
987
|
* Show or hide Liveboard title
|
|
1084
|
-
*
|
|
1085
988
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1086
989
|
* @default false
|
|
1087
|
-
*
|
|
1088
990
|
* @example
|
|
1089
991
|
* ```js
|
|
1090
992
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1096,10 +998,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1096
998
|
showLiveboardTitle?: boolean;
|
|
1097
999
|
/**
|
|
1098
1000
|
* Show or hide Liveboard description
|
|
1099
|
-
*
|
|
1100
1001
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1101
1002
|
* @default false
|
|
1102
|
-
*
|
|
1103
1003
|
* @example
|
|
1104
1004
|
* ```js
|
|
1105
1005
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1111,10 +1011,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1111
1011
|
showLiveboardDescription?: boolean;
|
|
1112
1012
|
/**
|
|
1113
1013
|
* Flag to control new Modular Home experience.
|
|
1114
|
-
*
|
|
1115
1014
|
* @default false
|
|
1116
1015
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1117
|
-
*
|
|
1118
1016
|
* @example
|
|
1119
1017
|
* ```js
|
|
1120
1018
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1126,7 +1024,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1126
1024
|
modularHomeExperience?: boolean;
|
|
1127
1025
|
/**
|
|
1128
1026
|
* Boolean to control if Liveboard header is sticky or not.
|
|
1129
|
-
*
|
|
1130
1027
|
* @example
|
|
1131
1028
|
* ```js
|
|
1132
1029
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1139,24 +1036,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1139
1036
|
isLiveboardHeaderSticky?: boolean;
|
|
1140
1037
|
/**
|
|
1141
1038
|
* enable or disable ask sage
|
|
1142
|
-
*
|
|
1143
1039
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1144
1040
|
* @default false
|
|
1145
1041
|
*/
|
|
1146
1042
|
enableAskSage?: boolean;
|
|
1147
1043
|
/**
|
|
1148
1044
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1149
|
-
*
|
|
1150
1045
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1151
1046
|
* @default false
|
|
1152
1047
|
*/
|
|
1153
1048
|
collapseSearchBarInitially?: boolean;
|
|
1154
1049
|
/**
|
|
1155
1050
|
* To enable custom column groups in data panel v2.
|
|
1156
|
-
*
|
|
1157
1051
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1158
1052
|
* @default false
|
|
1159
|
-
*
|
|
1160
1053
|
* @example
|
|
1161
1054
|
* ```js
|
|
1162
1055
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1173,10 +1066,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1173
1066
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1174
1067
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1175
1068
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1176
|
-
*
|
|
1177
1069
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1178
1070
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1179
|
-
*
|
|
1180
1071
|
* @example
|
|
1181
1072
|
* ```js
|
|
1182
1073
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1189,11 +1080,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1189
1080
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1190
1081
|
/**
|
|
1191
1082
|
* This flag is used to enable the 2 column layout in liveboard
|
|
1192
|
-
*
|
|
1193
1083
|
* @type {boolean}
|
|
1194
1084
|
* @default false
|
|
1195
1085
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1196
|
-
*
|
|
1197
1086
|
* @example
|
|
1198
1087
|
* ```js
|
|
1199
1088
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1205,14 +1094,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1205
1094
|
enable2ColumnLayout?: boolean;
|
|
1206
1095
|
/**
|
|
1207
1096
|
* Flag to use OnBeforeSearchExecute embed event
|
|
1208
|
-
*
|
|
1209
1097
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
1210
1098
|
*/
|
|
1211
1099
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1212
1100
|
}
|
|
1213
1101
|
/**
|
|
1214
1102
|
* Embeds full ThoughtSpot experience in a host application.
|
|
1215
|
-
*
|
|
1216
1103
|
* @group Embed components
|
|
1217
1104
|
*/
|
|
1218
1105
|
export declare class AppEmbed extends V1Embed {
|
|
@@ -1225,14 +1112,12 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1225
1112
|
protected getEmbedParams(): string;
|
|
1226
1113
|
/**
|
|
1227
1114
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
1228
|
-
*
|
|
1229
1115
|
* @param pageId The ID of the page to be embedded.
|
|
1230
1116
|
*/
|
|
1231
1117
|
getIFrameSrc(): string;
|
|
1232
1118
|
/**
|
|
1233
1119
|
* Set the iframe height as per the computed height received
|
|
1234
1120
|
* from the ThoughtSpot app.
|
|
1235
|
-
*
|
|
1236
1121
|
* @param data The event payload
|
|
1237
1122
|
*/
|
|
1238
1123
|
protected updateIFrameHeight: (data: MessagePayload) => void;
|
|
@@ -1240,7 +1125,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1240
1125
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
1241
1126
|
* This is used for embedding answers, pinboards, visualizations and full application
|
|
1242
1127
|
* only.
|
|
1243
|
-
*
|
|
1244
1128
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
1245
1129
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
1246
1130
|
* When used with `noReload` (default: true) this can also be a number
|
|
@@ -1251,7 +1135,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1251
1135
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
1252
1136
|
/**
|
|
1253
1137
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
1254
|
-
*
|
|
1255
1138
|
* @param renderOptions An object containing the page ID
|
|
1256
1139
|
* to be embedded.
|
|
1257
1140
|
*/
|
|
@@ -1264,13 +1147,11 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1264
1147
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
1265
1148
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
1266
1149
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
1267
|
-
*
|
|
1268
1150
|
* @summary Liveboard & visualization embed
|
|
1269
1151
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1270
1152
|
*/
|
|
1271
1153
|
/**
|
|
1272
1154
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
1273
|
-
*
|
|
1274
1155
|
* @group Embed components
|
|
1275
1156
|
*/
|
|
1276
1157
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -1283,9 +1164,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1283
1164
|
* visualizations to display on the screen.
|
|
1284
1165
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
1285
1166
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1286
|
-
*
|
|
1287
1167
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1288
|
-
*
|
|
1289
1168
|
* @example
|
|
1290
1169
|
* ```js
|
|
1291
1170
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1299,7 +1178,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1299
1178
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
1300
1179
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
1301
1180
|
* other screens navigable from a Liveboard.
|
|
1302
|
-
*
|
|
1303
1181
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1304
1182
|
* @default 500
|
|
1305
1183
|
* @example
|
|
@@ -1314,7 +1192,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1314
1192
|
defaultHeight?: number;
|
|
1315
1193
|
/**
|
|
1316
1194
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
1317
|
-
*
|
|
1318
1195
|
* @example
|
|
1319
1196
|
* ```js
|
|
1320
1197
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1322,14 +1199,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1322
1199
|
* enableVizTransformations:true,
|
|
1323
1200
|
* })
|
|
1324
1201
|
* ```
|
|
1325
|
-
*
|
|
1326
1202
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1327
1203
|
*/
|
|
1328
1204
|
enableVizTransformations?: boolean;
|
|
1329
1205
|
/**
|
|
1330
1206
|
* The Liveboard to display in the embedded view.
|
|
1331
1207
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
1332
|
-
*
|
|
1333
1208
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
1334
1209
|
* @example
|
|
1335
1210
|
* ```js
|
|
@@ -1341,15 +1216,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1341
1216
|
liveboardId?: string;
|
|
1342
1217
|
/**
|
|
1343
1218
|
* To support backward compatibility
|
|
1344
|
-
*
|
|
1345
1219
|
* @hidden
|
|
1346
1220
|
*/
|
|
1347
1221
|
pinboardId?: string;
|
|
1348
1222
|
/**
|
|
1349
1223
|
* The visualization within the Liveboard to display.
|
|
1350
|
-
*
|
|
1351
1224
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1352
|
-
*
|
|
1353
1225
|
* @example
|
|
1354
1226
|
* ```js
|
|
1355
1227
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1362,7 +1234,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1362
1234
|
/**
|
|
1363
1235
|
* If set to true, all filter chips from a
|
|
1364
1236
|
* Liveboard page will be read-only (no X buttons)
|
|
1365
|
-
*
|
|
1366
1237
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
1367
1238
|
* @example
|
|
1368
1239
|
* ```js
|
|
@@ -1377,9 +1248,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1377
1248
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
1378
1249
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
1379
1250
|
* event.
|
|
1380
|
-
*
|
|
1381
1251
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1382
|
-
*
|
|
1383
1252
|
* @example
|
|
1384
1253
|
* ```js
|
|
1385
1254
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1393,14 +1262,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1393
1262
|
visibleVizs?: string[];
|
|
1394
1263
|
/**
|
|
1395
1264
|
* To support backward compatibility
|
|
1396
|
-
*
|
|
1397
1265
|
* @hidden
|
|
1398
1266
|
*/
|
|
1399
1267
|
preventPinboardFilterRemoval?: boolean;
|
|
1400
1268
|
/**
|
|
1401
1269
|
* Render embedded Liveboards and visualizations in the
|
|
1402
1270
|
* new Liveboard experience mode.
|
|
1403
|
-
*
|
|
1404
1271
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
1405
1272
|
* @example
|
|
1406
1273
|
* ```js
|
|
@@ -1414,7 +1281,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1414
1281
|
/**
|
|
1415
1282
|
* Set a Liveboard tab as an active tab.
|
|
1416
1283
|
* Specify the tab ID.
|
|
1417
|
-
*
|
|
1418
1284
|
* @example
|
|
1419
1285
|
* ```js
|
|
1420
1286
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1427,9 +1293,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1427
1293
|
activeTabId?: string;
|
|
1428
1294
|
/**
|
|
1429
1295
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1430
|
-
*
|
|
1431
1296
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1432
|
-
*
|
|
1433
1297
|
* @example
|
|
1434
1298
|
* ```js
|
|
1435
1299
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1441,7 +1305,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1441
1305
|
hideTabPanel?: boolean;
|
|
1442
1306
|
/**
|
|
1443
1307
|
* Show or hide the Liveboard header.
|
|
1444
|
-
*
|
|
1445
1308
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1446
1309
|
* @default false
|
|
1447
1310
|
* @example
|
|
@@ -1457,7 +1320,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1457
1320
|
* Show or hide the Liveboard title.
|
|
1458
1321
|
* @default false
|
|
1459
1322
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1460
|
-
*
|
|
1461
1323
|
* @example
|
|
1462
1324
|
* ```js
|
|
1463
1325
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1471,7 +1333,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1471
1333
|
* Show or hide the Liveboard description.
|
|
1472
1334
|
* @default false
|
|
1473
1335
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1474
|
-
*
|
|
1475
1336
|
* @example
|
|
1476
1337
|
* ```js
|
|
1477
1338
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1485,7 +1346,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1485
1346
|
* Control the position and visibility of
|
|
1486
1347
|
* the Liveboard header as the users scroll down the
|
|
1487
1348
|
* embedded Liveboard page.
|
|
1488
|
-
*
|
|
1489
1349
|
* @example
|
|
1490
1350
|
* ```js
|
|
1491
1351
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1498,7 +1358,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1498
1358
|
isLiveboardHeaderSticky?: boolean;
|
|
1499
1359
|
/**
|
|
1500
1360
|
* enable or disable ask sage
|
|
1501
|
-
*
|
|
1502
1361
|
* @default false
|
|
1503
1362
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1504
1363
|
* @example
|
|
@@ -1512,11 +1371,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1512
1371
|
enableAskSage?: boolean;
|
|
1513
1372
|
/**
|
|
1514
1373
|
* This flag is used to enable the 2 column layout in liveboard
|
|
1515
|
-
*
|
|
1516
1374
|
* @type {boolean}
|
|
1517
1375
|
* @default false
|
|
1518
1376
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1519
|
-
*
|
|
1520
1377
|
* @example
|
|
1521
1378
|
* ```js
|
|
1522
1379
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1531,7 +1388,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1531
1388
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
1532
1389
|
* waits for the authentication to complete, so you need not wait for
|
|
1533
1390
|
* `AuthStatus.SUCCESS`.
|
|
1534
|
-
*
|
|
1535
1391
|
* @example
|
|
1536
1392
|
* ```js
|
|
1537
1393
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1555,14 +1411,12 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
1555
1411
|
protected handleRenderForPrerender(): void;
|
|
1556
1412
|
/**
|
|
1557
1413
|
* Triggers an event to the embedded app
|
|
1558
|
-
*
|
|
1559
1414
|
* @param messageType The event type
|
|
1560
1415
|
* @param data The payload to send with the message
|
|
1561
1416
|
*/
|
|
1562
1417
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
1563
1418
|
/**
|
|
1564
1419
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
1565
|
-
*
|
|
1566
1420
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
1567
1421
|
* visualization ID and the runtime filters.
|
|
1568
1422
|
*/
|
|
@@ -1598,7 +1452,6 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
|
|
|
1598
1452
|
*
|
|
1599
1453
|
* ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
|
|
1600
1454
|
* in other web applications.
|
|
1601
|
-
*
|
|
1602
1455
|
* @summary ThoughtSpot Visual Embed SDK
|
|
1603
1456
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1604
1457
|
*/
|
|
@@ -1608,21 +1461,18 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
1608
1461
|
* Copyright (c) 2023
|
|
1609
1462
|
*
|
|
1610
1463
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
1611
|
-
*
|
|
1612
1464
|
* @summary Type definitions for Embed SDK
|
|
1613
1465
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1614
1466
|
*/
|
|
1615
1467
|
/**
|
|
1616
1468
|
* The authentication mechanism for allowing access to the
|
|
1617
1469
|
* the embedded app
|
|
1618
|
-
*
|
|
1619
1470
|
* @group Authentication / Init
|
|
1620
1471
|
*/
|
|
1621
1472
|
export declare enum AuthType {
|
|
1622
1473
|
/**
|
|
1623
1474
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
1624
1475
|
* `Passthrough`.
|
|
1625
|
-
*
|
|
1626
1476
|
* @example
|
|
1627
1477
|
* ```js
|
|
1628
1478
|
* init({
|
|
@@ -1640,7 +1490,6 @@ export declare enum AuthType {
|
|
|
1640
1490
|
* To use this:
|
|
1641
1491
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1642
1492
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1643
|
-
*
|
|
1644
1493
|
* @example
|
|
1645
1494
|
* ```js
|
|
1646
1495
|
* init({
|
|
@@ -1653,14 +1502,12 @@ export declare enum AuthType {
|
|
|
1653
1502
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1654
1503
|
/**
|
|
1655
1504
|
* SSO using SAML
|
|
1656
|
-
*
|
|
1657
1505
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1658
1506
|
* @hidden
|
|
1659
1507
|
*/
|
|
1660
1508
|
SSO = "SSO_SAML",
|
|
1661
1509
|
/**
|
|
1662
1510
|
* SSO using SAML
|
|
1663
|
-
*
|
|
1664
1511
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1665
1512
|
* @hidden
|
|
1666
1513
|
*/
|
|
@@ -1672,7 +1519,6 @@ export declare enum AuthType {
|
|
|
1672
1519
|
*
|
|
1673
1520
|
* This redirects the host application to the SAML IdP. The host application
|
|
1674
1521
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1675
|
-
*
|
|
1676
1522
|
* @example
|
|
1677
1523
|
* ```js
|
|
1678
1524
|
* init({
|
|
@@ -1713,7 +1559,6 @@ export declare enum AuthType {
|
|
|
1713
1559
|
SAMLRedirect = "SSO_SAML",
|
|
1714
1560
|
/**
|
|
1715
1561
|
* SSO using OIDC
|
|
1716
|
-
*
|
|
1717
1562
|
* @hidden
|
|
1718
1563
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
1719
1564
|
*/
|
|
@@ -1726,7 +1571,6 @@ export declare enum AuthType {
|
|
|
1726
1571
|
OIDCRedirect = "SSO_OIDC",
|
|
1727
1572
|
/**
|
|
1728
1573
|
* Trusted authentication server
|
|
1729
|
-
*
|
|
1730
1574
|
* @hidden
|
|
1731
1575
|
* @deprecated Use {@link TrustedAuth} instead
|
|
1732
1576
|
*/
|
|
@@ -1735,7 +1579,6 @@ export declare enum AuthType {
|
|
|
1735
1579
|
* Trusted authentication server. Use your own authentication server
|
|
1736
1580
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1737
1581
|
* from ThoughtSpot.
|
|
1738
|
-
*
|
|
1739
1582
|
* @example
|
|
1740
1583
|
* ```js
|
|
1741
1584
|
* init({
|
|
@@ -1756,7 +1599,6 @@ export declare enum AuthType {
|
|
|
1756
1599
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1757
1600
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1758
1601
|
* implemented by some browsers.
|
|
1759
|
-
*
|
|
1760
1602
|
* @example
|
|
1761
1603
|
* ```js
|
|
1762
1604
|
* init({
|
|
@@ -1829,7 +1671,6 @@ export interface customCssInterface {
|
|
|
1829
1671
|
/**
|
|
1830
1672
|
* Can be used to define a custom font face
|
|
1831
1673
|
* like:
|
|
1832
|
-
*
|
|
1833
1674
|
* @example
|
|
1834
1675
|
* ```js
|
|
1835
1676
|
* rules_UNSTABLE?: {
|
|
@@ -1869,7 +1710,6 @@ export interface CustomStyles {
|
|
|
1869
1710
|
* Thoughtspot components.
|
|
1870
1711
|
* You can customize styles, text strings, and icons.
|
|
1871
1712
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
1872
|
-
*
|
|
1873
1713
|
* @example
|
|
1874
1714
|
* ```js
|
|
1875
1715
|
* init({
|
|
@@ -1912,7 +1752,6 @@ export interface CustomisationsInterface {
|
|
|
1912
1752
|
* It includes the ThoughtSpot hostname or IP address,
|
|
1913
1753
|
* the type of authentication, and the authentication endpoint
|
|
1914
1754
|
* if a trusted authentication server is used.
|
|
1915
|
-
*
|
|
1916
1755
|
* @group Authentication / Init
|
|
1917
1756
|
*/
|
|
1918
1757
|
export interface EmbedConfig {
|
|
@@ -1960,7 +1799,6 @@ export interface EmbedConfig {
|
|
|
1960
1799
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1961
1800
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1962
1801
|
* place.
|
|
1963
|
-
*
|
|
1964
1802
|
* @default false
|
|
1965
1803
|
* @deprecated
|
|
1966
1804
|
*/
|
|
@@ -1971,7 +1809,6 @@ export interface EmbedConfig {
|
|
|
1971
1809
|
*
|
|
1972
1810
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1973
1811
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1974
|
-
*
|
|
1975
1812
|
* @default false
|
|
1976
1813
|
* @version SDK: 1.18.0
|
|
1977
1814
|
*/
|
|
@@ -1982,7 +1819,6 @@ export interface EmbedConfig {
|
|
|
1982
1819
|
* terminated.
|
|
1983
1820
|
*
|
|
1984
1821
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1985
|
-
*
|
|
1986
1822
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1987
1823
|
*/
|
|
1988
1824
|
redirectPath?: string;
|
|
@@ -1992,7 +1828,6 @@ export interface EmbedConfig {
|
|
|
1992
1828
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1993
1829
|
* should be encoded in base64. This provides additional security to
|
|
1994
1830
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1995
|
-
*
|
|
1996
1831
|
* @default false
|
|
1997
1832
|
*/
|
|
1998
1833
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2002,7 +1837,6 @@ export interface EmbedConfig {
|
|
|
2002
1837
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
2003
1838
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
2004
1839
|
* in this case.
|
|
2005
|
-
*
|
|
2006
1840
|
* @default false
|
|
2007
1841
|
*/
|
|
2008
1842
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -2010,14 +1844,12 @@ export interface EmbedConfig {
|
|
|
2010
1844
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
2011
1845
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
2012
1846
|
* persists even in the case of a non-logged-in user.
|
|
2013
|
-
*
|
|
2014
1847
|
* @default false
|
|
2015
1848
|
*/
|
|
2016
1849
|
ignoreNoCookieAccess?: boolean;
|
|
2017
1850
|
/**
|
|
2018
1851
|
* Re-login a user with the previous login options
|
|
2019
1852
|
* when a user session expires.
|
|
2020
|
-
*
|
|
2021
1853
|
* @default false
|
|
2022
1854
|
*/
|
|
2023
1855
|
autoLogin?: boolean;
|
|
@@ -2026,20 +1858,17 @@ export interface EmbedConfig {
|
|
|
2026
1858
|
* This flag is typically used alongside the combination of authentication modes such
|
|
2027
1859
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
2028
1860
|
* EmbedConfig.autoLogin}
|
|
2029
|
-
*
|
|
2030
1861
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2031
1862
|
* @default false
|
|
2032
1863
|
*/
|
|
2033
1864
|
disableLoginRedirect?: boolean;
|
|
2034
1865
|
/**
|
|
2035
1866
|
* This message is displayed in the embedded view when a user login fails.
|
|
2036
|
-
*
|
|
2037
1867
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2038
1868
|
*/
|
|
2039
1869
|
loginFailedMessage?: string;
|
|
2040
1870
|
/**
|
|
2041
1871
|
* Calls the prefetch method internally when set to `true`
|
|
2042
|
-
*
|
|
2043
1872
|
* @default false
|
|
2044
1873
|
*/
|
|
2045
1874
|
callPrefetch?: boolean;
|
|
@@ -2047,7 +1876,6 @@ export interface EmbedConfig {
|
|
|
2047
1876
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
2048
1877
|
* to start after the previous embed's render is complete. This helps improve
|
|
2049
1878
|
* performance by decreasing the load on the browser.
|
|
2050
|
-
*
|
|
2051
1879
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2052
1880
|
* @default false
|
|
2053
1881
|
*/
|
|
@@ -2055,7 +1883,6 @@ export interface EmbedConfig {
|
|
|
2055
1883
|
/**
|
|
2056
1884
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
2057
1885
|
* You would also need to set `style-src` in the CSP settings.
|
|
2058
|
-
*
|
|
2059
1886
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2060
1887
|
* @default ''
|
|
2061
1888
|
*/
|
|
@@ -2067,13 +1894,11 @@ export interface EmbedConfig {
|
|
|
2067
1894
|
*
|
|
2068
1895
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
2069
1896
|
* involves an extra network call.
|
|
2070
|
-
*
|
|
2071
1897
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2072
1898
|
*/
|
|
2073
1899
|
detectCookieAccessSlow?: boolean;
|
|
2074
1900
|
/**
|
|
2075
1901
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
2076
|
-
*
|
|
2077
1902
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
2078
1903
|
*/
|
|
2079
1904
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -2084,7 +1909,6 @@ export interface EmbedConfig {
|
|
|
2084
1909
|
suppressSageEmbedBetaWarning?: boolean;
|
|
2085
1910
|
/**
|
|
2086
1911
|
* Custom style params for embed Config.
|
|
2087
|
-
*
|
|
2088
1912
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2089
1913
|
*/
|
|
2090
1914
|
customizations?: CustomisationsInterface;
|
|
@@ -2092,7 +1916,6 @@ export interface EmbedConfig {
|
|
|
2092
1916
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
2093
1917
|
* button that the user can click to trigger the flow.
|
|
2094
1918
|
* This attribute sets a containing element for that button.
|
|
2095
|
-
*
|
|
2096
1919
|
* @example
|
|
2097
1920
|
* ```js
|
|
2098
1921
|
* init({
|
|
@@ -2114,7 +1937,6 @@ export interface EmbedConfig {
|
|
|
2114
1937
|
/**
|
|
2115
1938
|
* Text to show in the button which triggers the popup auth flow.
|
|
2116
1939
|
* Default: `Authorize`.
|
|
2117
|
-
*
|
|
2118
1940
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2119
1941
|
*/
|
|
2120
1942
|
authTriggerText?: string;
|
|
@@ -2122,14 +1944,12 @@ export interface EmbedConfig {
|
|
|
2122
1944
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
2123
1945
|
* access to the embedded application users
|
|
2124
1946
|
* outside of the iframe.
|
|
2125
|
-
*
|
|
2126
1947
|
* @default true
|
|
2127
1948
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
2128
1949
|
*/
|
|
2129
1950
|
blockNonEmbedFullAppAccess?: boolean;
|
|
2130
1951
|
/**
|
|
2131
1952
|
* Host config in case embedded app is inside TS app itself
|
|
2132
|
-
*
|
|
2133
1953
|
* @hidden
|
|
2134
1954
|
*/
|
|
2135
1955
|
hostConfig?: {
|
|
@@ -2140,19 +1960,16 @@ export interface EmbedConfig {
|
|
|
2140
1960
|
/**
|
|
2141
1961
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
2142
1962
|
* 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].
|
|
2143
|
-
*
|
|
2144
1963
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
2145
1964
|
*/
|
|
2146
1965
|
pendoTrackingKey?: string;
|
|
2147
1966
|
/**
|
|
2148
1967
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
2149
|
-
*
|
|
2150
1968
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
2151
1969
|
*/
|
|
2152
1970
|
suppressErrorAlerts?: boolean;
|
|
2153
1971
|
/**
|
|
2154
1972
|
* Log level for the SDK.
|
|
2155
|
-
*
|
|
2156
1973
|
* @default LogLevel.ERROR
|
|
2157
1974
|
* @example
|
|
2158
1975
|
* ```js
|
|
@@ -2166,34 +1983,28 @@ export interface EmbedConfig {
|
|
|
2166
1983
|
logLevel?: LogLevel;
|
|
2167
1984
|
/**
|
|
2168
1985
|
* Disables the Mixpanel tracking from the SDK.
|
|
2169
|
-
*
|
|
2170
1986
|
* @version SDK: 1.27.9
|
|
2171
1987
|
*/
|
|
2172
1988
|
disableSDKTracking?: boolean;
|
|
2173
1989
|
/**
|
|
2174
1990
|
* Overrides default/user preffered locale for date formatting
|
|
2175
|
-
*
|
|
2176
1991
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2177
1992
|
*/
|
|
2178
1993
|
dateFormatLocale?: string;
|
|
2179
1994
|
/**
|
|
2180
1995
|
* Overrides default/user preffered locale for number formatting
|
|
2181
|
-
*
|
|
2182
1996
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2183
1997
|
*/
|
|
2184
1998
|
numberFormatLocale?: string;
|
|
2185
1999
|
/**
|
|
2186
2000
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2187
|
-
*
|
|
2188
2001
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2189
2002
|
*/
|
|
2190
2003
|
currencyFormat?: string;
|
|
2191
2004
|
/**
|
|
2192
2005
|
* This flag is used to disable the token verification in the SDK.
|
|
2193
2006
|
* Enabling this flag will also disable the caching of the token.
|
|
2194
|
-
*
|
|
2195
2007
|
* @hidden
|
|
2196
|
-
*
|
|
2197
2008
|
* @example
|
|
2198
2009
|
* ```js
|
|
2199
2010
|
* init({
|
|
@@ -2201,7 +2012,6 @@ export interface EmbedConfig {
|
|
|
2201
2012
|
* disableTokenVerification : true
|
|
2202
2013
|
* })
|
|
2203
2014
|
* ```
|
|
2204
|
-
*
|
|
2205
2015
|
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
2206
2016
|
*/
|
|
2207
2017
|
disableTokenVerification?: boolean;
|
|
@@ -2210,7 +2020,6 @@ export interface LayoutConfig {
|
|
|
2210
2020
|
}
|
|
2211
2021
|
/**
|
|
2212
2022
|
* Embedded iframe configuration
|
|
2213
|
-
*
|
|
2214
2023
|
* @group Embed components
|
|
2215
2024
|
*/
|
|
2216
2025
|
export interface FrameParams {
|
|
@@ -2245,9 +2054,7 @@ export interface ViewConfig {
|
|
|
2245
2054
|
/**
|
|
2246
2055
|
* The width and height dimensions to render an embedded
|
|
2247
2056
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2248
|
-
*
|
|
2249
2057
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2250
|
-
*
|
|
2251
2058
|
* @example
|
|
2252
2059
|
* ```js
|
|
2253
2060
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2273,7 +2080,6 @@ export interface ViewConfig {
|
|
|
2273
2080
|
* (...), and the contextual menu. These actions will be disabled
|
|
2274
2081
|
* for the user.
|
|
2275
2082
|
* Use this to disable actions.
|
|
2276
|
-
*
|
|
2277
2083
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2278
2084
|
* @example
|
|
2279
2085
|
* ```js
|
|
@@ -2301,9 +2107,7 @@ export interface ViewConfig {
|
|
|
2301
2107
|
* The list of actions to hide from the embedded.
|
|
2302
2108
|
* This actions will be hidden from the user.
|
|
2303
2109
|
* Use this to hide an action.
|
|
2304
|
-
*
|
|
2305
2110
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2306
|
-
*
|
|
2307
2111
|
* @example
|
|
2308
2112
|
* ```js
|
|
2309
2113
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2321,10 +2125,8 @@ export interface ViewConfig {
|
|
|
2321
2125
|
* Use this to hide all actions except the ones you want to show.
|
|
2322
2126
|
*
|
|
2323
2127
|
* Use either this or hiddenActions.
|
|
2324
|
-
*
|
|
2325
2128
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2326
2129
|
* @important
|
|
2327
|
-
*
|
|
2328
2130
|
* @example
|
|
2329
2131
|
* ```js
|
|
2330
2132
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2336,9 +2138,7 @@ export interface ViewConfig {
|
|
|
2336
2138
|
visibleActions?: Action[];
|
|
2337
2139
|
/**
|
|
2338
2140
|
* Show alert messages and toast messages in the embedded view.
|
|
2339
|
-
*
|
|
2340
2141
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2341
|
-
*
|
|
2342
2142
|
* @example
|
|
2343
2143
|
* ```js
|
|
2344
2144
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2351,9 +2151,7 @@ export interface ViewConfig {
|
|
|
2351
2151
|
/**
|
|
2352
2152
|
* The list of runtime filters to apply to a search answer,
|
|
2353
2153
|
* visualization, or Liveboard.
|
|
2354
|
-
*
|
|
2355
2154
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2356
|
-
*
|
|
2357
2155
|
* @example
|
|
2358
2156
|
* ```js
|
|
2359
2157
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2372,9 +2170,7 @@ export interface ViewConfig {
|
|
|
2372
2170
|
/**
|
|
2373
2171
|
* The list of parameter override to apply to a search answer,
|
|
2374
2172
|
* visualization, or Liveboard.
|
|
2375
|
-
*
|
|
2376
2173
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2377
|
-
*
|
|
2378
2174
|
* @example
|
|
2379
2175
|
* ```js
|
|
2380
2176
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2391,7 +2187,6 @@ export interface ViewConfig {
|
|
|
2391
2187
|
runtimeParameters?: RuntimeParameter[];
|
|
2392
2188
|
/**
|
|
2393
2189
|
* The locale/language to use for the embedded view.
|
|
2394
|
-
*
|
|
2395
2190
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2396
2191
|
* @example
|
|
2397
2192
|
* ```js
|
|
@@ -2427,7 +2222,6 @@ export interface ViewConfig {
|
|
|
2427
2222
|
/**
|
|
2428
2223
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
2429
2224
|
* You would also need to set `style-src` in the CSP settings.
|
|
2430
|
-
*
|
|
2431
2225
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
2432
2226
|
* @default ''
|
|
2433
2227
|
*/
|
|
@@ -2435,9 +2229,7 @@ export interface ViewConfig {
|
|
|
2435
2229
|
/**
|
|
2436
2230
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2437
2231
|
* child inside it.
|
|
2438
|
-
*
|
|
2439
2232
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2440
|
-
*
|
|
2441
2233
|
* @example
|
|
2442
2234
|
* ```js
|
|
2443
2235
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2449,7 +2241,6 @@ export interface ViewConfig {
|
|
|
2449
2241
|
insertAsSibling?: boolean;
|
|
2450
2242
|
/**
|
|
2451
2243
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2452
|
-
*
|
|
2453
2244
|
* @example
|
|
2454
2245
|
* ```js
|
|
2455
2246
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2462,7 +2253,6 @@ export interface ViewConfig {
|
|
|
2462
2253
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2463
2254
|
/**
|
|
2464
2255
|
* Flag to override openNew tab context menu link
|
|
2465
|
-
*
|
|
2466
2256
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2467
2257
|
* @example
|
|
2468
2258
|
* ```js
|
|
@@ -2475,7 +2265,6 @@ export interface ViewConfig {
|
|
|
2475
2265
|
linkOverride?: boolean;
|
|
2476
2266
|
/**
|
|
2477
2267
|
* flag to enable insert into slides action
|
|
2478
|
-
*
|
|
2479
2268
|
* @hidden
|
|
2480
2269
|
* @private
|
|
2481
2270
|
*/
|
|
@@ -2483,7 +2272,6 @@ export interface ViewConfig {
|
|
|
2483
2272
|
/**
|
|
2484
2273
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2485
2274
|
* if available and matches the configuration.
|
|
2486
|
-
*
|
|
2487
2275
|
* @version SDK: 1.22.0
|
|
2488
2276
|
* @hidden
|
|
2489
2277
|
*
|
|
@@ -2497,7 +2285,6 @@ export interface ViewConfig {
|
|
|
2497
2285
|
*
|
|
2498
2286
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2499
2287
|
* embedded view.
|
|
2500
|
-
*
|
|
2501
2288
|
* @default false
|
|
2502
2289
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2503
2290
|
*/
|
|
@@ -2506,7 +2293,6 @@ export interface ViewConfig {
|
|
|
2506
2293
|
* The list of tab IDs to hide from the embedded.
|
|
2507
2294
|
* This Tabs will be hidden from their respective LBs.
|
|
2508
2295
|
* Use this to hide an tabID.
|
|
2509
|
-
*
|
|
2510
2296
|
* @example
|
|
2511
2297
|
* ```js
|
|
2512
2298
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2526,7 +2312,6 @@ export interface ViewConfig {
|
|
|
2526
2312
|
* **Note**: This option does not apply to the classic homepage.
|
|
2527
2313
|
* To access the updated modular homepage, set
|
|
2528
2314
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2529
|
-
*
|
|
2530
2315
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2531
2316
|
* @example
|
|
2532
2317
|
* ```js
|
|
@@ -2535,7 +2320,6 @@ export interface ViewConfig {
|
|
|
2535
2320
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2536
2321
|
* })
|
|
2537
2322
|
* ```
|
|
2538
|
-
*
|
|
2539
2323
|
*/
|
|
2540
2324
|
hiddenHomepageModules?: HomepageModule[];
|
|
2541
2325
|
/**
|
|
@@ -2545,9 +2329,7 @@ export interface ViewConfig {
|
|
|
2545
2329
|
* **Note**: This option does not apply to the classic homepage.
|
|
2546
2330
|
* To access the updated modular homepage, set
|
|
2547
2331
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2548
|
-
*
|
|
2549
2332
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
2550
|
-
*
|
|
2551
2333
|
* @example
|
|
2552
2334
|
* ```js
|
|
2553
2335
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2562,9 +2344,7 @@ export interface ViewConfig {
|
|
|
2562
2344
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2563
2345
|
*
|
|
2564
2346
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2565
|
-
*
|
|
2566
2347
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2567
|
-
*
|
|
2568
2348
|
* @example
|
|
2569
2349
|
* ```js
|
|
2570
2350
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2581,8 +2361,7 @@ export interface ViewConfig {
|
|
|
2581
2361
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2582
2362
|
* There are 8 eight home navigation list items.
|
|
2583
2363
|
* To hide these items, specify the string in the array.
|
|
2584
|
-
*
|
|
2585
|
-
* * @example
|
|
2364
|
+
* @example
|
|
2586
2365
|
* ```js
|
|
2587
2366
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2588
2367
|
* ... // other options
|
|
@@ -2593,7 +2372,6 @@ export interface ViewConfig {
|
|
|
2593
2372
|
* **Note**: This option does not apply to the classic homepage.
|
|
2594
2373
|
* To access the updated modular homepage, set
|
|
2595
2374
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2596
|
-
*
|
|
2597
2375
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2598
2376
|
*/
|
|
2599
2377
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2601,7 +2379,6 @@ export interface ViewConfig {
|
|
|
2601
2379
|
* PreRender id to be used for PreRendering the embed.
|
|
2602
2380
|
* Use PreRender to render the embed in the background and then
|
|
2603
2381
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2604
|
-
*
|
|
2605
2382
|
* @example
|
|
2606
2383
|
* ```js
|
|
2607
2384
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2618,11 +2395,9 @@ export interface ViewConfig {
|
|
|
2618
2395
|
* of its embedding element and adjust its own size accordingly.
|
|
2619
2396
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2620
2397
|
* its dimensions based on changes to the size of the embedding element.
|
|
2621
|
-
*
|
|
2622
2398
|
* @type {boolean}
|
|
2623
2399
|
* @default false
|
|
2624
2400
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2625
|
-
*
|
|
2626
2401
|
* @example
|
|
2627
2402
|
* ```js
|
|
2628
2403
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2637,7 +2412,6 @@ export interface ViewConfig {
|
|
|
2637
2412
|
doNotTrackPreRenderSize?: boolean;
|
|
2638
2413
|
/**
|
|
2639
2414
|
* For internal tracking of the embed component type.
|
|
2640
|
-
*
|
|
2641
2415
|
* @hidden
|
|
2642
2416
|
*/
|
|
2643
2417
|
embedComponentType?: string;
|
|
@@ -2647,7 +2421,6 @@ export interface ViewConfig {
|
|
|
2647
2421
|
*
|
|
2648
2422
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2649
2423
|
* embedded view.
|
|
2650
|
-
*
|
|
2651
2424
|
* @default false
|
|
2652
2425
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2653
2426
|
*/
|
|
@@ -2655,7 +2428,6 @@ export interface ViewConfig {
|
|
|
2655
2428
|
}
|
|
2656
2429
|
/**
|
|
2657
2430
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
2658
|
-
*
|
|
2659
2431
|
* @group Events
|
|
2660
2432
|
*/
|
|
2661
2433
|
export type MessagePayload = {
|
|
@@ -2666,7 +2438,6 @@ export type MessagePayload = {
|
|
|
2666
2438
|
/**
|
|
2667
2439
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2668
2440
|
* option
|
|
2669
|
-
*
|
|
2670
2441
|
* @group Events
|
|
2671
2442
|
*/
|
|
2672
2443
|
export type MessageOptions = {
|
|
@@ -2678,7 +2449,6 @@ export type MessageOptions = {
|
|
|
2678
2449
|
};
|
|
2679
2450
|
/**
|
|
2680
2451
|
* MessageCallback: Embed event message callback
|
|
2681
|
-
*
|
|
2682
2452
|
* @group Events
|
|
2683
2453
|
*/
|
|
2684
2454
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -2772,7 +2542,6 @@ export declare enum RuntimeFilterOp {
|
|
|
2772
2542
|
* **Note**: This option does not apply to the classic homepage.
|
|
2773
2543
|
* To access the updated modular homepage, set
|
|
2774
2544
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2775
|
-
*
|
|
2776
2545
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2777
2546
|
*/
|
|
2778
2547
|
export declare enum HomepageModule {
|
|
@@ -2840,7 +2609,6 @@ export interface RuntimeParameter {
|
|
|
2840
2609
|
*
|
|
2841
2610
|
* To add an event listener use the corresponding
|
|
2842
2611
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
2843
|
-
*
|
|
2844
2612
|
* @example
|
|
2845
2613
|
* ```js
|
|
2846
2614
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2858,7 +2626,6 @@ export interface RuntimeParameter {
|
|
|
2858
2626
|
export declare enum EmbedEvent {
|
|
2859
2627
|
/**
|
|
2860
2628
|
* Rendering has initialized.
|
|
2861
|
-
*
|
|
2862
2629
|
* @example
|
|
2863
2630
|
*```js
|
|
2864
2631
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -2872,9 +2639,7 @@ export declare enum EmbedEvent {
|
|
|
2872
2639
|
Init = "init",
|
|
2873
2640
|
/**
|
|
2874
2641
|
* Authentication has either succeeded or failed.
|
|
2875
|
-
*
|
|
2876
2642
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2877
|
-
*
|
|
2878
2643
|
* @example
|
|
2879
2644
|
*```js
|
|
2880
2645
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -2886,9 +2651,7 @@ export declare enum EmbedEvent {
|
|
|
2886
2651
|
AuthInit = "authInit",
|
|
2887
2652
|
/**
|
|
2888
2653
|
* The embed object container has loaded.
|
|
2889
|
-
*
|
|
2890
2654
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2891
|
-
*
|
|
2892
2655
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2893
2656
|
* @example
|
|
2894
2657
|
*```js
|
|
@@ -2902,9 +2665,7 @@ export declare enum EmbedEvent {
|
|
|
2902
2665
|
Load = "load",
|
|
2903
2666
|
/**
|
|
2904
2667
|
* Data pertaining to answer or Liveboard is received
|
|
2905
|
-
*
|
|
2906
2668
|
* @return data - The answer or Liveboard data
|
|
2907
|
-
*
|
|
2908
2669
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2909
2670
|
* @example
|
|
2910
2671
|
*```js
|
|
@@ -2917,13 +2678,11 @@ export declare enum EmbedEvent {
|
|
|
2917
2678
|
Data = "data",
|
|
2918
2679
|
/**
|
|
2919
2680
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2920
|
-
*
|
|
2921
2681
|
* @hidden
|
|
2922
2682
|
*/
|
|
2923
2683
|
FiltersChanged = "filtersChanged",
|
|
2924
2684
|
/**
|
|
2925
2685
|
* Search query has been updated by the user.
|
|
2926
|
-
*
|
|
2927
2686
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2928
2687
|
* @example
|
|
2929
2688
|
*```js
|
|
@@ -2933,9 +2692,7 @@ export declare enum EmbedEvent {
|
|
|
2933
2692
|
QueryChanged = "queryChanged",
|
|
2934
2693
|
/**
|
|
2935
2694
|
* A drill-down operation has been performed.
|
|
2936
|
-
*
|
|
2937
2695
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2938
|
-
*
|
|
2939
2696
|
* @returns additionalFilters - Any additional filters applied
|
|
2940
2697
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2941
2698
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
@@ -2972,9 +2729,7 @@ export declare enum EmbedEvent {
|
|
|
2972
2729
|
Drilldown = "drillDown",
|
|
2973
2730
|
/**
|
|
2974
2731
|
* One or more data sources have been selected.
|
|
2975
|
-
*
|
|
2976
2732
|
* @returns dataSourceIds - the list of data sources
|
|
2977
|
-
*
|
|
2978
2733
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2979
2734
|
* @example
|
|
2980
2735
|
* ```js
|
|
@@ -2986,7 +2741,6 @@ export declare enum EmbedEvent {
|
|
|
2986
2741
|
DataSourceSelected = "dataSourceSelected",
|
|
2987
2742
|
/**
|
|
2988
2743
|
* One or more data columns have been selected.
|
|
2989
|
-
*
|
|
2990
2744
|
* @returns columnIds - the list of columns
|
|
2991
2745
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2992
2746
|
* @example
|
|
@@ -2999,11 +2753,9 @@ export declare enum EmbedEvent {
|
|
|
2999
2753
|
AddRemoveColumns = "addRemoveColumns",
|
|
3000
2754
|
/**
|
|
3001
2755
|
* A custom action has been triggered.
|
|
3002
|
-
*
|
|
3003
2756
|
* @returns actionId - ID of the custom action
|
|
3004
2757
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
3005
2758
|
* Answer or Liveboard data
|
|
3006
|
-
*
|
|
3007
2759
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3008
2760
|
* @example
|
|
3009
2761
|
* ```js
|
|
@@ -3018,7 +2770,6 @@ export declare enum EmbedEvent {
|
|
|
3018
2770
|
CustomAction = "customAction",
|
|
3019
2771
|
/**
|
|
3020
2772
|
* Listen to double click actions on a visualization.
|
|
3021
|
-
*
|
|
3022
2773
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
3023
2774
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
3024
2775
|
* @example
|
|
@@ -3031,7 +2782,6 @@ export declare enum EmbedEvent {
|
|
|
3031
2782
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
3032
2783
|
/**
|
|
3033
2784
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
3034
|
-
*
|
|
3035
2785
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
3036
2786
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3037
2787
|
* @important
|
|
@@ -3052,17 +2802,15 @@ export declare enum EmbedEvent {
|
|
|
3052
2802
|
/**
|
|
3053
2803
|
* An error has occurred. This event is fired for the following error types:
|
|
3054
2804
|
*
|
|
3055
|
-
*
|
|
3056
|
-
*
|
|
3057
|
-
*
|
|
3058
|
-
*
|
|
3059
|
-
*
|
|
3060
|
-
*
|
|
3061
|
-
*
|
|
3062
|
-
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
2805
|
+
* `API` - API call failure error.
|
|
2806
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2807
|
+
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2808
|
+
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
2809
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
2810
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
3063
2811
|
*
|
|
2812
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
3064
2813
|
* @returns error - An error object or message
|
|
3065
|
-
*
|
|
3066
2814
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3067
2815
|
* @example
|
|
3068
2816
|
* ```js
|
|
@@ -3087,11 +2835,8 @@ export declare enum EmbedEvent {
|
|
|
3087
2835
|
Error = "Error",
|
|
3088
2836
|
/**
|
|
3089
2837
|
* The embedded object has sent an alert.
|
|
3090
|
-
*
|
|
3091
2838
|
* @returns alert - An alert object
|
|
3092
|
-
*
|
|
3093
2839
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3094
|
-
*
|
|
3095
2840
|
* @example
|
|
3096
2841
|
* ```js
|
|
3097
2842
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -3100,9 +2845,7 @@ export declare enum EmbedEvent {
|
|
|
3100
2845
|
Alert = "alert",
|
|
3101
2846
|
/**
|
|
3102
2847
|
* The ThoughtSpot auth session has expired.
|
|
3103
|
-
*
|
|
3104
2848
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3105
|
-
*
|
|
3106
2849
|
* @example
|
|
3107
2850
|
*```js
|
|
3108
2851
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -3115,26 +2858,22 @@ export declare enum EmbedEvent {
|
|
|
3115
2858
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3116
2859
|
/**
|
|
3117
2860
|
* ThoughtSpot failed to validate the auth session.
|
|
3118
|
-
*
|
|
3119
2861
|
* @hidden
|
|
3120
2862
|
*/
|
|
3121
2863
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
3122
2864
|
/**
|
|
3123
2865
|
* ThoughtSpot failed to validate the auth session.
|
|
3124
|
-
*
|
|
3125
2866
|
* @hidden
|
|
3126
2867
|
*/
|
|
3127
2868
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
3128
2869
|
/**
|
|
3129
2870
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
3130
|
-
*
|
|
3131
2871
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
3132
2872
|
* @hidden
|
|
3133
2873
|
*/
|
|
3134
2874
|
EmbedHeight = "EMBED_HEIGHT",
|
|
3135
2875
|
/**
|
|
3136
2876
|
* The center of visible iframe viewport is calculated.
|
|
3137
|
-
*
|
|
3138
2877
|
* @returns data - The center of the visible Iframe viewport.
|
|
3139
2878
|
* @hidden
|
|
3140
2879
|
*/
|
|
@@ -3142,7 +2881,6 @@ export declare enum EmbedEvent {
|
|
|
3142
2881
|
/**
|
|
3143
2882
|
* Emitted when the **Get Data** action is initiated.
|
|
3144
2883
|
* Applicable to `SearchBarEmbed` only.
|
|
3145
|
-
*
|
|
3146
2884
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3147
2885
|
* @example
|
|
3148
2886
|
*```js
|
|
@@ -3155,7 +2893,6 @@ export declare enum EmbedEvent {
|
|
|
3155
2893
|
GetDataClick = "getDataClick",
|
|
3156
2894
|
/**
|
|
3157
2895
|
* Detects the route change.
|
|
3158
|
-
*
|
|
3159
2896
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3160
2897
|
* @example
|
|
3161
2898
|
*```js
|
|
@@ -3166,7 +2903,6 @@ export declare enum EmbedEvent {
|
|
|
3166
2903
|
RouteChange = "ROUTE_CHANGE",
|
|
3167
2904
|
/**
|
|
3168
2905
|
* The v1 event type for Data
|
|
3169
|
-
*
|
|
3170
2906
|
* @hidden
|
|
3171
2907
|
*/
|
|
3172
2908
|
V1Data = "exportVizDataToParent",
|
|
@@ -3174,7 +2910,6 @@ export declare enum EmbedEvent {
|
|
|
3174
2910
|
* Emitted when the embed does not have cookie access. This happens
|
|
3175
2911
|
* when Safari and other Web browsers block third-party cookies
|
|
3176
2912
|
* are blocked by default. `NoCookieAccess` can trigger
|
|
3177
|
-
*
|
|
3178
2913
|
* @example
|
|
3179
2914
|
*```js
|
|
3180
2915
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -3184,14 +2919,12 @@ export declare enum EmbedEvent {
|
|
|
3184
2919
|
NoCookieAccess = "noCookieAccess",
|
|
3185
2920
|
/**
|
|
3186
2921
|
* Emitted when SAML is complete
|
|
3187
|
-
*
|
|
3188
2922
|
* @private
|
|
3189
2923
|
* @hidden
|
|
3190
2924
|
*/
|
|
3191
2925
|
SAMLComplete = "samlComplete",
|
|
3192
2926
|
/**
|
|
3193
2927
|
* Emitted when any modal is opened in the app
|
|
3194
|
-
*
|
|
3195
2928
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3196
2929
|
* @example
|
|
3197
2930
|
*```js
|
|
@@ -3203,7 +2936,6 @@ export declare enum EmbedEvent {
|
|
|
3203
2936
|
DialogOpen = "dialog-open",
|
|
3204
2937
|
/**
|
|
3205
2938
|
* Emitted when any modal is closed in the app
|
|
3206
|
-
*
|
|
3207
2939
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3208
2940
|
* @example
|
|
3209
2941
|
*```js
|
|
@@ -3217,7 +2949,6 @@ export declare enum EmbedEvent {
|
|
|
3217
2949
|
* Emitted when the Liveboard shell loads.
|
|
3218
2950
|
* You can use this event as a hook to trigger
|
|
3219
2951
|
* other events on the rendered Liveboard.
|
|
3220
|
-
*
|
|
3221
2952
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3222
2953
|
* @example
|
|
3223
2954
|
*```js
|
|
@@ -3238,7 +2969,6 @@ export declare enum EmbedEvent {
|
|
|
3238
2969
|
LiveboardRendered = "PinboardRendered",
|
|
3239
2970
|
/**
|
|
3240
2971
|
* Emits all events.
|
|
3241
|
-
*
|
|
3242
2972
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3243
2973
|
* @example
|
|
3244
2974
|
*```js
|
|
@@ -3250,7 +2980,6 @@ export declare enum EmbedEvent {
|
|
|
3250
2980
|
ALL = "*",
|
|
3251
2981
|
/**
|
|
3252
2982
|
* Emitted when an Answer is saved in the app
|
|
3253
|
-
*
|
|
3254
2983
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3255
2984
|
* @example
|
|
3256
2985
|
*```js
|
|
@@ -3274,7 +3003,6 @@ export declare enum EmbedEvent {
|
|
|
3274
3003
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3275
3004
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3276
3005
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
3277
|
-
*
|
|
3278
3006
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3279
3007
|
* @example
|
|
3280
3008
|
*```js
|
|
@@ -3286,7 +3014,6 @@ export declare enum EmbedEvent {
|
|
|
3286
3014
|
Download = "download",
|
|
3287
3015
|
/**
|
|
3288
3016
|
* Emitted when the download action is triggered on an answer
|
|
3289
|
-
*
|
|
3290
3017
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3291
3018
|
* @example
|
|
3292
3019
|
*```js
|
|
@@ -3301,7 +3028,6 @@ export declare enum EmbedEvent {
|
|
|
3301
3028
|
DownloadAsPng = "downloadAsPng",
|
|
3302
3029
|
/**
|
|
3303
3030
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
3304
|
-
*
|
|
3305
3031
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3306
3032
|
* @example
|
|
3307
3033
|
*```js
|
|
@@ -3316,7 +3042,6 @@ export declare enum EmbedEvent {
|
|
|
3316
3042
|
DownloadAsPdf = "downloadAsPdf",
|
|
3317
3043
|
/**
|
|
3318
3044
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
3319
|
-
*
|
|
3320
3045
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3321
3046
|
* @example
|
|
3322
3047
|
*```js
|
|
@@ -3331,7 +3056,6 @@ export declare enum EmbedEvent {
|
|
|
3331
3056
|
DownloadAsCsv = "downloadAsCsv",
|
|
3332
3057
|
/**
|
|
3333
3058
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
3334
|
-
*
|
|
3335
3059
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3336
3060
|
* @example
|
|
3337
3061
|
*```js
|
|
@@ -3346,7 +3070,6 @@ export declare enum EmbedEvent {
|
|
|
3346
3070
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3347
3071
|
/**
|
|
3348
3072
|
* Emitted when an Answer is deleted in the app
|
|
3349
|
-
*
|
|
3350
3073
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3351
3074
|
* @example
|
|
3352
3075
|
*```js
|
|
@@ -3361,7 +3084,6 @@ export declare enum EmbedEvent {
|
|
|
3361
3084
|
AnswerDelete = "answerDelete",
|
|
3362
3085
|
/**
|
|
3363
3086
|
* Emitted when an answer is pinned to a Liveboard
|
|
3364
|
-
*
|
|
3365
3087
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3366
3088
|
* @example
|
|
3367
3089
|
*```js
|
|
@@ -3380,7 +3102,6 @@ export declare enum EmbedEvent {
|
|
|
3380
3102
|
Pin = "pin",
|
|
3381
3103
|
/**
|
|
3382
3104
|
* Emitted when SpotIQ analysis is triggered
|
|
3383
|
-
*
|
|
3384
3105
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3385
3106
|
* @example
|
|
3386
3107
|
*```js
|
|
@@ -3399,7 +3120,6 @@ export declare enum EmbedEvent {
|
|
|
3399
3120
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3400
3121
|
/**
|
|
3401
3122
|
* Emitted when a user shares an object with another user or group
|
|
3402
|
-
*
|
|
3403
3123
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3404
3124
|
* @example
|
|
3405
3125
|
*```js
|
|
@@ -3419,7 +3139,6 @@ export declare enum EmbedEvent {
|
|
|
3419
3139
|
/**
|
|
3420
3140
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
3421
3141
|
* data on a chart or table.
|
|
3422
|
-
*
|
|
3423
3142
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3424
3143
|
* @example
|
|
3425
3144
|
*```js
|
|
@@ -3432,7 +3151,6 @@ export declare enum EmbedEvent {
|
|
|
3432
3151
|
/**
|
|
3433
3152
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
3434
3153
|
* data on a chart or table
|
|
3435
|
-
*
|
|
3436
3154
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3437
3155
|
* @example
|
|
3438
3156
|
*```js
|
|
@@ -3444,7 +3162,6 @@ export declare enum EmbedEvent {
|
|
|
3444
3162
|
DrillExclude = "context-menu-item-exclude",
|
|
3445
3163
|
/**
|
|
3446
3164
|
* Emitted when a column value is copied in the embedded app.
|
|
3447
|
-
*
|
|
3448
3165
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3449
3166
|
* @example
|
|
3450
3167
|
*```js
|
|
@@ -3457,7 +3174,6 @@ export declare enum EmbedEvent {
|
|
|
3457
3174
|
/**
|
|
3458
3175
|
* Emitted when a user clicks the **Update TML** action on
|
|
3459
3176
|
* embedded Liveboard.
|
|
3460
|
-
*
|
|
3461
3177
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3462
3178
|
* @example
|
|
3463
3179
|
*```js
|
|
@@ -3469,7 +3185,6 @@ export declare enum EmbedEvent {
|
|
|
3469
3185
|
/**
|
|
3470
3186
|
* Emitted when a user clicks the **Edit TML** action
|
|
3471
3187
|
* on an embedded Liveboard.
|
|
3472
|
-
*
|
|
3473
3188
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3474
3189
|
* @example
|
|
3475
3190
|
*```js
|
|
@@ -3482,7 +3197,6 @@ export declare enum EmbedEvent {
|
|
|
3482
3197
|
/**
|
|
3483
3198
|
* Emitted when the **Export TML** action is triggered on an
|
|
3484
3199
|
* an embedded object in the app
|
|
3485
|
-
*
|
|
3486
3200
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3487
3201
|
* @example
|
|
3488
3202
|
*```js
|
|
@@ -3497,7 +3211,6 @@ export declare enum EmbedEvent {
|
|
|
3497
3211
|
ExportTML = "exportTSL",
|
|
3498
3212
|
/**
|
|
3499
3213
|
* Emitted when an Answer is saved as a View.
|
|
3500
|
-
*
|
|
3501
3214
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3502
3215
|
* @example
|
|
3503
3216
|
*```js
|
|
@@ -3509,7 +3222,6 @@ export declare enum EmbedEvent {
|
|
|
3509
3222
|
SaveAsView = "saveAsView",
|
|
3510
3223
|
/**
|
|
3511
3224
|
* Emitted when the user creates a copy of an Answer
|
|
3512
|
-
*
|
|
3513
3225
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3514
3226
|
* @example
|
|
3515
3227
|
*```js
|
|
@@ -3524,7 +3236,6 @@ export declare enum EmbedEvent {
|
|
|
3524
3236
|
CopyAEdit = "copyAEdit",
|
|
3525
3237
|
/**
|
|
3526
3238
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
3527
|
-
*
|
|
3528
3239
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3529
3240
|
* @example
|
|
3530
3241
|
*```js
|
|
@@ -3536,7 +3247,6 @@ export declare enum EmbedEvent {
|
|
|
3536
3247
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3537
3248
|
/**
|
|
3538
3249
|
* Emitted when an answer is switched to a chart or table view.
|
|
3539
|
-
*
|
|
3540
3250
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3541
3251
|
* @example
|
|
3542
3252
|
*```js
|
|
@@ -3548,13 +3258,11 @@ export declare enum EmbedEvent {
|
|
|
3548
3258
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3549
3259
|
/**
|
|
3550
3260
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
3551
|
-
*
|
|
3552
3261
|
* @hidden
|
|
3553
3262
|
*/
|
|
3554
3263
|
APP_INIT = "appInit",
|
|
3555
3264
|
/**
|
|
3556
3265
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3557
|
-
*
|
|
3558
3266
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3559
3267
|
* @example
|
|
3560
3268
|
*```js
|
|
@@ -3566,7 +3274,6 @@ export declare enum EmbedEvent {
|
|
|
3566
3274
|
LiveboardInfo = "pinboardInfo",
|
|
3567
3275
|
/**
|
|
3568
3276
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3569
|
-
*
|
|
3570
3277
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3571
3278
|
* @example
|
|
3572
3279
|
*```js
|
|
@@ -3578,7 +3285,6 @@ export declare enum EmbedEvent {
|
|
|
3578
3285
|
AddToFavorites = "addToFavorites",
|
|
3579
3286
|
/**
|
|
3580
3287
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3581
|
-
*
|
|
3582
3288
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3583
3289
|
* @example
|
|
3584
3290
|
*```js
|
|
@@ -3590,7 +3296,6 @@ export declare enum EmbedEvent {
|
|
|
3590
3296
|
Schedule = "subscription",
|
|
3591
3297
|
/**
|
|
3592
3298
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3593
|
-
*
|
|
3594
3299
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3595
3300
|
* @example
|
|
3596
3301
|
*```js
|
|
@@ -3602,7 +3307,6 @@ export declare enum EmbedEvent {
|
|
|
3602
3307
|
Edit = "edit",
|
|
3603
3308
|
/**
|
|
3604
3309
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3605
|
-
*
|
|
3606
3310
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3607
3311
|
* @example
|
|
3608
3312
|
*```js
|
|
@@ -3614,7 +3318,6 @@ export declare enum EmbedEvent {
|
|
|
3614
3318
|
MakeACopy = "makeACopy",
|
|
3615
3319
|
/**
|
|
3616
3320
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3617
|
-
*
|
|
3618
3321
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3619
3322
|
* @example
|
|
3620
3323
|
*```js
|
|
@@ -3630,7 +3333,6 @@ export declare enum EmbedEvent {
|
|
|
3630
3333
|
Present = "present",
|
|
3631
3334
|
/**
|
|
3632
3335
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3633
|
-
*
|
|
3634
3336
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3635
3337
|
* @example
|
|
3636
3338
|
*```js
|
|
@@ -3641,7 +3343,6 @@ export declare enum EmbedEvent {
|
|
|
3641
3343
|
Delete = "delete",
|
|
3642
3344
|
/**
|
|
3643
3345
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3644
|
-
*
|
|
3645
3346
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3646
3347
|
* @example
|
|
3647
3348
|
*```js
|
|
@@ -3651,7 +3352,6 @@ export declare enum EmbedEvent {
|
|
|
3651
3352
|
SchedulesList = "schedule-list",
|
|
3652
3353
|
/**
|
|
3653
3354
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3654
|
-
*
|
|
3655
3355
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3656
3356
|
* @example
|
|
3657
3357
|
*```js
|
|
@@ -3661,7 +3361,6 @@ export declare enum EmbedEvent {
|
|
|
3661
3361
|
Cancel = "cancel",
|
|
3662
3362
|
/**
|
|
3663
3363
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3664
|
-
*
|
|
3665
3364
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3666
3365
|
* @example
|
|
3667
3366
|
*```js
|
|
@@ -3672,7 +3371,6 @@ export declare enum EmbedEvent {
|
|
|
3672
3371
|
Explore = "explore",
|
|
3673
3372
|
/**
|
|
3674
3373
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3675
|
-
*
|
|
3676
3374
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3677
3375
|
* @example
|
|
3678
3376
|
*```js
|
|
@@ -3683,7 +3381,6 @@ export declare enum EmbedEvent {
|
|
|
3683
3381
|
CopyLink = "embedDocument",
|
|
3684
3382
|
/**
|
|
3685
3383
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3686
|
-
*
|
|
3687
3384
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3688
3385
|
* @example
|
|
3689
3386
|
*```js
|
|
@@ -3694,7 +3391,6 @@ export declare enum EmbedEvent {
|
|
|
3694
3391
|
CrossFilterChanged = "cross-filter-changed",
|
|
3695
3392
|
/**
|
|
3696
3393
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3697
|
-
*
|
|
3698
3394
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3699
3395
|
* @example
|
|
3700
3396
|
*```js
|
|
@@ -3706,7 +3402,6 @@ export declare enum EmbedEvent {
|
|
|
3706
3402
|
VizPointRightClick = "vizPointRightClick",
|
|
3707
3403
|
/**
|
|
3708
3404
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
3709
|
-
*
|
|
3710
3405
|
* @hidden
|
|
3711
3406
|
*/
|
|
3712
3407
|
InsertIntoSlide = "insertInToSlide",
|
|
@@ -3714,7 +3409,6 @@ export declare enum EmbedEvent {
|
|
|
3714
3409
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3715
3410
|
* Returns filter type and name, column name and ID, and runtime
|
|
3716
3411
|
* filter details.
|
|
3717
|
-
*
|
|
3718
3412
|
* @example
|
|
3719
3413
|
*
|
|
3720
3414
|
*```js
|
|
@@ -3727,32 +3421,27 @@ export declare enum EmbedEvent {
|
|
|
3727
3421
|
FilterChanged = "filterChanged",
|
|
3728
3422
|
/**
|
|
3729
3423
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
3730
|
-
*
|
|
3731
3424
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3732
3425
|
*/
|
|
3733
3426
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3734
3427
|
/**
|
|
3735
3428
|
* Emitted when a user selects a data source.
|
|
3736
|
-
*
|
|
3737
3429
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3738
3430
|
*/
|
|
3739
3431
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3740
3432
|
/**
|
|
3741
3433
|
* Emitted when a user updates a connection on the **Data** page
|
|
3742
|
-
*
|
|
3743
3434
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3744
3435
|
*/
|
|
3745
3436
|
UpdateConnection = "updateConnection",
|
|
3746
3437
|
/**
|
|
3747
3438
|
* Emitted when a user updates a connection on the **Data** page
|
|
3748
|
-
*
|
|
3749
3439
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3750
3440
|
*/
|
|
3751
3441
|
CreateConnection = "createConnection",
|
|
3752
3442
|
/**
|
|
3753
3443
|
* Emitted when name, status (private or public) or filter values of a
|
|
3754
3444
|
* Personalised view is updated.
|
|
3755
|
-
*
|
|
3756
3445
|
* @returns viewName: string
|
|
3757
3446
|
* @returns viewId: string
|
|
3758
3447
|
* @returns liveboardId: string
|
|
@@ -3762,7 +3451,6 @@ export declare enum EmbedEvent {
|
|
|
3762
3451
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3763
3452
|
/**
|
|
3764
3453
|
* Emitted when a Personalised view is saved.
|
|
3765
|
-
*
|
|
3766
3454
|
* @returns viewName: string
|
|
3767
3455
|
* @returns viewId: string
|
|
3768
3456
|
* @returns liveboardId: string
|
|
@@ -3772,7 +3460,6 @@ export declare enum EmbedEvent {
|
|
|
3772
3460
|
SavePersonalisedView = "savePersonalisedView",
|
|
3773
3461
|
/**
|
|
3774
3462
|
* Emitted when a Liveboard is reset.
|
|
3775
|
-
*
|
|
3776
3463
|
* @returns viewName: string
|
|
3777
3464
|
* @returns viewId: string
|
|
3778
3465
|
* @returns liveboardId: string
|
|
@@ -3782,7 +3469,6 @@ export declare enum EmbedEvent {
|
|
|
3782
3469
|
ResetLiveboard = "resetLiveboard",
|
|
3783
3470
|
/**
|
|
3784
3471
|
* Emitted when a PersonalisedView is deleted.
|
|
3785
|
-
*
|
|
3786
3472
|
* @returns views: string[]
|
|
3787
3473
|
* @returns liveboardId: string
|
|
3788
3474
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -3790,13 +3476,11 @@ export declare enum EmbedEvent {
|
|
|
3790
3476
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3791
3477
|
/**
|
|
3792
3478
|
* Emitted when a user creates a new worksheet
|
|
3793
|
-
*
|
|
3794
3479
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3795
3480
|
*/
|
|
3796
3481
|
CreateWorksheet = "createWorksheet",
|
|
3797
3482
|
/**
|
|
3798
3483
|
* Emitted when Ask Sage is initialized.
|
|
3799
|
-
*
|
|
3800
3484
|
* @returns viewName: string
|
|
3801
3485
|
* @returns viewId: string
|
|
3802
3486
|
* @returns liveboardId: string
|
|
@@ -3806,7 +3490,6 @@ export declare enum EmbedEvent {
|
|
|
3806
3490
|
AskSageInit = "AskSageInit",
|
|
3807
3491
|
/**
|
|
3808
3492
|
* Emitted when a LB/viz is renamed
|
|
3809
|
-
*
|
|
3810
3493
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3811
3494
|
*/
|
|
3812
3495
|
Rename = "rename",
|
|
@@ -3830,7 +3513,6 @@ export declare enum EmbedEvent {
|
|
|
3830
3513
|
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
3831
3514
|
/**
|
|
3832
3515
|
* Emitted when runtime parameters changes
|
|
3833
|
-
*
|
|
3834
3516
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3835
3517
|
*/
|
|
3836
3518
|
ParameterChanged = "ParameterChanged"
|
|
@@ -3842,7 +3524,6 @@ export declare enum EmbedEvent {
|
|
|
3842
3524
|
* To trigger an event use the corresponding
|
|
3843
3525
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
3844
3526
|
* SearchEmbed.trigger} method.
|
|
3845
|
-
*
|
|
3846
3527
|
* @example
|
|
3847
3528
|
* ```js
|
|
3848
3529
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3863,7 +3544,6 @@ export declare enum HostEvent {
|
|
|
3863
3544
|
* the search query string.
|
|
3864
3545
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3865
3546
|
* Includes the following properties:
|
|
3866
|
-
*
|
|
3867
3547
|
* @param - `searchQuery` - query string with search tokens
|
|
3868
3548
|
* @param - `dataSources` - Data source GUID to Search on
|
|
3869
3549
|
* - Although an array, only a single source
|
|
@@ -3882,7 +3562,6 @@ export declare enum HostEvent {
|
|
|
3882
3562
|
/**
|
|
3883
3563
|
* Triggers a drill on certain points of the specified column
|
|
3884
3564
|
* Includes the following properties:
|
|
3885
|
-
*
|
|
3886
3565
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
3887
3566
|
* to drill to. For example, { selectedPoints: []}
|
|
3888
3567
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -3932,19 +3611,16 @@ export declare enum HostEvent {
|
|
|
3932
3611
|
DrillDown = "triggerDrillDown",
|
|
3933
3612
|
/**
|
|
3934
3613
|
* Apply filters
|
|
3935
|
-
*
|
|
3936
3614
|
* @hidden
|
|
3937
3615
|
*/
|
|
3938
3616
|
Filter = "filter",
|
|
3939
3617
|
/**
|
|
3940
3618
|
* Reload the answer or visualization
|
|
3941
|
-
*
|
|
3942
3619
|
* @hidden
|
|
3943
3620
|
*/
|
|
3944
3621
|
Reload = "reload",
|
|
3945
3622
|
/**
|
|
3946
3623
|
* Display specific visualizations on a Liveboard.
|
|
3947
|
-
*
|
|
3948
3624
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
3949
3625
|
* in this parameter will be hidden.
|
|
3950
3626
|
* @example
|
|
@@ -3958,7 +3634,6 @@ export declare enum HostEvent {
|
|
|
3958
3634
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
3959
3635
|
/**
|
|
3960
3636
|
* Set a Liveboard tab as an active tab.
|
|
3961
|
-
*
|
|
3962
3637
|
* @param - tabId - string of id of Tab to show
|
|
3963
3638
|
* @example
|
|
3964
3639
|
* ```js
|
|
@@ -3979,17 +3654,16 @@ export declare enum HostEvent {
|
|
|
3979
3654
|
* _String_. The name of the column to filter on.
|
|
3980
3655
|
*
|
|
3981
3656
|
* `operator`
|
|
3982
|
-
*
|
|
3983
|
-
*
|
|
3657
|
+
* Runtime filter operator to apply. For information,
|
|
3658
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
3984
3659
|
*
|
|
3985
3660
|
* `values`
|
|
3986
|
-
*
|
|
3987
|
-
*
|
|
3988
|
-
*
|
|
3989
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3990
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3991
|
-
* embedding (SageEmbed).
|
|
3661
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
3662
|
+
* operators such as BW and IN accept multiple operands.
|
|
3992
3663
|
*
|
|
3664
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3665
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3666
|
+
* embedding (SageEmbed).
|
|
3993
3667
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
3994
3668
|
* @example
|
|
3995
3669
|
* ```js
|
|
@@ -4005,7 +3679,6 @@ export declare enum HostEvent {
|
|
|
4005
3679
|
/**
|
|
4006
3680
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4007
3681
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
4008
|
-
*
|
|
4009
3682
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4010
3683
|
* be a number; for example, `1`, `-1`.
|
|
4011
3684
|
* @example
|
|
@@ -4018,7 +3691,6 @@ export declare enum HostEvent {
|
|
|
4018
3691
|
/**
|
|
4019
3692
|
* Open the filter panel for a particular column.
|
|
4020
3693
|
* Works with Search and Liveboard embed.
|
|
4021
|
-
*
|
|
4022
3694
|
* @param - { columnId: string,
|
|
4023
3695
|
* name: string,
|
|
4024
3696
|
* type: INT64/CHAR/DATE,
|
|
@@ -4035,7 +3707,6 @@ export declare enum HostEvent {
|
|
|
4035
3707
|
OpenFilter = "openFilter",
|
|
4036
3708
|
/**
|
|
4037
3709
|
* Add columns to the current search query.
|
|
4038
|
-
*
|
|
4039
3710
|
* @param - { columnIds: string[] }
|
|
4040
3711
|
* @example
|
|
4041
3712
|
* ```js
|
|
@@ -4046,7 +3717,6 @@ export declare enum HostEvent {
|
|
|
4046
3717
|
AddColumns = "addColumns",
|
|
4047
3718
|
/**
|
|
4048
3719
|
* Remove a column from the current search query.
|
|
4049
|
-
*
|
|
4050
3720
|
* @param - { columnId: string }
|
|
4051
3721
|
* @example
|
|
4052
3722
|
* ```js
|
|
@@ -4061,7 +3731,6 @@ export declare enum HostEvent {
|
|
|
4061
3731
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
4062
3732
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
4063
3733
|
* sorting, toggling of legends, and data drill down.
|
|
4064
|
-
*
|
|
4065
3734
|
* @example
|
|
4066
3735
|
* ```js
|
|
4067
3736
|
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
@@ -4072,7 +3741,6 @@ export declare enum HostEvent {
|
|
|
4072
3741
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
4073
3742
|
/**
|
|
4074
3743
|
* Trigger the **Pin** action on an embedded object
|
|
4075
|
-
*
|
|
4076
3744
|
* @param - Liveboard embed takes the `vizId` as a
|
|
4077
3745
|
* key. Can be left undefined when embedding Search, full app, or
|
|
4078
3746
|
* a visualization.
|
|
@@ -4089,7 +3757,6 @@ export declare enum HostEvent {
|
|
|
4089
3757
|
/**
|
|
4090
3758
|
* Trigger the **Show Liveboard details** action
|
|
4091
3759
|
* on an embedded Liveboard.
|
|
4092
|
-
*
|
|
4093
3760
|
* @example
|
|
4094
3761
|
*```js
|
|
4095
3762
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -4099,7 +3766,6 @@ export declare enum HostEvent {
|
|
|
4099
3766
|
LiveboardInfo = "pinboardInfo",
|
|
4100
3767
|
/**
|
|
4101
3768
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
4102
|
-
*
|
|
4103
3769
|
* @example
|
|
4104
3770
|
* ```js
|
|
4105
3771
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -4109,7 +3775,6 @@ export declare enum HostEvent {
|
|
|
4109
3775
|
Schedule = "subscription",
|
|
4110
3776
|
/**
|
|
4111
3777
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
4112
|
-
*
|
|
4113
3778
|
* @example
|
|
4114
3779
|
* ```js
|
|
4115
3780
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -4120,20 +3785,16 @@ export declare enum HostEvent {
|
|
|
4120
3785
|
/**
|
|
4121
3786
|
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
4122
3787
|
* Answer.
|
|
4123
|
-
*
|
|
4124
3788
|
* @example
|
|
4125
3789
|
* ```js
|
|
4126
3790
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
4127
3791
|
* ```
|
|
4128
|
-
*
|
|
4129
3792
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4130
3793
|
*/
|
|
4131
3794
|
ExportTML = "exportTSL",
|
|
4132
3795
|
/**
|
|
4133
3796
|
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
4134
3797
|
* saved Answers in the full application embedding.
|
|
4135
|
-
*
|
|
4136
|
-
*
|
|
4137
3798
|
* @example
|
|
4138
3799
|
* ```js
|
|
4139
3800
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -4143,7 +3804,6 @@ export declare enum HostEvent {
|
|
|
4143
3804
|
EditTML = "editTSL",
|
|
4144
3805
|
/**
|
|
4145
3806
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
4146
|
-
*
|
|
4147
3807
|
* @example
|
|
4148
3808
|
* ```js
|
|
4149
3809
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -4157,7 +3817,6 @@ export declare enum HostEvent {
|
|
|
4157
3817
|
*
|
|
4158
3818
|
* **NOTE**: The **Download** > **PDF** action is available on
|
|
4159
3819
|
* visualizations and Answers if the data is in tabular format.
|
|
4160
|
-
*
|
|
4161
3820
|
* @example
|
|
4162
3821
|
* ```js
|
|
4163
3822
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -4168,7 +3827,6 @@ export declare enum HostEvent {
|
|
|
4168
3827
|
/**
|
|
4169
3828
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
4170
3829
|
* visualization page.
|
|
4171
|
-
*
|
|
4172
3830
|
* @example
|
|
4173
3831
|
* ```js
|
|
4174
3832
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -4184,7 +3842,6 @@ export declare enum HostEvent {
|
|
|
4184
3842
|
MakeACopy = "makeACopy",
|
|
4185
3843
|
/**
|
|
4186
3844
|
* Trigger the **Delete** action for a Liveboard.
|
|
4187
|
-
*
|
|
4188
3845
|
* @example
|
|
4189
3846
|
* ```js
|
|
4190
3847
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -4194,7 +3851,6 @@ export declare enum HostEvent {
|
|
|
4194
3851
|
Remove = "delete",
|
|
4195
3852
|
/**
|
|
4196
3853
|
* Trigger the **Explore** action on a visualization.
|
|
4197
|
-
*
|
|
4198
3854
|
* @param - an object with `vizId` as a key
|
|
4199
3855
|
* @example
|
|
4200
3856
|
* ```js
|
|
@@ -4205,7 +3861,6 @@ export declare enum HostEvent {
|
|
|
4205
3861
|
Explore = "explore",
|
|
4206
3862
|
/**
|
|
4207
3863
|
* Trigger the **Create alert** action on a visualization
|
|
4208
|
-
*
|
|
4209
3864
|
* @param - an object with `vizId` as a key
|
|
4210
3865
|
* @example
|
|
4211
3866
|
* ```js
|
|
@@ -4218,7 +3873,6 @@ export declare enum HostEvent {
|
|
|
4218
3873
|
CreateMonitor = "createMonitor",
|
|
4219
3874
|
/**
|
|
4220
3875
|
* Trigger the **Manage alerts** action on a visualization
|
|
4221
|
-
*
|
|
4222
3876
|
* @param - an object with `vizId` as a key
|
|
4223
3877
|
* @example
|
|
4224
3878
|
* ```js
|
|
@@ -4234,10 +3888,8 @@ export declare enum HostEvent {
|
|
|
4234
3888
|
* on a Liveboard.
|
|
4235
3889
|
*
|
|
4236
3890
|
* This event is not supported in visualization embed and search embed.
|
|
4237
|
-
*
|
|
4238
3891
|
* @param - object - To trigger the action for a specific visualization
|
|
4239
3892
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
4240
|
-
*
|
|
4241
3893
|
* @example
|
|
4242
3894
|
* ```js
|
|
4243
3895
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
@@ -4251,7 +3903,6 @@ export declare enum HostEvent {
|
|
|
4251
3903
|
Edit = "edit",
|
|
4252
3904
|
/**
|
|
4253
3905
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
4254
|
-
*
|
|
4255
3906
|
* @param - object - to trigger the action for a
|
|
4256
3907
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
4257
3908
|
* @example
|
|
@@ -4269,7 +3920,6 @@ export declare enum HostEvent {
|
|
|
4269
3920
|
CopyLink = "embedDocument",
|
|
4270
3921
|
/**
|
|
4271
3922
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
4272
|
-
*
|
|
4273
3923
|
* @param - object - to trigger the action for a specific visualization
|
|
4274
3924
|
* in Liveboard embed, pass in `vizId` as a key
|
|
4275
3925
|
* @example
|
|
@@ -4287,7 +3937,6 @@ export declare enum HostEvent {
|
|
|
4287
3937
|
Present = "present",
|
|
4288
3938
|
/**
|
|
4289
3939
|
* Get TML for the current search.
|
|
4290
|
-
*
|
|
4291
3940
|
* @example
|
|
4292
3941
|
* ```js
|
|
4293
3942
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
@@ -4302,7 +3951,6 @@ export declare enum HostEvent {
|
|
|
4302
3951
|
GetTML = "getTML",
|
|
4303
3952
|
/**
|
|
4304
3953
|
* Trigger the **Show underlying data** action on visualization or search
|
|
4305
|
-
*
|
|
4306
3954
|
* @param - an object with vizId as a key
|
|
4307
3955
|
* @example
|
|
4308
3956
|
* ```js
|
|
@@ -4322,7 +3970,6 @@ export declare enum HostEvent {
|
|
|
4322
3970
|
* Trigger the **Delete** action for a visualization
|
|
4323
3971
|
* in an embedded Liveboard, or a chart or table
|
|
4324
3972
|
* generated from Search.
|
|
4325
|
-
*
|
|
4326
3973
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
4327
3974
|
* Can be left empty if embedding Search or visualization.
|
|
4328
3975
|
* @example
|
|
@@ -4339,7 +3986,6 @@ export declare enum HostEvent {
|
|
|
4339
3986
|
/**
|
|
4340
3987
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
4341
3988
|
* or search.
|
|
4342
|
-
*
|
|
4343
3989
|
* @param - Liveboard embed takes `vizId` as a
|
|
4344
3990
|
* key. Can be left undefined when embedding Search or
|
|
4345
3991
|
* visualization.
|
|
@@ -4360,7 +4006,6 @@ export declare enum HostEvent {
|
|
|
4360
4006
|
/**
|
|
4361
4007
|
* Trigger the **Download** action on charts in
|
|
4362
4008
|
* the embedded view.
|
|
4363
|
-
*
|
|
4364
4009
|
* @example
|
|
4365
4010
|
* ```js
|
|
4366
4011
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -4377,7 +4022,6 @@ export declare enum HostEvent {
|
|
|
4377
4022
|
/**
|
|
4378
4023
|
* Trigger the **Download** > **PNG** action on
|
|
4379
4024
|
* charts in the embedded view.
|
|
4380
|
-
*
|
|
4381
4025
|
* @example
|
|
4382
4026
|
* ```js
|
|
4383
4027
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -4393,7 +4037,6 @@ export declare enum HostEvent {
|
|
|
4393
4037
|
/**
|
|
4394
4038
|
* Trigger the **Download** > **CSV** action on tables in
|
|
4395
4039
|
* the embedded view.
|
|
4396
|
-
*
|
|
4397
4040
|
* @example
|
|
4398
4041
|
* ```js
|
|
4399
4042
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -4411,7 +4054,6 @@ export declare enum HostEvent {
|
|
|
4411
4054
|
/**
|
|
4412
4055
|
* Trigger the **Download** > **XLSX** action on tables
|
|
4413
4056
|
* in the embedded view.
|
|
4414
|
-
*
|
|
4415
4057
|
* @example
|
|
4416
4058
|
* ```js
|
|
4417
4059
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -4429,7 +4071,6 @@ export declare enum HostEvent {
|
|
|
4429
4071
|
/**
|
|
4430
4072
|
* Trigger the **Share** action on an embedded
|
|
4431
4073
|
* Liveboard or Answer.
|
|
4432
|
-
*
|
|
4433
4074
|
* @example
|
|
4434
4075
|
* ```js
|
|
4435
4076
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -4443,7 +4084,6 @@ export declare enum HostEvent {
|
|
|
4443
4084
|
/**
|
|
4444
4085
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
4445
4086
|
* Saves the changes.
|
|
4446
|
-
*
|
|
4447
4087
|
* @example
|
|
4448
4088
|
* ```js
|
|
4449
4089
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -4457,7 +4097,6 @@ export declare enum HostEvent {
|
|
|
4457
4097
|
/**
|
|
4458
4098
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
4459
4099
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
4460
|
-
*
|
|
4461
4100
|
* @param - an object with `vizId` as a key
|
|
4462
4101
|
* @example
|
|
4463
4102
|
* ```js
|
|
@@ -4474,7 +4113,6 @@ export declare enum HostEvent {
|
|
|
4474
4113
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
4475
4114
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
4476
4115
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
4477
|
-
*
|
|
4478
4116
|
* @param - an object with vizId as a key
|
|
4479
4117
|
* @example
|
|
4480
4118
|
* ```js
|
|
@@ -4491,7 +4129,6 @@ export declare enum HostEvent {
|
|
|
4491
4129
|
* Trigger the **Manage pipelines** action on an embedded
|
|
4492
4130
|
* visualization or Answer.
|
|
4493
4131
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
4494
|
-
*
|
|
4495
4132
|
* @param - an object with `vizId` as a key
|
|
4496
4133
|
* @example
|
|
4497
4134
|
* ```js
|
|
@@ -4506,7 +4143,6 @@ export declare enum HostEvent {
|
|
|
4506
4143
|
ManagePipelines = "manage-pipeline",
|
|
4507
4144
|
/**
|
|
4508
4145
|
* Reset search operation on the Search or Answer page.
|
|
4509
|
-
*
|
|
4510
4146
|
* @example
|
|
4511
4147
|
* ```js
|
|
4512
4148
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -4520,19 +4156,16 @@ export declare enum HostEvent {
|
|
|
4520
4156
|
/**
|
|
4521
4157
|
* Get details of filters applied on the Liveboard.
|
|
4522
4158
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
4523
|
-
*
|
|
4524
4159
|
* @example
|
|
4525
4160
|
* ```js
|
|
4526
4161
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
4527
4162
|
* console.log('data', data);
|
|
4528
4163
|
* ```
|
|
4529
|
-
*
|
|
4530
4164
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4531
4165
|
*/
|
|
4532
4166
|
GetFilters = "getFilters",
|
|
4533
4167
|
/**
|
|
4534
4168
|
* Update one or several filters applied on a Liveboard.
|
|
4535
|
-
*
|
|
4536
4169
|
* @param - `filter`: a single filter object containing column name,
|
|
4537
4170
|
* filter operator, and values.
|
|
4538
4171
|
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
@@ -4549,7 +4182,6 @@ export declare enum HostEvent {
|
|
|
4549
4182
|
* `values` - An array of one or several values. The value definition on the
|
|
4550
4183
|
* data type you choose to filter on. For a complete list of supported data types,
|
|
4551
4184
|
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
4552
|
-
*
|
|
4553
4185
|
* @example
|
|
4554
4186
|
* ```js
|
|
4555
4187
|
*
|
|
@@ -4561,7 +4193,6 @@ export declare enum HostEvent {
|
|
|
4561
4193
|
* }
|
|
4562
4194
|
* });
|
|
4563
4195
|
* ```
|
|
4564
|
-
*
|
|
4565
4196
|
* @example
|
|
4566
4197
|
*
|
|
4567
4198
|
* ```js
|
|
@@ -4583,13 +4214,11 @@ export declare enum HostEvent {
|
|
|
4583
4214
|
* }]
|
|
4584
4215
|
* });
|
|
4585
4216
|
* ```
|
|
4586
|
-
*
|
|
4587
4217
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4588
4218
|
*/
|
|
4589
4219
|
UpdateFilters = "updateFilters",
|
|
4590
4220
|
/**
|
|
4591
4221
|
* Get tab details for the current Liveboard.
|
|
4592
|
-
*
|
|
4593
4222
|
* @example
|
|
4594
4223
|
* ```js
|
|
4595
4224
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -4603,7 +4232,6 @@ export declare enum HostEvent {
|
|
|
4603
4232
|
GetTabs = "getTabs",
|
|
4604
4233
|
/**
|
|
4605
4234
|
* Set the visible tabs on a Liveboard.
|
|
4606
|
-
*
|
|
4607
4235
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
4608
4236
|
* will be hidden.
|
|
4609
4237
|
* @example
|
|
@@ -4617,7 +4245,6 @@ export declare enum HostEvent {
|
|
|
4617
4245
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4618
4246
|
/**
|
|
4619
4247
|
* Set the hidden tabs on a Liveboard.
|
|
4620
|
-
*
|
|
4621
4248
|
* @param - an array of the IDs of the tabs to hide.
|
|
4622
4249
|
* The IDs not passed will be shown.
|
|
4623
4250
|
* @example
|
|
@@ -4631,7 +4258,6 @@ export declare enum HostEvent {
|
|
|
4631
4258
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4632
4259
|
/**
|
|
4633
4260
|
* Updates the search query string for Natural Language Search operations.
|
|
4634
|
-
*
|
|
4635
4261
|
* @param - `queryString`: Text string in Natural Language format
|
|
4636
4262
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
4637
4263
|
* @example
|
|
@@ -4646,7 +4272,6 @@ export declare enum HostEvent {
|
|
|
4646
4272
|
UpdateSageQuery = "updateSageQuery",
|
|
4647
4273
|
/**
|
|
4648
4274
|
* Get the answer session for a Search / Visualization.
|
|
4649
|
-
*
|
|
4650
4275
|
* @example
|
|
4651
4276
|
* ```js
|
|
4652
4277
|
* const {session} = await embed.trigger(
|
|
@@ -4659,7 +4284,6 @@ export declare enum HostEvent {
|
|
|
4659
4284
|
GetAnswerSession = "getAnswerSession",
|
|
4660
4285
|
/**
|
|
4661
4286
|
* Trigger Ask Sage for viz
|
|
4662
|
-
*
|
|
4663
4287
|
* @example
|
|
4664
4288
|
* ```js
|
|
4665
4289
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -4670,7 +4294,6 @@ export declare enum HostEvent {
|
|
|
4670
4294
|
AskSage = "AskSage",
|
|
4671
4295
|
/**
|
|
4672
4296
|
* Trigger UpdateCrossFilter for Liveboard
|
|
4673
|
-
*
|
|
4674
4297
|
* @example
|
|
4675
4298
|
* ```js
|
|
4676
4299
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4686,7 +4309,6 @@ export declare enum HostEvent {
|
|
|
4686
4309
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4687
4310
|
/**
|
|
4688
4311
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
4689
|
-
*
|
|
4690
4312
|
* @example
|
|
4691
4313
|
* ```js
|
|
4692
4314
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
@@ -4696,7 +4318,6 @@ export declare enum HostEvent {
|
|
|
4696
4318
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4697
4319
|
/**
|
|
4698
4320
|
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4699
|
-
*
|
|
4700
4321
|
* @example
|
|
4701
4322
|
* ```js
|
|
4702
4323
|
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
@@ -4837,7 +4458,6 @@ export declare enum Param {
|
|
|
4837
4458
|
* specific actions in the embedded view, define the Action
|
|
4838
4459
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
4839
4460
|
* or `hiddenActions` array.
|
|
4840
|
-
*
|
|
4841
4461
|
* @example
|
|
4842
4462
|
* ```js
|
|
4843
4463
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -4861,7 +4481,6 @@ export declare enum Action {
|
|
|
4861
4481
|
/**
|
|
4862
4482
|
* The **Save** action on an Answer or Liveboard.
|
|
4863
4483
|
* Allows users to save the changes.
|
|
4864
|
-
*
|
|
4865
4484
|
* @example
|
|
4866
4485
|
* ```js
|
|
4867
4486
|
* disabledActions: [Action.Save]
|
|
@@ -4880,7 +4499,6 @@ export declare enum Action {
|
|
|
4880
4499
|
* The **Save as View** action on the Answer
|
|
4881
4500
|
* page. Saves an Answer as a View object in the full
|
|
4882
4501
|
* application embedding mode.
|
|
4883
|
-
*
|
|
4884
4502
|
* @example
|
|
4885
4503
|
* ```js
|
|
4886
4504
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -4894,7 +4512,6 @@ export declare enum Action {
|
|
|
4894
4512
|
* visualizations in the embedded Liveboard view.
|
|
4895
4513
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
4896
4514
|
* Liveboards and visualizations.
|
|
4897
|
-
*
|
|
4898
4515
|
* @example
|
|
4899
4516
|
* ```js
|
|
4900
4517
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -4904,7 +4521,6 @@ export declare enum Action {
|
|
|
4904
4521
|
/**
|
|
4905
4522
|
* The **Copy and Edit** action on a Liveboard.
|
|
4906
4523
|
* This action is now replaced with `Action.MakeACopy`.
|
|
4907
|
-
*
|
|
4908
4524
|
* @example
|
|
4909
4525
|
* ```js
|
|
4910
4526
|
* disabledActions: [Action.EditACopy]
|
|
@@ -4914,7 +4530,6 @@ export declare enum Action {
|
|
|
4914
4530
|
/**
|
|
4915
4531
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
4916
4532
|
* Copies the visualization URL
|
|
4917
|
-
*
|
|
4918
4533
|
* @example
|
|
4919
4534
|
* ```js
|
|
4920
4535
|
* disabledActions: [Action.CopyLink]
|
|
@@ -4928,7 +4543,6 @@ export declare enum Action {
|
|
|
4928
4543
|
/**
|
|
4929
4544
|
* The **Schedule** menu action on a Liveboard.
|
|
4930
4545
|
* Allows scheduling a Liveboard notification.
|
|
4931
|
-
*
|
|
4932
4546
|
* @example
|
|
4933
4547
|
* ```js
|
|
4934
4548
|
* disabledActions: [Action.Schedule]
|
|
@@ -4938,7 +4552,6 @@ export declare enum Action {
|
|
|
4938
4552
|
/**
|
|
4939
4553
|
* The **Manage schedules** menu action on a Liveboard.
|
|
4940
4554
|
* Allows users to manage scheduled Liveboard jobs.
|
|
4941
|
-
*
|
|
4942
4555
|
* @example
|
|
4943
4556
|
* ```js
|
|
4944
4557
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -4948,7 +4561,6 @@ export declare enum Action {
|
|
|
4948
4561
|
/**
|
|
4949
4562
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
4950
4563
|
* Allows users to share an object with other users and groups.
|
|
4951
|
-
*
|
|
4952
4564
|
* @example
|
|
4953
4565
|
* ```js
|
|
4954
4566
|
* disabledActions: [Action.Share]
|
|
@@ -4958,7 +4570,6 @@ export declare enum Action {
|
|
|
4958
4570
|
/**
|
|
4959
4571
|
* The **Add filter** action on a Liveboard and Search page.
|
|
4960
4572
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
4961
|
-
*
|
|
4962
4573
|
* @example
|
|
4963
4574
|
* ```js
|
|
4964
4575
|
* disabledActions: [Action.AddFilter]
|
|
@@ -4969,7 +4580,6 @@ export declare enum Action {
|
|
|
4969
4580
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
4970
4581
|
* Allows to show action menu to add different objects (like
|
|
4971
4582
|
* formulas, parameters) in data panel v2.
|
|
4972
|
-
*
|
|
4973
4583
|
* @example
|
|
4974
4584
|
* ```js
|
|
4975
4585
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -4981,7 +4591,6 @@ export declare enum Action {
|
|
|
4981
4591
|
* Filter configuration options on a Liveboard and Search page.
|
|
4982
4592
|
* Allows configuring filter options when adding filters to a
|
|
4983
4593
|
* Liveboard or Answer.
|
|
4984
|
-
*
|
|
4985
4594
|
* @example
|
|
4986
4595
|
* ```js
|
|
4987
4596
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -4992,7 +4601,6 @@ export declare enum Action {
|
|
|
4992
4601
|
/**
|
|
4993
4602
|
* The **Choose sources** button on Search page.
|
|
4994
4603
|
* Allows selecting data sources for search queries.
|
|
4995
|
-
*
|
|
4996
4604
|
* @example
|
|
4997
4605
|
* ```js
|
|
4998
4606
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -5002,7 +4610,6 @@ export declare enum Action {
|
|
|
5002
4610
|
/**
|
|
5003
4611
|
* The **Create formula** action on a Search or Answer page.
|
|
5004
4612
|
* Allows adding formulas to an Answer.
|
|
5005
|
-
*
|
|
5006
4613
|
* @example
|
|
5007
4614
|
* ```js
|
|
5008
4615
|
* disabledActions: [Action.AddFormula]
|
|
@@ -5012,7 +4619,6 @@ export declare enum Action {
|
|
|
5012
4619
|
/**
|
|
5013
4620
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
5014
4621
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
5015
|
-
*
|
|
5016
4622
|
* @example
|
|
5017
4623
|
* ```js
|
|
5018
4624
|
* disabledActions: [Action.AddParameter]
|
|
@@ -5022,7 +4628,6 @@ export declare enum Action {
|
|
|
5022
4628
|
/**
|
|
5023
4629
|
* The **Add Column Set** action on a Answer.
|
|
5024
4630
|
* Allows adding column sets to a Answer.
|
|
5025
|
-
*
|
|
5026
4631
|
* @example
|
|
5027
4632
|
* ```js
|
|
5028
4633
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -5033,7 +4638,6 @@ export declare enum Action {
|
|
|
5033
4638
|
/**
|
|
5034
4639
|
* The **Add Query Set** action on a Answer.
|
|
5035
4640
|
* Allows adding query sets to a Answer.
|
|
5036
|
-
*
|
|
5037
4641
|
* @example
|
|
5038
4642
|
* ```js
|
|
5039
4643
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -5048,7 +4652,6 @@ export declare enum Action {
|
|
|
5048
4652
|
/**
|
|
5049
4653
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
5050
4654
|
* Answer page.
|
|
5051
|
-
*
|
|
5052
4655
|
* @example
|
|
5053
4656
|
* ```js
|
|
5054
4657
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -5071,7 +4674,6 @@ export declare enum Action {
|
|
|
5071
4674
|
/**
|
|
5072
4675
|
* The **Show underlying data** menu action on a visualization or
|
|
5073
4676
|
* Answer page.
|
|
5074
|
-
*
|
|
5075
4677
|
* @example
|
|
5076
4678
|
* ```js
|
|
5077
4679
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5082,7 +4684,6 @@ export declare enum Action {
|
|
|
5082
4684
|
* The **Download** menu action on Liveboard visualizations
|
|
5083
4685
|
* and Answers.
|
|
5084
4686
|
* Allows downloading a visualization or Answer.
|
|
5085
|
-
*
|
|
5086
4687
|
* @example
|
|
5087
4688
|
* ```js
|
|
5088
4689
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5093,7 +4694,6 @@ export declare enum Action {
|
|
|
5093
4694
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
5094
4695
|
* or Answer page.
|
|
5095
4696
|
* Downloads a visualization or Answer as a PNG file.
|
|
5096
|
-
*
|
|
5097
4697
|
* @example
|
|
5098
4698
|
* ```js
|
|
5099
4699
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5102,13 +4702,12 @@ export declare enum Action {
|
|
|
5102
4702
|
DownloadAsPng = "downloadAsPng",
|
|
5103
4703
|
/**
|
|
5104
4704
|
*
|
|
5105
|
-
*
|
|
5106
|
-
*
|
|
4705
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
4706
|
+
*visualization, or Answer as a PDF file.
|
|
5107
4707
|
*
|
|
5108
4708
|
*
|
|
5109
|
-
|
|
5110
|
-
*
|
|
5111
|
-
*
|
|
4709
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
4710
|
+
*visualizations and Answers if the data is in tabular format.
|
|
5112
4711
|
* @example
|
|
5113
4712
|
* ```js
|
|
5114
4713
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -5119,7 +4718,6 @@ export declare enum Action {
|
|
|
5119
4718
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
5120
4719
|
* or Answer page.
|
|
5121
4720
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5122
|
-
*
|
|
5123
4721
|
* @example
|
|
5124
4722
|
* ```js
|
|
5125
4723
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -5130,7 +4728,6 @@ export declare enum Action {
|
|
|
5130
4728
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
5131
4729
|
* or Answer page.
|
|
5132
4730
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5133
|
-
*
|
|
5134
4731
|
* @example
|
|
5135
4732
|
* ```js
|
|
5136
4733
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -5145,7 +4742,6 @@ export declare enum Action {
|
|
|
5145
4742
|
* The **Export TML** menu action on Liveboard, Answers
|
|
5146
4743
|
* Worksheets and Data Connections page.
|
|
5147
4744
|
* Exports an object as a TML file.
|
|
5148
|
-
*
|
|
5149
4745
|
* @example
|
|
5150
4746
|
* ```js
|
|
5151
4747
|
* disabledActions: [Action.ExportTML]
|
|
@@ -5155,7 +4751,6 @@ export declare enum Action {
|
|
|
5155
4751
|
/**
|
|
5156
4752
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
5157
4753
|
* Imports TML representation of ThoughtSpot objects.
|
|
5158
|
-
*
|
|
5159
4754
|
* @example
|
|
5160
4755
|
* ```js
|
|
5161
4756
|
* disabledActions: [Action.ImportTML]
|
|
@@ -5165,7 +4760,6 @@ export declare enum Action {
|
|
|
5165
4760
|
/**
|
|
5166
4761
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
5167
4762
|
* Update TML representation of ThoughtSpot objects.
|
|
5168
|
-
*
|
|
5169
4763
|
* @example
|
|
5170
4764
|
* ```js
|
|
5171
4765
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -5175,7 +4769,6 @@ export declare enum Action {
|
|
|
5175
4769
|
/**
|
|
5176
4770
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
5177
4771
|
* Opens the TML editor.
|
|
5178
|
-
*
|
|
5179
4772
|
* @example
|
|
5180
4773
|
* ```js
|
|
5181
4774
|
* disabledActions: [Action.EditTML]
|
|
@@ -5186,7 +4779,6 @@ export declare enum Action {
|
|
|
5186
4779
|
* The **Present** menu action for Liveboards and Answers.
|
|
5187
4780
|
* Allows presenting a Liveboard or visualization in
|
|
5188
4781
|
* slideshow mode.
|
|
5189
|
-
*
|
|
5190
4782
|
* @example
|
|
5191
4783
|
* ```js
|
|
5192
4784
|
* disabledActions: [Action.Present]
|
|
@@ -5196,7 +4788,6 @@ export declare enum Action {
|
|
|
5196
4788
|
/**
|
|
5197
4789
|
* The tile resize options in the visualization menu.
|
|
5198
4790
|
* Allows switching between different preset layouts.
|
|
5199
|
-
*
|
|
5200
4791
|
* @example
|
|
5201
4792
|
* ```js
|
|
5202
4793
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -5207,7 +4798,6 @@ export declare enum Action {
|
|
|
5207
4798
|
* The *Edit* action on the Liveboard page and in the
|
|
5208
4799
|
* visualization menu.
|
|
5209
4800
|
* Opens a Liveboard or visualization in edit mode.
|
|
5210
|
-
*
|
|
5211
4801
|
* @example
|
|
5212
4802
|
* ```js
|
|
5213
4803
|
* disabledActions: [Action.Edit]
|
|
@@ -5216,7 +4806,6 @@ export declare enum Action {
|
|
|
5216
4806
|
Edit = "edit",
|
|
5217
4807
|
/**
|
|
5218
4808
|
* The text edit option for Liveboard and visualization titles.
|
|
5219
|
-
*
|
|
5220
4809
|
* @example
|
|
5221
4810
|
* ```js
|
|
5222
4811
|
* disabledActions: [Action.EditTitle]
|
|
@@ -5226,7 +4815,6 @@ export declare enum Action {
|
|
|
5226
4815
|
/**
|
|
5227
4816
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
5228
4817
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
5229
|
-
*
|
|
5230
4818
|
* @example
|
|
5231
4819
|
* ```js
|
|
5232
4820
|
* disabledActions: [Action.Remove]
|
|
@@ -5258,7 +4846,6 @@ export declare enum Action {
|
|
|
5258
4846
|
* Displays details such as the name, description, and
|
|
5259
4847
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
5260
4848
|
* and update.
|
|
5261
|
-
*
|
|
5262
4849
|
* @example
|
|
5263
4850
|
* ```js
|
|
5264
4851
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -5276,7 +4863,6 @@ export declare enum Action {
|
|
|
5276
4863
|
/**
|
|
5277
4864
|
* The **Pin** menu action on an Answer or
|
|
5278
4865
|
* Search results page.
|
|
5279
|
-
*
|
|
5280
4866
|
* @example
|
|
5281
4867
|
* ```js
|
|
5282
4868
|
* disabledActions: [Action.Pin]
|
|
@@ -5289,7 +4875,6 @@ export declare enum Action {
|
|
|
5289
4875
|
AnalysisInfo = "analysisInfo",
|
|
5290
4876
|
/**
|
|
5291
4877
|
* The **Schedule** menu action on a Liveboard.
|
|
5292
|
-
*
|
|
5293
4878
|
* @example
|
|
5294
4879
|
* ```js
|
|
5295
4880
|
* disabledActions: [Action.Subscription]
|
|
@@ -5298,7 +4883,6 @@ export declare enum Action {
|
|
|
5298
4883
|
Subscription = "subscription",
|
|
5299
4884
|
/**
|
|
5300
4885
|
* The **Explore** action on Liveboard visualizations
|
|
5301
|
-
*
|
|
5302
4886
|
* @example
|
|
5303
4887
|
* ```js
|
|
5304
4888
|
* disabledActions: [Action.Explore]
|
|
@@ -5308,7 +4892,6 @@ export declare enum Action {
|
|
|
5308
4892
|
/**
|
|
5309
4893
|
* The action to include data points on a drilled-down Answer
|
|
5310
4894
|
* or visualization
|
|
5311
|
-
*
|
|
5312
4895
|
* @example
|
|
5313
4896
|
* ```js
|
|
5314
4897
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5318,7 +4901,6 @@ export declare enum Action {
|
|
|
5318
4901
|
/**
|
|
5319
4902
|
* The action to exclude data points on a drilled-down Answer
|
|
5320
4903
|
* or visualization
|
|
5321
|
-
*
|
|
5322
4904
|
* @example
|
|
5323
4905
|
* ```js
|
|
5324
4906
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5329,7 +4911,6 @@ export declare enum Action {
|
|
|
5329
4911
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
5330
4912
|
* or Liveboard.
|
|
5331
4913
|
* Copies the selected data point.
|
|
5332
|
-
*
|
|
5333
4914
|
* @example
|
|
5334
4915
|
* ```js
|
|
5335
4916
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -5347,7 +4928,6 @@ export declare enum Action {
|
|
|
5347
4928
|
* The **Drill down** menu action on Answers and Liveboard
|
|
5348
4929
|
* visualizations.
|
|
5349
4930
|
* Allows drilling down to a specific data point on a chart or table.
|
|
5350
|
-
*
|
|
5351
4931
|
* @example
|
|
5352
4932
|
* ```js
|
|
5353
4933
|
* disabledActions: [Action.DrillDown]
|
|
@@ -5357,7 +4937,6 @@ export declare enum Action {
|
|
|
5357
4937
|
/**
|
|
5358
4938
|
* The request access action on Liveboards.
|
|
5359
4939
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
5360
|
-
*
|
|
5361
4940
|
* @example
|
|
5362
4941
|
* ```js
|
|
5363
4942
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -5367,7 +4946,6 @@ export declare enum Action {
|
|
|
5367
4946
|
/**
|
|
5368
4947
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
5369
4948
|
* of the Answer page
|
|
5370
|
-
*
|
|
5371
4949
|
* @example
|
|
5372
4950
|
* ```js
|
|
5373
4951
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5377,7 +4955,6 @@ export declare enum Action {
|
|
|
5377
4955
|
/**
|
|
5378
4956
|
* The **Delete** action for Answers in the full application
|
|
5379
4957
|
* embedding mode.
|
|
5380
|
-
*
|
|
5381
4958
|
* @example
|
|
5382
4959
|
* ```js
|
|
5383
4960
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -5387,7 +4964,6 @@ export declare enum Action {
|
|
|
5387
4964
|
AnswerDelete = "onDeleteAnswer",
|
|
5388
4965
|
/**
|
|
5389
4966
|
* The Chart switcher icon on Answer and visualization pages.
|
|
5390
|
-
*
|
|
5391
4967
|
* @example
|
|
5392
4968
|
* ```js
|
|
5393
4969
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5397,7 +4973,6 @@ export declare enum Action {
|
|
|
5397
4973
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5398
4974
|
/**
|
|
5399
4975
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
5400
|
-
*
|
|
5401
4976
|
* @example
|
|
5402
4977
|
* ```js
|
|
5403
4978
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5407,7 +4982,6 @@ export declare enum Action {
|
|
|
5407
4982
|
AddToFavorites = "addToFavorites",
|
|
5408
4983
|
/**
|
|
5409
4984
|
* The edit icon on Liveboards (Classic experience).
|
|
5410
|
-
*
|
|
5411
4985
|
* @example
|
|
5412
4986
|
* ```js
|
|
5413
4987
|
* disabledActions: [Action.EditDetails]
|
|
@@ -5417,7 +4991,6 @@ export declare enum Action {
|
|
|
5417
4991
|
EditDetails = "editDetails",
|
|
5418
4992
|
/**
|
|
5419
4993
|
* The Create alert action on KPI charts.
|
|
5420
|
-
*
|
|
5421
4994
|
* @example
|
|
5422
4995
|
* ```js
|
|
5423
4996
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -5436,7 +5009,6 @@ export declare enum Action {
|
|
|
5436
5009
|
/**
|
|
5437
5010
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
5438
5011
|
* Allows sending data to a Google Sheet.
|
|
5439
|
-
*
|
|
5440
5012
|
* @example
|
|
5441
5013
|
* ```js
|
|
5442
5014
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -5448,7 +5020,6 @@ export declare enum Action {
|
|
|
5448
5020
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
5449
5021
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
5450
5022
|
* Microsoft Teams, and so on.
|
|
5451
|
-
*
|
|
5452
5023
|
* @example
|
|
5453
5024
|
* ```js
|
|
5454
5025
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5459,7 +5030,6 @@ export declare enum Action {
|
|
|
5459
5030
|
/**
|
|
5460
5031
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
5461
5032
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5462
|
-
*
|
|
5463
5033
|
* @example
|
|
5464
5034
|
* ```js
|
|
5465
5035
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5470,7 +5040,6 @@ export declare enum Action {
|
|
|
5470
5040
|
/**
|
|
5471
5041
|
* The **Filter** action on Liveboard visualizations.
|
|
5472
5042
|
* Allows users to apply cross-filters on a Liveboard.
|
|
5473
|
-
*
|
|
5474
5043
|
* @example
|
|
5475
5044
|
* ```js
|
|
5476
5045
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -5481,7 +5050,6 @@ export declare enum Action {
|
|
|
5481
5050
|
/**
|
|
5482
5051
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5483
5052
|
* Allows sending data to third-party apps Slack
|
|
5484
|
-
*
|
|
5485
5053
|
* @example
|
|
5486
5054
|
* ```js
|
|
5487
5055
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -5492,7 +5060,6 @@ export declare enum Action {
|
|
|
5492
5060
|
/**
|
|
5493
5061
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5494
5062
|
* Allows sending data to third-party apps Team
|
|
5495
|
-
*
|
|
5496
5063
|
* @example
|
|
5497
5064
|
* ```js
|
|
5498
5065
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -5504,7 +5071,6 @@ export declare enum Action {
|
|
|
5504
5071
|
* The **Remove** action that appears when cross filters are applied
|
|
5505
5072
|
* on a Liveboard.
|
|
5506
5073
|
* Removes filters applied o a visualization.
|
|
5507
|
-
*
|
|
5508
5074
|
* @example
|
|
5509
5075
|
* ```js
|
|
5510
5076
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5516,7 +5082,6 @@ export declare enum Action {
|
|
|
5516
5082
|
* The **Aggregate** option in the chart axis or the
|
|
5517
5083
|
* table column customization menu.
|
|
5518
5084
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
5519
|
-
*
|
|
5520
5085
|
* @example
|
|
5521
5086
|
* ```js
|
|
5522
5087
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -5528,7 +5093,6 @@ export declare enum Action {
|
|
|
5528
5093
|
* The **Time bucket** option in the chart axis or table column
|
|
5529
5094
|
* customization menu.
|
|
5530
5095
|
* Allows defining time metric for date comparison.
|
|
5531
|
-
*
|
|
5532
5096
|
* @example
|
|
5533
5097
|
* ```js
|
|
5534
5098
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -5539,7 +5103,6 @@ export declare enum Action {
|
|
|
5539
5103
|
/**
|
|
5540
5104
|
* The **Filter** action in the chart axis or table column
|
|
5541
5105
|
* customization menu.
|
|
5542
|
-
*
|
|
5543
5106
|
* @example
|
|
5544
5107
|
* ```js
|
|
5545
5108
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -5551,7 +5114,6 @@ export declare enum Action {
|
|
|
5551
5114
|
* The **Conditional formatting** action on chart or table.
|
|
5552
5115
|
* Allows adding rules for conditional formatting of data
|
|
5553
5116
|
* points on a chart or table.
|
|
5554
|
-
*
|
|
5555
5117
|
* @example
|
|
5556
5118
|
* ```js
|
|
5557
5119
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5563,7 +5125,6 @@ export declare enum Action {
|
|
|
5563
5125
|
* The **Sort** menu action on a table or chart axis
|
|
5564
5126
|
* Sorts data in ascending or descending order.
|
|
5565
5127
|
* Allows adding, editing, or removing filters.
|
|
5566
|
-
*
|
|
5567
5128
|
* @example
|
|
5568
5129
|
* ```js
|
|
5569
5130
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5576,7 +5137,6 @@ export declare enum Action {
|
|
|
5576
5137
|
* customization menu.
|
|
5577
5138
|
* Allows grouping data points if the axes use the same
|
|
5578
5139
|
* unit of measurement and a similar scale.
|
|
5579
|
-
*
|
|
5580
5140
|
* @example
|
|
5581
5141
|
* ```js
|
|
5582
5142
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -5588,7 +5148,6 @@ export declare enum Action {
|
|
|
5588
5148
|
* The **Position** option in the axis customization menu.
|
|
5589
5149
|
* Allows changing the position of the axis to the
|
|
5590
5150
|
* left or right side of the chart.
|
|
5591
|
-
*
|
|
5592
5151
|
* @example
|
|
5593
5152
|
* ```js
|
|
5594
5153
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -5599,7 +5158,6 @@ export declare enum Action {
|
|
|
5599
5158
|
/**
|
|
5600
5159
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
5601
5160
|
* Renames the axis label on a chart or the column header on a table.
|
|
5602
|
-
*
|
|
5603
5161
|
* @example
|
|
5604
5162
|
* ```js
|
|
5605
5163
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -5611,7 +5169,6 @@ export declare enum Action {
|
|
|
5611
5169
|
* The **Edit** action in the axis customization menu.
|
|
5612
5170
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
5613
5171
|
* and format of a column.
|
|
5614
|
-
*
|
|
5615
5172
|
* @example
|
|
5616
5173
|
* ```js
|
|
5617
5174
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -5622,7 +5179,6 @@ export declare enum Action {
|
|
|
5622
5179
|
/**
|
|
5623
5180
|
* The **Number format** action to customize the format of
|
|
5624
5181
|
* the data labels on a chart or table.
|
|
5625
|
-
*
|
|
5626
5182
|
* @example
|
|
5627
5183
|
* ```js
|
|
5628
5184
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -5633,7 +5189,6 @@ export declare enum Action {
|
|
|
5633
5189
|
/**
|
|
5634
5190
|
* The **Text wrapping** action on a table.
|
|
5635
5191
|
* Wraps or clips column text on a table.
|
|
5636
|
-
*
|
|
5637
5192
|
* @example
|
|
5638
5193
|
* ```js
|
|
5639
5194
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -5646,7 +5201,6 @@ export declare enum Action {
|
|
|
5646
5201
|
* customization menu.
|
|
5647
5202
|
* Removes the data labels from a chart or the column of a
|
|
5648
5203
|
* table visualization.
|
|
5649
|
-
*
|
|
5650
5204
|
* @example
|
|
5651
5205
|
* ```js
|
|
5652
5206
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -5661,7 +5215,6 @@ export declare enum Action {
|
|
|
5661
5215
|
/**
|
|
5662
5216
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
5663
5217
|
* Allows renaming a Liveboard or visualization.
|
|
5664
|
-
*
|
|
5665
5218
|
* @example
|
|
5666
5219
|
* ```js
|
|
5667
5220
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -5705,7 +5258,6 @@ export declare enum Action {
|
|
|
5705
5258
|
/**
|
|
5706
5259
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
5707
5260
|
* Allows moving a visualization to a different tab.
|
|
5708
|
-
*
|
|
5709
5261
|
* @example
|
|
5710
5262
|
* ```js
|
|
5711
5263
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -5714,7 +5266,6 @@ export declare enum Action {
|
|
|
5714
5266
|
MoveToTab = "onContainerMove",
|
|
5715
5267
|
/**
|
|
5716
5268
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
5717
|
-
*
|
|
5718
5269
|
* @example
|
|
5719
5270
|
* ```js
|
|
5720
5271
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5723,7 +5274,6 @@ export declare enum Action {
|
|
|
5723
5274
|
ManageMonitor = "ManageMonitor",
|
|
5724
5275
|
/**
|
|
5725
5276
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5726
|
-
*
|
|
5727
5277
|
* @example
|
|
5728
5278
|
* ```js
|
|
5729
5279
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -5733,7 +5283,6 @@ export declare enum Action {
|
|
|
5733
5283
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5734
5284
|
/**
|
|
5735
5285
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
5736
|
-
*
|
|
5737
5286
|
* @example
|
|
5738
5287
|
* ```js
|
|
5739
5288
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -5745,7 +5294,6 @@ export declare enum Action {
|
|
|
5745
5294
|
* Action ID for the Parent TML action
|
|
5746
5295
|
* The parent action **TML** must be included to access TML-related options
|
|
5747
5296
|
* within the cascading menu (specific to the answer page)
|
|
5748
|
-
*
|
|
5749
5297
|
* @example
|
|
5750
5298
|
* ```js
|
|
5751
5299
|
* // to include specific TML actions
|
|
@@ -5757,13 +5305,11 @@ export declare enum Action {
|
|
|
5757
5305
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5758
5306
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5759
5307
|
* ```
|
|
5760
|
-
*
|
|
5761
5308
|
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5762
5309
|
*/
|
|
5763
5310
|
TML = "tml",
|
|
5764
5311
|
/**
|
|
5765
5312
|
* Action ID for to hide Verified Liveboard Banner
|
|
5766
|
-
*
|
|
5767
5313
|
* @example
|
|
5768
5314
|
* ```js
|
|
5769
5315
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -5773,7 +5319,6 @@ export declare enum Action {
|
|
|
5773
5319
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
5774
5320
|
/**
|
|
5775
5321
|
* Action ID for ask sage button
|
|
5776
|
-
*
|
|
5777
5322
|
* @example
|
|
5778
5323
|
* ```js
|
|
5779
5324
|
* hiddenAction: [Action.AskAi]
|
|
@@ -5783,7 +5328,6 @@ export declare enum Action {
|
|
|
5783
5328
|
AskAi = "AskAi",
|
|
5784
5329
|
/**
|
|
5785
5330
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
5786
|
-
*
|
|
5787
5331
|
* @example
|
|
5788
5332
|
* ```js
|
|
5789
5333
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -5793,7 +5337,6 @@ export declare enum Action {
|
|
|
5793
5337
|
AddToWatchlist = "addToWatchlist",
|
|
5794
5338
|
/**
|
|
5795
5339
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
5796
|
-
*
|
|
5797
5340
|
* @example
|
|
5798
5341
|
* ```js
|
|
5799
5342
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -5803,7 +5346,6 @@ export declare enum Action {
|
|
|
5803
5346
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
5804
5347
|
/**
|
|
5805
5348
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
5806
|
-
*
|
|
5807
5349
|
* @example
|
|
5808
5350
|
* ```js
|
|
5809
5351
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -5813,7 +5355,6 @@ export declare enum Action {
|
|
|
5813
5355
|
OrganiseFavourites = "organiseFavourites",
|
|
5814
5356
|
/**
|
|
5815
5357
|
* Action ID for AI Highlights button
|
|
5816
|
-
*
|
|
5817
5358
|
* @example
|
|
5818
5359
|
* ```js
|
|
5819
5360
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -5882,7 +5423,6 @@ export interface CustomActionPayload {
|
|
|
5882
5423
|
export declare enum LogLevel {
|
|
5883
5424
|
/**
|
|
5884
5425
|
* No logs will be logged in the console.
|
|
5885
|
-
*
|
|
5886
5426
|
* @example
|
|
5887
5427
|
* ```js
|
|
5888
5428
|
* init({
|
|
@@ -5895,7 +5435,6 @@ export declare enum LogLevel {
|
|
|
5895
5435
|
SILENT = "SILENT",
|
|
5896
5436
|
/**
|
|
5897
5437
|
* Only ERROR logs will be logged in the console.
|
|
5898
|
-
*
|
|
5899
5438
|
* @example
|
|
5900
5439
|
* ```js
|
|
5901
5440
|
* init({
|
|
@@ -5908,7 +5447,6 @@ export declare enum LogLevel {
|
|
|
5908
5447
|
ERROR = "ERROR",
|
|
5909
5448
|
/**
|
|
5910
5449
|
* Only WARN and ERROR logs will be logged in the console.
|
|
5911
|
-
*
|
|
5912
5450
|
* @example
|
|
5913
5451
|
* ```js
|
|
5914
5452
|
* init({
|
|
@@ -5921,7 +5459,6 @@ export declare enum LogLevel {
|
|
|
5921
5459
|
WARN = "WARN",
|
|
5922
5460
|
/**
|
|
5923
5461
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
5924
|
-
*
|
|
5925
5462
|
* @example
|
|
5926
5463
|
* ```js
|
|
5927
5464
|
* init({
|
|
@@ -5934,7 +5471,6 @@ export declare enum LogLevel {
|
|
|
5934
5471
|
INFO = "INFO",
|
|
5935
5472
|
/**
|
|
5936
5473
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
5937
|
-
*
|
|
5938
5474
|
* @example
|
|
5939
5475
|
* ```js
|
|
5940
5476
|
* init({
|
|
@@ -5947,7 +5483,6 @@ export declare enum LogLevel {
|
|
|
5947
5483
|
DEBUG = "DEBUG",
|
|
5948
5484
|
/**
|
|
5949
5485
|
* All logs will be logged in the console.
|
|
5950
|
-
*
|
|
5951
5486
|
* @example
|
|
5952
5487
|
* ```js
|
|
5953
5488
|
* init({
|
|
@@ -5964,7 +5499,6 @@ export declare enum LogLevel {
|
|
|
5964
5499
|
* Copyright (c) 2022
|
|
5965
5500
|
*
|
|
5966
5501
|
* Base classes
|
|
5967
|
-
*
|
|
5968
5502
|
* @summary Base classes
|
|
5969
5503
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
5970
5504
|
*/
|
|
@@ -6013,19 +5547,16 @@ export declare class TsEmbed {
|
|
|
6013
5547
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
6014
5548
|
/**
|
|
6015
5549
|
* Handles errors within the SDK
|
|
6016
|
-
*
|
|
6017
5550
|
* @param error The error message or object
|
|
6018
5551
|
*/
|
|
6019
5552
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
6020
5553
|
/**
|
|
6021
5554
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
6022
|
-
*
|
|
6023
5555
|
* @param query
|
|
6024
5556
|
*/
|
|
6025
5557
|
protected getEmbedBasePath(query: string): string;
|
|
6026
5558
|
/**
|
|
6027
5559
|
* Common query params set for all the embed modes.
|
|
6028
|
-
*
|
|
6029
5560
|
* @param queryParams
|
|
6030
5561
|
* @returns queryParams
|
|
6031
5562
|
*/
|
|
@@ -6033,7 +5564,6 @@ export declare class TsEmbed {
|
|
|
6033
5564
|
/**
|
|
6034
5565
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
6035
5566
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
6036
|
-
*
|
|
6037
5567
|
* @param queryString The query string to append to the URL.
|
|
6038
5568
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
6039
5569
|
* the full application.
|
|
@@ -6046,7 +5576,6 @@ export declare class TsEmbed {
|
|
|
6046
5576
|
/**
|
|
6047
5577
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
6048
5578
|
* event listeners.
|
|
6049
|
-
*
|
|
6050
5579
|
* @param url - The URL of the embedded ThoughtSpot app.
|
|
6051
5580
|
*/
|
|
6052
5581
|
protected renderIFrame(url: string): Promise<any>;
|
|
@@ -6060,13 +5589,11 @@ export declare class TsEmbed {
|
|
|
6060
5589
|
protected insertIntoDOM(child: string | Node): void;
|
|
6061
5590
|
/**
|
|
6062
5591
|
* Sets the height of the iframe
|
|
6063
|
-
*
|
|
6064
5592
|
* @param height The height in pixels
|
|
6065
5593
|
*/
|
|
6066
5594
|
protected setIFrameHeight(height: number | string): void;
|
|
6067
5595
|
/**
|
|
6068
5596
|
* Executes all registered event handlers for a particular event type
|
|
6069
|
-
*
|
|
6070
5597
|
* @param eventType The event type
|
|
6071
5598
|
* @param data The payload invoked with the event handler
|
|
6072
5599
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -6078,7 +5605,6 @@ export declare class TsEmbed {
|
|
|
6078
5605
|
protected getThoughtSpotHost(): string;
|
|
6079
5606
|
/**
|
|
6080
5607
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
6081
|
-
*
|
|
6082
5608
|
* @param eventType The v2 event type
|
|
6083
5609
|
* @returns The corresponding v1 event type if one exists
|
|
6084
5610
|
* or else the v2 event type itself
|
|
@@ -6088,7 +5614,6 @@ export declare class TsEmbed {
|
|
|
6088
5614
|
* Calculates the iframe center for the current visible viewPort
|
|
6089
5615
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
6090
5616
|
* in Host app. ViewPort height of the tab.
|
|
6091
|
-
*
|
|
6092
5617
|
* @returns iframe Center in visible viewport,
|
|
6093
5618
|
* Iframe height,
|
|
6094
5619
|
* View port height.
|
|
@@ -6103,7 +5628,6 @@ export declare class TsEmbed {
|
|
|
6103
5628
|
/**
|
|
6104
5629
|
* Registers an event listener to trigger an alert when the ThoughtSpot app
|
|
6105
5630
|
* sends an event of a particular message type to the host application.
|
|
6106
|
-
*
|
|
6107
5631
|
* @param messageType The message type
|
|
6108
5632
|
* @param callback A callback as a function
|
|
6109
5633
|
* @param options The message options
|
|
@@ -6127,7 +5651,6 @@ export declare class TsEmbed {
|
|
|
6127
5651
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
|
|
6128
5652
|
/**
|
|
6129
5653
|
* Removes an event listener for a particular event type.
|
|
6130
|
-
*
|
|
6131
5654
|
* @param messageType The message type
|
|
6132
5655
|
* @param callback The callback to remove
|
|
6133
5656
|
* @example
|
|
@@ -6140,7 +5663,6 @@ export declare class TsEmbed {
|
|
|
6140
5663
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
6141
5664
|
/**
|
|
6142
5665
|
* Triggers an event to the embedded app
|
|
6143
|
-
*
|
|
6144
5666
|
* @param messageType The event type
|
|
6145
5667
|
* @param data The payload to send with the message
|
|
6146
5668
|
*/
|
|
@@ -6149,7 +5671,6 @@ export declare class TsEmbed {
|
|
|
6149
5671
|
* Marks the ThoughtSpot object to have been rendered
|
|
6150
5672
|
* Needs to be overridden by subclasses to do the actual
|
|
6151
5673
|
* rendering of the iframe.
|
|
6152
|
-
*
|
|
6153
5674
|
* @param args
|
|
6154
5675
|
*/
|
|
6155
5676
|
render(): Promise<TsEmbed>;
|
|
@@ -6157,7 +5678,6 @@ export declare class TsEmbed {
|
|
|
6157
5678
|
protected handleRenderForPrerender(): void;
|
|
6158
5679
|
/**
|
|
6159
5680
|
* Creates the preRender shell
|
|
6160
|
-
*
|
|
6161
5681
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
6162
5682
|
*/
|
|
6163
5683
|
preRender(showPreRenderByDefault?: boolean): TsEmbed;
|
|
@@ -6165,13 +5685,11 @@ export declare class TsEmbed {
|
|
|
6165
5685
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
6166
5686
|
* host app URL.
|
|
6167
5687
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
6168
|
-
*
|
|
6169
5688
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
6170
5689
|
*/
|
|
6171
5690
|
getThoughtSpotPostUrlParams(): string;
|
|
6172
5691
|
/**
|
|
6173
5692
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
6174
|
-
*
|
|
6175
5693
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
6176
5694
|
*/
|
|
6177
5695
|
destroy(): void;
|
|
@@ -6180,7 +5698,6 @@ export declare class TsEmbed {
|
|
|
6180
5698
|
* Prerenders a generic instance of the TS component.
|
|
6181
5699
|
* This means without the path but with the flags already applied.
|
|
6182
5700
|
* This is useful for prerendering the component in the background.
|
|
6183
|
-
*
|
|
6184
5701
|
* @version SDK: 1.22.0
|
|
6185
5702
|
* @returns
|
|
6186
5703
|
*/
|
|
@@ -6198,7 +5715,6 @@ export declare class TsEmbed {
|
|
|
6198
5715
|
* element. This function adjusts the position, width, and height of the PreRender
|
|
6199
5716
|
* component
|
|
6200
5717
|
* to match the dimensions and position of the embedding element.
|
|
6201
|
-
*
|
|
6202
5718
|
* @throws {Error} Throws an error if the embedding element (passed as domSelector)
|
|
6203
5719
|
* is not defined or not found.
|
|
6204
5720
|
*/
|
|
@@ -6211,7 +5727,6 @@ export declare class TsEmbed {
|
|
|
6211
5727
|
/**
|
|
6212
5728
|
* Retrieves unique HTML element IDs for PreRender-related elements.
|
|
6213
5729
|
* These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
|
|
6214
|
-
*
|
|
6215
5730
|
* @returns {object} An object containing the IDs for the PreRender elements.
|
|
6216
5731
|
* @property {string} wrapper - The HTML element ID for the PreRender wrapper.
|
|
6217
5732
|
* @property {string} child - The HTML element ID for the PreRender child.
|
|
@@ -6223,7 +5738,6 @@ export declare class TsEmbed {
|
|
|
6223
5738
|
/**
|
|
6224
5739
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
6225
5740
|
* session.
|
|
6226
|
-
*
|
|
6227
5741
|
* @param vizId [Optional] to get for a specific viz in case of a liveboard.
|
|
6228
5742
|
* @version SDK: 1.25.0 / ThoughtSpot 9.10.0
|
|
6229
5743
|
*/
|
|
@@ -6233,7 +5747,6 @@ export declare class TsEmbed {
|
|
|
6233
5747
|
* Base class for embedding v1 experience
|
|
6234
5748
|
* Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
|
|
6235
5749
|
* which is currently under migration to v2
|
|
6236
|
-
*
|
|
6237
5750
|
* @inheritdoc
|
|
6238
5751
|
*/
|
|
6239
5752
|
export declare class V1Embed extends TsEmbed {
|
|
@@ -6241,7 +5754,6 @@ export declare class V1Embed extends TsEmbed {
|
|
|
6241
5754
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
6242
5755
|
/**
|
|
6243
5756
|
* Render the app in an iframe and set up event handlers
|
|
6244
|
-
*
|
|
6245
5757
|
* @param iframeSrc
|
|
6246
5758
|
*/
|
|
6247
5759
|
protected renderV1Embed(iframeSrc: string): Promise<any>;
|
|
@@ -6291,7 +5803,6 @@ export declare const handleAuth: () => Promise<boolean>;
|
|
|
6291
5803
|
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
6292
5804
|
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
6293
5805
|
* to your app.
|
|
6294
|
-
*
|
|
6295
5806
|
* @param url The URL provided for prefetch
|
|
6296
5807
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
6297
5808
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -6303,7 +5814,6 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
|
|
|
6303
5814
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
6304
5815
|
* component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
|
|
6305
5816
|
* to actually embed. That is handled internally.
|
|
6306
|
-
*
|
|
6307
5817
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
6308
5818
|
* authentication mechanism and so on.
|
|
6309
5819
|
* @example
|
|
@@ -6330,7 +5840,6 @@ export declare function disableAutoLogin(): void;
|
|
|
6330
5840
|
*
|
|
6331
5841
|
* You can call the `init` method again to re login, if autoLogin is set to
|
|
6332
5842
|
* true in this second call it will be honored.
|
|
6333
|
-
*
|
|
6334
5843
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
6335
5844
|
* @returns Promise which resolves when logout completes.
|
|
6336
5845
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
@@ -6340,13 +5849,11 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
6340
5849
|
/**
|
|
6341
5850
|
* Renders functions in a queue, resolves to next function only after the callback next
|
|
6342
5851
|
* is called
|
|
6343
|
-
*
|
|
6344
5852
|
* @param fn The function being registered
|
|
6345
5853
|
*/
|
|
6346
5854
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
6347
5855
|
/**
|
|
6348
5856
|
* Imports TML representation of the metadata objects into ThoughtSpot.
|
|
6349
|
-
*
|
|
6350
5857
|
* @param data
|
|
6351
5858
|
* @example
|
|
6352
5859
|
* ```js
|
|
@@ -6371,7 +5878,6 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
6371
5878
|
/**
|
|
6372
5879
|
* Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
|
|
6373
5880
|
* format.
|
|
6374
|
-
*
|
|
6375
5881
|
* @param data
|
|
6376
5882
|
* @example
|
|
6377
5883
|
* ```js
|
|
@@ -6417,7 +5923,6 @@ interface sessionInfoInterface {
|
|
|
6417
5923
|
/**
|
|
6418
5924
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
6419
5925
|
* of {@link AuthStatus.FAILURE}.
|
|
6420
|
-
*
|
|
6421
5926
|
* @group Authentication / Init
|
|
6422
5927
|
*/
|
|
6423
5928
|
export declare enum AuthFailureType {
|
|
@@ -6428,7 +5933,6 @@ export declare enum AuthFailureType {
|
|
|
6428
5933
|
}
|
|
6429
5934
|
/**
|
|
6430
5935
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
6431
|
-
*
|
|
6432
5936
|
* @group Authentication / Init
|
|
6433
5937
|
*/
|
|
6434
5938
|
export declare enum AuthStatus {
|
|
@@ -6452,27 +5956,23 @@ export declare enum AuthStatus {
|
|
|
6452
5956
|
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
6453
5957
|
* popup is waiting to be triggered either programmatically
|
|
6454
5958
|
* or by the trigger button.
|
|
6455
|
-
*
|
|
6456
5959
|
* @version SDK: 1.19.0
|
|
6457
5960
|
*/
|
|
6458
5961
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
6459
5962
|
}
|
|
6460
5963
|
/**
|
|
6461
5964
|
* Event emitter returned from {@link init}.
|
|
6462
|
-
*
|
|
6463
5965
|
* @group Authentication / Init
|
|
6464
5966
|
*/
|
|
6465
5967
|
export interface AuthEventEmitter {
|
|
6466
5968
|
/**
|
|
6467
5969
|
* Register a listener on Auth failure.
|
|
6468
|
-
*
|
|
6469
5970
|
* @param event
|
|
6470
5971
|
* @param listener
|
|
6471
5972
|
*/
|
|
6472
5973
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
6473
5974
|
/**
|
|
6474
5975
|
* Register a listener on Auth SDK success.
|
|
6475
|
-
*
|
|
6476
5976
|
* @param event
|
|
6477
5977
|
* @param listener
|
|
6478
5978
|
*/
|
|
@@ -6483,13 +5983,11 @@ export interface AuthEventEmitter {
|
|
|
6483
5983
|
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
6484
5984
|
/**
|
|
6485
5985
|
* Trigger an event on the emitter returned from init.
|
|
6486
|
-
*
|
|
6487
5986
|
* @param {@link AuthEvent}
|
|
6488
5987
|
*/
|
|
6489
5988
|
emit(event: AuthEvent, ...args: any[]): boolean;
|
|
6490
5989
|
/**
|
|
6491
5990
|
* Remove listener from the emitter returned from init.
|
|
6492
|
-
*
|
|
6493
5991
|
* @param event
|
|
6494
5992
|
* @param listener
|
|
6495
5993
|
* @param context
|
|
@@ -6498,14 +5996,12 @@ export interface AuthEventEmitter {
|
|
|
6498
5996
|
off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
|
|
6499
5997
|
/**
|
|
6500
5998
|
* Remove all the event listeners
|
|
6501
|
-
*
|
|
6502
5999
|
* @param event
|
|
6503
6000
|
*/
|
|
6504
6001
|
removeAllListeners(event: AuthStatus): this;
|
|
6505
6002
|
}
|
|
6506
6003
|
/**
|
|
6507
6004
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
6508
|
-
*
|
|
6509
6005
|
* @group Authentication / Init
|
|
6510
6006
|
*/
|
|
6511
6007
|
export declare enum AuthEvent {
|
|
@@ -6550,19 +6046,16 @@ export declare function getReleaseVersion(): string;
|
|
|
6550
6046
|
/**
|
|
6551
6047
|
* Return a promise that resolves with the session information when
|
|
6552
6048
|
* authentication is successful. And info is available.
|
|
6553
|
-
*
|
|
6554
6049
|
* @group Global methods
|
|
6555
6050
|
*/
|
|
6556
6051
|
export declare function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
6557
6052
|
/**
|
|
6558
6053
|
* Perform token based authentication
|
|
6559
|
-
*
|
|
6560
6054
|
* @param embedConfig The embed configuration
|
|
6561
6055
|
*/
|
|
6562
6056
|
export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
6563
6057
|
/**
|
|
6564
6058
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
6565
|
-
*
|
|
6566
6059
|
* @param embedConfig The embed configuration
|
|
6567
6060
|
*/
|
|
6568
6061
|
export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -6572,7 +6065,6 @@ export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promis
|
|
|
6572
6065
|
*
|
|
6573
6066
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
6574
6067
|
* strongly advised not to use this authentication method in production.
|
|
6575
|
-
*
|
|
6576
6068
|
* @param embedConfig The embed configuration
|
|
6577
6069
|
*/
|
|
6578
6070
|
export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -6581,7 +6073,6 @@ export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
6581
6073
|
export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
6582
6074
|
/**
|
|
6583
6075
|
* Perform authentication on the ThoughtSpot cluster
|
|
6584
|
-
*
|
|
6585
6076
|
* @param embedConfig The embed configuration
|
|
6586
6077
|
*/
|
|
6587
6078
|
export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -6953,7 +6444,6 @@ export interface UnderlyingDataPoint {
|
|
|
6953
6444
|
* custom action payload. This service could be used to run
|
|
6954
6445
|
* graphql queries in the context of the answer on which the
|
|
6955
6446
|
* custom action was triggered.
|
|
6956
|
-
*
|
|
6957
6447
|
* @example
|
|
6958
6448
|
* ```js
|
|
6959
6449
|
* embed.on(EmbedEvent.CustomAction, e => {
|
|
@@ -6979,7 +6469,6 @@ export interface UnderlyingDataPoint {
|
|
|
6979
6469
|
export declare class AnswerService {
|
|
6980
6470
|
/**
|
|
6981
6471
|
* Should not need to be called directly.
|
|
6982
|
-
*
|
|
6983
6472
|
* @param session
|
|
6984
6473
|
* @param answer
|
|
6985
6474
|
* @param thoughtSpotHost
|
|
@@ -6993,38 +6482,34 @@ export declare class AnswerService {
|
|
|
6993
6482
|
getSourceDetail(): Promise<any>;
|
|
6994
6483
|
/**
|
|
6995
6484
|
* Remove columnIds and return updated answer session.
|
|
6996
|
-
*
|
|
6997
6485
|
* @param columnIds
|
|
6998
6486
|
* @returns
|
|
6999
6487
|
*/
|
|
7000
6488
|
removeColumns(columnIds: string[]): Promise<any>;
|
|
7001
6489
|
/**
|
|
7002
6490
|
* Add columnIds and return updated answer session.
|
|
7003
|
-
*
|
|
7004
6491
|
* @param columnIds
|
|
7005
6492
|
* @returns
|
|
7006
6493
|
*/
|
|
7007
6494
|
addColumns(columnIds: string[]): Promise<any>;
|
|
7008
6495
|
/**
|
|
7009
6496
|
* Add columns by names and return updated answer session.
|
|
7010
|
-
*
|
|
7011
6497
|
* @param columnNames
|
|
7012
6498
|
* @returns
|
|
7013
6499
|
* @example
|
|
7014
6500
|
* ```js
|
|
7015
6501
|
* embed.on(EmbedEvent.Data, async (e) => {
|
|
7016
6502
|
* const service = await embed.getAnswerService();
|
|
7017
|
-
* await service.
|
|
6503
|
+
* await service.addColumnsByName([
|
|
7018
6504
|
* "col name 1",
|
|
7019
6505
|
* "col name 2"
|
|
7020
6506
|
* ]);
|
|
7021
6507
|
* console.log(await service.fetchData());
|
|
7022
6508
|
* });
|
|
7023
6509
|
*/
|
|
7024
|
-
|
|
6510
|
+
addColumnsByName(columnNames: string[]): Promise<any>;
|
|
7025
6511
|
/**
|
|
7026
6512
|
* Add a filter to the answer.
|
|
7027
|
-
*
|
|
7028
6513
|
* @param columnName
|
|
7029
6514
|
* @param operator
|
|
7030
6515
|
* @param values
|
|
@@ -7033,7 +6518,6 @@ export declare class AnswerService {
|
|
|
7033
6518
|
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
7034
6519
|
/**
|
|
7035
6520
|
* Fetch data from the answer.
|
|
7036
|
-
*
|
|
7037
6521
|
* @param offset
|
|
7038
6522
|
* @param size
|
|
7039
6523
|
* @returns
|
|
@@ -7045,7 +6529,6 @@ export declare class AnswerService {
|
|
|
7045
6529
|
/**
|
|
7046
6530
|
* Fetch the data for the answer as a CSV blob. This might be
|
|
7047
6531
|
* quicker for larger data.
|
|
7048
|
-
*
|
|
7049
6532
|
* @param userLocale
|
|
7050
6533
|
* @param includeInfo Include the CSV header in the output
|
|
7051
6534
|
* @returns Response
|
|
@@ -7054,7 +6537,6 @@ export declare class AnswerService {
|
|
|
7054
6537
|
/**
|
|
7055
6538
|
* Just get the internal URL for this answer's data
|
|
7056
6539
|
* as a CSV blob.
|
|
7057
|
-
*
|
|
7058
6540
|
* @param userLocale
|
|
7059
6541
|
* @param includeInfo
|
|
7060
6542
|
* @returns
|
|
@@ -7064,7 +6546,6 @@ export declare class AnswerService {
|
|
|
7064
6546
|
* Get underlying data given a point and the output column names.
|
|
7065
6547
|
* In case of a context menu action, the selectedPoints are
|
|
7066
6548
|
* automatically passed.
|
|
7067
|
-
*
|
|
7068
6549
|
* @param outputColumnNames
|
|
7069
6550
|
* @param selectedPoints
|
|
7070
6551
|
* @example
|
|
@@ -7081,7 +6562,6 @@ export declare class AnswerService {
|
|
|
7081
6562
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
7082
6563
|
/**
|
|
7083
6564
|
* Execute a custom graphql query in the context of the answer.
|
|
7084
|
-
*
|
|
7085
6565
|
* @param query graphql query
|
|
7086
6566
|
* @param variables graphql variables
|
|
7087
6567
|
* @returns
|
|
@@ -7089,7 +6569,6 @@ export declare class AnswerService {
|
|
|
7089
6569
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
7090
6570
|
/**
|
|
7091
6571
|
* Get the internal session details for the answer.
|
|
7092
|
-
*
|
|
7093
6572
|
* @returns
|
|
7094
6573
|
*/
|
|
7095
6574
|
getSession(): SessionInterface;
|
|
@@ -7098,7 +6577,6 @@ export declare class AnswerService {
|
|
|
7098
6577
|
|
|
7099
6578
|
/**
|
|
7100
6579
|
* Gets the configuration embed was initialized with.
|
|
7101
|
-
*
|
|
7102
6580
|
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
7103
6581
|
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
7104
6582
|
* @group Global methods
|
|
@@ -7107,7 +6585,6 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
7107
6585
|
/**
|
|
7108
6586
|
* Sets the configuration embed was initialized with.
|
|
7109
6587
|
* And returns the new configuration.
|
|
7110
|
-
*
|
|
7111
6588
|
* @param newConfig The configuration to set.
|
|
7112
6589
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
7113
6590
|
* @group Global methods
|
|
@@ -7130,7 +6607,6 @@ export declare const MIXPANEL_EVENT: {
|
|
|
7130
6607
|
};
|
|
7131
6608
|
/**
|
|
7132
6609
|
* Pushes the event with its Property key-value map to mixpanel.
|
|
7133
|
-
*
|
|
7134
6610
|
* @param eventId
|
|
7135
6611
|
* @param eventProps
|
|
7136
6612
|
*/
|
|
@@ -7148,7 +6624,6 @@ export declare function testResetMixpanel(): void;
|
|
|
7148
6624
|
/**
|
|
7149
6625
|
* Fetch wrapper that adds the authentication token to the request.
|
|
7150
6626
|
* Use this to call the ThoughtSpot APIs when using the visual embed sdk.
|
|
7151
|
-
*
|
|
7152
6627
|
* @param input
|
|
7153
6628
|
* @param init
|
|
7154
6629
|
* @version SDK: 1.28.0
|
|
@@ -7159,7 +6634,6 @@ export declare const tokenizedFetch: typeof fetch;
|
|
|
7159
6634
|
export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
|
|
7160
6635
|
/**
|
|
7161
6636
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
7162
|
-
*
|
|
7163
6637
|
* @example
|
|
7164
6638
|
* ```js
|
|
7165
6639
|
* resetCachedAuthToken();
|