@thoughtspot/visual-embed-sdk 1.29.1-alpha.0 → 1.29.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 (347) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +2 -1
  3. package/cjs/src/auth.d.ts +0 -15
  4. package/cjs/src/auth.d.ts.map +1 -1
  5. package/cjs/src/auth.js +2 -13
  6. package/cjs/src/auth.js.map +1 -1
  7. package/cjs/src/authToken.d.ts +1 -2
  8. package/cjs/src/authToken.d.ts.map +1 -1
  9. package/cjs/src/authToken.js +9 -3
  10. package/cjs/src/authToken.js.map +1 -1
  11. package/cjs/src/authToken.spec.d.ts +2 -0
  12. package/cjs/src/authToken.spec.d.ts.map +1 -0
  13. package/cjs/src/authToken.spec.js +29 -0
  14. package/cjs/src/authToken.spec.js.map +1 -0
  15. package/cjs/src/config.d.ts +0 -1
  16. package/cjs/src/config.d.ts.map +1 -1
  17. package/cjs/src/config.js +0 -2
  18. package/cjs/src/config.js.map +1 -1
  19. package/cjs/src/embed/app.d.ts +73 -43
  20. package/cjs/src/embed/app.d.ts.map +1 -1
  21. package/cjs/src/embed/app.js +45 -12
  22. package/cjs/src/embed/app.js.map +1 -1
  23. package/cjs/src/embed/app.spec.js +21 -0
  24. package/cjs/src/embed/app.spec.js.map +1 -1
  25. package/cjs/src/embed/base.d.ts +1 -7
  26. package/cjs/src/embed/base.d.ts.map +1 -1
  27. package/cjs/src/embed/base.js +9 -15
  28. package/cjs/src/embed/base.js.map +1 -1
  29. package/cjs/src/embed/base.spec.js +3 -1
  30. package/cjs/src/embed/base.spec.js.map +1 -1
  31. package/cjs/src/embed/embedConfig.d.ts +0 -2
  32. package/cjs/src/embed/embedConfig.d.ts.map +1 -1
  33. package/cjs/src/embed/embedConfig.js +0 -2
  34. package/cjs/src/embed/embedConfig.js.map +1 -1
  35. package/cjs/src/embed/liveboard.d.ts +14 -28
  36. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  37. package/cjs/src/embed/liveboard.js +9 -9
  38. package/cjs/src/embed/liveboard.js.map +1 -1
  39. package/cjs/src/embed/liveboard.spec.js +79 -4
  40. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  41. package/cjs/src/embed/sage.d.ts +5 -21
  42. package/cjs/src/embed/sage.d.ts.map +1 -1
  43. package/cjs/src/embed/sage.js +2 -23
  44. package/cjs/src/embed/sage.js.map +1 -1
  45. package/cjs/src/embed/sage.spec.js +20 -31
  46. package/cjs/src/embed/sage.spec.js.map +1 -1
  47. package/cjs/src/embed/search-bar.d.ts +0 -11
  48. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  49. package/cjs/src/embed/search-bar.js +0 -2
  50. package/cjs/src/embed/search-bar.js.map +1 -1
  51. package/cjs/src/embed/search.d.ts +60 -29
  52. package/cjs/src/embed/search.d.ts.map +1 -1
  53. package/cjs/src/embed/search.js +43 -9
  54. package/cjs/src/embed/search.js.map +1 -1
  55. package/cjs/src/embed/search.spec.js +34 -0
  56. package/cjs/src/embed/search.spec.js.map +1 -1
  57. package/cjs/src/embed/ts-embed.d.ts +1 -31
  58. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  59. package/cjs/src/embed/ts-embed.js +34 -43
  60. package/cjs/src/embed/ts-embed.js.map +1 -1
  61. package/cjs/src/embed/ts-embed.spec.js +83 -9
  62. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  63. package/cjs/src/errors.js +1 -1
  64. package/cjs/src/errors.js.map +1 -1
  65. package/cjs/src/index.d.ts +0 -1
  66. package/cjs/src/index.d.ts.map +1 -1
  67. package/cjs/src/index.js +0 -1
  68. package/cjs/src/index.js.map +1 -1
  69. package/cjs/src/mixpanel-service.d.ts +0 -1
  70. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  71. package/cjs/src/mixpanel-service.js +0 -1
  72. package/cjs/src/mixpanel-service.js.map +1 -1
  73. package/cjs/src/react/index.d.ts +1 -12
  74. package/cjs/src/react/index.d.ts.map +1 -1
  75. package/cjs/src/react/index.js +1 -11
  76. package/cjs/src/react/index.js.map +1 -1
  77. package/cjs/src/react/index.spec.js +15 -3
  78. package/cjs/src/react/index.spec.js.map +1 -1
  79. package/cjs/src/test/test-utils.d.ts +0 -2
  80. package/cjs/src/test/test-utils.d.ts.map +1 -1
  81. package/cjs/src/test/test-utils.js +0 -2
  82. package/cjs/src/test/test-utils.js.map +1 -1
  83. package/cjs/src/tokenizedFetch.d.ts +0 -1
  84. package/cjs/src/tokenizedFetch.d.ts.map +1 -1
  85. package/cjs/src/tokenizedFetch.js +0 -1
  86. package/cjs/src/tokenizedFetch.js.map +1 -1
  87. package/cjs/src/types.d.ts +245 -366
  88. package/cjs/src/types.d.ts.map +1 -1
  89. package/cjs/src/types.js +196 -296
  90. package/cjs/src/types.js.map +1 -1
  91. package/cjs/src/utils/authService/authService.d.ts +0 -1
  92. package/cjs/src/utils/authService/authService.d.ts.map +1 -1
  93. package/cjs/src/utils/authService/authService.js +0 -1
  94. package/cjs/src/utils/authService/authService.js.map +1 -1
  95. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +2 -0
  96. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  97. package/cjs/src/utils/graphql/answerService/answer-queries.js +57 -1
  98. package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  99. package/cjs/src/utils/graphql/answerService/answerService.d.ts +37 -12
  100. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  101. package/cjs/src/utils/graphql/answerService/answerService.js +70 -14
  102. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  103. package/cjs/src/utils/graphql/answerService/answerService.spec.js +78 -0
  104. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  105. package/cjs/src/utils/logger.d.ts.map +1 -1
  106. package/cjs/src/utils/logger.js +3 -5
  107. package/cjs/src/utils/logger.js.map +1 -1
  108. package/cjs/src/utils/processData.js +1 -1
  109. package/cjs/src/utils/processData.js.map +1 -1
  110. package/cjs/src/utils/processData.spec.js +1 -1
  111. package/cjs/src/utils/processData.spec.js.map +1 -1
  112. package/cjs/src/utils/processTrigger.d.ts +0 -1
  113. package/cjs/src/utils/processTrigger.d.ts.map +1 -1
  114. package/cjs/src/utils/processTrigger.js +0 -2
  115. package/cjs/src/utils/processTrigger.js.map +1 -1
  116. package/cjs/src/utils.d.ts +2 -10
  117. package/cjs/src/utils.d.ts.map +1 -1
  118. package/cjs/src/utils.js +19 -13
  119. package/cjs/src/utils.js.map +1 -1
  120. package/dist/src/auth.d.ts +0 -15
  121. package/dist/src/auth.d.ts.map +1 -1
  122. package/dist/src/authToken.d.ts +1 -2
  123. package/dist/src/authToken.d.ts.map +1 -1
  124. package/dist/src/authToken.spec.d.ts +2 -0
  125. package/dist/src/authToken.spec.d.ts.map +1 -0
  126. package/dist/src/config.d.ts +0 -1
  127. package/dist/src/config.d.ts.map +1 -1
  128. package/dist/src/embed/app.d.ts +73 -43
  129. package/dist/src/embed/app.d.ts.map +1 -1
  130. package/dist/src/embed/base.d.ts +1 -7
  131. package/dist/src/embed/base.d.ts.map +1 -1
  132. package/dist/src/embed/embedConfig.d.ts +0 -2
  133. package/dist/src/embed/embedConfig.d.ts.map +1 -1
  134. package/dist/src/embed/liveboard.d.ts +14 -28
  135. package/dist/src/embed/liveboard.d.ts.map +1 -1
  136. package/dist/src/embed/sage.d.ts +5 -21
  137. package/dist/src/embed/sage.d.ts.map +1 -1
  138. package/dist/src/embed/search-bar.d.ts +0 -11
  139. package/dist/src/embed/search-bar.d.ts.map +1 -1
  140. package/dist/src/embed/search.d.ts +60 -29
  141. package/dist/src/embed/search.d.ts.map +1 -1
  142. package/dist/src/embed/ts-embed.d.ts +1 -31
  143. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  144. package/dist/src/index.d.ts +0 -1
  145. package/dist/src/index.d.ts.map +1 -1
  146. package/dist/src/mixpanel-service.d.ts +0 -1
  147. package/dist/src/mixpanel-service.d.ts.map +1 -1
  148. package/dist/src/react/index.d.ts +1 -12
  149. package/dist/src/react/index.d.ts.map +1 -1
  150. package/dist/src/test/test-utils.d.ts +0 -2
  151. package/dist/src/test/test-utils.d.ts.map +1 -1
  152. package/dist/src/tokenizedFetch.d.ts +0 -1
  153. package/dist/src/tokenizedFetch.d.ts.map +1 -1
  154. package/dist/src/types.d.ts +245 -366
  155. package/dist/src/types.d.ts.map +1 -1
  156. package/dist/src/utils/authService/authService.d.ts +0 -1
  157. package/dist/src/utils/authService/authService.d.ts.map +1 -1
  158. package/dist/src/utils/graphql/answerService/answer-queries.d.ts +2 -0
  159. package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  160. package/dist/src/utils/graphql/answerService/answerService.d.ts +37 -12
  161. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  162. package/dist/src/utils/logger.d.ts.map +1 -1
  163. package/dist/src/utils/processTrigger.d.ts +0 -1
  164. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  165. package/dist/src/utils.d.ts +2 -10
  166. package/dist/src/utils.d.ts.map +1 -1
  167. package/dist/tsembed-react.es.js +2331 -2358
  168. package/dist/tsembed-react.js +3475 -3498
  169. package/dist/tsembed.es.js +3690 -3922
  170. package/dist/tsembed.js +15218 -15442
  171. package/dist/visual-embed-sdk-react-full.d.ts +431 -564
  172. package/dist/visual-embed-sdk-react.d.ts +434 -567
  173. package/dist/visual-embed-sdk.d.ts +430 -552
  174. package/lib/package.json +2 -1
  175. package/lib/src/auth.d.ts +0 -15
  176. package/lib/src/auth.d.ts.map +1 -1
  177. package/lib/src/auth.js +3 -14
  178. package/lib/src/auth.js.map +1 -1
  179. package/lib/src/authToken.d.ts +1 -2
  180. package/lib/src/authToken.d.ts.map +1 -1
  181. package/lib/src/authToken.js +9 -3
  182. package/lib/src/authToken.js.map +1 -1
  183. package/lib/src/authToken.spec.d.ts +2 -0
  184. package/lib/src/authToken.spec.d.ts.map +1 -0
  185. package/lib/src/authToken.spec.js +26 -0
  186. package/lib/src/authToken.spec.js.map +1 -0
  187. package/lib/src/config.d.ts +0 -1
  188. package/lib/src/config.d.ts.map +1 -1
  189. package/lib/src/config.js +0 -2
  190. package/lib/src/config.js.map +1 -1
  191. package/lib/src/embed/app.d.ts +73 -43
  192. package/lib/src/embed/app.d.ts.map +1 -1
  193. package/lib/src/embed/app.js +44 -11
  194. package/lib/src/embed/app.js.map +1 -1
  195. package/lib/src/embed/app.spec.js +22 -1
  196. package/lib/src/embed/app.spec.js.map +1 -1
  197. package/lib/src/embed/base.d.ts +1 -7
  198. package/lib/src/embed/base.d.ts.map +1 -1
  199. package/lib/src/embed/base.js +8 -14
  200. package/lib/src/embed/base.js.map +1 -1
  201. package/lib/src/embed/base.spec.js +4 -2
  202. package/lib/src/embed/base.spec.js.map +1 -1
  203. package/lib/src/embed/embedConfig.d.ts +0 -2
  204. package/lib/src/embed/embedConfig.d.ts.map +1 -1
  205. package/lib/src/embed/embedConfig.js +0 -2
  206. package/lib/src/embed/embedConfig.js.map +1 -1
  207. package/lib/src/embed/liveboard.d.ts +14 -28
  208. package/lib/src/embed/liveboard.d.ts.map +1 -1
  209. package/lib/src/embed/liveboard.js +10 -10
  210. package/lib/src/embed/liveboard.js.map +1 -1
  211. package/lib/src/embed/liveboard.spec.js +79 -4
  212. package/lib/src/embed/liveboard.spec.js.map +1 -1
  213. package/lib/src/embed/sage.d.ts +5 -21
  214. package/lib/src/embed/sage.d.ts.map +1 -1
  215. package/lib/src/embed/sage.js +2 -23
  216. package/lib/src/embed/sage.js.map +1 -1
  217. package/lib/src/embed/sage.spec.js +20 -31
  218. package/lib/src/embed/sage.spec.js.map +1 -1
  219. package/lib/src/embed/search-bar.d.ts +0 -11
  220. package/lib/src/embed/search-bar.d.ts.map +1 -1
  221. package/lib/src/embed/search-bar.js +0 -2
  222. package/lib/src/embed/search-bar.js.map +1 -1
  223. package/lib/src/embed/search.d.ts +60 -29
  224. package/lib/src/embed/search.d.ts.map +1 -1
  225. package/lib/src/embed/search.js +43 -9
  226. package/lib/src/embed/search.js.map +1 -1
  227. package/lib/src/embed/search.spec.js +35 -1
  228. package/lib/src/embed/search.spec.js.map +1 -1
  229. package/lib/src/embed/ts-embed.d.ts +1 -31
  230. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  231. package/lib/src/embed/ts-embed.js +37 -46
  232. package/lib/src/embed/ts-embed.js.map +1 -1
  233. package/lib/src/embed/ts-embed.spec.js +83 -9
  234. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  235. package/lib/src/errors.js +1 -1
  236. package/lib/src/errors.js.map +1 -1
  237. package/lib/src/index.d.ts +0 -1
  238. package/lib/src/index.d.ts.map +1 -1
  239. package/lib/src/index.js +0 -1
  240. package/lib/src/index.js.map +1 -1
  241. package/lib/src/mixpanel-service.d.ts +0 -1
  242. package/lib/src/mixpanel-service.d.ts.map +1 -1
  243. package/lib/src/mixpanel-service.js +0 -1
  244. package/lib/src/mixpanel-service.js.map +1 -1
  245. package/lib/src/react/index.d.ts +1 -12
  246. package/lib/src/react/index.d.ts.map +1 -1
  247. package/lib/src/react/index.js +1 -11
  248. package/lib/src/react/index.js.map +1 -1
  249. package/lib/src/react/index.spec.js +16 -4
  250. package/lib/src/react/index.spec.js.map +1 -1
  251. package/lib/src/test/test-utils.d.ts +0 -2
  252. package/lib/src/test/test-utils.d.ts.map +1 -1
  253. package/lib/src/test/test-utils.js +0 -2
  254. package/lib/src/test/test-utils.js.map +1 -1
  255. package/lib/src/tokenizedFetch.d.ts +0 -1
  256. package/lib/src/tokenizedFetch.d.ts.map +1 -1
  257. package/lib/src/tokenizedFetch.js +0 -1
  258. package/lib/src/tokenizedFetch.js.map +1 -1
  259. package/lib/src/types.d.ts +245 -366
  260. package/lib/src/types.d.ts.map +1 -1
  261. package/lib/src/types.js +196 -296
  262. package/lib/src/types.js.map +1 -1
  263. package/lib/src/utils/authService/authService.d.ts +0 -1
  264. package/lib/src/utils/authService/authService.d.ts.map +1 -1
  265. package/lib/src/utils/authService/authService.js +0 -1
  266. package/lib/src/utils/authService/authService.js.map +1 -1
  267. package/lib/src/utils/authService/authService.spec.js +1 -1
  268. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  269. package/lib/src/utils/graphql/answerService/answer-queries.d.ts +2 -0
  270. package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  271. package/lib/src/utils/graphql/answerService/answer-queries.js +56 -0
  272. package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  273. package/lib/src/utils/graphql/answerService/answerService.d.ts +37 -12
  274. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  275. package/lib/src/utils/graphql/answerService/answerService.js +71 -15
  276. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  277. package/lib/src/utils/graphql/answerService/answerService.spec.js +80 -2
  278. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  279. package/lib/src/utils/logger.d.ts.map +1 -1
  280. package/lib/src/utils/logger.js +2 -3
  281. package/lib/src/utils/logger.js.map +1 -1
  282. package/lib/src/utils/processData.js +1 -1
  283. package/lib/src/utils/processData.js.map +1 -1
  284. package/lib/src/utils/processData.spec.js +1 -1
  285. package/lib/src/utils/processData.spec.js.map +1 -1
  286. package/lib/src/utils/processTrigger.d.ts +0 -1
  287. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  288. package/lib/src/utils/processTrigger.js +0 -2
  289. package/lib/src/utils/processTrigger.js.map +1 -1
  290. package/lib/src/utils.d.ts +2 -10
  291. package/lib/src/utils.d.ts.map +1 -1
  292. package/lib/src/utils.js +17 -12
  293. package/lib/src/utils.js.map +1 -1
  294. package/lib/src/visual-embed-sdk.d.ts +436 -558
  295. package/package.json +3 -1
  296. package/src/auth.spec.ts +72 -66
  297. package/src/auth.ts +53 -54
  298. package/src/authToken.spec.ts +31 -0
  299. package/src/authToken.ts +12 -12
  300. package/src/config.ts +0 -2
  301. package/src/embed/app.spec.ts +39 -5
  302. package/src/embed/app.ts +108 -50
  303. package/src/embed/base.spec.ts +5 -4
  304. package/src/embed/base.ts +30 -36
  305. package/src/embed/embed.spec.ts +0 -2
  306. package/src/embed/embedConfig.ts +0 -2
  307. package/src/embed/events.spec.ts +0 -2
  308. package/src/embed/liveboard.spec.ts +104 -11
  309. package/src/embed/liveboard.ts +25 -38
  310. package/src/embed/pinboard.spec.ts +0 -2
  311. package/src/embed/sage.spec.ts +20 -38
  312. package/src/embed/sage.ts +5 -38
  313. package/src/embed/search-bar.tsx +0 -11
  314. package/src/embed/search.spec.ts +48 -2
  315. package/src/embed/search.ts +94 -38
  316. package/src/embed/ts-embed-trigger.spec.ts +0 -3
  317. package/src/embed/ts-embed.spec.ts +109 -32
  318. package/src/embed/ts-embed.ts +68 -79
  319. package/src/errors.ts +1 -1
  320. package/src/index.ts +1 -3
  321. package/src/mixpanel-service.spec.ts +3 -4
  322. package/src/mixpanel-service.ts +1 -4
  323. package/src/react/index.spec.tsx +48 -67
  324. package/src/react/index.tsx +1 -13
  325. package/src/test/test-utils.ts +0 -2
  326. package/src/tokenizedFetch.ts +0 -1
  327. package/src/types.ts +245 -365
  328. package/src/utils/authService/authService.spec.ts +8 -13
  329. package/src/utils/authService/authService.ts +0 -2
  330. package/src/utils/authService/tokenizedAuthService.ts +8 -38
  331. package/src/utils/graphql/answerService/answer-queries.ts +58 -0
  332. package/src/utils/graphql/answerService/answerService.spec.ts +88 -2
  333. package/src/utils/graphql/answerService/answerService.ts +87 -16
  334. package/src/utils/logger.ts +2 -3
  335. package/src/utils/processData.spec.ts +3 -4
  336. package/src/utils/processData.ts +4 -2
  337. package/src/utils/processTrigger.ts +0 -2
  338. package/src/utils.ts +21 -13
  339. package/cjs/src/utils/sessionInfoService.d.ts +0 -66
  340. package/cjs/src/utils/sessionInfoService.d.ts.map +0 -1
  341. package/cjs/src/utils/sessionInfoService.js +0 -92
  342. package/cjs/src/utils/sessionInfoService.js.map +0 -1
  343. package/lib/src/utils/sessionInfoService.d.ts +0 -66
  344. package/lib/src/utils/sessionInfoService.d.ts.map +0 -1
  345. package/lib/src/utils/sessionInfoService.js +0 -85
  346. package/lib/src/utils/sessionInfoService.js.map +0 -1
  347. package/src/utils/sessionInfoService.ts +0 -101
