@thoughtspot/visual-embed-sdk 1.28.5 → 1.29.0-addfilter.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.map +1 -1
- package/cjs/src/auth.js +2 -2
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +1 -1
- package/cjs/src/authToken.js +1 -1
- package/cjs/src/embed/app.d.ts +58 -7
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +40 -4
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +11 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +1 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +6 -6
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -1
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +8 -2
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/search.d.ts +56 -5
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +41 -5
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +11 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +12 -6
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +9 -18
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.spec.js +1 -13
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +58 -31
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +44 -20
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/answerService/answerService.d.ts +34 -0
- package/cjs/src/utils/answerService/answerService.d.ts.map +1 -0
- package/cjs/src/utils/answerService/answerService.js +142 -0
- package/cjs/src/utils/answerService/answerService.js.map +1 -0
- package/cjs/src/utils/answerService/answerService.spec.d.ts +1 -0
- package/cjs/src/utils/answerService/answerService.spec.d.ts.map +1 -0
- package/cjs/src/utils/answerService/answerService.spec.js +1 -0
- package/cjs/src/utils/answerService/answerService.spec.js.map +1 -0
- package/cjs/src/utils/answerService/graphql-queries.d.ts +6 -0
- package/cjs/src/utils/answerService/graphql-queries.d.ts.map +1 -0
- package/cjs/src/utils/answerService/graphql-queries.js +123 -0
- package/cjs/src/utils/answerService/graphql-queries.js.map +1 -0
- package/cjs/src/utils/answerService.d.ts +10 -0
- package/cjs/src/utils/answerService.d.ts.map +1 -0
- package/cjs/src/utils/answerService.js +61 -0
- package/cjs/src/utils/answerService.js.map +1 -0
- package/cjs/src/utils/answerService.spec.d.ts +2 -0
- package/cjs/src/utils/answerService.spec.d.ts.map +1 -0
- package/cjs/src/utils/answerService.spec.js +31 -0
- package/cjs/src/utils/answerService.spec.js.map +1 -0
- package/cjs/src/utils/authService.d.ts +37 -0
- package/cjs/src/utils/authService.d.ts.map +1 -0
- package/cjs/src/utils/authService.js +106 -0
- package/cjs/src/utils/authService.js.map +1 -0
- package/cjs/src/utils/authService.spec.d.ts +2 -0
- package/cjs/src/utils/authService.spec.d.ts.map +1 -0
- package/cjs/src/utils/authService.spec.js +72 -0
- package/cjs/src/utils/authService.spec.js.map +1 -0
- 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 +8 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +37 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +60 -0
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +49 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/graphql-queries.d.ts +5 -0
- package/cjs/src/utils/graphql/answerService/graphql-queries.d.ts.map +1 -0
- package/cjs/src/utils/graphql/answerService/graphql-queries.js +80 -0
- package/cjs/src/utils/graphql/answerService/graphql-queries.js.map +1 -0
- package/cjs/src/utils.d.ts +2 -1
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +19 -2
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +1 -1
- package/dist/src/embed/app.d.ts +58 -7
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +8 -2
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +56 -5
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +58 -31
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/answerService.d.ts +10 -0
- package/dist/src/utils/answerService.d.ts.map +1 -0
- package/dist/src/utils/answerService.spec.d.ts +2 -0
- package/dist/src/utils/answerService.spec.d.ts.map +1 -0
- package/dist/src/utils/authService.d.ts +37 -0
- package/dist/src/utils/authService.d.ts.map +1 -0
- package/dist/src/utils/authService.spec.d.ts +2 -0
- package/dist/src/utils/authService.spec.d.ts.map +1 -0
- 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 +37 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +2 -1
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +7105 -6920
- package/dist/tsembed-react.js +7133 -6948
- package/dist/tsembed.es.js +7372 -7187
- package/dist/tsembed.js +15659 -15474
- package/dist/visual-embed-sdk-react-full.d.ts +215 -44
- package/dist/visual-embed-sdk-react.d.ts +215 -44
- package/dist/visual-embed-sdk.d.ts +215 -44
- package/lib/package.json +1 -1
- package/lib/src/.index.d.ts.swp +0 -0
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +3 -3
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +1 -1
- package/lib/src/authToken.js +1 -1
- package/lib/src/embed/app.d.ts +58 -7
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +39 -3
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +12 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +5 -5
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +8 -2
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/search.d.ts +56 -5
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +41 -5
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +12 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +15 -9
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +9 -18
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.spec.js +1 -13
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +58 -31
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +44 -20
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/answerService/answerService.d.ts +34 -0
- package/lib/src/utils/answerService/answerService.d.ts.map +1 -0
- package/lib/src/utils/answerService/answerService.js +137 -0
- package/lib/src/utils/answerService/answerService.js.map +1 -0
- package/lib/src/utils/answerService/answerService.spec.d.ts +1 -0
- package/lib/src/utils/answerService/answerService.spec.d.ts.map +1 -0
- package/lib/src/utils/answerService/answerService.spec.js +1 -0
- package/lib/src/utils/answerService/answerService.spec.js.map +1 -0
- package/lib/src/utils/answerService/graphql-queries.d.ts +6 -0
- package/lib/src/utils/answerService/graphql-queries.d.ts.map +1 -0
- package/lib/src/utils/answerService/graphql-queries.js +120 -0
- package/lib/src/utils/answerService/graphql-queries.js.map +1 -0
- package/lib/src/utils/answerService.d.ts +10 -0
- package/lib/src/utils/answerService.d.ts.map +1 -0
- package/lib/src/utils/answerService.js +57 -0
- package/lib/src/utils/answerService.js.map +1 -0
- package/lib/src/utils/answerService.spec.d.ts +2 -0
- package/lib/src/utils/answerService.spec.d.ts.map +1 -0
- package/lib/src/utils/answerService.spec.js +29 -0
- package/lib/src/utils/answerService.spec.js.map +1 -0
- 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/authService.d.ts +37 -0
- package/lib/src/utils/authService.d.ts.map +1 -0
- package/lib/src/utils/authService.js +97 -0
- package/lib/src/utils/authService.js.map +1 -0
- package/lib/src/utils/authService.spec.d.ts +2 -0
- package/lib/src/utils/authService.spec.d.ts.map +1 -0
- package/lib/src/utils/authService.spec.js +70 -0
- package/lib/src/utils/authService.spec.js.map +1 -0
- 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 +7 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +37 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +61 -1
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +51 -2
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/graphql/answerService/graphql-queries.d.ts +5 -0
- package/lib/src/utils/graphql/answerService/graphql-queries.d.ts.map +1 -0
- package/lib/src/utils/graphql/answerService/graphql-queries.js +77 -0
- package/lib/src/utils/graphql/answerService/graphql-queries.js.map +1 -0
- package/lib/src/utils.d.ts +2 -1
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +17 -1
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +220 -49
- package/package.json +1 -1
- package/src/auth.ts +6 -6
- package/src/authToken.ts +1 -1
- package/src/embed/app.spec.ts +22 -1
- package/src/embed/app.ts +86 -9
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +14 -14
- package/src/embed/liveboard.ts +16 -3
- package/src/embed/search.spec.ts +20 -1
- package/src/embed/search.ts +85 -11
- package/src/embed/ts-embed.spec.ts +26 -34
- package/src/embed/ts-embed.ts +49 -39
- package/src/react/index.spec.tsx +1 -30
- package/src/types.ts +56 -30
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/graphql/answerService/answer-queries.ts +8 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +58 -2
- package/src/utils/graphql/answerService/answerService.ts +71 -2
- package/src/utils.ts +21 -2
|
@@ -58,6 +58,24 @@ export enum Page {
|
|
|
58
58
|
*/
|
|
59
59
|
SpotIQ = "insights"
|
|
60
60
|
}
|
|
61
|
+
/**
|
|
62
|
+
* Define the initial state os column custom group accordions
|
|
63
|
+
* in data panel v2.
|
|
64
|
+
*/
|
|
65
|
+
export enum DataPanelCustomColumnGroupsAccordionState {
|
|
66
|
+
/**
|
|
67
|
+
* Expand all the accordion initially in data panel v2.
|
|
68
|
+
*/
|
|
69
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
70
|
+
/**
|
|
71
|
+
* Collapse all the accordions initially in data panel v2.
|
|
72
|
+
*/
|
|
73
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
74
|
+
/**
|
|
75
|
+
* Expand the first accordion and collapse the rest.
|
|
76
|
+
*/
|
|
77
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
78
|
+
}
|
|
61
79
|
/**
|
|
62
80
|
* The view configuration for full app embedding.
|
|
63
81
|
*
|
|
@@ -71,6 +89,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
71
89
|
*
|
|
72
90
|
* @default true
|
|
73
91
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
92
|
+
*
|
|
74
93
|
* @example
|
|
75
94
|
* ```js
|
|
76
95
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -86,7 +105,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
86
105
|
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
87
106
|
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
88
107
|
*
|
|
89
|
-
*
|
|
90
108
|
* **Note**: This option does not apply to the classic homepage.
|
|
91
109
|
* To access the updated modular homepage, set
|
|
92
110
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -106,9 +124,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
106
124
|
/**
|
|
107
125
|
* Control the visibility of the help (?) and profile buttons on the
|
|
108
126
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
109
|
-
*
|
|
110
127
|
* @default false
|
|
111
128
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
129
|
+
*
|
|
112
130
|
* @example
|
|
113
131
|
* ```js
|
|
114
132
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -122,7 +140,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
122
140
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
123
141
|
* By default, the application switcher is shown.
|
|
124
142
|
*
|
|
125
|
-
*
|
|
126
143
|
* **Note**: This option does not apply to the classic homepage.
|
|
127
144
|
* To access the updated modular homepage, set
|
|
128
145
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -143,7 +160,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
143
160
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
144
161
|
* By default, the Org switcher button is shown.
|
|
145
162
|
*
|
|
146
|
-
*
|
|
147
163
|
* **Note**: This option does not apply to the classic homepage.
|
|
148
164
|
* To access the updated modular homepage, set
|
|
149
165
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -170,6 +186,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
170
186
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
171
187
|
*
|
|
172
188
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
189
|
+
*
|
|
173
190
|
* @example
|
|
174
191
|
* ```js
|
|
175
192
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -187,6 +204,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
187
204
|
* path within the app, use the `path` attribute which is more flexible.
|
|
188
205
|
*
|
|
189
206
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
207
|
+
*
|
|
190
208
|
* @example
|
|
191
209
|
* ```js
|
|
192
210
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -215,6 +233,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
215
233
|
* The array of GUIDs to be hidden
|
|
216
234
|
*
|
|
217
235
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
236
|
+
*
|
|
218
237
|
* @example
|
|
219
238
|
* ```js
|
|
220
239
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -237,9 +256,10 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
237
256
|
liveboardV2?: boolean;
|
|
238
257
|
/**
|
|
239
258
|
* If set to true, the Search Assist feature is enabled.
|
|
240
|
-
*
|
|
241
259
|
* @default true
|
|
260
|
+
*
|
|
242
261
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
262
|
+
*
|
|
243
263
|
* @example
|
|
244
264
|
* ```js
|
|
245
265
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -254,6 +274,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
254
274
|
* according to the height of the pages which support fullHeight mode.
|
|
255
275
|
*
|
|
256
276
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
277
|
+
*
|
|
257
278
|
* @example
|
|
258
279
|
* ```js
|
|
259
280
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -276,6 +297,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
276
297
|
*
|
|
277
298
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
278
299
|
* @default false
|
|
300
|
+
*
|
|
279
301
|
* @example
|
|
280
302
|
* ```js
|
|
281
303
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -290,6 +312,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
290
312
|
*
|
|
291
313
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
292
314
|
* @default false
|
|
315
|
+
*
|
|
293
316
|
* @example
|
|
294
317
|
* ```js
|
|
295
318
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -304,6 +327,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
304
327
|
*
|
|
305
328
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
306
329
|
* @default false
|
|
330
|
+
*
|
|
307
331
|
* @example
|
|
308
332
|
* ```js
|
|
309
333
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -356,7 +380,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
356
380
|
*/
|
|
357
381
|
collapseSearchBarInitially?: boolean;
|
|
358
382
|
/**
|
|
359
|
-
* To enable custom column groups in data panel v2
|
|
383
|
+
* To enable custom column groups in data panel v2.
|
|
360
384
|
*
|
|
361
385
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
362
386
|
* @default false
|
|
@@ -370,6 +394,27 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
370
394
|
* ```
|
|
371
395
|
*/
|
|
372
396
|
enableCustomColumnGroups?: boolean;
|
|
397
|
+
/**
|
|
398
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
399
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
400
|
+
* List of different enum values:-
|
|
401
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
402
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
403
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
404
|
+
*
|
|
405
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
406
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
407
|
+
*
|
|
408
|
+
* @example
|
|
409
|
+
* ```js
|
|
410
|
+
* const embed = new AppEmbed('#embed', {
|
|
411
|
+
* ... // other app view config
|
|
412
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
413
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
414
|
+
* });
|
|
415
|
+
* ```
|
|
416
|
+
*/
|
|
417
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
373
418
|
/**
|
|
374
419
|
* This flag is used to enable the 2 column layout in liveboard
|
|
375
420
|
*
|
|
@@ -386,6 +431,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
386
431
|
* ```
|
|
387
432
|
*/
|
|
388
433
|
enable2ColumnLayout?: boolean;
|
|
434
|
+
/**
|
|
435
|
+
* Flag to use OnBeforeSearchExecute embed event
|
|
436
|
+
*
|
|
437
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
438
|
+
*/
|
|
439
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
389
440
|
}
|
|
390
441
|
/**
|
|
391
442
|
* Embeds full ThoughtSpot experience in a host application.
|
|
@@ -600,6 +651,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
600
651
|
* incrementally as users scroll the page to view the charts and tables.
|
|
601
652
|
*
|
|
602
653
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
654
|
+
*
|
|
603
655
|
* @example
|
|
604
656
|
* ```js
|
|
605
657
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -628,6 +680,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
628
680
|
defaultHeight?: number;
|
|
629
681
|
/**
|
|
630
682
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
683
|
+
*
|
|
631
684
|
* @example
|
|
632
685
|
* ```js
|
|
633
686
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -635,6 +688,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
635
688
|
* enableVizTransformations:true,
|
|
636
689
|
* })
|
|
637
690
|
* ```
|
|
691
|
+
*
|
|
638
692
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
639
693
|
*/
|
|
640
694
|
enableVizTransformations?: boolean;
|
|
@@ -661,6 +715,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
661
715
|
* The visualization within the Liveboard to display.
|
|
662
716
|
*
|
|
663
717
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
718
|
+
*
|
|
664
719
|
* @example
|
|
665
720
|
* ```js
|
|
666
721
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -690,6 +745,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
690
745
|
* event.
|
|
691
746
|
*
|
|
692
747
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
748
|
+
*
|
|
693
749
|
* @example
|
|
694
750
|
* ```js
|
|
695
751
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -739,6 +795,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
739
795
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
740
796
|
*
|
|
741
797
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
798
|
+
*
|
|
742
799
|
* @example
|
|
743
800
|
* ```js
|
|
744
801
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -764,9 +821,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
764
821
|
hideLiveboardHeader?: boolean;
|
|
765
822
|
/**
|
|
766
823
|
* Show or hide the Liveboard title.
|
|
767
|
-
*
|
|
768
824
|
* @default false
|
|
769
825
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
826
|
+
*
|
|
770
827
|
* @example
|
|
771
828
|
* ```js
|
|
772
829
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -778,9 +835,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
778
835
|
showLiveboardTitle?: boolean;
|
|
779
836
|
/**
|
|
780
837
|
* Show or hide the Liveboard description.
|
|
781
|
-
*
|
|
782
838
|
* @default false
|
|
783
839
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
840
|
+
*
|
|
784
841
|
* @example
|
|
785
842
|
* ```js
|
|
786
843
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -909,6 +966,24 @@ export interface SearchOptions {
|
|
|
909
966
|
*/
|
|
910
967
|
executeSearch?: boolean;
|
|
911
968
|
}
|
|
969
|
+
/**
|
|
970
|
+
* Define the initial state os column custom group accordions
|
|
971
|
+
* in data panel v2.
|
|
972
|
+
*/
|
|
973
|
+
export enum DataPanelCustomColumnGroupsAccordionState {
|
|
974
|
+
/**
|
|
975
|
+
* Expand all the accordion initially in data panel v2.
|
|
976
|
+
*/
|
|
977
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
978
|
+
/**
|
|
979
|
+
* Collapse all the accordions initially in data panel v2.
|
|
980
|
+
*/
|
|
981
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
982
|
+
/**
|
|
983
|
+
* Expand the first accordion and collapse the rest.
|
|
984
|
+
*/
|
|
985
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
986
|
+
}
|
|
912
987
|
/**
|
|
913
988
|
* The configuration attributes for the embedded search view.
|
|
914
989
|
*
|
|
@@ -920,6 +995,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
920
995
|
* but can be expanded manually.
|
|
921
996
|
*
|
|
922
997
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
998
|
+
*
|
|
923
999
|
* @example
|
|
924
1000
|
* ```js
|
|
925
1001
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -933,6 +1009,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
933
1009
|
* Show or hide the data sources panel.
|
|
934
1010
|
*
|
|
935
1011
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
1012
|
+
*
|
|
936
1013
|
* @example
|
|
937
1014
|
* ```js
|
|
938
1015
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -948,6 +1025,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
948
1025
|
* using raw answer data.
|
|
949
1026
|
*
|
|
950
1027
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
1028
|
+
*
|
|
951
1029
|
* @example
|
|
952
1030
|
* ```js
|
|
953
1031
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -957,14 +1035,11 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
957
1035
|
* ```
|
|
958
1036
|
*/
|
|
959
1037
|
hideResults?: boolean;
|
|
960
|
-
/**
|
|
961
|
-
* If set to true, expands all the data sources panel.
|
|
962
|
-
*/
|
|
963
|
-
expandAllDataSource?: boolean;
|
|
964
1038
|
/**
|
|
965
1039
|
* If set to true, the Search Assist feature is enabled.
|
|
966
1040
|
*
|
|
967
1041
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
1042
|
+
*
|
|
968
1043
|
* @example
|
|
969
1044
|
* ```js
|
|
970
1045
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -979,6 +1054,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
979
1054
|
* format for presenting search data.
|
|
980
1055
|
*
|
|
981
1056
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1057
|
+
*
|
|
982
1058
|
* @example
|
|
983
1059
|
* ```js
|
|
984
1060
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -992,6 +1068,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
992
1068
|
* Only a single data source is supported currently.
|
|
993
1069
|
*
|
|
994
1070
|
* @deprecated Use `dataSource` instead.
|
|
1071
|
+
*
|
|
995
1072
|
* @example
|
|
996
1073
|
* ```js
|
|
997
1074
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1005,6 +1082,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1005
1082
|
* The array of data source GUIDs to set on load.
|
|
1006
1083
|
*
|
|
1007
1084
|
* @version: SDK: 1.19.0
|
|
1085
|
+
*
|
|
1008
1086
|
* @example
|
|
1009
1087
|
* ```js
|
|
1010
1088
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1046,6 +1124,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1046
1124
|
* The GUID of a saved answer to load initially.
|
|
1047
1125
|
*
|
|
1048
1126
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1127
|
+
*
|
|
1049
1128
|
* @example
|
|
1050
1129
|
* ```js
|
|
1051
1130
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1060,6 +1139,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1060
1139
|
* The chart/table should still be visible.
|
|
1061
1140
|
*
|
|
1062
1141
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1142
|
+
*
|
|
1063
1143
|
* @example
|
|
1064
1144
|
* ```js
|
|
1065
1145
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1074,6 +1154,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1074
1154
|
*
|
|
1075
1155
|
* @default false
|
|
1076
1156
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1157
|
+
*
|
|
1077
1158
|
* @example
|
|
1078
1159
|
* ```js
|
|
1079
1160
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1111,6 +1192,33 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1111
1192
|
* ```
|
|
1112
1193
|
*/
|
|
1113
1194
|
enableCustomColumnGroups?: boolean;
|
|
1195
|
+
/**
|
|
1196
|
+
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1197
|
+
*
|
|
1198
|
+
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
1199
|
+
*/
|
|
1200
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1201
|
+
/**
|
|
1202
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
1203
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
1204
|
+
* List of different enum values:-
|
|
1205
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1206
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1207
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1208
|
+
*
|
|
1209
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1210
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1211
|
+
*
|
|
1212
|
+
* @example
|
|
1213
|
+
* ```js
|
|
1214
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
1215
|
+
* ... // other options
|
|
1216
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
1217
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
1218
|
+
* });
|
|
1219
|
+
* ```
|
|
1220
|
+
*/
|
|
1221
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1114
1222
|
}
|
|
1115
1223
|
export const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
1116
1224
|
/**
|
|
@@ -1563,7 +1671,6 @@ export enum AuthType {
|
|
|
1563
1671
|
* .then((data) => data.token);
|
|
1564
1672
|
* }
|
|
1565
1673
|
* });
|
|
1566
|
-
* });
|
|
1567
1674
|
* ```
|
|
1568
1675
|
*/
|
|
1569
1676
|
TrustedAuthToken = "AuthServer",
|
|
@@ -2064,6 +2171,7 @@ export interface ViewConfig {
|
|
|
2064
2171
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2065
2172
|
*
|
|
2066
2173
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2174
|
+
*
|
|
2067
2175
|
* @example
|
|
2068
2176
|
* ```js
|
|
2069
2177
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2102,7 +2210,6 @@ export interface ViewConfig {
|
|
|
2102
2210
|
disabledActions?: Action[];
|
|
2103
2211
|
/**
|
|
2104
2212
|
* The tooltip to display for disabled actions.
|
|
2105
|
-
*
|
|
2106
2213
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2107
2214
|
* @example
|
|
2108
2215
|
* ```js
|
|
@@ -2120,6 +2227,7 @@ export interface ViewConfig {
|
|
|
2120
2227
|
* Use this to hide an action.
|
|
2121
2228
|
*
|
|
2122
2229
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2230
|
+
*
|
|
2123
2231
|
* @example
|
|
2124
2232
|
* ```js
|
|
2125
2233
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2140,6 +2248,7 @@ export interface ViewConfig {
|
|
|
2140
2248
|
*
|
|
2141
2249
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2142
2250
|
* @important
|
|
2251
|
+
*
|
|
2143
2252
|
* @example
|
|
2144
2253
|
* ```js
|
|
2145
2254
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2153,6 +2262,7 @@ export interface ViewConfig {
|
|
|
2153
2262
|
* Show alert messages and toast messages in the embedded view.
|
|
2154
2263
|
*
|
|
2155
2264
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2265
|
+
*
|
|
2156
2266
|
* @example
|
|
2157
2267
|
* ```js
|
|
2158
2268
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2167,6 +2277,7 @@ export interface ViewConfig {
|
|
|
2167
2277
|
* visualization, or Liveboard.
|
|
2168
2278
|
*
|
|
2169
2279
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2280
|
+
*
|
|
2170
2281
|
* @example
|
|
2171
2282
|
* ```js
|
|
2172
2283
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2187,6 +2298,7 @@ export interface ViewConfig {
|
|
|
2187
2298
|
* visualization, or Liveboard.
|
|
2188
2299
|
*
|
|
2189
2300
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2301
|
+
*
|
|
2190
2302
|
* @example
|
|
2191
2303
|
* ```js
|
|
2192
2304
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2221,7 +2333,6 @@ export interface ViewConfig {
|
|
|
2221
2333
|
* Warning: This option is for advanced use only and is used internally
|
|
2222
2334
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
2223
2335
|
* list of supported keys and values associated with each.
|
|
2224
|
-
*
|
|
2225
2336
|
* @example
|
|
2226
2337
|
* ```js
|
|
2227
2338
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2250,6 +2361,7 @@ export interface ViewConfig {
|
|
|
2250
2361
|
* child inside it.
|
|
2251
2362
|
*
|
|
2252
2363
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2364
|
+
*
|
|
2253
2365
|
* @example
|
|
2254
2366
|
* ```js
|
|
2255
2367
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2335,8 +2447,6 @@ export interface ViewConfig {
|
|
|
2335
2447
|
* Hide the home page modules
|
|
2336
2448
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
2337
2449
|
*
|
|
2338
|
-
*
|
|
2339
|
-
*
|
|
2340
2450
|
* **Note**: This option does not apply to the classic homepage.
|
|
2341
2451
|
* To access the updated modular homepage, set
|
|
2342
2452
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -2349,13 +2459,13 @@ export interface ViewConfig {
|
|
|
2349
2459
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2350
2460
|
* })
|
|
2351
2461
|
* ```
|
|
2462
|
+
*
|
|
2352
2463
|
*/
|
|
2353
2464
|
hiddenHomepageModules?: HomepageModule[];
|
|
2354
2465
|
/**
|
|
2355
2466
|
* reordering the home page modules
|
|
2356
2467
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
2357
2468
|
*
|
|
2358
|
-
*
|
|
2359
2469
|
* **Note**: This option does not apply to the classic homepage.
|
|
2360
2470
|
* To access the updated modular homepage, set
|
|
2361
2471
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -2378,6 +2488,7 @@ export interface ViewConfig {
|
|
|
2378
2488
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2379
2489
|
*
|
|
2380
2490
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2491
|
+
*
|
|
2381
2492
|
* @example
|
|
2382
2493
|
* ```js
|
|
2383
2494
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2403,8 +2514,6 @@ export interface ViewConfig {
|
|
|
2403
2514
|
* })
|
|
2404
2515
|
* ```
|
|
2405
2516
|
*
|
|
2406
|
-
*
|
|
2407
|
-
*
|
|
2408
2517
|
* **Note**: This option does not apply to the classic homepage.
|
|
2409
2518
|
* To access the updated modular homepage, set
|
|
2410
2519
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
@@ -2437,6 +2546,7 @@ export interface ViewConfig {
|
|
|
2437
2546
|
* @type {boolean}
|
|
2438
2547
|
* @default false
|
|
2439
2548
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2549
|
+
*
|
|
2440
2550
|
* @example
|
|
2441
2551
|
* ```js
|
|
2442
2552
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2618,7 +2728,7 @@ export interface RuntimeFilter {
|
|
|
2618
2728
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
2619
2729
|
* operands.
|
|
2620
2730
|
*/
|
|
2621
|
-
values: (number | boolean | string)[];
|
|
2731
|
+
values: (number | boolean | string | bigint)[];
|
|
2622
2732
|
}
|
|
2623
2733
|
/**
|
|
2624
2734
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -2851,19 +2961,14 @@ export enum EmbedEvent {
|
|
|
2851
2961
|
/**
|
|
2852
2962
|
* An error has occurred. This event is fired for the following error types:
|
|
2853
2963
|
*
|
|
2854
|
-
*
|
|
2855
|
-
*
|
|
2856
|
-
*
|
|
2857
|
-
*
|
|
2858
|
-
*
|
|
2964
|
+
* `API` - API call failure error.
|
|
2965
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
|
|
2966
|
+
* `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
|
|
2967
|
+
* `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
2968
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
2969
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
2859
2970
|
*
|
|
2860
|
-
*
|
|
2861
|
-
*
|
|
2862
|
-
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
2863
|
-
*
|
|
2864
|
-
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
2865
|
-
*
|
|
2866
|
-
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
2971
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
2867
2972
|
*
|
|
2868
2973
|
* @returns error - An error object or message
|
|
2869
2974
|
*
|
|
@@ -2977,7 +3082,7 @@ export enum EmbedEvent {
|
|
|
2977
3082
|
/**
|
|
2978
3083
|
* Emitted when the embed does not have cookie access. This happens
|
|
2979
3084
|
* when Safari and other Web browsers block third-party cookies
|
|
2980
|
-
* are blocked by default.
|
|
3085
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
2981
3086
|
*
|
|
2982
3087
|
* @example
|
|
2983
3088
|
*```js
|
|
@@ -3020,7 +3125,7 @@ export enum EmbedEvent {
|
|
|
3020
3125
|
/**
|
|
3021
3126
|
* Emitted when the Liveboard shell loads.
|
|
3022
3127
|
* You can use this event as a hook to trigger
|
|
3023
|
-
*
|
|
3128
|
+
* other events on the rendered Liveboard.
|
|
3024
3129
|
*
|
|
3025
3130
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3026
3131
|
* @example
|
|
@@ -3074,7 +3179,7 @@ export enum EmbedEvent {
|
|
|
3074
3179
|
/**
|
|
3075
3180
|
* Emitted when the download action is triggered on an answer
|
|
3076
3181
|
*
|
|
3077
|
-
*
|
|
3182
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
3078
3183
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3079
3184
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3080
3185
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
@@ -3157,7 +3262,7 @@ export enum EmbedEvent {
|
|
|
3157
3262
|
* //emit when action starts
|
|
3158
3263
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3159
3264
|
* console.log('delete answer', payload)}, {start: true })
|
|
3160
|
-
* //
|
|
3265
|
+
* //trigger when action is completed
|
|
3161
3266
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3162
3267
|
* console.log('delete answer', payload)})
|
|
3163
3268
|
*```
|
|
@@ -3489,7 +3594,7 @@ export enum EmbedEvent {
|
|
|
3489
3594
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3490
3595
|
* @example
|
|
3491
3596
|
*```js
|
|
3492
|
-
* liveboardEmbed.
|
|
3597
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
3493
3598
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3494
3599
|
*```
|
|
3495
3600
|
*/
|
|
@@ -3517,14 +3622,14 @@ export enum EmbedEvent {
|
|
|
3517
3622
|
* Returns filter type and name, column name and ID, and runtime
|
|
3518
3623
|
* filter details.
|
|
3519
3624
|
*
|
|
3520
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3521
3625
|
* @example
|
|
3522
3626
|
*
|
|
3523
3627
|
*```js
|
|
3524
3628
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3525
3629
|
* console.log('payload', payload);
|
|
3526
3630
|
* })
|
|
3527
|
-
|
|
3631
|
+
*
|
|
3632
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3528
3633
|
*/
|
|
3529
3634
|
FilterChanged = "filterChanged",
|
|
3530
3635
|
/**
|
|
@@ -3611,7 +3716,25 @@ export enum EmbedEvent {
|
|
|
3611
3716
|
*
|
|
3612
3717
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3613
3718
|
*/
|
|
3614
|
-
Rename = "rename"
|
|
3719
|
+
Rename = "rename",
|
|
3720
|
+
/**
|
|
3721
|
+
* Emitted when user wants to intercept the search execution
|
|
3722
|
+
*
|
|
3723
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
3724
|
+
* event
|
|
3725
|
+
*
|
|
3726
|
+
*```js
|
|
3727
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
3728
|
+
* responder({
|
|
3729
|
+
* data: {
|
|
3730
|
+
* execute: true,
|
|
3731
|
+
* error: {errorText: "My own customised error"}
|
|
3732
|
+
* }})
|
|
3733
|
+
* })
|
|
3734
|
+
*```
|
|
3735
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3736
|
+
*/
|
|
3737
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept"
|
|
3615
3738
|
}
|
|
3616
3739
|
/**
|
|
3617
3740
|
* Event types that can be triggered by the host application
|
|
@@ -4414,7 +4537,17 @@ export enum HostEvent {
|
|
|
4414
4537
|
* ```
|
|
4415
4538
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4416
4539
|
*/
|
|
4417
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
4540
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4541
|
+
/**
|
|
4542
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4543
|
+
*
|
|
4544
|
+
* @example
|
|
4545
|
+
* ```js
|
|
4546
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
4547
|
+
*
|
|
4548
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4549
|
+
*/
|
|
4550
|
+
CreateLiveboard = "CreateLiveboard"
|
|
4418
4551
|
}
|
|
4419
4552
|
/**
|
|
4420
4553
|
* The different visual modes that the data sources panel within
|
|
@@ -4512,12 +4645,14 @@ export enum Param {
|
|
|
4512
4645
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
4513
4646
|
enableAskSage = "enableAskSage",
|
|
4514
4647
|
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
4648
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
4515
4649
|
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
4516
4650
|
DateFormatLocale = "dateFormatLocale",
|
|
4517
4651
|
NumberFormatLocale = "numberFormatLocale",
|
|
4518
4652
|
CurrencyFormat = "currencyFormat",
|
|
4519
4653
|
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4520
|
-
IsFullAppEmbed = "isFullAppEmbed"
|
|
4654
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
4655
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4521
4656
|
}
|
|
4522
4657
|
/**
|
|
4523
4658
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -6176,6 +6311,16 @@ export interface UnderlyingDataPoint {
|
|
|
6176
6311
|
* const data = await underlying.fetchData(0, 100);
|
|
6177
6312
|
* })
|
|
6178
6313
|
* ```
|
|
6314
|
+
* @example
|
|
6315
|
+
* ```js
|
|
6316
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6317
|
+
* const service = await embed.getAnswerService();
|
|
6318
|
+
* await service.addColumns([
|
|
6319
|
+
* "<column guid>"
|
|
6320
|
+
* ]);
|
|
6321
|
+
* console.log(await service.fetchData());
|
|
6322
|
+
* });
|
|
6323
|
+
* ```
|
|
6179
6324
|
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
6180
6325
|
* @group Events
|
|
6181
6326
|
*/
|
|
@@ -6208,6 +6353,32 @@ export class AnswerService {
|
|
|
6208
6353
|
* @returns
|
|
6209
6354
|
*/
|
|
6210
6355
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6356
|
+
/**
|
|
6357
|
+
* Add columns by names and return updated answer session.
|
|
6358
|
+
*
|
|
6359
|
+
* @param columnNames
|
|
6360
|
+
* @returns
|
|
6361
|
+
* @example
|
|
6362
|
+
* ```js
|
|
6363
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6364
|
+
* const service = await embed.getAnswerService();
|
|
6365
|
+
* await service.addColumnsByNames([
|
|
6366
|
+
* "col name 1",
|
|
6367
|
+
* "col name 2"
|
|
6368
|
+
* ]);
|
|
6369
|
+
* console.log(await service.fetchData());
|
|
6370
|
+
* });
|
|
6371
|
+
*/
|
|
6372
|
+
addColumnsByNames(columnNames: string[]): Promise<any>;
|
|
6373
|
+
/**
|
|
6374
|
+
* Add a filter to the answer.
|
|
6375
|
+
*
|
|
6376
|
+
* @param columnName
|
|
6377
|
+
* @param operator
|
|
6378
|
+
* @param values
|
|
6379
|
+
* @returns
|
|
6380
|
+
*/
|
|
6381
|
+
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6211
6382
|
/**
|
|
6212
6383
|
* Fetch data from the answer.
|
|
6213
6384
|
*
|
|
@@ -6340,7 +6511,7 @@ export const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<strin
|
|
|
6340
6511
|
* ```js
|
|
6341
6512
|
* resetCachedAuthToken();
|
|
6342
6513
|
* ```
|
|
6343
|
-
* @version SDK: 1.28.
|
|
6514
|
+
* @version SDK: 1.28.0 | ThoughtSpot: *
|
|
6344
6515
|
* @group Authentication / Init
|
|
6345
6516
|
*/
|
|
6346
6517
|
export const resetCachedAuthToken: () => void;
|