@thoughtspot/visual-embed-sdk 1.29.1 → 1.30.0-alpha.1

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