package/lib/src/types.js CHANGED
@@ -2,14 +2,12 @@
2
2
  * Copyright (c) 2023
3
3
  *
4
4
  * TypeScript type definitions for ThoughtSpot Visual Embed SDK
5
- *
6
5
  * @summary Type definitions for Embed SDK
7
6
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
8
7
  */
9
8
  /**
10
9
  * The authentication mechanism for allowing access to the
11
10
  * the embedded app
12
- *
13
11
  * @group Authentication / Init
14
12
  */
15
13
  // eslint-disable-next-line no-shadow
@@ -18,7 +16,6 @@ export var AuthType;
18
16
  /**
19
17
  * No authentication on the SDK. Passthrough to the embedded App. Alias for
20
18
  * `Passthrough`.
21
- *
22
19
  * @example
23
20
  * ```js
24
21
  * init({
@@ -36,7 +33,6 @@ export var AuthType;
36
33
  * To use this:
37
34
  * Your SAML or OpenID provider must allow iframe redirects.
38
35
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
39
- *
40
36
  * @example
41
37
  * ```js
42
38
  * init({
@@ -49,14 +45,12 @@ export var AuthType;
49
45
  AuthType["EmbeddedSSO"] = "EmbeddedSSO";
50
46
  /**
51
47
  * SSO using SAML
52
- *
53
48
  * @deprecated Use {@link SAMLRedirect} instead
54
49
  * @hidden
55
50
  */
56
51
  AuthType["SSO"] = "SSO_SAML";
57
52
  /**
58
53
  * SSO using SAML
59
- *
60
54
  * @deprecated Use {@link SAMLRedirect} instead
61
55
  * @hidden
62
56
  */
@@ -68,7 +62,6 @@ export var AuthType;
68
62
  *
69
63
  * This redirects the host application to the SAML IdP. The host application
70
64
  * will be redirected back to the ThoughtSpot app after authentication.
71
- *
72
65
  * @example
73
66
  * ```js
74
67
  * init({
@@ -109,7 +102,6 @@ export var AuthType;
109
102
  AuthType["SAMLRedirect"] = "SSO_SAML";
110
103
  /**
111
104
  * SSO using OIDC
112
- *
113
105
  * @hidden
114
106
  * @deprecated Use {@link OIDCRedirect} instead
115
107
  */
@@ -122,7 +114,6 @@ export var AuthType;
122
114
  AuthType["OIDCRedirect"] = "SSO_OIDC";
123
115
  /**
124
116
  * Trusted authentication server
125
- *
126
117
  * @hidden
127
118
  * @deprecated Use {@link TrustedAuth} instead
128
119
  */
@@ -131,7 +122,6 @@ export var AuthType;
131
122
  * Trusted authentication server. Use your own authentication server
132
123
  * which returns a bearer token, generated using the `secret_key` obtained
133
124
  * from ThoughtSpot.
134
- *
135
125
  * @example
136
126
  * ```js
137
127
  * init({
@@ -143,6 +133,7 @@ export var AuthType;
143
133
  * .then((data) => data.token);
144
134
  * }
145
135
  * });
136
+ * });
146
137
  * ```
147
138
  */
148
139
  AuthType["TrustedAuthToken"] = "AuthServer";
@@ -152,7 +143,6 @@ export var AuthType;
152
143
  * obtained from ThoughtSpot. This uses a cookieless authentication
153
144
  * approach, recommended to bypass the third-party cookie-blocking restriction
154
145
  * implemented by some browsers.
155
- *
156
146
  * @example
157
147
  * ```js
158
148
  * init({
@@ -278,7 +268,6 @@ export var RuntimeFilterOp;
278
268
  * **Note**: This option does not apply to the classic homepage.
279
269
  * To access the updated modular homepage, set
280
270
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
281
- *
282
271
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
283
272
  */
284
273
  // eslint-disable-next-line no-shadow
@@ -314,7 +303,6 @@ export var HomepageModule;
314
303
  *
315
304
  * To add an event listener use the corresponding
316
305
  * {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
317
- *
318
306
  * @example
319
307
  * ```js
320
308
  * import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
@@ -334,7 +322,6 @@ export var EmbedEvent;
334
322
  (function (EmbedEvent) {
335
323
  /**
336
324
  * Rendering has initialized.
337
- *
338
325
  * @example
339
326
  *```js
340
327
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -348,7 +335,7 @@ export var EmbedEvent;
348
335
  EmbedEvent["Init"] = "init";
349
336
  /**
350
337
  * Authentication has either succeeded or failed.
351
- *
338
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
352
339
  * @example
353
340
  *```js
354
341
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
@@ -360,8 +347,8 @@ export var EmbedEvent;
360
347
  EmbedEvent["AuthInit"] = "authInit";
361
348
  /**
362
349
  * The embed object container has loaded.
363
- *
364
350
  * @returns timestamp - The timestamp when the event was generated.
351
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
365
352
  * @example
366
353
  *```js
367
354
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
@@ -374,8 +361,8 @@ export var EmbedEvent;
374
361
  EmbedEvent["Load"] = "load";
375
362
  /**
376
363
  * Data pertaining to answer or Liveboard is received
377
- *
378
364
  * @return data - The answer or Liveboard data
365
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
379
366
  * @example
380
367
  *```js
381
368
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
@@ -387,13 +374,12 @@ export var EmbedEvent;
387
374
  EmbedEvent["Data"] = "data";
388
375
  /**
389
376
  * Search/Answer/Liveboard filters have been applied/updated by the user.
390
- *
391
377
  * @hidden
392
378
  */
393
379
  EmbedEvent["FiltersChanged"] = "filtersChanged";
394
380
  /**
395
381
  * Search query has been updated by the user.
396
- *
382
+ * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
397
383
  * @example
398
384
  *```js
399
385
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
@@ -402,13 +388,13 @@ export var EmbedEvent;
402
388
  EmbedEvent["QueryChanged"] = "queryChanged";
403
389
  /**
404
390
  * A drill-down operation has been performed.
405
- *
391
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
406
392
  * @returns additionalFilters - Any additional filters applied
407
393
  * @returns drillDownColumns - The columns on which drill down was performed
408
394
  * @returns nonFilteredColumns - The columns that were not filtered
409
395
  * @example
410
396
  *```js
411
- * searchEmbed.trigger(EmbedEvent.DrillDown, {
397
+ * searchEmbed.on(EmbedEvent.DrillDown, {
412
398
  * points: {
413
399
  * clickedPoint,
414
400
  * selectedPoints: selectedPoint
@@ -439,8 +425,8 @@ export var EmbedEvent;
439
425
  EmbedEvent["Drilldown"] = "drillDown";
440
426
  /**
441
427
  * One or more data sources have been selected.
442
- *
443
428
  * @returns dataSourceIds - the list of data sources
429
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
444
430
  * @example
445
431
  * ```js
446
432
  * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
@@ -451,7 +437,6 @@ export var EmbedEvent;
451
437
  EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
452
438
  /**
453
439
  * One or more data columns have been selected.
454
- *
455
440
  * @returns columnIds - the list of columns
456
441
  * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
457
442
  * @example
@@ -464,10 +449,10 @@ export var EmbedEvent;
464
449
  EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
465
450
  /**
466
451
  * A custom action has been triggered.
467
- *
468
452
  * @returns actionId - ID of the custom action
469
453
  * @returns payload {@link CustomActionPayload} - Response payload with the
470
454
  * Answer or Liveboard data
455
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
471
456
  * @example
472
457
  * ```js
473
458
  * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -481,7 +466,6 @@ export var EmbedEvent;
481
466
  EmbedEvent["CustomAction"] = "customAction";
482
467
  /**
483
468
  * Listen to double click actions on a visualization.
484
- *
485
469
  * @return ContextMenuInputPoints - Data point that is double-clicked
486
470
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
487
471
  * @example
@@ -494,7 +478,6 @@ export var EmbedEvent;
494
478
  EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
495
479
  /**
496
480
  * Listen to clicks on a visualization in a Liveboard or Search result.
497
- *
498
481
  * @return viz, clickedPoint - metadata about the point that is clicked
499
482
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
500
483
  * @important
@@ -515,21 +498,22 @@ export var EmbedEvent;
515
498
  /**
516
499
  * An error has occurred. This event is fired for the following error types:
517
500
  *
518
- * API - API call failure error.
519
- *
520
- * FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
501
+ * `API`: API call failure error.
521
502
  *
522
- * SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
503
+ * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
504
+ * mode.
523
505
  *
524
- * NON_EXIST_FILTER - Error due to a non-existent filter.
506
+ * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
525
507
  *
526
- * INVALID_DATE_VALUE - Invalid date value error.
508
+ * `NON_EXIST_FILTER`: Error due to a non-existent filter.
527
509
  *
528
- * INVALID_OPERATOR - Use of invalid operator during filter application.
510
+ * `INVALID_DATE_VALUE`: Invalid date value error.
529
511
  *
530
- * For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
512
+ * `INVALID_OPERATOR`: Use of invalid operator during filter application.
531
513
  *
514
+ * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
532
515
  * @returns error - An error object or message
516
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
533
517
  * @example
534
518
  * ```js
535
519
  * // API error
@@ -553,8 +537,8 @@ export var EmbedEvent;
553
537
  EmbedEvent["Error"] = "Error";
554
538
  /**
555
539
  * The embedded object has sent an alert.
556
- *
557
540
  * @returns alert - An alert object
541
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
558
542
  * @example
559
543
  * ```js
560
544
  * searchEmbed.on(EmbedEvent.Alert)
@@ -563,7 +547,7 @@ export var EmbedEvent;
563
547
  EmbedEvent["Alert"] = "alert";
564
548
  /**
565
549
  * The ThoughtSpot auth session has expired.
566
- *
550
+ * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
567
551
  * @example
568
552
  *```js
569
553
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
@@ -576,26 +560,22 @@ export var EmbedEvent;
576
560
  EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
577
561
  /**
578
562
  * ThoughtSpot failed to validate the auth session.
579
- *
580
563
  * @hidden
581
564
  */
582
565
  EmbedEvent["AuthFailure"] = "ThoughtspotAuthFailure";
583
566
  /**
584
567
  * ThoughtSpot failed to validate the auth session.
585
- *
586
568
  * @hidden
587
569
  */
588
570
  EmbedEvent["AuthLogout"] = "ThoughtspotAuthLogout";
589
571
  /**
590
572
  * The height of the embedded Liveboard or visualization has been computed.
591
- *
592
573
  * @returns data - The height of the embedded Liveboard or visualization
593
574
  * @hidden
594
575
  */
595
576
  EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
596
577
  /**
597
578
  * The center of visible iframe viewport is calculated.
598
- *
599
579
  * @returns data - The center of the visible Iframe viewport.
600
580
  * @hidden
601
581
  */
@@ -603,7 +583,6 @@ export var EmbedEvent;
603
583
  /**
604
584
  * Emitted when the **Get Data** action is initiated.
605
585
  * Applicable to `SearchBarEmbed` only.
606
- *
607
586
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
608
587
  * @example
609
588
  *```js
@@ -616,7 +595,7 @@ export var EmbedEvent;
616
595
  EmbedEvent["GetDataClick"] = "getDataClick";
617
596
  /**
618
597
  * Detects the route change.
619
- *
598
+ * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
620
599
  * @example
621
600
  *```js
622
601
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
@@ -626,15 +605,13 @@ export var EmbedEvent;
626
605
  EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
627
606
  /**
628
607
  * The v1 event type for Data
629
- *
630
608
  * @hidden
631
609
  */
632
610
  EmbedEvent["V1Data"] = "exportVizDataToParent";
633
611
  /**
634
612
  * Emitted when the embed does not have cookie access. This happens
635
613
  * when Safari and other Web browsers block third-party cookies
636
- * are blocked by default. `NoCookieAccess` can trigger
637
- *
614
+ * are blocked by default.
638
615
  * @example
639
616
  *```js
640
617
  * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -644,14 +621,12 @@ export var EmbedEvent;
644
621
  EmbedEvent["NoCookieAccess"] = "noCookieAccess";
645
622
  /**
646
623
  * Emitted when SAML is complete
647
- *
648
624
  * @private
649
625
  * @hidden
650
626
  */
651
627
  EmbedEvent["SAMLComplete"] = "samlComplete";
652
628
  /**
653
629
  * Emitted when any modal is opened in the app
654
- *
655
630
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
656
631
  * @example
657
632
  *```js
@@ -663,7 +638,6 @@ export var EmbedEvent;
663
638
  EmbedEvent["DialogOpen"] = "dialog-open";
664
639
  /**
665
640
  * Emitted when any modal is closed in the app
666
- *
667
641
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
668
642
  * @example
669
643
  *```js
@@ -676,8 +650,7 @@ export var EmbedEvent;
676
650
  /**
677
651
  * Emitted when the Liveboard shell loads.
678
652
  * You can use this event as a hook to trigger
679
- * other events on the rendered Liveboard.
680
- *
653
+ * actions on the rendered Liveboard.
681
654
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
682
655
  * @example
683
656
  *```js
@@ -697,9 +670,7 @@ export var EmbedEvent;
697
670
  */
698
671
  EmbedEvent["LiveboardRendered"] = "PinboardRendered";
699
672
  /**
700
- * This can be used to register an event listener which
701
- * is triggered on all events.
702
- *
673
+ * Emits all events.
703
674
  * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
704
675
  * @example
705
676
  *```js
@@ -711,17 +682,16 @@ export var EmbedEvent;
711
682
  EmbedEvent["ALL"] = "*";
712
683
  /**
713
684
  * Emitted when an Answer is saved in the app
714
- *
715
685
  * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
716
686
  * @example
717
687
  *```js
718
- * //trigger when action starts
688
+ * //Emit when action starts
719
689
  * searchEmbed.on(EmbedEvent.Save, payload => {
720
690
  * console.log('Save', payload)
721
691
  * }, {
722
692
  * start: true
723
693
  * })
724
- * //trigger when action ends
694
+ * //emit when action ends
725
695
  * searchEmbed.on(EmbedEvent.Save, payload => {
726
696
  * console.log('Save', payload)
727
697
  * })
@@ -731,15 +701,14 @@ export var EmbedEvent;
731
701
  /**
732
702
  * Emitted when the download action is triggered on an answer
733
703
  *
734
- * **Note**: This event is deprecated in v1.21.0.
704
+ * **Note**: This event is deprecated in v1.21.0.
735
705
  * To fire an event when a download action is initiated on a chart or table,
736
706
  * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
737
707
  * or `EmbedEvent.DownloadAsXLSX`
738
- *
739
708
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
740
709
  * @example
741
710
  *```js
742
- * liveboardEmbed.trigger(HostEvent.Download, {
711
+ * liveboardEmbed.on(EmbedEvent.Download, {
743
712
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
744
713
  * })
745
714
  *```
@@ -747,14 +716,13 @@ export var EmbedEvent;
747
716
  EmbedEvent["Download"] = "download";
748
717
  /**
749
718
  * Emitted when the download action is triggered on an answer
750
- *
751
719
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
752
720
  * @example
753
721
  *```js
754
- * //trigger when action starts
722
+ * //emit when action starts
755
723
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
756
724
  * console.log('download PNG', payload)}, {start: true })
757
- * //trigger when action ends
725
+ * //emit when action ends
758
726
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
759
727
  * console.log('download PNG', payload)})
760
728
  *```
@@ -762,14 +730,13 @@ export var EmbedEvent;
762
730
  EmbedEvent["DownloadAsPng"] = "downloadAsPng";
763
731
  /**
764
732
  * Emitted when the Download as PDF action is triggered on an answer
765
- *
766
733
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
767
734
  * @example
768
735
  *```js
769
- * //trigger when action starts
736
+ * //emit when action starts
770
737
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
771
738
  * console.log('download PDF', payload)}, {start: true })
772
- * //trigger when action ends
739
+ * //emit when action ends
773
740
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
774
741
  * console.log('download PDF', payload)})
775
742
  *```
@@ -777,14 +744,13 @@ export var EmbedEvent;
777
744
  EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
778
745
  /**
779
746
  * Emitted when the Download as CSV action is triggered on an answer
780
- *
781
747
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
782
748
  * @example
783
749
  *```js
784
- * //trigger when action starts
750
+ * //emit when action starts
785
751
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
786
752
  * console.log('download CSV', payload)}, {start: true })
787
- * //trigger when action ends
753
+ * //emit when action ends
788
754
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
789
755
  * console.log('download CSV', payload)})
790
756
  *```
@@ -792,14 +758,13 @@ export var EmbedEvent;
792
758
  EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
793
759
  /**
794
760
  * Emitted when the Download as XLSX action is triggered on an answer
795
- *
796
761
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
797
762
  * @example
798
763
  *```js
799
- * //trigger when action starts
764
+ * //emit when action starts
800
765
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
801
766
  * console.log('download Xlsx', payload)}, { start: true })
802
- * //trigger when action ends
767
+ * //emit when action ends
803
768
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
804
769
  * console.log('download Xlsx', payload)})
805
770
  *```
@@ -807,14 +772,13 @@ export var EmbedEvent;
807
772
  EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
808
773
  /**
809
774
  * Emitted when an Answer is deleted in the app
810
- *
811
775
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
812
776
  * @example
813
777
  *```js
814
- * //trigger when action starts
778
+ * //emit when action starts
815
779
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
816
780
  * console.log('delete answer', payload)}, {start: true })
817
- * //trigger when action is completed
781
+ * //emit when action is completed
818
782
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
819
783
  * console.log('delete answer', payload)})
820
784
  *```
@@ -822,17 +786,16 @@ export var EmbedEvent;
822
786
  EmbedEvent["AnswerDelete"] = "answerDelete";
823
787
  /**
824
788
  * Emitted when an answer is pinned to a Liveboard
825
- *
826
789
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
827
790
  * @example
828
791
  *```js
829
- * //trigger when action starts
792
+ * //emit when action starts
830
793
  * searchEmbed.on(EmbedEvent.Pin, payload => {
831
794
  * console.log('pin', payload)
832
795
  * }, {
833
796
  * start: true
834
797
  * })
835
- * //trigger when action ends
798
+ * //emit when action ends
836
799
  * searchEmbed.on(EmbedEvent.Pin, payload => {
837
800
  * console.log('pin', payload)
838
801
  * })
@@ -841,17 +804,16 @@ export var EmbedEvent;
841
804
  EmbedEvent["Pin"] = "pin";
842
805
  /**
843
806
  * Emitted when SpotIQ analysis is triggered
844
- *
845
807
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
846
808
  * @example
847
809
  *```js
848
- * //trigger when action starts
810
+ * //emit when action starts
849
811
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
850
812
  * console.log('SpotIQAnalyze', payload)
851
813
  * }, {
852
814
  * start: true
853
815
  * })
854
- * //trigger when action ends
816
+ * //emit when action ends
855
817
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
856
818
  * console.log('SpotIQ analyze', payload)
857
819
  * })
@@ -860,17 +822,16 @@ export var EmbedEvent;
860
822
  EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
861
823
  /**
862
824
  * Emitted when a user shares an object with another user or group
863
- *
864
825
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
865
826
  * @example
866
827
  *```js
867
- * //trigger when action starts
828
+ * //emit when action starts
868
829
  * searchEmbed.on(EmbedEvent.Share, payload => {
869
830
  * console.log('Share', payload)
870
831
  * }, {
871
832
  * start: true
872
833
  * })
873
- * //trigger when action ends
834
+ * //emit when action ends
874
835
  * searchEmbed.on(EmbedEvent.Share, payload => {
875
836
  * console.log('Share', payload)
876
837
  * })
@@ -880,7 +841,6 @@ export var EmbedEvent;
880
841
  /**
881
842
  * Emitted when a user clicks the **Include** action to include a specific value or
882
843
  * data on a chart or table.
883
- *
884
844
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
885
845
  * @example
886
846
  *```js
@@ -893,7 +853,6 @@ export var EmbedEvent;
893
853
  /**
894
854
  * Emitted when a user clicks the **Exclude** action to exclude a specific value or
895
855
  * data on a chart or table
896
- *
897
856
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
898
857
  * @example
899
858
  *```js
@@ -905,7 +864,6 @@ export var EmbedEvent;
905
864
  EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
906
865
  /**
907
866
  * Emitted when a column value is copied in the embedded app.
908
- *
909
867
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
910
868
  * @example
911
869
  *```js
@@ -917,7 +875,6 @@ export var EmbedEvent;
917
875
  EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
918
876
  /**
919
877
  * Emitted when a user clicks the **Update TML** action
920
- *
921
878
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
922
879
  * @example
923
880
  *```js
@@ -928,7 +885,6 @@ export var EmbedEvent;
928
885
  EmbedEvent["UpdateTML"] = "updateTSL";
929
886
  /**
930
887
  * Emitted when a user clicks the **Edit TML** action
931
- *
932
888
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
933
889
  * @example
934
890
  *```js
@@ -941,14 +897,13 @@ export var EmbedEvent;
941
897
  /**
942
898
  * Emitted when the **Export TML** action is triggered on an
943
899
  * an embedded object in the app
944
- *
945
900
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
946
901
  * @example
947
902
  *```js
948
- * //trigger when action starts
903
+ * //emit when action starts
949
904
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
950
905
  * console.log('Export TML', payload)}, { start: true })
951
- * //trigger when action ends
906
+ * //emit when action ends
952
907
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
953
908
  * console.log('Export TML', payload)})
954
909
  *```
@@ -956,7 +911,6 @@ export var EmbedEvent;
956
911
  EmbedEvent["ExportTML"] = "exportTSL";
957
912
  /**
958
913
  * Emitted when an Answer is saved as a View.
959
- *
960
914
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
961
915
  * @example
962
916
  *```js
@@ -968,14 +922,13 @@ export var EmbedEvent;
968
922
  EmbedEvent["SaveAsView"] = "saveAsView";
969
923
  /**
970
924
  * Emitted when the user creates a copy of an Answer
971
- *
972
925
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
973
926
  * @example
974
927
  *```js
975
- * //trigger when action starts
928
+ * //emit when action starts
976
929
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
977
930
  * console.log('Copy and edit', payload)}, {start: true })
978
- * //trigger when action ends
931
+ * //emit when action ends
979
932
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
980
933
  * console.log('Copy and edit', payload)})
981
934
  *```
@@ -983,7 +936,6 @@ export var EmbedEvent;
983
936
  EmbedEvent["CopyAEdit"] = "copyAEdit";
984
937
  /**
985
938
  * Emitted when a user clicks Show underlying data on an Answer
986
- *
987
939
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
988
940
  * @example
989
941
  *```js
@@ -995,7 +947,6 @@ export var EmbedEvent;
995
947
  EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
996
948
  /**
997
949
  * Emitted when an answer is switched to a chart or table view.
998
- *
999
950
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1000
951
  * @example
1001
952
  *```js
@@ -1007,13 +958,11 @@ export var EmbedEvent;
1007
958
  EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
1008
959
  /**
1009
960
  * Internal event to communicate the initial settings back to the ThoughtSpot app
1010
- *
1011
961
  * @hidden
1012
962
  */
1013
963
  EmbedEvent["APP_INIT"] = "appInit";
1014
964
  /**
1015
965
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
1016
- *
1017
966
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1018
967
  * @example
1019
968
  *```js
@@ -1025,7 +974,6 @@ export var EmbedEvent;
1025
974
  EmbedEvent["LiveboardInfo"] = "pinboardInfo";
1026
975
  /**
1027
976
  * Emitted when a user clicks on the Favorite icon on a Liveboard
1028
- *
1029
977
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1030
978
  * @example
1031
979
  *```js
@@ -1037,7 +985,6 @@ export var EmbedEvent;
1037
985
  EmbedEvent["AddToFavorites"] = "addToFavorites";
1038
986
  /**
1039
987
  * Emitted when a user clicks **Schedule** on a Liveboard
1040
- *
1041
988
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1042
989
  * @example
1043
990
  *```js
@@ -1049,7 +996,6 @@ export var EmbedEvent;
1049
996
  EmbedEvent["Schedule"] = "subscription";
1050
997
  /**
1051
998
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
1052
- *
1053
999
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1054
1000
  * @example
1055
1001
  *```js
@@ -1061,7 +1007,6 @@ export var EmbedEvent;
1061
1007
  EmbedEvent["Edit"] = "edit";
1062
1008
  /**
1063
1009
  * Emitted when a user clicks *Make a copy* on a Liveboard
1064
- *
1065
1010
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1066
1011
  * @example
1067
1012
  *```js
@@ -1073,11 +1018,10 @@ export var EmbedEvent;
1073
1018
  EmbedEvent["MakeACopy"] = "makeACopy";
1074
1019
  /**
1075
1020
  * Emitted when a user clicks **Present** on a Liveboard or visualization
1076
- *
1077
1021
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1078
1022
  * @example
1079
1023
  *```js
1080
- * liveboardEmbed.trigger(HostEvent.Present)
1024
+ * liveboardEmbed.on(EmbedEvent.Present)
1081
1025
  *```
1082
1026
  * @example
1083
1027
  *```js
@@ -1089,71 +1033,64 @@ export var EmbedEvent;
1089
1033
  EmbedEvent["Present"] = "present";
1090
1034
  /**
1091
1035
  * Emitted when a user clicks **Delete** on a visualization
1092
- *
1093
1036
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1094
1037
  * @example
1095
1038
  *```js
1096
- * liveboardEmbed.trigger(EmbedEvent.Delete,
1039
+ * liveboardEmbed.on(EmbedEvent.Delete,
1097
1040
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1098
1041
  *```
1099
1042
  */
1100
1043
  EmbedEvent["Delete"] = "delete";
1101
1044
  /**
1102
1045
  * Emitted when a user clicks Manage schedules on a Liveboard
1103
- *
1104
1046
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1105
1047
  * @example
1106
1048
  *```js
1107
- * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
1049
+ * liveboardEmbed.on(EmbedEvent.SchedulesList)
1108
1050
  *```
1109
1051
  */
1110
1052
  EmbedEvent["SchedulesList"] = "schedule-list";
1111
1053
  /**
1112
1054
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
1113
- *
1114
1055
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1115
1056
  * @example
1116
1057
  *```js
1117
- * liveboardEmbed.trigger(EmbedEvent.Cancel)
1058
+ * liveboardEmbed.on(EmbedEvent.Cancel)
1118
1059
  *```
1119
1060
  */
1120
1061
  EmbedEvent["Cancel"] = "cancel";
1121
1062
  /**
1122
1063
  * Emitted when a user clicks **Explore** on a visualization
1123
- *
1124
1064
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1125
1065
  * @example
1126
1066
  *```js
1127
- * liveboardEmbed.trigger(EmbedEvent.Explore, {
1067
+ * liveboardEmbed.on(EmbedEvent.Explore, {
1128
1068
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1129
1069
  *```
1130
1070
  */
1131
1071
  EmbedEvent["Explore"] = "explore";
1132
1072
  /**
1133
1073
  * Emitted when a user clicks **Copy link** action on a visualization
1134
- *
1135
1074
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
1136
1075
  * @example
1137
1076
  *```js
1138
- * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
1077
+ * liveboardEmbed.on(EmbedEvent.CopyLink, {
1139
1078
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1140
1079
  *```
1141
1080
  */
1142
1081
  EmbedEvent["CopyLink"] = "embedDocument";
1143
1082
  /**
1144
1083
  * Emitted when a user interacts with cross filters on a visualization or Liveboard
1145
- *
1146
1084
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1147
1085
  * @example
1148
1086
  *```js
1149
- * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
1087
+ * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
1150
1088
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
1151
1089
  *```
1152
1090
  */
1153
1091
  EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
1154
1092
  /**
1155
1093
  * Emitted when a user right clicks on a visualization (chart or table)
1156
- *
1157
1094
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1158
1095
  * @example
1159
1096
  *```js
@@ -1165,44 +1102,53 @@ export var EmbedEvent;
1165
1102
  EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
1166
1103
  /**
1167
1104
  * Emitted when a user clicks **Insert to slide** on a visualization
1168
- *
1169
1105
  * @hidden
1170
1106
  */
1171
1107
  EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
1172
1108
  /**
1173
- * @hidden
1174
1109
  * Emitted when a user changes any filter on a Liveboard.
1110
+ * Returns filter type and name, column name and ID, and runtime
1111
+ * filter details.
1112
+ * @example
1113
+ *
1114
+ *```js
1115
+ * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1116
+ * console.log('payload', payload);
1117
+ * })
1118
+ *
1175
1119
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
1120
+ * @example
1121
+ *
1122
+ *```js
1123
+ * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
1124
+ * console.log('payload', payload);
1125
+ * })
1126
+ *```
1176
1127
  */
1177
1128
  EmbedEvent["FilterChanged"] = "filterChanged";
1178
1129
  /**
1179
1130
  * Emitted when a user clicks the **Go** button on the Search page
1180
- *
1181
1131
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1182
1132
  */
1183
1133
  EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
1184
1134
  /**
1185
1135
  * Emitted when a user selects a data source.
1186
- *
1187
1136
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1188
1137
  */
1189
1138
  EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
1190
1139
  /**
1191
1140
  * Emitted when a user updates a connection on the **Data** page
1192
- *
1193
1141
  * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
1194
1142
  */
1195
1143
  EmbedEvent["UpdateConnection"] = "updateConnection";
1196
1144
  /**
1197
1145
  * Emitted when a user updates a connection on the **Data** page
1198
- *
1199
1146
  * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
1200
1147
  */
1201
1148
  EmbedEvent["CreateConnection"] = "createConnection";
1202
1149
  /**
1203
1150
  * Emitted when name, status (private or public) or filter values of a
1204
1151
  * Personalised view is updated.
1205
- *
1206
1152
  * @returns viewName: string
1207
1153
  * @returns viewId: string
1208
1154
  * @returns liveboardId: string
@@ -1212,7 +1158,6 @@ export var EmbedEvent;
1212
1158
  EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
1213
1159
  /**
1214
1160
  * Emitted when a Personalised view is saved.
1215
- *
1216
1161
  * @returns viewName: string
1217
1162
  * @returns viewId: string
1218
1163
  * @returns liveboardId: string
@@ -1222,7 +1167,6 @@ export var EmbedEvent;
1222
1167
  EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
1223
1168
  /**
1224
1169
  * Emitted when a Liveboard is reset.
1225
- *
1226
1170
  * @returns viewName: string
1227
1171
  * @returns viewId: string
1228
1172
  * @returns liveboardId: string
@@ -1232,7 +1176,6 @@ export var EmbedEvent;
1232
1176
  EmbedEvent["ResetLiveboard"] = "resetLiveboard";
1233
1177
  /**
1234
1178
  * Emitted when a PersonalisedView is deleted.
1235
- *
1236
1179
  * @returns views: string[]
1237
1180
  * @returns liveboardId: string
1238
1181
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
@@ -1240,13 +1183,11 @@ export var EmbedEvent;
1240
1183
  EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
1241
1184
  /**
1242
1185
  * Emitted when a user creates a new worksheet
1243
- *
1244
1186
  * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
1245
1187
  */
1246
1188
  EmbedEvent["CreateWorksheet"] = "createWorksheet";
1247
1189
  /**
1248
1190
  * Emitted when Ask Sage is initialized.
1249
- *
1250
1191
  * @returns viewName: string
1251
1192
  * @returns viewId: string
1252
1193
  * @returns liveboardId: string
@@ -1256,10 +1197,32 @@ export var EmbedEvent;
1256
1197
  EmbedEvent["AskSageInit"] = "AskSageInit";
1257
1198
  /**
1258
1199
  * Emitted when a LB/viz is renamed
1259
- *
1260
1200
  * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
1261
1201
  */
1262
1202
  EmbedEvent["Rename"] = "rename";
1203
+ /**
1204
+ * Emitted when user wants to intercept the search execution
1205
+ *
1206
+ * Make isOnBeforeGetVizDataEnabled : true to use this embed
1207
+ * event
1208
+ *
1209
+ *```js
1210
+ * searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
1211
+ * responder({
1212
+ * data: {
1213
+ * execute: true,
1214
+ * error: {errorText: "My own customised error"}
1215
+ * }})
1216
+ * })
1217
+ *```
1218
+ * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
1219
+ */
1220
+ EmbedEvent["OnBeforeGetVizDataIntercept"] = "onBeforeGetVizDataIntercept";
1221
+ /**
1222
+ * Emitted when runtime parameters changes
1223
+ * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
1224
+ */
1225
+ EmbedEvent["ParameterChanged"] = "ParameterChanged";
1263
1226
  })(EmbedEvent || (EmbedEvent = {}));
1264
1227
  /**
1265
1228
  * Event types that can be triggered by the host application
@@ -1268,7 +1231,6 @@ export var EmbedEvent;
1268
1231
  * To trigger an event use the corresponding
1269
1232
  * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
1270
1233
  * SearchEmbed.trigger} method.
1271
- *
1272
1234
  * @example
1273
1235
  * ```js
1274
1236
  * import { HostEvent } from '@thoughtspot/visual-embed-sdk';
@@ -1291,7 +1253,6 @@ export var HostEvent;
1291
1253
  * the search query string.
1292
1254
  * Supported in `AppEmbed` and `SearchEmbed` deployments.
1293
1255
  * Includes the following properties:
1294
- *
1295
1256
  * @param - `searchQuery` - query string with search tokens
1296
1257
  * @param - `dataSources` - Data source GUID to Search on
1297
1258
  * - Although an array, only a single source
@@ -1310,7 +1271,6 @@ export var HostEvent;
1310
1271
  /**
1311
1272
  * Triggers a drill on certain points of the specified column
1312
1273
  * Includes the following properties:
1313
- *
1314
1274
  * @param - points - an object containing selectedPoints/clickedPoints
1315
1275
  * to drill to. For example, { selectedPoints: []}
1316
1276
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -1360,19 +1320,16 @@ export var HostEvent;
1360
1320
  HostEvent["DrillDown"] = "triggerDrillDown";
1361
1321
  /**
1362
1322
  * Apply filters
1363
- *
1364
1323
  * @hidden
1365
1324
  */
1366
1325
  HostEvent["Filter"] = "filter";
1367
1326
  /**
1368
1327
  * Reload the answer or visualization
1369
- *
1370
1328
  * @hidden
1371
1329
  */
1372
1330
  HostEvent["Reload"] = "reload";
1373
1331
  /**
1374
1332
  * Display specific visualizations on a Liveboard.
1375
- *
1376
1333
  * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
1377
1334
  * in this parameter will be hidden.
1378
1335
  * @example
@@ -1386,7 +1343,6 @@ export var HostEvent;
1386
1343
  HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
1387
1344
  /**
1388
1345
  * Set a Liveboard tab as an active tab.
1389
- *
1390
1346
  * @param - tabId - string of id of Tab to show
1391
1347
  * @example
1392
1348
  * ```js
@@ -1402,18 +1358,21 @@ export var HostEvent;
1402
1358
  * runtime filters passed here are appended to the existing runtime
1403
1359
  * filters.
1404
1360
  * Pass an array of runtime filters with the following attributes:
1361
+ *
1405
1362
  * `columnName`
1406
1363
  * _String_. The name of the column to filter on.
1364
+ *
1407
1365
  * `operator`
1408
- * Runtime filter operator to apply. For information,
1409
- * see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
1366
+ * Runtime filter operator to apply. For information,
1367
+ * see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
1368
+ *
1410
1369
  * `values`
1411
- * List of operands. Some operators such as EQ, LE allow a single value, whereas
1412
- * operators such as BW and IN accept multiple operands.
1413
- * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
1414
- * Search embedding (SearchEmbed) and Natural Language Search
1415
- * embedding (SageEmbed).
1370
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
1371
+ * operators such as BW and IN accept multiple operands.
1416
1372
  *
1373
+ * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
1374
+ * Search embedding (SearchEmbed) and Natural Language Search
1375
+ * embedding (SageEmbed).
1417
1376
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
1418
1377
  * @example
1419
1378
  * ```js
@@ -1429,7 +1388,6 @@ export var HostEvent;
1429
1388
  /**
1430
1389
  * Navigate to a specific page in the embedded ThoughtSpot application.
1431
1390
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
1432
- *
1433
1391
  * @param - `path` - the path to navigate to to go forward or back. The path value can
1434
1392
  * be a number; for example, `1`, `-1`.
1435
1393
  * @example
@@ -1442,7 +1400,6 @@ export var HostEvent;
1442
1400
  /**
1443
1401
  * Open the filter panel for a particular column.
1444
1402
  * Works with Search and Liveboard embed.
1445
- *
1446
1403
  * @param - { columnId: string,
1447
1404
  * name: string,
1448
1405
  * type: INT64/CHAR/DATE,
@@ -1459,7 +1416,6 @@ export var HostEvent;
1459
1416
  HostEvent["OpenFilter"] = "openFilter";
1460
1417
  /**
1461
1418
  * Add columns to the current search query.
1462
- *
1463
1419
  * @param - { columnIds: string[] }
1464
1420
  * @example
1465
1421
  * ```js
@@ -1470,7 +1426,6 @@ export var HostEvent;
1470
1426
  HostEvent["AddColumns"] = "addColumns";
1471
1427
  /**
1472
1428
  * Remove a column from the current search query.
1473
- *
1474
1429
  * @param - { columnId: string }
1475
1430
  * @example
1476
1431
  * ```js
@@ -1485,7 +1440,6 @@ export var HostEvent;
1485
1440
  * Liveboard filters, runtime filters applied on visualizations on a
1486
1441
  * Liveboard, and Liveboard layout, changes to visualizations such as
1487
1442
  * sorting, toggling of legends, and data drill down.
1488
- *
1489
1443
  * @example
1490
1444
  * ```js
1491
1445
  * liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
@@ -1496,7 +1450,6 @@ export var HostEvent;
1496
1450
  HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
1497
1451
  /**
1498
1452
  * Trigger the **Pin** action on an embedded object
1499
- *
1500
1453
  * @param - Liveboard embed takes the `vizId` as a
1501
1454
  * key. Can be left undefined when embedding Search, full app, or
1502
1455
  * a visualization.
@@ -1513,7 +1466,6 @@ export var HostEvent;
1513
1466
  /**
1514
1467
  * Trigger the **Show Liveboard details** action
1515
1468
  * on an embedded Liveboard.
1516
- *
1517
1469
  * @example
1518
1470
  *```js
1519
1471
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
@@ -1523,7 +1475,6 @@ export var HostEvent;
1523
1475
  HostEvent["LiveboardInfo"] = "pinboardInfo";
1524
1476
  /**
1525
1477
  * Trigger the **Schedule** action on an embedded Liveboard.
1526
- *
1527
1478
  * @example
1528
1479
  * ```js
1529
1480
  * liveboardEmbed.trigger(HostEvent.Schedule)
@@ -1533,7 +1484,6 @@ export var HostEvent;
1533
1484
  HostEvent["Schedule"] = "subscription";
1534
1485
  /**
1535
1486
  * Trigger the **Manage schedule** action on an embedded Liveboard
1536
- *
1537
1487
  * @example
1538
1488
  * ```js
1539
1489
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
@@ -1543,7 +1493,6 @@ export var HostEvent;
1543
1493
  HostEvent["SchedulesList"] = "schedule-list";
1544
1494
  /**
1545
1495
  * Trigger the **Export TML** action on an embedded Liveboard.
1546
- *
1547
1496
  * @example
1548
1497
  * ```js
1549
1498
  * liveboardEmbed.trigger(HostEvent.ExportTML)
@@ -1553,7 +1502,6 @@ export var HostEvent;
1553
1502
  HostEvent["ExportTML"] = "exportTSL";
1554
1503
  /**
1555
1504
  * Trigger the **Edit TML** action on an embedded Liveboard.
1556
- *
1557
1505
  * @example
1558
1506
  * ```js
1559
1507
  * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -1563,7 +1511,6 @@ export var HostEvent;
1563
1511
  HostEvent["EditTML"] = "editTSL";
1564
1512
  /**
1565
1513
  * Trigger the **Update TML** action on an embedded Liveboard.
1566
- *
1567
1514
  * @example
1568
1515
  * ```js
1569
1516
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
@@ -1573,7 +1520,6 @@ export var HostEvent;
1573
1520
  HostEvent["UpdateTML"] = "updateTSL";
1574
1521
  /**
1575
1522
  * Trigger the **Download PDF** action on an embedded Liveboard.
1576
- *
1577
1523
  * @example
1578
1524
  * ```js
1579
1525
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -1584,7 +1530,6 @@ export var HostEvent;
1584
1530
  /**
1585
1531
  * Trigger the **Make a copy** action on a Liveboard, Search, or
1586
1532
  * visualization page.
1587
- *
1588
1533
  * @example
1589
1534
  * ```js
1590
1535
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
@@ -1600,7 +1545,6 @@ export var HostEvent;
1600
1545
  HostEvent["MakeACopy"] = "makeACopy";
1601
1546
  /**
1602
1547
  * Trigger the **Delete** action for a Liveboard.
1603
- *
1604
1548
  * @example
1605
1549
  * ```js
1606
1550
  * appEmbed.trigger(HostEvent.Remove)
@@ -1610,7 +1554,6 @@ export var HostEvent;
1610
1554
  HostEvent["Remove"] = "delete";
1611
1555
  /**
1612
1556
  * Trigger the **Explore** action on a visualization.
1613
- *
1614
1557
  * @param - an object with `vizId` as a key
1615
1558
  * @example
1616
1559
  * ```js
@@ -1621,7 +1564,6 @@ export var HostEvent;
1621
1564
  HostEvent["Explore"] = "explore";
1622
1565
  /**
1623
1566
  * Trigger the **Create alert** action on a visualization
1624
- *
1625
1567
  * @param - an object with `vizId` as a key
1626
1568
  * @example
1627
1569
  * ```js
@@ -1634,7 +1576,6 @@ export var HostEvent;
1634
1576
  HostEvent["CreateMonitor"] = "createMonitor";
1635
1577
  /**
1636
1578
  * Trigger the **Manage alerts** action on a visualization
1637
- *
1638
1579
  * @param - an object with `vizId` as a key
1639
1580
  * @example
1640
1581
  * ```js
@@ -1647,7 +1588,6 @@ export var HostEvent;
1647
1588
  HostEvent["ManageMonitor"] = "manageMonitor";
1648
1589
  /**
1649
1590
  * Trigger the **Edit** action on a Liveboard or visualization
1650
- *
1651
1591
  * @param - object - To trigger the action for a specific visualization
1652
1592
  * in Liveboard embed, pass in `vizId` as a key.
1653
1593
  * Can be left undefined when embedding Search, full app, or
@@ -1668,7 +1608,6 @@ export var HostEvent;
1668
1608
  HostEvent["Edit"] = "edit";
1669
1609
  /**
1670
1610
  * Trigger the **Copy link** action on a Liveboard or visualization
1671
- *
1672
1611
  * @param - object - to trigger the action for a
1673
1612
  * specific visualization in Liveboard embed, pass in `vizId` as a key
1674
1613
  * @example
@@ -1686,7 +1625,6 @@ export var HostEvent;
1686
1625
  HostEvent["CopyLink"] = "embedDocument";
1687
1626
  /**
1688
1627
  * Trigger the **Present** action on a Liveboard or visualization
1689
- *
1690
1628
  * @param - object - to trigger the action for a specific visualization
1691
1629
  * in Liveboard embed, pass in `vizId` as a key
1692
1630
  * @example
@@ -1704,12 +1642,11 @@ export var HostEvent;
1704
1642
  HostEvent["Present"] = "present";
1705
1643
  /**
1706
1644
  * Get TML for the current search.
1707
- *
1708
1645
  * @example
1709
1646
  * ```js
1710
1647
  * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
1711
1648
  * console.log(
1712
- * tml.search_query // TML representation of the search query
1649
+ * tml.answer.search_query // TML representation of the search query
1713
1650
  * );
1714
1651
  * })
1715
1652
  * ```
@@ -1719,7 +1656,6 @@ export var HostEvent;
1719
1656
  HostEvent["GetTML"] = "getTML";
1720
1657
  /**
1721
1658
  * Trigger the **Show underlying data** action on visualization or search
1722
- *
1723
1659
  * @param - an object with vizId as a key
1724
1660
  * @example
1725
1661
  * ```js
@@ -1739,7 +1675,6 @@ export var HostEvent;
1739
1675
  * Trigger the **Delete** action for a visualization
1740
1676
  * in an embedded Liveboard, or a chart or table
1741
1677
  * generated from Search.
1742
- *
1743
1678
  * @param - Liveboard embed takes an object with `vizId` as a key.
1744
1679
  * Can be left empty if embedding Search or visualization.
1745
1680
  * @example
@@ -1756,7 +1691,6 @@ export var HostEvent;
1756
1691
  /**
1757
1692
  * Trigger the **SpotIQ analyze** action on visualization
1758
1693
  * or search.
1759
- *
1760
1694
  * @param - Liveboard embed takes `vizId` as a
1761
1695
  * key. Can be left undefined when embedding Search or
1762
1696
  * visualization.
@@ -1777,7 +1711,6 @@ export var HostEvent;
1777
1711
  /**
1778
1712
  * Trigger the **Download** action on charts in
1779
1713
  * the embedded view.
1780
- *
1781
1714
  * @example
1782
1715
  * ```js
1783
1716
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -1794,7 +1727,6 @@ export var HostEvent;
1794
1727
  /**
1795
1728
  * Trigger the **Download** > **PNG** action on
1796
1729
  * charts in the embedded view.
1797
- *
1798
1730
  * @example
1799
1731
  * ```js
1800
1732
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1810,7 +1742,6 @@ export var HostEvent;
1810
1742
  /**
1811
1743
  * Trigger the **Download** > **CSV** action on tables in
1812
1744
  * the embedded view.
1813
- *
1814
1745
  * @example
1815
1746
  * ```js
1816
1747
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -1828,7 +1759,6 @@ export var HostEvent;
1828
1759
  /**
1829
1760
  * Trigger the **Download** > **XLSX** action on tables
1830
1761
  * in the embedded view.
1831
- *
1832
1762
  * @example
1833
1763
  * ```js
1834
1764
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -1846,7 +1776,6 @@ export var HostEvent;
1846
1776
  /**
1847
1777
  * Trigger the **Share** action on an embedded
1848
1778
  * Liveboard or Answer.
1849
- *
1850
1779
  * @example
1851
1780
  * ```js
1852
1781
  * liveboardEmbed.trigger(HostEvent.Share)
@@ -1860,7 +1789,6 @@ export var HostEvent;
1860
1789
  /**
1861
1790
  * Trigger the **Save** action on a Liveboard or Answer.
1862
1791
  * Saves the changes.
1863
- *
1864
1792
  * @example
1865
1793
  * ```js
1866
1794
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -1874,7 +1802,6 @@ export var HostEvent;
1874
1802
  /**
1875
1803
  * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
1876
1804
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
1877
- *
1878
1805
  * @param - an object with `vizId` as a key
1879
1806
  * @example
1880
1807
  * ```js
@@ -1891,7 +1818,6 @@ export var HostEvent;
1891
1818
  * Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
1892
1819
  * Sends data from an Answer or Liveboard visualization to third-party apps such
1893
1820
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
1894
- *
1895
1821
  * @param - an object with vizId as a key
1896
1822
  * @example
1897
1823
  * ```js
@@ -1908,7 +1834,6 @@ export var HostEvent;
1908
1834
  * Trigger the **Manage pipelines** action on an embedded
1909
1835
  * visualization or Answer.
1910
1836
  * Allows users to manage ThoughtSpot Sync pipelines.
1911
- *
1912
1837
  * @param - an object with `vizId` as a key
1913
1838
  * @example
1914
1839
  * ```js
@@ -1923,7 +1848,6 @@ export var HostEvent;
1923
1848
  HostEvent["ManagePipelines"] = "manage-pipeline";
1924
1849
  /**
1925
1850
  * Reset search operation on the Search or Answer page.
1926
- *
1927
1851
  * @example
1928
1852
  * ```js
1929
1853
  * searchEmbed.trigger(HostEvent.ResetSearch)
@@ -1935,32 +1859,70 @@ export var HostEvent;
1935
1859
  */
1936
1860
  HostEvent["ResetSearch"] = "resetSearch";
1937
1861
  /**
1938
- *
1939
- * Get the currents visible and runtime filters applied on a Liveboard
1940
- *
1862
+ * Get details of the visible and runtime filters applied on Liveboard.
1941
1863
  * @example
1942
- * liveboardEmbed.trigger(HostEvent.GetFilters)
1864
+ * ```js
1865
+ * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
1866
+ * console.log('data', data);
1867
+ * ```
1943
1868
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1944
1869
  */
1945
1870
  HostEvent["GetFilters"] = "getFilters";
1946
1871
  /**
1872
+ * Update one or several filters applied on a Liveboard.
1873
+ * @param - `filter`: a single filter object containing column name,
1874
+ * filter operator, and values.
1875
+ * @param - `filters`: multiple filter objects with column name, filter operator,
1876
+ * and values for each.
1947
1877
  *
1948
- * Update the visible filters on the Liveboard.
1878
+ * Each filter object must include the following attributes:
1879
+ *
1880
+ * `column` - Name of the column to filter on.
1881
+ *
1882
+ * `oper` - Filter operator, for example, EQ, IN, CONTAINS.
1883
+ * For information about the supported filter operators,
1884
+ * see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
1885
+ *
1886
+ * `values` - An array of one or several values. The value definition on the
1887
+ * data type you choose to filter on. For a complete list of supported data types,
1888
+ * see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
1889
+ * @example
1890
+ * ```js
1949
1891
  *
1950
- * @param - filter: filter object containing column name and filter operation and values
1892
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1893
+ * filter: {
1894
+ * column: "item type",
1895
+ * oper: "IN",
1896
+ * values: ["bags","shirts"],
1897
+ * }
1898
+ * });
1899
+ * ```
1951
1900
  * @example
1952
1901
  *
1953
1902
  * ```js
1954
1903
  * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
1955
- * filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
1956
- * })
1904
+ * filters: [{
1905
+ * column: "Item Type",
1906
+ * oper: 'IN',
1907
+ * values: ["bags","shirts"]
1908
+ * },
1909
+ * {
1910
+ * column: "Region",
1911
+ * oper: 'IN',
1912
+ * values: ["West","Midwest"]
1913
+ * },
1914
+ * {
1915
+ * column: "Date",
1916
+ * oper: 'EQ',
1917
+ * values: ["1656680400"]
1918
+ * }]
1919
+ * });
1957
1920
  * ```
1958
1921
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
1959
1922
  */
1960
1923
  HostEvent["UpdateFilters"] = "updateFilters";
1961
1924
  /**
1962
1925
  * Get tab details for the current Liveboard.
1963
- *
1964
1926
  * @example
1965
1927
  * ```js
1966
1928
  * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
@@ -1974,7 +1936,6 @@ export var HostEvent;
1974
1936
  HostEvent["GetTabs"] = "getTabs";
1975
1937
  /**
1976
1938
  * Set the visible tabs on a Liveboard.
1977
- *
1978
1939
  * @param - an array of ids of tabs to show, the IDs not passed
1979
1940
  * will be hidden.
1980
1941
  * @example
@@ -1988,7 +1949,6 @@ export var HostEvent;
1988
1949
  HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
1989
1950
  /**
1990
1951
  * Set the hidden tabs on a Liveboard.
1991
- *
1992
1952
  * @param - an array of the IDs of the tabs to hide.
1993
1953
  * The IDs not passed will be shown.
1994
1954
  * @example
@@ -2002,7 +1962,6 @@ export var HostEvent;
2002
1962
  HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
2003
1963
  /**
2004
1964
  * Updates the search query string for Natural Language Search operations.
2005
- *
2006
1965
  * @param - `queryString`: Text string in Natural Language format
2007
1966
  * @param - `executeSearch`: Boolean to execute search and update search query
2008
1967
  * @example
@@ -2017,7 +1976,6 @@ export var HostEvent;
2017
1976
  HostEvent["UpdateSageQuery"] = "updateSageQuery";
2018
1977
  /**
2019
1978
  * Get the answer session for a Search / Visualization.
2020
- *
2021
1979
  * @example
2022
1980
  * ```js
2023
1981
  * const {session} = await embed.trigger(
@@ -2030,7 +1988,6 @@ export var HostEvent;
2030
1988
  HostEvent["GetAnswerSession"] = "getAnswerSession";
2031
1989
  /**
2032
1990
  * Trigger Ask Sage for viz
2033
- *
2034
1991
  * @example
2035
1992
  * ```js
2036
1993
  * liveboardEmbed.trigger(HostEvent.AskSage,
@@ -2041,7 +1998,6 @@ export var HostEvent;
2041
1998
  HostEvent["AskSage"] = "AskSage";
2042
1999
  /**
2043
2000
  * Trigger UpdateCrossFilter for Liveboard
2044
- *
2045
2001
  * @example
2046
2002
  * ```js
2047
2003
  * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -2057,7 +2013,6 @@ export var HostEvent;
2057
2013
  HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
2058
2014
  /**
2059
2015
  * Trigger ResetLiveboardPersonalisedView for Liveboard
2060
- *
2061
2016
  * @example
2062
2017
  * ```js
2063
2018
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
@@ -2065,6 +2020,35 @@ export var HostEvent;
2065
2020
  * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2066
2021
  */
2067
2022
  HostEvent["ResetLiveboardPersonalisedView"] = "ResetLiveboardPersonalisedView";
2023
+ /**
2024
+ * Trigger CreateLiveboard for liveboard list page & Pin Modal
2025
+ * @example
2026
+ * ```js
2027
+ * liveboardEmbed.trigger(HostEvent.CreateLiveboard);
2028
+ *
2029
+ * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2030
+ */
2031
+ HostEvent["CreateLiveboard"] = "CreateLiveboard";
2032
+ /**
2033
+ * Triggers Update RuntimeParameters for answers and liveboard
2034
+ * @example
2035
+ * ```js
2036
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
2037
+ * name: "Color",
2038
+ * value: "almond"
2039
+ * }])
2040
+ *
2041
+ * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2042
+ */
2043
+ HostEvent["UpdateParameters"] = "UpdateParameters";
2044
+ /**
2045
+ * Triggers GetParameters to fetch the runtime parameters
2046
+ * ```js
2047
+ * liveboardEmbed.trigger(HostEvent.GetParameters);
2048
+ *
2049
+ * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
2050
+ */
2051
+ HostEvent["GetParameters"] = "GetParameters";
2068
2052
  })(HostEvent || (HostEvent = {}));
2069
2053
  /**
2070
2054
  * The different visual modes that the data sources panel within
@@ -2167,6 +2151,14 @@ export var Param;
2167
2151
  Param["OverrideNativeConsole"] = "overrideConsoleLogs";
2168
2152
  Param["enableAskSage"] = "enableAskSage";
2169
2153
  Param["CollapseSearchBarInitially"] = "collapseSearchBarInitially";
2154
+ Param["DataPanelCustomGroupsAccordionInitialState"] = "dataPanelCustomGroupsAccordionInitialState";
2155
+ Param["EnableCustomColumnGroups"] = "enableCustomColumnGroups";
2156
+ Param["DateFormatLocale"] = "dateFormatLocale";
2157
+ Param["NumberFormatLocale"] = "numberFormatLocale";
2158
+ Param["CurrencyFormat"] = "currencyFormat";
2159
+ Param["Enable2ColumnLayout"] = "enable2ColumnLayout";
2160
+ Param["IsFullAppEmbed"] = "isFullAppEmbed";
2161
+ Param["IsOnBeforeGetVizDataInterceptEnabled"] = "isOnBeforeGetVizDataInterceptEnabled";
2170
2162
  })(Param || (Param = {}));
2171
2163
  /**
2172
2164
  * ThoughtSpot application pages include actions and menu commands
@@ -2175,7 +2167,6 @@ export var Param;
2175
2167
  * specific actions in the embedded view, define the Action
2176
2168
  * enumeration members in the `disabledActions`, `visibleActions`,
2177
2169
  * or `hiddenActions` array.
2178
- *
2179
2170
  * @example
2180
2171
  * ```js
2181
2172
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2201,10 +2192,9 @@ export var Action;
2201
2192
  /**
2202
2193
  * The **Save** action on an Answer or Liveboard.
2203
2194
  * Allows users to save the changes.
2204
- *
2205
2195
  * @example
2206
2196
  * ```js
2207
- * disabledActions: [Action.SaveAsView]
2197
+ * disabledActions: [Action.Save]
2208
2198
  * ```
2209
2199
  */
2210
2200
  Action["Save"] = "save";
@@ -2219,7 +2209,6 @@ export var Action;
2219
2209
  /**
2220
2210
  * The **Save as View** action on the Answer
2221
2211
  * page. Saves an Answer as a View object.
2222
- *
2223
2212
  * @example
2224
2213
  * ```js
2225
2214
  * disabledActions: [Action.SaveAsView]
@@ -2233,7 +2222,6 @@ export var Action;
2233
2222
  * visualizations in the embedded Liveboard view.
2234
2223
  * In AppEmbed, the **Make a copy** action is available on both
2235
2224
  * Liveboards and visualizations.
2236
- *
2237
2225
  * @example
2238
2226
  * ```js
2239
2227
  * disabledActions: [Action.MakeACopy]
@@ -2243,7 +2231,6 @@ export var Action;
2243
2231
  /**
2244
2232
  * The **Copy and Edit** action on a Liveboard.
2245
2233
  * This action is now replaced with `Action.MakeACopy`.
2246
- *
2247
2234
  * @example
2248
2235
  * ```js
2249
2236
  * disabledActions: [Action.EditACopy]
@@ -2253,7 +2240,6 @@ export var Action;
2253
2240
  /**
2254
2241
  * The **Copy link** menu action on a Liveboard visualization.
2255
2242
  * Copies the visualization URL
2256
- *
2257
2243
  * @example
2258
2244
  * ```js
2259
2245
  * disabledActions: [Action.CopyLink]
@@ -2267,7 +2253,6 @@ export var Action;
2267
2253
  /**
2268
2254
  * The **Schedule** menu action on a Liveboard.
2269
2255
  * Allows scheduling a Liveboard notification.
2270
- *
2271
2256
  * @example
2272
2257
  * ```js
2273
2258
  * disabledActions: [Action.Schedule]
@@ -2277,7 +2262,6 @@ export var Action;
2277
2262
  /**
2278
2263
  * The **Manage schedules** menu action on a Liveboard.
2279
2264
  * Allows users to manage scheduled Liveboard jobs.
2280
- *
2281
2265
  * @example
2282
2266
  * ```js
2283
2267
  * disabledActions: [Action.SchedulesList]
@@ -2287,7 +2271,6 @@ export var Action;
2287
2271
  /**
2288
2272
  * The **Share** action on a Liveboard, Answer, or Worksheet.
2289
2273
  * Allows users to share an object with other users and groups.
2290
- *
2291
2274
  * @example
2292
2275
  * ```js
2293
2276
  * disabledActions: [Action.Share]
@@ -2297,7 +2280,6 @@ export var Action;
2297
2280
  /**
2298
2281
  * The **Add filter** action on a Liveboard and Search page.
2299
2282
  * Allows adding filters to Answers and visualizations on a Liveboard.
2300
- *
2301
2283
  * @example
2302
2284
  * ```js
2303
2285
  * disabledActions: [Action.AddFilter]
@@ -2308,7 +2290,6 @@ export var Action;
2308
2290
  * The **Add Data Panel Objects** action on the data panel v2.
2309
2291
  * Allows to show action menu to add different objects (like
2310
2292
  * formulas, parameters) in data panel v2.
2311
- *
2312
2293
  * @example
2313
2294
  * ```js
2314
2295
  * disabledActions: [Action.AddDataPanelObjects]
@@ -2320,7 +2301,6 @@ export var Action;
2320
2301
  * Filter configuration options on a Liveboard and Search page.
2321
2302
  * Allows configuring filter options when adding filters to a
2322
2303
  * Liveboard or Answer.
2323
- *
2324
2304
  * @example
2325
2305
  * ```js
2326
2306
  * disabledActions: [Action.ConfigureFilter]
@@ -2331,7 +2311,6 @@ export var Action;
2331
2311
  /**
2332
2312
  * The **Choose sources** button on Search page.
2333
2313
  * Allows selecting data sources for search queries.
2334
- *
2335
2314
  * @example
2336
2315
  * ```js
2337
2316
  * disabledActions: [Action.ChooseDataSources]
@@ -2341,7 +2320,6 @@ export var Action;
2341
2320
  /**
2342
2321
  * The **Create formula** action on a Search or Answer page.
2343
2322
  * Allows adding formulas to an Answer.
2344
- *
2345
2323
  * @example
2346
2324
  * ```js
2347
2325
  * disabledActions: [Action.AddFormula]
@@ -2351,7 +2329,6 @@ export var Action;
2351
2329
  /**
2352
2330
  * The **Add parameter** action on a Liveboard or Answer.
2353
2331
  * Allows adding Parameters to a Liveboard or Answer.
2354
- *
2355
2332
  * @example
2356
2333
  * ```js
2357
2334
  * disabledActions: [Action.AddParameter]
@@ -2361,7 +2338,6 @@ export var Action;
2361
2338
  /**
2362
2339
  * The **Add Column Set** action on a Answer.
2363
2340
  * Allows adding column sets to a Answer.
2364
- *
2365
2341
  * @example
2366
2342
  * ```js
2367
2343
  * disabledActions: [Action.AddColumnSet]
@@ -2372,7 +2348,6 @@ export var Action;
2372
2348
  /**
2373
2349
  * The **Add Query Set** action on a Answer.
2374
2350
  * Allows adding query sets to a Answer.
2375
- *
2376
2351
  * @example
2377
2352
  * ```js
2378
2353
  * disabledActions: [Action.AddQuerySet]
@@ -2387,7 +2362,6 @@ export var Action;
2387
2362
  /**
2388
2363
  * The **SpotIQ analyze** menu action on a visualization or
2389
2364
  * Answer page.
2390
- *
2391
2365
  * @example
2392
2366
  * ```js
2393
2367
  * disabledActions: [Action.SpotIQAnalyze]
@@ -2410,7 +2384,6 @@ export var Action;
2410
2384
  /**
2411
2385
  * The **Show underlying data** menu action on a visualization or
2412
2386
  * Answer page.
2413
- *
2414
2387
  * @example
2415
2388
  * ```js
2416
2389
  * disabledActions: [Action.ShowUnderlyingData]
@@ -2421,7 +2394,6 @@ export var Action;
2421
2394
  * The **Download** menu action on Liveboard visualizations
2422
2395
  * and Answers.
2423
2396
  * Allows downloading a visualization or Answer.
2424
- *
2425
2397
  * @example
2426
2398
  * ```js
2427
2399
  * disabledActions: [Action.DownloadAsPng]
@@ -2432,7 +2404,6 @@ export var Action;
2432
2404
  * The **Download** > **PNG** menu action for charts on a Liveboard
2433
2405
  * or Answer page.
2434
2406
  * Downloads a visualization or Answer as a PNG file.
2435
- *
2436
2407
  * @example
2437
2408
  * ```js
2438
2409
  * disabledActions: [Action.DownloadAsPng]
@@ -2440,9 +2411,12 @@ export var Action;
2440
2411
  */
2441
2412
  Action["DownloadAsPng"] = "downloadAsPng";
2442
2413
  /**
2443
- * The **Download** > **PDF** menu action on a Liveboard.
2444
- * Downloads a visualization or Answer as a PDF file.
2445
2414
  *
2415
+ *The **Download PDF** action that downloads a Liveboard,
2416
+ *visualization, or Answer as a PDF file.
2417
+ *
2418
+ ***NOTE**: The **Download** > **PDF** action is available on
2419
+ *visualizations and Answers if the data is in tabular format.
2446
2420
  * @example
2447
2421
  * ```js
2448
2422
  * disabledActions: [Action.DownloadAsPdf]
@@ -2453,7 +2427,6 @@ export var Action;
2453
2427
  * The **Download** > **CSV** menu action for tables on a Liveboard
2454
2428
  * or Answer page.
2455
2429
  * Downloads a visualization or Answer in the XLSX format.
2456
- *
2457
2430
  * @example
2458
2431
  * ```js
2459
2432
  * disabledActions: [Action.DownloadAsCsv]
@@ -2464,7 +2437,6 @@ export var Action;
2464
2437
  * The **Download** > **XLSX** menu action for tables on a Liveboard
2465
2438
  * or Answer page.
2466
2439
  * Downloads a visualization or Answer in the XLSX format.
2467
- *
2468
2440
  * @example
2469
2441
  * ```js
2470
2442
  * disabledActions: [Action.DownloadAsXlsx]
@@ -2479,7 +2451,6 @@ export var Action;
2479
2451
  * The **Export TML** menu action on Liveboard, Answers
2480
2452
  * Worksheets and Data Connections page.
2481
2453
  * Exports an object as a TML file.
2482
- *
2483
2454
  * @example
2484
2455
  * ```js
2485
2456
  * disabledActions: [Action.ExportTML]
@@ -2489,7 +2460,6 @@ export var Action;
2489
2460
  /**
2490
2461
  * The **Import TML** menu action for Liveboards and Answers.
2491
2462
  * Imports TML representation of ThoughtSpot objects.
2492
- *
2493
2463
  * @example
2494
2464
  * ```js
2495
2465
  * disabledActions: [Action.ImportTML]
@@ -2499,7 +2469,6 @@ export var Action;
2499
2469
  /**
2500
2470
  * The **Update TML** menu action for Liveboards and Answers.
2501
2471
  * Update TML representation of ThoughtSpot objects.
2502
- *
2503
2472
  * @example
2504
2473
  * ```js
2505
2474
  * disabledActions: [Action.UpdateTML]
@@ -2509,7 +2478,6 @@ export var Action;
2509
2478
  /**
2510
2479
  * The **Edit TML** menu action for Liveboards and Answers.
2511
2480
  * Opens the TML editor.
2512
- *
2513
2481
  * @example
2514
2482
  * ```js
2515
2483
  * disabledActions: [Action.EditTML]
@@ -2520,7 +2488,6 @@ export var Action;
2520
2488
  * The **Present** menu action for Liveboards and Answers.
2521
2489
  * Allows presenting a Liveboard or visualization in
2522
2490
  * slideshow mode.
2523
- *
2524
2491
  * @example
2525
2492
  * ```js
2526
2493
  * disabledActions: [Action.Present]
@@ -2530,7 +2497,6 @@ export var Action;
2530
2497
  /**
2531
2498
  * The tile resize options in the visualization menu.
2532
2499
  * Allows switching between different preset layouts.
2533
- *
2534
2500
  * @example
2535
2501
  * ```js
2536
2502
  * disabledActions: [Action.ToggleSize]
@@ -2541,7 +2507,6 @@ export var Action;
2541
2507
  * The *Edit* action on the Liveboard page and in the
2542
2508
  * visualization menu.
2543
2509
  * Opens a Liveboard or visualization in edit mode.
2544
- *
2545
2510
  * @example
2546
2511
  * ```js
2547
2512
  * disabledActions: [Action.Edit]
@@ -2550,7 +2515,6 @@ export var Action;
2550
2515
  Action["Edit"] = "edit";
2551
2516
  /**
2552
2517
  * The text edit option for Liveboard and visualization titles.
2553
- *
2554
2518
  * @example
2555
2519
  * ```js
2556
2520
  * disabledActions: [Action.EditTitle]
@@ -2560,7 +2524,6 @@ export var Action;
2560
2524
  /**
2561
2525
  * The **Delete** menu action on Liveboards and visualizations.
2562
2526
  * Deletes a Liveboard or a visualization from a Liveboard.
2563
- *
2564
2527
  * @example
2565
2528
  * ```js
2566
2529
  * disabledActions: [Action.Remove]
@@ -2592,7 +2555,6 @@ export var Action;
2592
2555
  * Displays details such as the name, description, and
2593
2556
  * author of the Liveboard, and timestamp of Liveboard creation
2594
2557
  * and update.
2595
- *
2596
2558
  * @example
2597
2559
  * ```js
2598
2560
  * disabledActions: [Action.LiveboardInfo]
@@ -2610,7 +2572,6 @@ export var Action;
2610
2572
  /**
2611
2573
  * The **Pin** menu action on an Answer or
2612
2574
  * Search results page.
2613
- *
2614
2575
  * @example
2615
2576
  * ```js
2616
2577
  * disabledActions: [Action.Pin]
@@ -2623,7 +2584,6 @@ export var Action;
2623
2584
  Action["AnalysisInfo"] = "analysisInfo";
2624
2585
  /**
2625
2586
  * The **Schedule** menu action on a Liveboard.
2626
- *
2627
2587
  * @example
2628
2588
  * ```js
2629
2589
  * disabledActions: [Action.Subscription]
@@ -2632,7 +2592,6 @@ export var Action;
2632
2592
  Action["Subscription"] = "subscription";
2633
2593
  /**
2634
2594
  * The **Explore** action on Liveboard visualizations
2635
- *
2636
2595
  * @example
2637
2596
  * ```js
2638
2597
  * disabledActions: [Action.Explore]
@@ -2642,7 +2601,6 @@ export var Action;
2642
2601
  /**
2643
2602
  * The action to include data points on a drilled-down Answer
2644
2603
  * or visualization
2645
- *
2646
2604
  * @example
2647
2605
  * ```js
2648
2606
  * disabledActions: [Action.DrillInclude]
@@ -2652,7 +2610,6 @@ export var Action;
2652
2610
  /**
2653
2611
  * The action to exclude data points on a drilled-down Answer
2654
2612
  * or visualization
2655
- *
2656
2613
  * @example
2657
2614
  * ```js
2658
2615
  * disabledActions: [Action.DrillInclude]
@@ -2663,7 +2620,6 @@ export var Action;
2663
2620
  * The **Copy to clipboard** menu action on tables in an Answer
2664
2621
  * or Liveboard.
2665
2622
  * Copies the selected data point.
2666
- *
2667
2623
  * @example
2668
2624
  * ```js
2669
2625
  * disabledActions: [Action.CopyToClipboard]
@@ -2681,7 +2637,6 @@ export var Action;
2681
2637
  * The **Drill down** menu action on Answers and Liveboard
2682
2638
  * visualizations.
2683
2639
  * Allows drilling down to a specific data point on a chart or table.
2684
- *
2685
2640
  * @example
2686
2641
  * ```js
2687
2642
  * disabledActions: [Action.DrillDown]
@@ -2691,7 +2646,6 @@ export var Action;
2691
2646
  /**
2692
2647
  * The request access action on Liveboards.
2693
2648
  * Allows users with view permissions to request edit access to a Liveboard.
2694
- *
2695
2649
  * @example
2696
2650
  * ```js
2697
2651
  * disabledActions: [Action.RequestAccess]
@@ -2701,7 +2655,6 @@ export var Action;
2701
2655
  /**
2702
2656
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
2703
2657
  * of the Answer page
2704
- *
2705
2658
  * @example
2706
2659
  * ```js
2707
2660
  * disabledActions: [Action.QueryDetailsButtons]
@@ -2710,7 +2663,6 @@ export var Action;
2710
2663
  Action["QueryDetailsButtons"] = "queryDetailsButtons";
2711
2664
  /**
2712
2665
  * The **Delete** action for Answers.
2713
- *
2714
2666
  * @example
2715
2667
  * ```js
2716
2668
  * disabledActions: [Action.AnswerDelete]
@@ -2720,7 +2672,6 @@ export var Action;
2720
2672
  Action["AnswerDelete"] = "onDeleteAnswer";
2721
2673
  /**
2722
2674
  * The Chart switcher icon on Answer and visualization pages.
2723
- *
2724
2675
  * @example
2725
2676
  * ```js
2726
2677
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -2730,7 +2681,6 @@ export var Action;
2730
2681
  Action["AnswerChartSwitcher"] = "answerChartSwitcher";
2731
2682
  /**
2732
2683
  * Favorites icon (*) on Answers, Liveboard, and Data pages
2733
- *
2734
2684
  * @example
2735
2685
  * ```js
2736
2686
  * disabledActions: [Action.AddToFavorites]
@@ -2740,7 +2690,6 @@ export var Action;
2740
2690
  Action["AddToFavorites"] = "addToFavorites";
2741
2691
  /**
2742
2692
  * The edit icon on Liveboards (Classic experience).
2743
- *
2744
2693
  * @example
2745
2694
  * ```js
2746
2695
  * disabledActions: [Action.EditDetails]
@@ -2750,7 +2699,6 @@ export var Action;
2750
2699
  Action["EditDetails"] = "editDetails";
2751
2700
  /**
2752
2701
  * The Create alert action on KPI charts.
2753
- *
2754
2702
  * @example
2755
2703
  * ```js
2756
2704
  * disabledActions: [Action.CreateMonitor ]
@@ -2769,7 +2717,6 @@ export var Action;
2769
2717
  /**
2770
2718
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
2771
2719
  * Allows sending data to a Google Sheet.
2772
- *
2773
2720
  * @example
2774
2721
  * ```js
2775
2722
  * disabledActions: [Action.SyncToSheets]
@@ -2781,7 +2728,6 @@ export var Action;
2781
2728
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
2782
2729
  * Allows sending data to third-party apps like Slack, Salesforce,
2783
2730
  * Microsoft Teams, and so on.
2784
- *
2785
2731
  * @example
2786
2732
  * ```js
2787
2733
  * disabledActions: [Action.SyncToOtherApps]
@@ -2792,7 +2738,6 @@ export var Action;
2792
2738
  /**
2793
2739
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
2794
2740
  * Allows users to manage data sync pipelines to third-party apps.
2795
- *
2796
2741
  * @example
2797
2742
  * ```js
2798
2743
  * disabledActions: [Action.SyncToOtherApps]
@@ -2803,7 +2748,6 @@ export var Action;
2803
2748
  /**
2804
2749
  * The **Filter** action on Liveboard visualizations.
2805
2750
  * Allows users to apply cross-filters on a Liveboard.
2806
- *
2807
2751
  * @example
2808
2752
  * ```js
2809
2753
  * disabledActions: [Action.CrossFilter]
@@ -2814,7 +2758,6 @@ export var Action;
2814
2758
  /**
2815
2759
  * The **Sync to Slack** action on Liveboard visualizations.
2816
2760
  * Allows sending data to third-party apps Slack
2817
- *
2818
2761
  * @example
2819
2762
  * ```js
2820
2763
  * disabledActions: [Action.SyncToSlack]
@@ -2825,7 +2768,6 @@ export var Action;
2825
2768
  /**
2826
2769
  * The **Sync to Teams** action on Liveboard visualizations.
2827
2770
  * Allows sending data to third-party apps Team
2828
- *
2829
2771
  * @example
2830
2772
  * ```js
2831
2773
  * disabledActions: [Action.SyncToTeams]
@@ -2837,7 +2779,6 @@ export var Action;
2837
2779
  * The **Remove** action that appears when cross filters are applied
2838
2780
  * on a Liveboard.
2839
2781
  * Removes filters applied o a visualization.
2840
- *
2841
2782
  * @example
2842
2783
  * ```js
2843
2784
  * disabledActions: [Action.RemoveCrossFilter]
@@ -2849,7 +2790,6 @@ export var Action;
2849
2790
  * The **Aggregate** option in the chart axis or the
2850
2791
  * table column customization menu.
2851
2792
  * Provides aggregation options to analyze the data on a chart or table.
2852
- *
2853
2793
  * @example
2854
2794
  * ```js
2855
2795
  * disabledActions: [Action.AxisMenuAggregate]
@@ -2861,7 +2801,6 @@ export var Action;
2861
2801
  * The **Time bucket** option in the chart axis or table column
2862
2802
  * customization menu.
2863
2803
  * Allows defining time metric for date comparison.
2864
- *
2865
2804
  * @example
2866
2805
  * ```js
2867
2806
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -2872,7 +2811,6 @@ export var Action;
2872
2811
  /**
2873
2812
  * The **Filter** action in the chart axis or table column
2874
2813
  * customization menu.
2875
- *
2876
2814
  * @example
2877
2815
  * ```js
2878
2816
  * disabledActions: [Action.AxisMenuFilter]
@@ -2884,7 +2822,6 @@ export var Action;
2884
2822
  * The **Conditional formatting** action on chart or table.
2885
2823
  * Allows adding rules for conditional formatting of data
2886
2824
  * points on a chart or table.
2887
- *
2888
2825
  * @example
2889
2826
  * ```js
2890
2827
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2896,7 +2833,6 @@ export var Action;
2896
2833
  * The **Sort** menu action on a table or chart axis
2897
2834
  * Sorts data in ascending or descending order.
2898
2835
  * Allows adding, editing, or removing filters.
2899
- *
2900
2836
  * @example
2901
2837
  * ```js
2902
2838
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2909,7 +2845,6 @@ export var Action;
2909
2845
  * customization menu.
2910
2846
  * Allows grouping data points if the axes use the same
2911
2847
  * unit of measurement and a similar scale.
2912
- *
2913
2848
  * @example
2914
2849
  * ```js
2915
2850
  * disabledActions: [Action.AxisMenuGroup]
@@ -2921,7 +2856,6 @@ export var Action;
2921
2856
  * The **Position** option in the axis customization menu.
2922
2857
  * Allows changing the position of the axis to the
2923
2858
  * left or right side of the chart.
2924
- *
2925
2859
  * @example
2926
2860
  * ```js
2927
2861
  * disabledActions: [Action.AxisMenuPosition]
@@ -2932,7 +2866,6 @@ export var Action;
2932
2866
  /**
2933
2867
  * The **Rename** option in the chart axis or table column customization menu.
2934
2868
  * Renames the axis label on a chart or the column header on a table.
2935
- *
2936
2869
  * @example
2937
2870
  * ```js
2938
2871
  * disabledActions: [Action.AxisMenuRename]
@@ -2944,7 +2877,6 @@ export var Action;
2944
2877
  * The **Edit** action in the axis customization menu.
2945
2878
  * Allows editing the axis name, position, minimum and maximum values,
2946
2879
  * and format of a column.
2947
- *
2948
2880
  * @example
2949
2881
  * ```js
2950
2882
  * disabledActions: [Action.AxisMenuEdit]
@@ -2955,7 +2887,6 @@ export var Action;
2955
2887
  /**
2956
2888
  * The **Number format** action to customize the format of
2957
2889
  * the data labels on a chart or table.
2958
- *
2959
2890
  * @example
2960
2891
  * ```js
2961
2892
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -2966,7 +2897,6 @@ export var Action;
2966
2897
  /**
2967
2898
  * The **Text wrapping** action on a table.
2968
2899
  * Wraps or clips column text on a table.
2969
- *
2970
2900
  * @example
2971
2901
  * ```js
2972
2902
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -2979,7 +2909,6 @@ export var Action;
2979
2909
  * customization menu.
2980
2910
  * Removes the data labels from a chart or the column of a
2981
2911
  * table visualization.
2982
- *
2983
2912
  * @example
2984
2913
  * ```js
2985
2914
  * disabledActions: [Action.AxisMenuRemove]
@@ -2994,7 +2923,6 @@ export var Action;
2994
2923
  /**
2995
2924
  * The **Rename** menu action on Liveboards and visualizations.
2996
2925
  * Allows renaming a Liveboard or visualization.
2997
- *
2998
2926
  * @example
2999
2927
  * ```js
3000
2928
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -3038,7 +2966,6 @@ export var Action;
3038
2966
  /**
3039
2967
  * The **Move to Tab** menu action on visualizations in liveboard edit mode.
3040
2968
  * Allows moving a visualization to a different tab.
3041
- *
3042
2969
  * @example
3043
2970
  * ```js
3044
2971
  * disabledActions: [Action.MoveToTab]
@@ -3047,7 +2974,6 @@ export var Action;
3047
2974
  Action["MoveToTab"] = "onContainerMove";
3048
2975
  /**
3049
2976
  * The **Manage Alertsb** menu action on KPI visualizations.
3050
- *
3051
2977
  * @example
3052
2978
  * ```js
3053
2979
  * disabledActions: [Action.ManageMonitor]
@@ -3056,7 +2982,6 @@ export var Action;
3056
2982
  Action["ManageMonitor"] = "ManageMonitor";
3057
2983
  /**
3058
2984
  * Action ID for Liveboard Personalised Views dropdown
3059
- *
3060
2985
  * @example
3061
2986
  * ```js
3062
2987
  * disabledActions: [Action.PersonalisedViewsDropdown]
@@ -3066,7 +2991,6 @@ export var Action;
3066
2991
  Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
3067
2992
  /**
3068
2993
  * Action ID for Liveboard Users ( Recently Visited / social proof )
3069
- *
3070
2994
  * @example
3071
2995
  * ```js
3072
2996
  * disabledActions: [Action.LiveboardUsers]
@@ -3078,7 +3002,6 @@ export var Action;
3078
3002
  * Action ID for the Parent TML action
3079
3003
  * The parent action **TML** must be included to access TML-related options
3080
3004
  * within the cascading menu (specific to the answer page)
3081
- *
3082
3005
  * @example
3083
3006
  * ```js
3084
3007
  * // to include specific TML actions
@@ -3090,13 +3013,11 @@ export var Action;
3090
3013
  * hiddenAction: [Action.TML] // hide all TML actions
3091
3014
  * disabledActions: [Action.TML] // to disable all TML actions
3092
3015
  * ```
3093
- *
3094
- * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
3016
+ * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
3095
3017
  */
3096
3018
  Action["TML"] = "tml";
3097
3019
  /**
3098
3020
  * Action ID for to hide Verified Liveboard Banner
3099
- *
3100
3021
  * @example
3101
3022
  * ```js
3102
3023
  * hiddenAction: [Action.VerifiedLiveboard]
@@ -3106,7 +3027,6 @@ export var Action;
3106
3027
  Action["VerifiedLiveboard"] = "verifiedLiveboard";
3107
3028
  /**
3108
3029
  * Action ID for ask sage button
3109
- *
3110
3030
  * @example
3111
3031
  * ```js
3112
3032
  * hiddenAction: [Action.AskAi]
@@ -3116,7 +3036,6 @@ export var Action;
3116
3036
  Action["AskAi"] = "AskAi";
3117
3037
  /**
3118
3038
  * The **Add KPI to Watchlist** action on Home page watchlist.
3119
- *
3120
3039
  * @example
3121
3040
  * ```js
3122
3041
  * disabledActions: [Action.AddToWatchlist]
@@ -3126,7 +3045,6 @@ export var Action;
3126
3045
  Action["AddToWatchlist"] = "addToWatchlist";
3127
3046
  /**
3128
3047
  * The **Remove from watchlist** menu action on KPI watchlist.
3129
- *
3130
3048
  * @example
3131
3049
  * ```js
3132
3050
  * disabledActions: [Action.RemoveFromWatchlist]
@@ -3134,19 +3052,8 @@ export var Action;
3134
3052
  * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
3135
3053
  */
3136
3054
  Action["RemoveFromWatchlist"] = "removeFromWatchlist";
3137
- /**
3138
- * The **Copy KPI Link** menu action on KPI watchlist.
3139
- *
3140
- * @example
3141
- * ```js
3142
- * disabledActions: [Action.CopyKpiLink]
3143
- * ```
3144
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
3145
- */
3146
- Action["CopyKpiLink"] = "copyKpiLink";
3147
3055
  /**
3148
3056
  * The **Organise Favourites** action on Homepage Favourite Module.
3149
- *
3150
3057
  * @example
3151
3058
  * ```js
3152
3059
  * disabledActions: [Action.OrganiseFavourites]
@@ -3156,7 +3063,6 @@ export var Action;
3156
3063
  Action["OrganiseFavourites"] = "organiseFavourites";
3157
3064
  /**
3158
3065
  * Action ID for AI Highlights button
3159
- *
3160
3066
  * @example
3161
3067
  * ```js
3162
3068
  * hiddenAction: [Action.AIHighlights]
@@ -3184,7 +3090,6 @@ export var LogLevel;
3184
3090
  (function (LogLevel) {
3185
3091
  /**
3186
3092
  * No logs will be logged in the console.
3187
- *
3188
3093
  * @example
3189
3094
  * ```js
3190
3095
  * init({
@@ -3197,7 +3102,6 @@ export var LogLevel;
3197
3102
  LogLevel["SILENT"] = "SILENT";
3198
3103
  /**
3199
3104
  * Only ERROR logs will be logged in the console.
3200
- *
3201
3105
  * @example
3202
3106
  * ```js
3203
3107
  * init({
@@ -3210,7 +3114,6 @@ export var LogLevel;
3210
3114
  LogLevel["ERROR"] = "ERROR";
3211
3115
  /**
3212
3116
  * Only WARN and ERROR logs will be logged in the console.
3213
- *
3214
3117
  * @example
3215
3118
  * ```js
3216
3119
  * init({
@@ -3223,7 +3126,6 @@ export var LogLevel;
3223
3126
  LogLevel["WARN"] = "WARN";
3224
3127
  /**
3225
3128
  * Only INFO, WARN, and ERROR logs will be logged in the console.
3226
- *
3227
3129
  * @example
3228
3130
  * ```js
3229
3131
  * init({
@@ -3236,7 +3138,6 @@ export var LogLevel;
3236
3138
  LogLevel["INFO"] = "INFO";
3237
3139
  /**
3238
3140
  * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
3239
- *
3240
3141
  * @example
3241
3142
  * ```js
3242
3143
  * init({
@@ -3249,7 +3150,6 @@ export var LogLevel;
3249
3150
  LogLevel["DEBUG"] = "DEBUG";
3250
3151
  /**
3251
3152
  * All logs will be logged in the console.
3252
- *
3253
3153
  * @example
3254
3154
  * ```js
3255
3155
  * init({