@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.3

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 (257) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts +29 -4
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +29 -7
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/auth.spec.js +1 -3
  7. package/cjs/src/auth.spec.js.map +1 -1
  8. package/cjs/src/authToken.js +0 -1
  9. package/cjs/src/authToken.js.map +1 -1
  10. package/cjs/src/authToken.spec.js +2 -1
  11. package/cjs/src/authToken.spec.js.map +1 -1
  12. package/cjs/src/css-variables.d.ts +17 -17
  13. package/cjs/src/embed/app.d.ts +62 -33
  14. package/cjs/src/embed/app.d.ts.map +1 -1
  15. package/cjs/src/embed/app.js +10 -3
  16. package/cjs/src/embed/app.js.map +1 -1
  17. package/cjs/src/embed/app.spec.js +34 -1
  18. package/cjs/src/embed/app.spec.js.map +1 -1
  19. package/cjs/src/embed/auto-frame-renderer.d.ts +41 -0
  20. package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -0
  21. package/cjs/src/embed/auto-frame-renderer.js +145 -0
  22. package/cjs/src/embed/auto-frame-renderer.js.map +1 -0
  23. package/cjs/src/embed/auto-frame-renderer.spec.d.ts +2 -0
  24. package/cjs/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
  25. package/cjs/src/embed/auto-frame-renderer.spec.js +195 -0
  26. package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -0
  27. package/cjs/src/embed/base.d.ts +2 -2
  28. package/cjs/src/embed/base.d.ts.map +1 -1
  29. package/cjs/src/embed/base.js +6 -9
  30. package/cjs/src/embed/base.js.map +1 -1
  31. package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
  32. package/cjs/src/embed/bodyless-conversation.js +4 -4
  33. package/cjs/src/embed/conversation.d.ts +43 -30
  34. package/cjs/src/embed/conversation.d.ts.map +1 -1
  35. package/cjs/src/embed/conversation.js +10 -11
  36. package/cjs/src/embed/conversation.js.map +1 -1
  37. package/cjs/src/embed/conversation.spec.js +27 -0
  38. package/cjs/src/embed/conversation.spec.js.map +1 -1
  39. package/cjs/src/embed/hostEventClient/host-event-client.js +0 -2
  40. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  41. package/cjs/src/embed/liveboard.d.ts +42 -35
  42. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  43. package/cjs/src/embed/liveboard.js +6 -4
  44. package/cjs/src/embed/liveboard.js.map +1 -1
  45. package/cjs/src/embed/liveboard.spec.js +5 -3
  46. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  47. package/cjs/src/embed/sage.d.ts +5 -5
  48. package/cjs/src/embed/sage.js +1 -2
  49. package/cjs/src/embed/sage.js.map +1 -1
  50. package/cjs/src/embed/search-bar.d.ts +7 -7
  51. package/cjs/src/embed/search-bar.js +1 -1
  52. package/cjs/src/embed/search.d.ts +13 -12
  53. package/cjs/src/embed/search.d.ts.map +1 -1
  54. package/cjs/src/embed/search.js.map +1 -1
  55. package/cjs/src/embed/search.spec.js +0 -2
  56. package/cjs/src/embed/search.spec.js.map +1 -1
  57. package/cjs/src/embed/ts-embed.d.ts +3 -3
  58. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  59. package/cjs/src/embed/ts-embed.js +15 -9
  60. package/cjs/src/embed/ts-embed.js.map +1 -1
  61. package/cjs/src/embed/ts-embed.spec.js +37 -1
  62. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  63. package/cjs/src/index.d.ts +3 -2
  64. package/cjs/src/index.d.ts.map +1 -1
  65. package/cjs/src/index.js +3 -1
  66. package/cjs/src/index.js.map +1 -1
  67. package/cjs/src/react/index.d.ts +15 -15
  68. package/cjs/src/react/index.js +12 -13
  69. package/cjs/src/react/index.js.map +1 -1
  70. package/cjs/src/react/index.spec.js +6 -3
  71. package/cjs/src/react/index.spec.js.map +1 -1
  72. package/cjs/src/tokenizedFetch.d.ts +1 -1
  73. package/cjs/src/tokenizedFetch.js +1 -1
  74. package/cjs/src/types.d.ts +350 -287
  75. package/cjs/src/types.d.ts.map +1 -1
  76. package/cjs/src/types.js +240 -218
  77. package/cjs/src/types.js.map +1 -1
  78. package/cjs/src/utils/graphql/answerService/answerService.d.ts +9 -6
  79. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  80. package/cjs/src/utils/graphql/answerService/answerService.js +13 -15
  81. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  82. package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
  83. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  84. package/cjs/src/utils/graphql/preview-service.js +0 -1
  85. package/cjs/src/utils/graphql/preview-service.js.map +1 -1
  86. package/cjs/src/utils/processData.js +0 -5
  87. package/cjs/src/utils/processData.js.map +1 -1
  88. package/cjs/src/utils.d.ts +9 -0
  89. package/cjs/src/utils.d.ts.map +1 -1
  90. package/cjs/src/utils.js +10 -1
  91. package/cjs/src/utils.js.map +1 -1
  92. package/dist/{index-Vyh6Ha5f.js → index-DyX-x6uN.js} +1 -1
  93. package/dist/src/auth.d.ts +29 -4
  94. package/dist/src/auth.d.ts.map +1 -1
  95. package/dist/src/css-variables.d.ts +17 -17
  96. package/dist/src/embed/app.d.ts +62 -33
  97. package/dist/src/embed/app.d.ts.map +1 -1
  98. package/dist/src/embed/auto-frame-renderer.d.ts +41 -0
  99. package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -0
  100. package/dist/src/embed/auto-frame-renderer.spec.d.ts +2 -0
  101. package/dist/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
  102. package/dist/src/embed/base.d.ts +2 -2
  103. package/dist/src/embed/base.d.ts.map +1 -1
  104. package/dist/src/embed/bodyless-conversation.d.ts +5 -5
  105. package/dist/src/embed/conversation.d.ts +43 -30
  106. package/dist/src/embed/conversation.d.ts.map +1 -1
  107. package/dist/src/embed/liveboard.d.ts +42 -35
  108. package/dist/src/embed/liveboard.d.ts.map +1 -1
  109. package/dist/src/embed/sage.d.ts +5 -5
  110. package/dist/src/embed/search-bar.d.ts +7 -7
  111. package/dist/src/embed/search.d.ts +13 -12
  112. package/dist/src/embed/search.d.ts.map +1 -1
  113. package/dist/src/embed/ts-embed.d.ts +3 -3
  114. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  115. package/dist/src/index.d.ts +3 -2
  116. package/dist/src/index.d.ts.map +1 -1
  117. package/dist/src/react/index.d.ts +15 -15
  118. package/dist/src/tokenizedFetch.d.ts +1 -1
  119. package/dist/src/types.d.ts +350 -287
  120. package/dist/src/types.d.ts.map +1 -1
  121. package/dist/src/utils/graphql/answerService/answerService.d.ts +9 -6
  122. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  123. package/dist/src/utils.d.ts +9 -0
  124. package/dist/src/utils.d.ts.map +1 -1
  125. package/dist/tsembed-react.es.js +359 -329
  126. package/dist/tsembed-react.js +358 -328
  127. package/dist/tsembed.es.js +490 -321
  128. package/dist/tsembed.js +489 -319
  129. package/dist/visual-embed-sdk-react-full.d.ts +574 -442
  130. package/dist/visual-embed-sdk-react.d.ts +572 -440
  131. package/dist/visual-embed-sdk.d.ts +622 -446
  132. package/lib/package.json +1 -1
  133. package/lib/src/auth.d.ts +29 -4
  134. package/lib/src/auth.d.ts.map +1 -1
  135. package/lib/src/auth.js +29 -7
  136. package/lib/src/auth.js.map +1 -1
  137. package/lib/src/auth.spec.js +1 -3
  138. package/lib/src/auth.spec.js.map +1 -1
  139. package/lib/src/authToken.js +0 -1
  140. package/lib/src/authToken.js.map +1 -1
  141. package/lib/src/authToken.spec.js +2 -1
  142. package/lib/src/authToken.spec.js.map +1 -1
  143. package/lib/src/css-variables.d.ts +17 -17
  144. package/lib/src/embed/app.d.ts +62 -33
  145. package/lib/src/embed/app.d.ts.map +1 -1
  146. package/lib/src/embed/app.js +11 -4
  147. package/lib/src/embed/app.js.map +1 -1
  148. package/lib/src/embed/app.spec.js +34 -1
  149. package/lib/src/embed/app.spec.js.map +1 -1
  150. package/lib/src/embed/auto-frame-renderer.d.ts +41 -0
  151. package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -0
  152. package/lib/src/embed/auto-frame-renderer.js +141 -0
  153. package/lib/src/embed/auto-frame-renderer.js.map +1 -0
  154. package/lib/src/embed/auto-frame-renderer.spec.d.ts +2 -0
  155. package/lib/src/embed/auto-frame-renderer.spec.d.ts.map +1 -0
  156. package/lib/src/embed/auto-frame-renderer.spec.js +192 -0
  157. package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -0
  158. package/lib/src/embed/base.d.ts +2 -2
  159. package/lib/src/embed/base.d.ts.map +1 -1
  160. package/lib/src/embed/base.js +6 -9
  161. package/lib/src/embed/base.js.map +1 -1
  162. package/lib/src/embed/bodyless-conversation.d.ts +5 -5
  163. package/lib/src/embed/bodyless-conversation.js +4 -4
  164. package/lib/src/embed/conversation.d.ts +43 -30
  165. package/lib/src/embed/conversation.d.ts.map +1 -1
  166. package/lib/src/embed/conversation.js +11 -11
  167. package/lib/src/embed/conversation.js.map +1 -1
  168. package/lib/src/embed/conversation.spec.js +27 -0
  169. package/lib/src/embed/conversation.spec.js.map +1 -1
  170. package/lib/src/embed/hostEventClient/host-event-client.js +0 -2
  171. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  172. package/lib/src/embed/liveboard.d.ts +42 -35
  173. package/lib/src/embed/liveboard.d.ts.map +1 -1
  174. package/lib/src/embed/liveboard.js +6 -4
  175. package/lib/src/embed/liveboard.js.map +1 -1
  176. package/lib/src/embed/liveboard.spec.js +5 -3
  177. package/lib/src/embed/liveboard.spec.js.map +1 -1
  178. package/lib/src/embed/sage.d.ts +5 -5
  179. package/lib/src/embed/sage.js +1 -2
  180. package/lib/src/embed/sage.js.map +1 -1
  181. package/lib/src/embed/search-bar.d.ts +7 -7
  182. package/lib/src/embed/search-bar.js +1 -1
  183. package/lib/src/embed/search.d.ts +13 -12
  184. package/lib/src/embed/search.d.ts.map +1 -1
  185. package/lib/src/embed/search.js.map +1 -1
  186. package/lib/src/embed/search.spec.js +0 -2
  187. package/lib/src/embed/search.spec.js.map +1 -1
  188. package/lib/src/embed/ts-embed.d.ts +3 -3
  189. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  190. package/lib/src/embed/ts-embed.js +15 -9
  191. package/lib/src/embed/ts-embed.js.map +1 -1
  192. package/lib/src/embed/ts-embed.spec.js +37 -1
  193. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  194. package/lib/src/index.d.ts +3 -2
  195. package/lib/src/index.d.ts.map +1 -1
  196. package/lib/src/index.js +1 -0
  197. package/lib/src/index.js.map +1 -1
  198. package/lib/src/react/index.d.ts +15 -15
  199. package/lib/src/react/index.js +12 -13
  200. package/lib/src/react/index.js.map +1 -1
  201. package/lib/src/react/index.spec.js +6 -3
  202. package/lib/src/react/index.spec.js.map +1 -1
  203. package/lib/src/tokenizedFetch.d.ts +1 -1
  204. package/lib/src/tokenizedFetch.js +1 -1
  205. package/lib/src/types.d.ts +350 -287
  206. package/lib/src/types.d.ts.map +1 -1
  207. package/lib/src/types.js +240 -218
  208. package/lib/src/types.js.map +1 -1
  209. package/lib/src/utils/graphql/answerService/answerService.d.ts +9 -6
  210. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  211. package/lib/src/utils/graphql/answerService/answerService.js +12 -14
  212. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  213. package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
  214. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  215. package/lib/src/utils/graphql/preview-service.js +0 -1
  216. package/lib/src/utils/graphql/preview-service.js.map +1 -1
  217. package/lib/src/utils/processData.js +0 -5
  218. package/lib/src/utils/processData.js.map +1 -1
  219. package/lib/src/utils.d.ts +9 -0
  220. package/lib/src/utils.d.ts.map +1 -1
  221. package/lib/src/utils.js +8 -0
  222. package/lib/src/utils.js.map +1 -1
  223. package/lib/src/visual-embed-sdk.d.ts +11466 -0
  224. package/package.json +1 -1
  225. package/src/auth.spec.ts +1 -1
  226. package/src/auth.ts +32 -7
  227. package/src/authToken.spec.ts +2 -1
  228. package/src/authToken.ts +1 -1
  229. package/src/css-variables.ts +17 -17
  230. package/src/embed/app.spec.ts +46 -1
  231. package/src/embed/app.ts +74 -36
  232. package/src/embed/auto-frame-renderer.spec.ts +266 -0
  233. package/src/embed/auto-frame-renderer.ts +152 -0
  234. package/src/embed/base.spec.ts +1 -1
  235. package/src/embed/base.ts +9 -10
  236. package/src/embed/bodyless-conversation.ts +5 -5
  237. package/src/embed/conversation.spec.ts +37 -0
  238. package/src/embed/conversation.ts +55 -38
  239. package/src/embed/hostEventClient/host-event-client.ts +2 -2
  240. package/src/embed/liveboard.spec.ts +5 -3
  241. package/src/embed/liveboard.ts +47 -38
  242. package/src/embed/sage.ts +6 -6
  243. package/src/embed/search-bar.tsx +7 -7
  244. package/src/embed/search.spec.ts +2 -2
  245. package/src/embed/search.ts +13 -12
  246. package/src/embed/ts-embed.spec.ts +44 -1
  247. package/src/embed/ts-embed.ts +14 -9
  248. package/src/index.ts +3 -0
  249. package/src/react/index.spec.tsx +6 -3
  250. package/src/react/index.tsx +16 -16
  251. package/src/tokenizedFetch.ts +1 -1
  252. package/src/types.ts +350 -286
  253. package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
  254. package/src/utils/graphql/answerService/answerService.ts +14 -10
  255. package/src/utils/graphql/preview-service.ts +1 -1
  256. package/src/utils/processData.ts +5 -5
  257. package/src/utils.ts +14 -0
@@ -428,37 +428,37 @@ export interface CustomCssVariables {
428
428
  /**
429
429
  * Padding of the groups in the Liveboard.
430
430
  *
431
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
431
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
432
432
  */
433
433
  "--ts-var-liveboard-group-padding"?: string;
434
434
  /**
435
435
  * Font size of the title of the groups in the Liveboard.
436
436
  *
437
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
437
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
438
438
  */
439
439
  "--ts-var-liveboard-group-title-font-size"?: string;
440
440
  /**
441
441
  * Font weight of the title of the groups in the Liveboard.
442
442
  *
443
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
443
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
444
444
  */
445
445
  "--ts-var-liveboard-group-title-font-weight"?: string;
446
446
  /**
447
447
  * Font size of the title of the tiles inside the groups in the Liveboard.
448
448
  *
449
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
449
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
450
450
  */
451
451
  "--ts-var-liveboard-group-tile-title-font-size"?: string;
452
452
  /**
453
453
  * Font weight of the title of the tiles inside the groups in the Liveboard.
454
454
  *
455
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
455
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
456
456
  */
457
457
  "--ts-var-liveboard-group-tile-title-font-weight"?: string;
458
458
  /**
459
459
  * Padding of the group tiles in the Liveboard.
460
460
  *
461
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
461
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
462
462
  */
463
463
  "--ts-var-liveboard-group-tile-padding"?: string;
464
464
  /**
@@ -468,13 +468,13 @@ export interface CustomCssVariables {
468
468
  /**
469
469
  * Background color of the groups in the Liveboard.
470
470
  *
471
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
471
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
472
472
  */
473
473
  "--ts-var-liveboard-group-background"?: string;
474
474
  /**
475
475
  * Border color of the groups in the Liveboard.
476
476
  *
477
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
477
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
478
478
  */
479
479
  "--ts-var-liveboard-group-border-color"?: string;
480
480
  /**
@@ -488,55 +488,55 @@ export interface CustomCssVariables {
488
488
  /**
489
489
  * Font color of the title of the groups in the Liveboard.
490
490
  *
491
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
491
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
492
492
  */
493
493
  "--ts-var-liveboard-group-title-font-color"?: string;
494
494
  /**
495
495
  * Font color of the description of the groups in the Liveboard.
496
496
  *
497
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
497
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
498
498
  */
499
499
  "--ts-var-liveboard-group-description-font-color"?: string;
500
500
  /**
501
501
  * Font color of the title of the tiles inside the groups in the Liveboard.
502
502
  *
503
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
503
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
504
504
  */
505
505
  "--ts-var-liveboard-group-tile-title-font-color"?: string;
506
506
  /**
507
507
  * Font color of the description of the tiles inside the groups in the Liveboard.
508
508
  *
509
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
509
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
510
510
  */
511
511
  "--ts-var-liveboard-group-tile-description-font-color"?: string;
512
512
  /**
513
513
  * Background color of the tiles inside the groups in the Liveboard.
514
514
  *
515
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
515
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
516
516
  */
517
517
  "--ts-var-liveboard-group-tile-background"?: string;
518
518
  /**
519
519
  * Background color of the filter chips in the Liveboard.
520
520
  *
521
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
521
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
522
522
  */
523
523
  "--ts-var-liveboard-chip-background"?: string;
524
524
  /**
525
525
  * Font color of the filter chips in the Liveboard.
526
526
  *
527
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
527
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
528
528
  */
529
529
  "--ts-var-liveboard-chip-color"?: string;
530
530
  /**
531
531
  * Background color of the filter chips in the Liveboard on hover.
532
532
  *
533
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
533
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
534
534
  */
535
535
  "--ts-var-liveboard-chip--hover-background"?: string;
536
536
  /**
537
537
  * Background color of the filter chips in the Liveboard on active.
538
538
  *
539
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
539
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
540
540
  */
541
541
  "--ts-var-liveboard-chip--active-background"?: string;
542
542
  /**
@@ -809,6 +809,7 @@ declare class AnswerService {
809
809
  * ]);
810
810
  * console.log(await service.fetchData());
811
811
  * });
812
+ * ```
812
813
  */
813
814
  addColumnsByName(columnNames: string[]): Promise<any>;
814
815
  /**
@@ -880,7 +881,7 @@ declare class AnswerService {
880
881
  * const data = await underlying.fetchData(0, 100);
881
882
  * })
882
883
  * ```
883
- * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
884
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
884
885
  */
885
886
  getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
886
887
  /**
@@ -901,7 +902,7 @@ declare class AnswerService {
901
902
  setTMLOverride(override: any): void;
902
903
  }
903
904
  /**
904
- * The authentication mechanism for allowing access to the
905
+ * The authentication mechanism for allowing access to
905
906
  * the embedded app
906
907
  * @group Authentication / Init
907
908
  */
@@ -926,6 +927,7 @@ export declare enum AuthType {
926
927
  * To use this:
927
928
  * Your SAML or OpenID provider must allow iframe redirects.
928
929
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
930
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
929
931
  * @example
930
932
  * ```js
931
933
  * init({
@@ -933,18 +935,17 @@ export declare enum AuthType {
933
935
  * authType: AuthType.EmbeddedSSO,
934
936
  * });
935
937
  * ```
936
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
937
938
  */
938
939
  EmbeddedSSO = "EmbeddedSSO",
939
940
  /**
940
- * SSO using SAML
941
- * @deprecated Use {@link SAMLRedirect} instead
941
+ * SSO using SAML, Use {@link SAMLRedirect} instead
942
+ * @deprecated This option is deprecated.
942
943
  * @hidden
943
944
  */
944
945
  SSO = "SSO_SAML",
945
946
  /**
946
- * SSO using SAML
947
- * @deprecated Use {@link SAMLRedirect} instead
947
+ * SSO using SAML, Use {@link SAMLRedirect} instead
948
+ * @deprecated This option is deprecated.
948
949
  * @hidden
949
950
  */
950
951
  SAML = "SSO_SAML",
@@ -995,8 +996,9 @@ export declare enum AuthType {
995
996
  SAMLRedirect = "SSO_SAML",
996
997
  /**
997
998
  * SSO using OIDC
999
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
1000
+ * @deprecated This option is deprecated.
998
1001
  * @hidden
999
- * @deprecated Use {@link OIDCRedirect} instead
1000
1002
  */
1001
1003
  OIDC = "SSO_OIDC",
1002
1004
  /**
@@ -1007,8 +1009,9 @@ export declare enum AuthType {
1007
1009
  OIDCRedirect = "SSO_OIDC",
1008
1010
  /**
1009
1011
  * Trusted authentication server
1012
+ * Use {@link TrustedAuth} instead
1013
+ * @deprecated This option is deprecated.
1010
1014
  * @hidden
1011
- * @deprecated Use {@link TrustedAuth} instead
1012
1015
  */
1013
1016
  AuthServer = "AuthServer",
1014
1017
  /**
@@ -1035,6 +1038,7 @@ export declare enum AuthType {
1035
1038
  * obtained from ThoughtSpot. This uses a cookieless authentication
1036
1039
  * approach, recommended to bypass the third-party cookie-blocking restriction
1037
1040
  * implemented by some browsers.
1041
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1038
1042
  * @example
1039
1043
  * ```js
1040
1044
  * init({
@@ -1045,8 +1049,8 @@ export declare enum AuthType {
1045
1049
  * .then((response) => response.json())
1046
1050
  * .then((data) => data.token);
1047
1051
  * }
1052
+ * });
1048
1053
  * ```
1049
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1050
1054
  */
1051
1055
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1052
1056
  /**
@@ -1061,43 +1065,43 @@ declare enum HomeLeftNavItem {
1061
1065
  /**
1062
1066
  * The *Search data* option in
1063
1067
  * the *Insights* left navigation panel.
1064
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1068
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1065
1069
  */
1066
1070
  SearchData = "search-data",
1067
1071
  /**
1068
1072
  * The *Home* menu option in
1069
1073
  * the *Insights* left navigation panel.
1070
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1074
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1071
1075
  */
1072
1076
  Home = "insights-home",
1073
1077
  /**
1074
1078
  * The *Liveboards* menu option in
1075
1079
  * the *Insights* left navigation panel.
1076
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1080
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1077
1081
  */
1078
1082
  Liveboards = "liveboards",
1079
1083
  /**
1080
1084
  * The *Answers* menu option in
1081
1085
  * the *Insights* left navigation panel.
1082
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1086
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1083
1087
  */
1084
1088
  Answers = "answers",
1085
1089
  /**
1086
1090
  * The *Monitor subscriptions* menu option in
1087
1091
  * the *Insights* left navigation panel.
1088
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1092
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1089
1093
  */
1090
1094
  MonitorSubscription = "monitor-alerts",
1091
1095
  /**
1092
1096
  * The *SpotIQ analysis* menu option in
1093
1097
  * the *Insights* left navigation panel.
1094
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1098
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1095
1099
  */
1096
1100
  SpotIQAnalysis = "spotiq-analysis",
1097
1101
  /**
1098
1102
  * The *Liveboard schedules* menu option in
1099
1103
  * the *Insights* left navigation panel.
1100
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
1104
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
1101
1105
  */
1102
1106
  LiveboardSchedules = "liveboard-schedules",
1103
1107
  /**
@@ -1268,8 +1272,8 @@ export interface EmbedConfig {
1268
1272
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
1269
1273
  * open the SAML auth flow in a popup, instead of redirecting the browser in
1270
1274
  * place.
1275
+ * @deprecated This option is deprecated.
1271
1276
  * @default false
1272
- * @deprecated
1273
1277
  */
1274
1278
  noRedirect?: boolean;
1275
1279
  /**
@@ -1278,8 +1282,8 @@ export interface EmbedConfig {
1278
1282
  *
1279
1283
  * Need to use this with `authTriggerContainer`. Or manually trigger
1280
1284
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
1281
- * @default false
1282
1285
  * @version SDK: 1.18.0
1286
+ * @default false
1283
1287
  */
1284
1288
  inPopup?: boolean;
1285
1289
  /**
@@ -1288,7 +1292,7 @@ export interface EmbedConfig {
1288
1292
  * terminated.
1289
1293
  *
1290
1294
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1291
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
1295
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1292
1296
  */
1293
1297
  redirectPath?: string;
1294
1298
  /** @internal */
@@ -1361,7 +1365,7 @@ export interface EmbedConfig {
1361
1365
  detectCookieAccessSlow?: boolean;
1362
1366
  /**
1363
1367
  * Hide the `beta` alert warning message for SearchEmbed.
1364
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1368
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1365
1369
  */
1366
1370
  suppressSearchEmbedBetaWarning?: boolean;
1367
1371
  /**
@@ -1378,6 +1382,7 @@ export interface EmbedConfig {
1378
1382
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
1379
1383
  * button that the user can click to trigger the flow.
1380
1384
  * This attribute sets a containing element for that button.
1385
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1381
1386
  * @example
1382
1387
  * ```js
1383
1388
  * init({
@@ -1386,7 +1391,6 @@ export interface EmbedConfig {
1386
1391
  * authTriggerContainer: '#auth-trigger-container'
1387
1392
  * })
1388
1393
  * ```
1389
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1390
1394
  */
1391
1395
  authTriggerContainer?: string | HTMLElement;
1392
1396
  /**
@@ -1403,11 +1407,10 @@ export interface EmbedConfig {
1403
1407
  */
1404
1408
  authTriggerText?: string;
1405
1409
  /**
1406
- * Prevent users from accessing the full application or ThoughtSpot application pages
1407
- * access to the embedded application users
1408
- * outside of the iframe.
1409
- * @default true
1410
+ * Prevent embedded application users from accessing ThoughtSpot
1411
+ * application pages outside of the iframe.
1410
1412
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1413
+ * @default true
1411
1414
  */
1412
1415
  blockNonEmbedFullAppAccess?: boolean;
1413
1416
  /**
@@ -1437,6 +1440,7 @@ export interface EmbedConfig {
1437
1440
  * other logs such as warnings, information alerts,
1438
1441
  * and debug messages in the console output.
1439
1442
  *
1443
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1440
1444
  * @default LogLevel.ERROR
1441
1445
  * @example
1442
1446
  * ```js
@@ -1445,7 +1449,6 @@ export interface EmbedConfig {
1445
1449
  * logLevel: LogLevel.SILENT
1446
1450
  * })
1447
1451
  * ```
1448
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1449
1452
  */
1450
1453
  logLevel?: LogLevel;
1451
1454
  /**
@@ -1472,6 +1475,7 @@ export interface EmbedConfig {
1472
1475
  * This flag is used to disable the token verification in the SDK.
1473
1476
  * Enabling this flag will also disable the caching of the token.
1474
1477
  * @hidden
1478
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
1475
1479
  * @example
1476
1480
  * ```js
1477
1481
  * init({
@@ -1479,12 +1483,11 @@ export interface EmbedConfig {
1479
1483
  * disableTokenVerification : true
1480
1484
  * })
1481
1485
  * ```
1482
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
1483
1486
  */
1484
1487
  disableTokenVerification?: boolean;
1485
1488
  /**
1486
1489
  * This flag is used to disable showing the login failure page in the embedded app.
1487
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
1490
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
1488
1491
  */
1489
1492
  disableLoginFailurePage?: boolean;
1490
1493
  /**
@@ -1494,6 +1497,7 @@ export interface EmbedConfig {
1494
1497
  * Warning: This option is for advanced use only and is used internally
1495
1498
  * to control embed behavior in non-regular ways. We do not publish the
1496
1499
  * list of supported keys and values associated with each.
1500
+ * @version SDK: 1.33.5 | ThoughtSpot: *
1497
1501
  * @example
1498
1502
  * ```js
1499
1503
  * const embed = new LiveboardEmbed('#embed', {
@@ -1504,7 +1508,6 @@ export interface EmbedConfig {
1504
1508
  * }
1505
1509
  * });
1506
1510
  * ```
1507
- * @version SDK: 1.33.5 | ThoughtSpot: *
1508
1511
  */
1509
1512
  additionalFlags?: {
1510
1513
  [key: string]: string | number | boolean;
@@ -1512,6 +1515,7 @@ export interface EmbedConfig {
1512
1515
  /**
1513
1516
  * This is an object (key/val) for customVariables being
1514
1517
  * used by the third party tool's script.
1518
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1515
1519
  * @example
1516
1520
  * ```js
1517
1521
  * const embed = new LiveboardEmbed('#embed', {
@@ -1522,15 +1526,14 @@ export interface EmbedConfig {
1522
1526
  * }
1523
1527
  * });
1524
1528
  * ```
1525
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
1526
1529
  */
1527
1530
  customVariablesForThirdPartyTools?: Record<string, any>;
1528
1531
  disablePreauthCache?: boolean;
1529
1532
  /**
1530
1533
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
1531
1534
  * and exiting fullscreen mode for embedded visualizations during presentations.
1532
- * @default true (feature is disabled by default)
1533
1535
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1536
+ * @default true (feature is disabled by default)
1534
1537
  * @example
1535
1538
  * ```js
1536
1539
  * init({
@@ -1736,7 +1739,7 @@ export interface FrameParams {
1736
1739
  */
1737
1740
  loading?: "lazy" | "eager" | "auto";
1738
1741
  /**
1739
- * This parameters will be passed on the iframe
1742
+ * These parameters will be passed to the iframe
1740
1743
  * as is.
1741
1744
  */
1742
1745
  [key: string]: string | number | boolean | undefined;
@@ -1811,8 +1814,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1811
1814
  */
1812
1815
  disabledActionReason?: string;
1813
1816
  /**
1814
- * The list of actions to hide from the embedded.
1815
- * This actions will be hidden from the user.
1817
+ * The list of actions to hide from the embedded view.
1818
+ * These actions will be hidden from the user.
1816
1819
  * Use this to hide an action.
1817
1820
  *
1818
1821
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -1853,7 +1856,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1853
1856
  * The locale settings to apply to the embedded view.
1854
1857
  *
1855
1858
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1856
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1859
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1857
1860
  * @example
1858
1861
  * ```js
1859
1862
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1868,12 +1871,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1868
1871
  * This is an object (key/val) of override flags which will be applied
1869
1872
  * to the internal embedded object. This can be used to add any
1870
1873
  * URL flag.
1871
- * If the same flags are passed in init, they will be overriden by the values here.
1874
+ * If the same flags are passed in init, they will be overridden by the values here.
1872
1875
  * Warning: This option is for advanced use only and is used internally
1873
1876
  * to control embed behavior in non-regular ways. We do not publish the
1874
1877
  * list of supported keys and values associated with each.
1875
1878
  *
1876
1879
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1880
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1877
1881
  * @example
1878
1882
  * ```js
1879
1883
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1885,7 +1889,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1885
1889
  * },
1886
1890
  * });
1887
1891
  * ```
1888
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1889
1892
  */
1890
1893
  additionalFlags?: {
1891
1894
  [key: string]: string | number | boolean;
@@ -1928,6 +1931,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1928
1931
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
1929
1932
  *
1930
1933
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1934
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1931
1935
  * @example
1932
1936
  * ```js
1933
1937
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1937,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1937
1941
  * });
1938
1942
  * embed.showPreRender();
1939
1943
  * ```
1940
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1941
1944
  */
1942
1945
  preRenderId?: string;
1943
1946
  /**
@@ -1947,7 +1950,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1947
1950
  * its dimensions based on changes to the size of the embedding element.
1948
1951
  * @type {boolean}
1949
1952
  * @default false
1950
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1953
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1951
1954
  * @example
1952
1955
  * ```js
1953
1956
  * // Disable tracking PreRender size in the configuration
@@ -1962,9 +1965,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1962
1965
  doNotTrackPreRenderSize?: boolean;
1963
1966
  /**
1964
1967
  * Enable the V2 shell. This can provide performance benefits
1965
- * due to a lighterweight shell.
1968
+ * due to a lighter-weight shell.
1966
1969
  *
1967
1970
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1971
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1968
1972
  * @example
1969
1973
  * ```js
1970
1974
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1973,7 +1977,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1973
1977
  * enableV2Shell_experimental: true,
1974
1978
  * });
1975
1979
  * ```
1976
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1977
1980
  */
1978
1981
  enableV2Shell_experimental?: boolean;
1979
1982
  /**
@@ -1992,6 +1995,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1992
1995
  * and disable redirection of links in a new tab.
1993
1996
  *
1994
1997
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1998
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1995
1999
  * @example
1996
2000
  * ```js
1997
2001
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2000,7 +2004,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2000
2004
  * disableRedirectionLinksInNewTab: true,
2001
2005
  * });
2002
2006
  * ```
2003
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2004
2007
  */
2005
2008
  disableRedirectionLinksInNewTab?: boolean;
2006
2009
  /**
@@ -2011,6 +2014,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2011
2014
  * Per Org URL feature is enabled on your ThoughtSpot instance.
2012
2015
  *
2013
2016
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2017
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2014
2018
  * @example
2015
2019
  * ```js
2016
2020
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2019,24 +2023,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2019
2023
  * overrideOrgId: 142536,
2020
2024
  * });
2021
2025
  * ```
2022
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2023
2026
  */
2024
2027
  overrideOrgId?: number;
2025
2028
  /**
2026
- * Flag to override the *Open Link in New Tab* context menu option.
2029
+ * Flag to override the *Open Link in New Tab* context
2030
+ * menu option.
2027
2031
  *
2028
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2032
+ * For improved link override handling, use
2033
+ * {@link enableLinkOverridesV2} instead.
2034
+ *
2035
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2036
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2037
+ * `SpotterEmbed`, `SearchBarEmbed`
2029
2038
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2030
2039
  * @example
2031
2040
  * ```js
2032
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2033
- * const embed = new <EmbedComponent>('#tsEmbed', {
2041
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2034
2042
  * ... // other embed view config
2035
- * linkOverride:false,
2043
+ * linkOverride: true,
2036
2044
  * })
2037
2045
  * ```
2038
2046
  */
2039
2047
  linkOverride?: boolean;
2048
+ /**
2049
+ * Enables the V2 link override mechanism with improved
2050
+ * handling. When enabled, navigation links within the
2051
+ * embedded ThoughtSpot app are intercepted and routed
2052
+ * through the SDK via the `EmbedEvent.DialogOpen`
2053
+ * event.
2054
+ *
2055
+ * The SDK automatically sends {@link linkOverride}
2056
+ * alongside this flag for backward compatibility with
2057
+ * older ThoughtSpot versions.
2058
+ *
2059
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2060
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2061
+ * `SpotterEmbed`, `SearchBarEmbed`
2062
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
2063
+ * @example
2064
+ * ```js
2065
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2066
+ * ... // other embed view config
2067
+ * enableLinkOverridesV2: true,
2068
+ * });
2069
+ *
2070
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
2071
+ * console.log('Link clicked:', payload);
2072
+ * });
2073
+ * ```
2074
+ */
2075
+ enableLinkOverridesV2?: boolean;
2040
2076
  /**
2041
2077
  * The primary action to display on top of the viz for Liveboard and App Embed.
2042
2078
  * Use this to set the primary action.
@@ -2061,7 +2097,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2061
2097
  insertInToSlide?: boolean;
2062
2098
  /**
2063
2099
  * Show alert messages and toast messages in the embed.
2064
- * Supported embed in all embed types.
2100
+ * Supported in all embed types.
2065
2101
  *
2066
2102
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2067
2103
  * @example
@@ -2300,8 +2336,9 @@ export interface HomePageConfig {
2300
2336
  * *Liveboards* and *Answers*.
2301
2337
  * For example: `hiddenListColumns = [ListPageColumns.Author]`
2302
2338
  *
2303
- * **Note**: This option is available only in full app embedding and requires importing the `ListPageColumns` enum.
2304
- * Starting with version 10.14.0.cl, you can use this attribute to
2339
+ * **Note**: This option is available only in full app embedding and requires
2340
+ * importing the `ListPageColumns` enum. Starting with version 10.14.0.cl, you can
2341
+ * use this attribute to
2305
2342
  * hide the columns on all list pages in the *Insights* section.
2306
2343
  *
2307
2344
  * Supported embed types: `AppEmbed`
@@ -2341,11 +2378,12 @@ export interface HomePageConfig {
2341
2378
  /**
2342
2379
  * Reorder home page modules.
2343
2380
  * To specify the modules, import the `HomepageModule` enum.
2344
- * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]`
2345
- * **Note**: This attribute is not supported in the classic (v1) homepage.
2381
+ * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
2382
+ * HomepageModule.Watchlist]` **Note**: This attribute is not supported in the
2383
+ * classic (v1) homepage.
2346
2384
  *
2347
2385
  * Supported embed types: `AppEmbed`
2348
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2386
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2349
2387
  * @example
2350
2388
  * ```js
2351
2389
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -2366,6 +2404,7 @@ export interface HomePageConfig {
2366
2404
  * **Note**: This attribute is not supported in the classic (v1) homepage.
2367
2405
  *
2368
2406
  * Supported embed types: `AppEmbed`
2407
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2369
2408
  * @example
2370
2409
  * ```js
2371
2410
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -2376,7 +2415,6 @@ export interface HomePageConfig {
2376
2415
  * ... //other embed view configuration attributes
2377
2416
  * })
2378
2417
  * ```
2379
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2380
2418
  */
2381
2419
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2382
2420
  }
@@ -2389,7 +2427,7 @@ export interface SearchLiveboardCommonViewConfig {
2389
2427
  * visualization, or Liveboard.
2390
2428
  *
2391
2429
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
2392
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2430
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2393
2431
  * @example
2394
2432
  * ```js
2395
2433
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2407,11 +2445,11 @@ export interface SearchLiveboardCommonViewConfig {
2407
2445
  */
2408
2446
  runtimeFilters?: RuntimeFilter[];
2409
2447
  /**
2410
- * The list of parameter override to apply to a search Answer,
2448
+ * The list of parameter overrides to apply to a search Answer,
2411
2449
  * visualization, or Liveboard.
2412
2450
  *
2413
2451
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
2414
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2452
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2415
2453
  * @example
2416
2454
  * ```js
2417
2455
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2431,6 +2469,7 @@ export interface SearchLiveboardCommonViewConfig {
2431
2469
  * flag to set ContextMenu Trigger to either left or right click.
2432
2470
  *
2433
2471
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
2472
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2434
2473
  * @example
2435
2474
  * ```js
2436
2475
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -2439,7 +2478,6 @@ export interface SearchLiveboardCommonViewConfig {
2439
2478
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
2440
2479
  * })
2441
2480
  * ```
2442
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2443
2481
  */
2444
2482
  contextMenuTrigger?: ContextMenuTriggerOptions;
2445
2483
  /**
@@ -2462,7 +2500,7 @@ export interface SearchLiveboardCommonViewConfig {
2462
2500
  * when set to false, runtime parameters will be included in the URL
2463
2501
  * (default behavior before SDK 1.45.0).
2464
2502
  *
2465
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
2503
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
2466
2504
  * embedded view.
2467
2505
  * @default true
2468
2506
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -2481,14 +2519,15 @@ export interface SearchLiveboardCommonViewConfig {
2481
2519
  * ... // other embed view config
2482
2520
  * collapseSearchBar: true,
2483
2521
  * });
2522
+ * ```
2484
2523
  */
2485
2524
  collapseSearchBar?: boolean;
2486
2525
  /**
2487
2526
  * Flag to control Data panel experience
2488
2527
  *
2489
2528
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2529
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2490
2530
  * @default true
2491
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2492
2531
  * @example
2493
2532
  * ```js
2494
2533
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -2521,6 +2560,7 @@ export interface SearchLiveboardCommonViewConfig {
2521
2560
  * the current time period in filter results.
2522
2561
  *
2523
2562
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2563
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
2524
2564
  * @example
2525
2565
  * ```js
2526
2566
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -2528,7 +2568,6 @@ export interface SearchLiveboardCommonViewConfig {
2528
2568
  * isThisPeriodInDateFiltersEnabled: true,
2529
2569
  * })
2530
2570
  * ```
2531
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
2532
2571
  */
2533
2572
  isThisPeriodInDateFiltersEnabled?: boolean;
2534
2573
  }
@@ -2588,6 +2627,7 @@ export interface LiveboardAppEmbedViewConfig {
2588
2627
  * Boolean to control if Liveboard header is sticky or not.
2589
2628
  *
2590
2629
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2630
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2591
2631
  * @example
2592
2632
  * ```js
2593
2633
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2596,7 +2636,6 @@ export interface LiveboardAppEmbedViewConfig {
2596
2636
  * isLiveboardHeaderSticky: true,
2597
2637
  * });
2598
2638
  * ```
2599
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2600
2639
  */
2601
2640
  isLiveboardHeaderSticky?: boolean;
2602
2641
  /**
@@ -2604,8 +2643,8 @@ export interface LiveboardAppEmbedViewConfig {
2604
2643
  *
2605
2644
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2606
2645
  * @type {boolean}
2646
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
2607
2647
  * @default false
2608
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
2609
2648
  * @example
2610
2649
  * ```js
2611
2650
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2621,8 +2660,8 @@ export interface LiveboardAppEmbedViewConfig {
2621
2660
  *
2622
2661
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2623
2662
  * @type {boolean}
2663
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
2624
2664
  * @default false
2625
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
2626
2665
  * @example
2627
2666
  * ```js
2628
2667
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2638,7 +2677,7 @@ export interface LiveboardAppEmbedViewConfig {
2638
2677
  * header.
2639
2678
  *
2640
2679
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2641
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
2680
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2642
2681
  * @default true
2643
2682
  * @example
2644
2683
  * ```js
@@ -2653,10 +2692,12 @@ export interface LiveboardAppEmbedViewConfig {
2653
2692
  /**
2654
2693
  * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
2655
2694
  *
2656
- * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
2695
+ * **Note**: This feature is supported only if compact header is enabled on your
2696
+ * Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled`
2697
+ * attribute.
2657
2698
  *
2658
2699
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2659
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
2700
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2660
2701
  * @default false
2661
2702
  * @example
2662
2703
  * ```js
@@ -2674,7 +2715,7 @@ export interface LiveboardAppEmbedViewConfig {
2674
2715
  * compact header
2675
2716
  *
2676
2717
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2677
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
2718
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2678
2719
  * @default true
2679
2720
  * @example
2680
2721
  * ```js
@@ -2707,7 +2748,7 @@ export interface LiveboardAppEmbedViewConfig {
2707
2748
  * the cover and filters pages in the Liveboard PDF.
2708
2749
  *
2709
2750
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2710
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
2751
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
2711
2752
  * @example
2712
2753
  * ```js
2713
2754
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2719,9 +2760,9 @@ export interface LiveboardAppEmbedViewConfig {
2719
2760
  */
2720
2761
  coverAndFilterOptionInPDF?: boolean;
2721
2762
  /**
2722
- * This flag is used to enable or disable the new centralized Liveboard filter UX (v2).
2723
- * When enabled, a unified modal is used to manage and update multiple filters at once,
2724
- * replacing the older individual filter interactions.
2763
+ * This flag is used to enable or disable the new centralized Liveboard filter UX
2764
+ * (v2). When enabled, a unified modal is used to manage and update multiple filters
2765
+ * at once, replacing the older individual filter interactions.
2725
2766
  * To enable this feature on your instance, contact ThoughtSpot Support.
2726
2767
  *
2727
2768
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
@@ -2752,7 +2793,8 @@ export interface LiveboardAppEmbedViewConfig {
2752
2793
  */
2753
2794
  isLinkParametersEnabled?: boolean;
2754
2795
  /**
2755
- * This flag is used to enable or disable the enhanced filter interactivity in liveboard.
2796
+ * This flag is used to enable or disable the enhanced filter interactivity in
2797
+ * liveboard.
2756
2798
  *
2757
2799
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2758
2800
  * @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
@@ -2903,7 +2945,7 @@ declare enum HomepageModule {
2903
2945
  */
2904
2946
  Search = "SEARCH",
2905
2947
  /**
2906
- * kPI watchlist module
2948
+ * KPI watchlist module
2907
2949
  */
2908
2950
  Watchlist = "WATCHLIST",
2909
2951
  /**
@@ -2929,7 +2971,8 @@ declare enum ListPageColumns {
2929
2971
  */
2930
2972
  Favorites = "FAVOURITE",
2931
2973
  /**
2932
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2974
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2975
+ * @deprecated This option is deprecated.
2933
2976
  */
2934
2977
  Favourite = "FAVOURITE",
2935
2978
  /**
@@ -3030,13 +3073,13 @@ export declare enum EmbedEvent {
3030
3073
  /**
3031
3074
  * Rendering has initialized.
3032
3075
  * @example
3033
- *```js
3076
+ * ```js
3034
3077
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
3035
3078
  * //show a loader
3036
3079
  * function showLoader() {
3037
3080
  * document.getElementById("loader");
3038
3081
  * }
3039
- *```
3082
+ * ```
3040
3083
  * @returns timestamp - The timestamp when the event was generated.
3041
3084
  */
3042
3085
  Init = "init",
@@ -3044,11 +3087,11 @@ export declare enum EmbedEvent {
3044
3087
  * Authentication has either succeeded or failed.
3045
3088
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3046
3089
  * @example
3047
- *```js
3090
+ * ```js
3048
3091
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
3049
3092
  * console.log('AuthInit', payload);
3050
3093
  * })
3051
- *```
3094
+ * ```
3052
3095
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
3053
3096
  */
3054
3097
  AuthInit = "authInit",
@@ -3057,13 +3100,13 @@ export declare enum EmbedEvent {
3057
3100
  * @returns timestamp - The timestamp when the event was generated.
3058
3101
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3059
3102
  * @example
3060
- *```js
3103
+ * ```js
3061
3104
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
3062
3105
  * //hide loader
3063
3106
  * function hideLoader() {
3064
3107
  * document.getElementById("loader");
3065
3108
  * }
3066
- *```
3109
+ * ```
3067
3110
  */
3068
3111
  Load = "load",
3069
3112
  /**
@@ -3072,11 +3115,11 @@ export declare enum EmbedEvent {
3072
3115
  * @return data - Answer of Liveboard data
3073
3116
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3074
3117
  * @example
3075
- *```js
3118
+ * ```js
3076
3119
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
3077
3120
  * console.log('data', payload);
3078
3121
  * })
3079
- *```
3122
+ * ```
3080
3123
  * @important
3081
3124
  */
3082
3125
  Data = "data",
@@ -3084,9 +3127,9 @@ export declare enum EmbedEvent {
3084
3127
  * Search query has been updated by the user.
3085
3128
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
3086
3129
  * @example
3087
- *```js
3130
+ * ```js
3088
3131
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
3089
- *```
3132
+ * ```
3090
3133
  */
3091
3134
  QueryChanged = "queryChanged",
3092
3135
  /**
@@ -3096,7 +3139,7 @@ export declare enum EmbedEvent {
3096
3139
  * @returns drillDownColumns - The columns on which drill down was performed
3097
3140
  * @returns nonFilteredColumns - The columns that were not filtered
3098
3141
  * @example
3099
- *```js
3142
+ * ```js
3100
3143
  * searchEmbed.on(EmbedEvent.DrillDown, {
3101
3144
  * points: {
3102
3145
  * clickedPoint,
@@ -3104,12 +3147,12 @@ export declare enum EmbedEvent {
3104
3147
  * },
3105
3148
  * autoDrillDown: true,
3106
3149
  * })
3107
- *```
3150
+ * ```
3108
3151
  * In this example, `VizPointDoubleClick` event is used for
3109
3152
  * triggering the `DrillDown` event when an area or specific
3110
3153
  * data point on a table or chart is double-clicked.
3111
3154
  * @example
3112
- *```js
3155
+ * ```js
3113
3156
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
3114
3157
  * console.log(payload);
3115
3158
  * const clickedPoint = payload.data.clickedPoint;
@@ -3123,7 +3166,7 @@ export declare enum EmbedEvent {
3123
3166
  * autoDrillDown: true,
3124
3167
  * })
3125
3168
  * })
3126
- *```
3169
+ * ```
3127
3170
  */
3128
3171
  Drilldown = "drillDown",
3129
3172
  /**
@@ -3248,13 +3291,13 @@ export declare enum EmbedEvent {
3248
3291
  * The ThoughtSpot authentication session has expired.
3249
3292
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
3250
3293
  * @example
3251
- *```js
3294
+ * ```js
3252
3295
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
3253
3296
  * //show auth expired banner
3254
3297
  * function showAuthExpired() {
3255
3298
  * document.getElementById("authExpiredBanner");
3256
3299
  * }
3257
- *```
3300
+ * ```
3258
3301
  */
3259
3302
  AuthExpire = "ThoughtspotAuthExpired",
3260
3303
  /**
@@ -3289,22 +3332,22 @@ export declare enum EmbedEvent {
3289
3332
  * Applicable to `SearchBarEmbed` only.
3290
3333
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
3291
3334
  * @example
3292
- *```js
3335
+ * ```js
3293
3336
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
3294
3337
  * .then(data => {
3295
3338
  * console.log('Answer Data:', data);
3296
3339
  * })
3297
- *```
3340
+ * ```
3298
3341
  */
3299
3342
  GetDataClick = "getDataClick",
3300
3343
  /**
3301
3344
  * Detects the route change.
3302
3345
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
3303
3346
  * @example
3304
- *```js
3347
+ * ```js
3305
3348
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
3306
3349
  * console.log('data', payload))
3307
- *```
3350
+ * ```
3308
3351
  */
3309
3352
  RouteChange = "ROUTE_CHANGE",
3310
3353
  /**
@@ -3314,12 +3357,12 @@ export declare enum EmbedEvent {
3314
3357
  V1Data = "exportVizDataToParent",
3315
3358
  /**
3316
3359
  * Emitted when the embed does not have cookie access. This happens
3317
- * when Safari and other Web browsers block third-party cookies
3318
- * are blocked by default. `NoCookieAccess` can trigger.
3360
+ * when third-party cookies are blocked by Safari or other
3361
+ * web browsers. `NoCookieAccess` can trigger.
3319
3362
  * @example
3320
- *```js
3363
+ * ```js
3321
3364
  * appEmbed.on(EmbedEvent.NoCookieAccess)
3322
- *```
3365
+ * ```
3323
3366
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
3324
3367
  */
3325
3368
  NoCookieAccess = "noCookieAccess",
@@ -3333,22 +3376,22 @@ export declare enum EmbedEvent {
3333
3376
  * Emitted when any modal is opened in the app
3334
3377
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3335
3378
  * @example
3336
- *```js
3379
+ * ```js
3337
3380
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
3338
3381
  * console.log('dialog open', payload);
3339
3382
  * })
3340
- *```
3383
+ * ```
3341
3384
  */
3342
3385
  DialogOpen = "dialog-open",
3343
3386
  /**
3344
3387
  * Emitted when any modal is closed in the app
3345
3388
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3346
3389
  * @example
3347
- *```js
3390
+ * ```js
3348
3391
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
3349
3392
  * console.log('dialog close', payload);
3350
3393
  * })
3351
- *```
3394
+ * ```
3352
3395
  */
3353
3396
  DialogClose = "dialog-close",
3354
3397
  /**
@@ -3357,39 +3400,39 @@ export declare enum EmbedEvent {
3357
3400
  * other events on the rendered Liveboard.
3358
3401
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3359
3402
  * @example
3360
- *```js
3403
+ * ```js
3361
3404
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
3362
3405
  console.log('Liveboard is rendered', payload);
3363
3406
  })
3364
- *```
3407
+ * ```
3365
3408
  * The following example shows how to trigger
3366
3409
  * `SetVisibleVizs` event using LiveboardRendered embed event:
3367
3410
  * @example
3368
- *```js
3411
+ * ```js
3369
3412
  * const embedRef = useEmbedRef();
3370
3413
  * const onLiveboardRendered = () => {
3371
3414
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
3372
3415
  * };
3373
- *```
3416
+ * ```
3374
3417
  */
3375
3418
  LiveboardRendered = "PinboardRendered",
3376
3419
  /**
3377
3420
  * Emits all events.
3378
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
3421
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
3379
3422
  * @example
3380
- *```js
3423
+ * ```js
3381
3424
  * appEmbed.on(EmbedEvent.ALL, payload => {
3382
3425
  * console.log('Embed Events', payload)
3383
3426
  * })
3384
- *```
3427
+ * ```
3385
3428
  */
3386
3429
  ALL = "*",
3387
3430
  /**
3388
3431
  * Emitted when an Answer is saved in the app.
3389
3432
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
3390
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3433
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3391
3434
  * @example
3392
- *```js
3435
+ * ```js
3393
3436
  * //Emit when action starts
3394
3437
  * searchEmbed.on(EmbedEvent.Save, payload => {
3395
3438
  * console.log('Save', payload)
@@ -3400,7 +3443,7 @@ export declare enum EmbedEvent {
3400
3443
  * searchEmbed.on(EmbedEvent.Save, payload => {
3401
3444
  * console.log('Save', payload)
3402
3445
  * })
3403
- *```
3446
+ * ```
3404
3447
  */
3405
3448
  Save = "save",
3406
3449
  /**
@@ -3412,106 +3455,112 @@ export declare enum EmbedEvent {
3412
3455
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
3413
3456
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3414
3457
  * @example
3415
- *```js
3458
+ * ```js
3416
3459
  * liveboardEmbed.on(EmbedEvent.Download, {
3417
3460
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3418
3461
  * })
3419
- *```
3462
+ * ```
3420
3463
  */
3421
3464
  Download = "download",
3422
3465
  /**
3423
3466
  * Emitted when the download action is triggered on an Answer.
3424
- * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
3467
+ * Use start:true to subscribe to when download is initiated, or end:true to
3468
+ * subscribe to when download is completed. Default is end:true.
3425
3469
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
3426
3470
  * @example
3427
- *```js
3471
+ * ```js
3428
3472
  * //emit when action starts
3429
3473
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3430
3474
  * console.log('download PNG', payload)}, {start: true })
3431
3475
  * //emit when action ends
3432
3476
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3433
3477
  * console.log('download PNG', payload)})
3434
- *```
3478
+ * ```
3435
3479
  */
3436
3480
  DownloadAsPng = "downloadAsPng",
3437
3481
  /**
3438
3482
  * Emitted when the Download as PDF action is triggered on an Answer
3439
- * Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
3483
+ * Use start:true to subscribe to when download as PDF is initiated, or end:true to
3484
+ * subscribe to when download as PDF is completed. Default is end:true.
3440
3485
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3441
3486
  * @example
3442
- *```js
3487
+ * ```js
3443
3488
  * //emit when action starts
3444
3489
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3445
3490
  * console.log('download PDF', payload)}, {start: true })
3446
3491
  * //emit when action ends
3447
3492
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3448
3493
  * console.log('download PDF', payload)})
3449
- *```
3494
+ * ```
3450
3495
  */
3451
3496
  DownloadAsPdf = "downloadAsPdf",
3452
3497
  /**
3453
3498
  * Emitted when the Download as CSV action is triggered on an Answer.
3454
- * Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
3499
+ * Use start:true to subscribe to when download as CSV is initiated, or end:true to
3500
+ * subscribe to when download as CSV is completed. Default is end:true.
3455
3501
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3456
3502
  * @example
3457
- *```js
3503
+ * ```js
3458
3504
  * //emit when action starts
3459
3505
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
3460
3506
  * console.log('download CSV', payload)}, {start: true })
3461
3507
  * //emit when action ends
3462
3508
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
3463
3509
  * console.log('download CSV', payload)})
3464
- *```
3510
+ * ```
3465
3511
  */
3466
3512
  DownloadAsCsv = "downloadAsCsv",
3467
3513
  /**
3468
3514
  * Emitted when the Download as XLSX action is triggered on an Answer.
3469
- * Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
3515
+ * Use start:true to subscribe to when download as XLSX is initiated, or end:true to
3516
+ * subscribe to when download as XLSX is completed. Default is end:true.
3470
3517
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3471
3518
  * @example
3472
- *```js
3519
+ * ```js
3473
3520
  * //emit when action starts
3474
3521
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3475
3522
  * console.log('download Xlsx', payload)}, { start: true })
3476
3523
  * //emit when action ends
3477
3524
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3478
3525
  * console.log('download Xlsx', payload)})
3479
- *```
3526
+ * ```
3480
3527
  */
3481
3528
  DownloadAsXlsx = "downloadAsXlsx",
3482
3529
  /**
3483
3530
  * Emitted when an Answer is deleted in the app
3484
- * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
3531
+ * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
3532
+ * to when delete is completed. Default is end:true.
3485
3533
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3486
3534
  * @example
3487
- *```js
3535
+ * ```js
3488
3536
  * //emit when action starts
3489
3537
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3490
3538
  * console.log('delete answer', payload)}, {start: true })
3491
3539
  * //trigger when action is completed
3492
3540
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3493
3541
  * console.log('delete answer', payload)})
3494
- *```
3542
+ * ```
3495
3543
  */
3496
3544
  AnswerDelete = "answerDelete",
3497
3545
  /**
3498
3546
  * Emitted when the AI Highlights action is triggered on a Liveboard
3499
3547
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
3500
3548
  * @example
3501
- *```js
3549
+ * ```js
3502
3550
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
3503
3551
  * console.log('AI Highlights', payload);
3504
3552
  * })
3505
- *```
3553
+ * ```
3506
3554
  */
3507
3555
  AIHighlights = "AIHighlights",
3508
3556
  /**
3509
3557
  * Emitted when a user initiates the Pin action to
3510
3558
  * add an Answer to a Liveboard.
3511
- * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
3559
+ * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to
3560
+ * when pin is completed. Default is end:true.
3512
3561
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3513
3562
  * @example
3514
- *```js
3563
+ * ```js
3515
3564
  * //emit when action starts
3516
3565
  * searchEmbed.on(EmbedEvent.Pin, payload => {
3517
3566
  * console.log('pin', payload)
@@ -3522,14 +3571,14 @@ export declare enum EmbedEvent {
3522
3571
  * searchEmbed.on(EmbedEvent.Pin, payload => {
3523
3572
  * console.log('pin', payload)
3524
3573
  * })
3525
- *```
3574
+ * ```
3526
3575
  */
3527
3576
  Pin = "pin",
3528
3577
  /**
3529
3578
  * Emitted when SpotIQ analysis is triggered
3530
3579
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3531
3580
  * @example
3532
- *```js
3581
+ * ```js
3533
3582
  * //emit when action starts
3534
3583
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
3535
3584
  * console.log('SpotIQAnalyze', payload)
@@ -3540,14 +3589,14 @@ export declare enum EmbedEvent {
3540
3589
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
3541
3590
  * console.log('SpotIQ analyze', payload)
3542
3591
  * })
3543
- *```
3592
+ * ```
3544
3593
  */
3545
3594
  SpotIQAnalyze = "spotIQAnalyze",
3546
3595
  /**
3547
3596
  * Emitted when a user shares an object with another user or group
3548
3597
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3549
3598
  * @example
3550
- *```js
3599
+ * ```js
3551
3600
  * //emit when action starts
3552
3601
  * searchEmbed.on(EmbedEvent.Share, payload => {
3553
3602
  * console.log('Share', payload)
@@ -3558,7 +3607,7 @@ export declare enum EmbedEvent {
3558
3607
  * searchEmbed.on(EmbedEvent.Share, payload => {
3559
3608
  * console.log('Share', payload)
3560
3609
  * })
3561
- *```
3610
+ * ```
3562
3611
  */
3563
3612
  Share = "share",
3564
3613
  /**
@@ -3566,11 +3615,11 @@ export declare enum EmbedEvent {
3566
3615
  * data on a chart or table.
3567
3616
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3568
3617
  * @example
3569
- *```js
3618
+ * ```js
3570
3619
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
3571
3620
  * console.log('Drill include', payload);
3572
3621
  * })
3573
- *```
3622
+ * ```
3574
3623
  */
3575
3624
  DrillInclude = "context-menu-item-include",
3576
3625
  /**
@@ -3578,22 +3627,22 @@ export declare enum EmbedEvent {
3578
3627
  * data on a chart or table
3579
3628
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3580
3629
  * @example
3581
- *```js
3630
+ * ```js
3582
3631
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
3583
3632
  * console.log('Drill exclude', payload);
3584
3633
  * })
3585
- *```
3634
+ * ```
3586
3635
  */
3587
3636
  DrillExclude = "context-menu-item-exclude",
3588
3637
  /**
3589
3638
  * Emitted when a column value is copied in the embedded app.
3590
3639
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3591
3640
  * @example
3592
- *```js
3593
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
3641
+ * ```js
3642
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
3594
3643
  * console.log('copy to clipboard', payload);
3595
3644
  * })
3596
- *```
3645
+ * ```
3597
3646
  */
3598
3647
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
3599
3648
  /**
@@ -3601,10 +3650,10 @@ export declare enum EmbedEvent {
3601
3650
  * embedded Liveboard.
3602
3651
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3603
3652
  * @example
3604
- *```js
3653
+ * ```js
3605
3654
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
3606
3655
  * })
3607
- *```
3656
+ * ```
3608
3657
  */
3609
3658
  UpdateTML = "updateTSL",
3610
3659
  /**
@@ -3612,75 +3661,77 @@ export declare enum EmbedEvent {
3612
3661
  * on an embedded Liveboard.
3613
3662
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3614
3663
  * @example
3615
- *```js
3664
+ * ```js
3616
3665
  * appEmbed.on(EmbedEvent.EditTML, payload => {
3617
3666
  * console.log('Edit TML', payload);
3618
3667
  * })
3619
- *```
3668
+ * ```
3620
3669
  */
3621
3670
  EditTML = "editTSL",
3622
3671
  /**
3623
3672
  * Emitted when the **Export TML** action is triggered on an
3624
3673
  * an embedded object in the app
3625
- * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
3674
+ * Use start:true to subscribe to when export is initiated, or end:true to subscribe
3675
+ * to when export is completed. Default is end:true.
3626
3676
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3627
3677
  * @example
3628
- *```js
3678
+ * ```js
3629
3679
  * //emit when action starts
3630
3680
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3631
3681
  * console.log('Export TML', payload)}, { start: true })
3632
3682
  * //emit when action ends
3633
3683
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3634
3684
  * console.log('Export TML', payload)})
3635
- *```
3685
+ * ```
3636
3686
  */
3637
3687
  ExportTML = "exportTSL",
3638
3688
  /**
3639
3689
  * Emitted when an Answer is saved as a View.
3640
3690
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3641
3691
  * @example
3642
- *```js
3692
+ * ```js
3643
3693
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
3644
3694
  * console.log('View', payload);
3645
3695
  * })
3646
- *```
3696
+ * ```
3647
3697
  */
3648
3698
  SaveAsView = "saveAsView",
3649
3699
  /**
3650
3700
  * Emitted when the user creates a copy of an Answer.
3651
- * Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
3701
+ * Use start:true to subscribe to when copy and edit is initiated, or end:true to
3702
+ * subscribe to when copy and edit is completed. Default is end:true.
3652
3703
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3653
3704
  * @example
3654
- *```js
3705
+ * ```js
3655
3706
  * //emit when action starts
3656
3707
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
3657
3708
  * console.log('Copy and edit', payload)}, {start: true })
3658
3709
  * //emit when action ends
3659
3710
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
3660
3711
  * console.log('Copy and edit', payload)})
3661
- *```
3712
+ * ```
3662
3713
  */
3663
3714
  CopyAEdit = "copyAEdit",
3664
3715
  /**
3665
3716
  * Emitted when a user clicks *Show underlying data* on an Answer.
3666
3717
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3667
3718
  * @example
3668
- *```js
3719
+ * ```js
3669
3720
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
3670
3721
  * console.log('show data', payload);
3671
3722
  * })
3672
- *```
3723
+ * ```
3673
3724
  */
3674
3725
  ShowUnderlyingData = "showUnderlyingData",
3675
3726
  /**
3676
3727
  * Emitted when an Answer is switched to a chart or table view.
3677
3728
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3678
3729
  * @example
3679
- *```js
3730
+ * ```js
3680
3731
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
3681
3732
  * console.log('switch view', payload);
3682
3733
  * })
3683
- *```
3734
+ * ```
3684
3735
  */
3685
3736
  AnswerChartSwitcher = "answerChartSwitcher",
3686
3737
  /**
@@ -3697,118 +3748,118 @@ export declare enum EmbedEvent {
3697
3748
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
3698
3749
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3699
3750
  * @example
3700
- *```js
3751
+ * ```js
3701
3752
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
3702
3753
  * console.log('Liveboard details', payload);
3703
3754
  * })
3704
- *```
3755
+ * ```
3705
3756
  */
3706
3757
  LiveboardInfo = "pinboardInfo",
3707
3758
  /**
3708
3759
  * Emitted when a user clicks on the Favorite icon on a Liveboard
3709
3760
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3710
3761
  * @example
3711
- *```js
3762
+ * ```js
3712
3763
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
3713
3764
  * console.log('favorites', payload);
3714
3765
  * })
3715
- *```
3766
+ * ```
3716
3767
  */
3717
3768
  AddToFavorites = "addToFavorites",
3718
3769
  /**
3719
3770
  * Emitted when a user clicks **Schedule** on a Liveboard
3720
3771
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3721
3772
  * @example
3722
- *```js
3773
+ * ```js
3723
3774
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
3724
- * console.log(`Liveboard schedule', payload);
3775
+ * console.log('Liveboard schedule', payload);
3725
3776
  * })
3726
- *```
3777
+ * ```
3727
3778
  */
3728
3779
  Schedule = "subscription",
3729
3780
  /**
3730
3781
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
3731
3782
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3732
3783
  * @example
3733
- *```js
3784
+ * ```js
3734
3785
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
3735
- * console.log(`Liveboard edit', payload);
3786
+ * console.log('Liveboard edit', payload);
3736
3787
  * })
3737
- *```
3788
+ * ```
3738
3789
  */
3739
3790
  Edit = "edit",
3740
3791
  /**
3741
3792
  * Emitted when a user clicks *Make a copy* on a Liveboard
3742
3793
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3743
3794
  * @example
3744
- *```js
3795
+ * ```js
3745
3796
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
3746
- * console.log(`Copy', payload);
3797
+ * console.log('Copy', payload);
3747
3798
  * })
3748
- *```
3799
+ * ```
3749
3800
  */
3750
3801
  MakeACopy = "makeACopy",
3751
3802
  /**
3752
3803
  * Emitted when a user clicks **Present** on a Liveboard or visualization
3753
3804
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3754
3805
  * @example
3755
- *```js
3806
+ * ```js
3756
3807
  * liveboardEmbed.on(EmbedEvent.Present)
3757
- *```
3808
+ * ```
3758
3809
  * @example
3759
- *```js
3810
+ * ```js
3760
3811
  * liveboardEmbed.on(EmbedEvent.Present, {
3761
3812
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3762
3813
  * })
3763
- *```
3814
+ * ```
3764
3815
  */
3765
3816
  Present = "present",
3766
3817
  /**
3767
3818
  * Emitted when a user clicks **Delete** on a visualization
3768
3819
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3769
3820
  * @example
3770
- *```js
3821
+ * ```js
3771
3822
  * liveboardEmbed.on(EmbedEvent.Delete,
3772
3823
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3773
- *```
3824
+ * ```
3774
3825
  */
3775
3826
  Delete = "delete",
3776
3827
  /**
3777
3828
  * Emitted when a user clicks Manage schedules on a Liveboard
3778
3829
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3779
3830
  * @example
3780
- *```js
3831
+ * ```js
3781
3832
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
3782
- *```
3833
+ * ```
3783
3834
  */
3784
3835
  SchedulesList = "schedule-list",
3785
3836
  /**
3786
3837
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
3787
3838
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3788
3839
  * @example
3789
- *```js
3840
+ * ```js
3790
3841
  * liveboardEmbed.on(EmbedEvent.Cancel)
3791
- *```
3842
+ * ```
3792
3843
  */
3793
3844
  Cancel = "cancel",
3794
3845
  /**
3795
3846
  * Emitted when a user clicks **Explore** on a visualization
3796
3847
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3797
3848
  * @example
3798
- *```js
3849
+ * ```js
3799
3850
  * liveboardEmbed.on(EmbedEvent.Explore, {
3800
3851
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3801
- *```
3852
+ * ```
3802
3853
  */
3803
3854
  Explore = "explore",
3804
3855
  /**
3805
3856
  * Emitted when a user clicks **Copy link** action on a visualization.
3806
3857
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3807
3858
  * @example
3808
- *```js
3859
+ * ```js
3809
3860
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
3810
3861
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3811
- *```
3862
+ * ```
3812
3863
  */
3813
3864
  CopyLink = "embedDocument",
3814
3865
  /**
@@ -3816,21 +3867,21 @@ export declare enum EmbedEvent {
3816
3867
  * visualization or Liveboard.
3817
3868
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3818
3869
  * @example
3819
- *```js
3870
+ * ```js
3820
3871
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3821
3872
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3822
- *```
3873
+ * ```
3823
3874
  */
3824
3875
  CrossFilterChanged = "cross-filter-changed",
3825
3876
  /**
3826
3877
  * Emitted when a user right clicks on a visualization (chart or table)
3827
3878
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3828
3879
  * @example
3829
- *```js
3880
+ * ```js
3830
3881
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
3831
3882
  * console.log('VizPointClick', payload)
3832
3883
  * })
3833
- *```
3884
+ * ```
3834
3885
  */
3835
3886
  VizPointRightClick = "vizPointRightClick",
3836
3887
  /**
@@ -3844,35 +3895,35 @@ export declare enum EmbedEvent {
3844
3895
  * filter details.
3845
3896
  * @example
3846
3897
  *
3847
- *```js
3898
+ * ```js
3848
3899
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3849
3900
  * console.log('payload', payload);
3850
3901
  * })
3851
- *
3902
+ * ```
3852
3903
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3853
3904
  */
3854
3905
  FilterChanged = "filterChanged",
3855
3906
  /**
3856
3907
  * Emitted when a user clicks the **Go** button to initiate
3857
3908
  * a Natural Language Search query
3858
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3909
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3859
3910
  */
3860
3911
  SageEmbedQuery = "sageEmbedQuery",
3861
3912
  /**
3862
3913
  * Emitted when a user selects a data source on the embedded
3863
3914
  * Natural Language Search interface.
3864
3915
  *
3865
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3916
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3866
3917
  */
3867
3918
  SageWorksheetUpdated = "sageWorksheetUpdated",
3868
3919
  /**
3869
3920
  * Emitted when a user updates a connection on the **Data** page
3870
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3921
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3871
3922
  */
3872
3923
  UpdateConnection = "updateConnection",
3873
3924
  /**
3874
3925
  * Emitted when a user updates a connection on the **Data** page
3875
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3926
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3876
3927
  */
3877
3928
  CreateConnection = "createConnection",
3878
3929
  /**
@@ -3882,7 +3933,7 @@ export declare enum EmbedEvent {
3882
3933
  * @returns viewId: string
3883
3934
  * @returns liveboardId: string
3884
3935
  * @returns isPublic: boolean
3885
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3936
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3886
3937
  */
3887
3938
  UpdatePersonalisedView = "updatePersonalisedView",
3888
3939
  /**
@@ -3891,7 +3942,7 @@ export declare enum EmbedEvent {
3891
3942
  * @returns viewId: string
3892
3943
  * @returns liveboardId: string
3893
3944
  * @returns isPublic: boolean
3894
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3945
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3895
3946
  */
3896
3947
  SavePersonalisedView = "savePersonalisedView",
3897
3948
  /**
@@ -3900,19 +3951,19 @@ export declare enum EmbedEvent {
3900
3951
  * @returns viewId: string
3901
3952
  * @returns liveboardId: string
3902
3953
  * @returns isPublic: boolean
3903
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3954
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3904
3955
  */
3905
3956
  ResetLiveboard = "resetLiveboard",
3906
3957
  /**
3907
3958
  * Emitted when a PersonalisedView is deleted.
3908
3959
  * @returns views: string[]
3909
3960
  * @returns liveboardId: string
3910
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3961
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3911
3962
  */
3912
3963
  DeletePersonalisedView = "deletePersonalisedView",
3913
3964
  /**
3914
3965
  * Emitted when a user creates a Worksheet.
3915
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3966
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3916
3967
  */
3917
3968
  CreateWorksheet = "createWorksheet",
3918
3969
  /**
@@ -3921,12 +3972,12 @@ export declare enum EmbedEvent {
3921
3972
  * @returns viewId: string
3922
3973
  * @returns liveboardId: string
3923
3974
  * @returns isPublic: boolean
3924
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3975
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3925
3976
  */
3926
3977
  AskSageInit = "AskSageInit",
3927
3978
  /**
3928
3979
  * Emitted when a Liveboard or visualization is renamed.
3929
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3980
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3930
3981
  */
3931
3982
  Rename = "rename",
3932
3983
  /**
@@ -3949,7 +4000,7 @@ export declare enum EmbedEvent {
3949
4000
  * - `error` - Developers can customize the user-facing error message when `execute`
3950
4001
  * is `false` by using the `error` parameters in `responder`.
3951
4002
  * - `errorText` - The error message text shown to the user.
3952
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
4003
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3953
4004
  * @example
3954
4005
  *
3955
4006
  * This example blocks search operation and returns a custom error message:
@@ -4001,8 +4052,8 @@ export declare enum EmbedEvent {
4001
4052
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
4002
4053
  * console.log('payload', payload);
4003
4054
  * })
4004
- *```
4005
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
4055
+ * ```
4056
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
4006
4057
  */
4007
4058
  ParameterChanged = "parameterChanged",
4008
4059
  /**
@@ -4057,24 +4108,24 @@ export declare enum EmbedEvent {
4057
4108
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
4058
4109
  * console.log('payload', payload);
4059
4110
  * })
4060
- *```
4061
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
4111
+ * ```
4112
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
4062
4113
  */
4063
4114
  CreateLiveboard = "createLiveboard",
4064
4115
  /**
4065
4116
  * Emitted when a user creates a Model.
4066
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
4117
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
4067
4118
  */
4068
4119
  CreateModel = "createModel",
4069
4120
  /**
4070
4121
  * @hidden
4071
4122
  * Emitted when a user exits present mode.
4072
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
4123
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4073
4124
  */
4074
4125
  ExitPresentMode = "exitPresentMode",
4075
4126
  /**
4076
4127
  * Emitted when a user requests the full height lazy load data.
4077
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
4128
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4078
4129
  * @hidden
4079
4130
  */
4080
4131
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
@@ -4085,7 +4136,7 @@ export declare enum EmbedEvent {
4085
4136
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
4086
4137
  * console.log('payload', payload);
4087
4138
  * })
4088
- *```
4139
+ * ```
4089
4140
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4090
4141
  */
4091
4142
  SpotterData = "SpotterData",
@@ -4096,7 +4147,7 @@ export declare enum EmbedEvent {
4096
4147
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
4097
4148
  * console.log('payload', payload);
4098
4149
  * })
4099
- *```
4150
+ * ```
4100
4151
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4101
4152
  */
4102
4153
  PreviewSpotterData = "PreviewSpotterData",
@@ -4107,7 +4158,7 @@ export declare enum EmbedEvent {
4107
4158
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
4108
4159
  * console.log('payload', payload);
4109
4160
  * })
4110
- *```
4161
+ * ```
4111
4162
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4112
4163
  */
4113
4164
  AddToCoaching = "addToCoaching",
@@ -4129,7 +4180,7 @@ export declare enum EmbedEvent {
4129
4180
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
4130
4181
  * console.log('payload', payload);
4131
4182
  * })
4132
- *```
4183
+ * ```
4133
4184
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4134
4185
  */
4135
4186
  SpotterQueryTriggered = "SpotterQueryTriggered",
@@ -4140,7 +4191,7 @@ export declare enum EmbedEvent {
4140
4191
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
4141
4192
  * console.log('payload', payload);
4142
4193
  * })
4143
- *```
4194
+ * ```
4144
4195
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4145
4196
  */
4146
4197
  LastPromptEdited = "LastPromptEdited",
@@ -4151,18 +4202,18 @@ export declare enum EmbedEvent {
4151
4202
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
4152
4203
  * console.log('payload', payload);
4153
4204
  * })
4154
- *```
4205
+ * ```
4155
4206
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4156
4207
  */
4157
4208
  LastPromptDeleted = "LastPromptDeleted",
4158
4209
  /**
4159
- * Emitted when the coversation is reset in spotter embed.
4210
+ * Emitted when the conversation is reset in Spotter embed.
4160
4211
  * @example
4161
4212
  * ```js
4162
4213
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
4163
4214
  * console.log('payload', payload);
4164
4215
  * })
4165
- *```
4216
+ * ```
4166
4217
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4167
4218
  */
4168
4219
  ResetSpotterConversation = "ResetSpotterConversation",
@@ -4173,7 +4224,7 @@ export declare enum EmbedEvent {
4173
4224
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
4174
4225
  * console.log('payload', payload);
4175
4226
  * })
4176
- *```
4227
+ * ```
4177
4228
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4178
4229
  */
4179
4230
  SpotterInit = "spotterInit",
@@ -4184,7 +4235,7 @@ export declare enum EmbedEvent {
4184
4235
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
4185
4236
  * console.log('payload', payload);
4186
4237
  * })
4187
- *```
4238
+ * ```
4188
4239
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
4189
4240
  */
4190
4241
  SpotterLoadComplete = "spotterLoadComplete",
@@ -4411,7 +4462,8 @@ export declare enum HostEvent {
4411
4462
  * - `autoDrillDown`: Optional. If `true`, the drill down will be done automatically
4412
4463
  * on the most popular column.
4413
4464
  * - `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case
4414
- * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
4465
+ * of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is
4466
+ * **required**.
4415
4467
  * @example
4416
4468
  * ```js
4417
4469
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -4538,7 +4590,7 @@ export declare enum HostEvent {
4538
4590
  * ```js
4539
4591
  * appEmbed.navigateToPage(-1)
4540
4592
  * ```
4541
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
4593
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
4542
4594
  */
4543
4595
  Navigate = "Navigate",
4544
4596
  /**
@@ -4607,7 +4659,8 @@ export declare enum HostEvent {
4607
4659
  * the following parameters:
4608
4660
  *
4609
4661
  * @param - Includes the following keys:
4610
- * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.
4662
+ * - `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a
4663
+ * Liveboard.
4611
4664
  * Optional when pinning a new chart or table generated from a Search query.
4612
4665
  * **Required** in Spotter Embed.
4613
4666
  * - `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,
@@ -4671,9 +4724,9 @@ export declare enum HostEvent {
4671
4724
  * Trigger the **Show Liveboard details** action
4672
4725
  * on an embedded Liveboard.
4673
4726
  * @example
4674
- *```js
4727
+ * ```js
4675
4728
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
4676
- *```
4729
+ * ```
4677
4730
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4678
4731
  */
4679
4732
  LiveboardInfo = "pinboardInfo",
@@ -4801,7 +4854,7 @@ export declare enum HostEvent {
4801
4854
  * appEmbed.trigger(HostEvent.Remove)
4802
4855
  * ```
4803
4856
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4804
- * * @example
4857
+ * @example
4805
4858
  * ```js
4806
4859
  * liveboardEmbed.trigger(HostEvent.Remove)
4807
4860
  * ```
@@ -4863,7 +4916,8 @@ export declare enum HostEvent {
4863
4916
  * This event is not supported in visualization embed and search embed.
4864
4917
  * @param - Object parameter. Includes the following keys:
4865
4918
  * - `vizId`: To trigger the action for a specific visualization in Liveboard embed,
4866
- * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.
4919
+ * pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and
4920
+ * is **required**.
4867
4921
  *
4868
4922
  * @example
4869
4923
  * ```js
@@ -4892,7 +4946,7 @@ export declare enum HostEvent {
4892
4946
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4893
4947
  * ```
4894
4948
  * ```js
4895
- * vizEmbed.trigger((HostEvent.CopyLink)
4949
+ * vizEmbed.trigger(HostEvent.CopyLink)
4896
4950
  * ```
4897
4951
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4898
4952
  */
@@ -4909,7 +4963,7 @@ export declare enum HostEvent {
4909
4963
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4910
4964
  * ```
4911
4965
  * ```js
4912
- * vizEmbed.trigger((HostEvent.Present)
4966
+ * vizEmbed.trigger(HostEvent.Present)
4913
4967
  * ```
4914
4968
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4915
4969
  */
@@ -4924,23 +4978,22 @@ export declare enum HostEvent {
4924
4978
  * );
4925
4979
  * })
4926
4980
  * ```
4927
- * * @example
4981
+ * @example
4928
4982
  * ```js
4929
-
4930
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
4931
- * let latestSpotterVizId = '';
4932
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4933
- * latestSpotterVizId = payload.data.id;
4934
- * });
4935
- *
4936
- * spotterEmbed.trigger(HostEvent.GetTML, {
4983
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4984
+ * let latestSpotterVizId = '';
4985
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4986
+ * latestSpotterVizId = payload.data.id;
4987
+ * });
4988
+ *
4989
+ * spotterEmbed.trigger(HostEvent.GetTML, {
4937
4990
  * vizId: latestSpotterVizId
4938
4991
  * }).then((tml) => {
4939
4992
  * console.log(
4940
4993
  * tml.answer.search_query // TML representation of the search query
4941
4994
  * );
4942
4995
  * })
4943
- * ```
4996
+ * ```
4944
4997
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4945
4998
  * @important
4946
4999
  */
@@ -5004,6 +5057,11 @@ export declare enum HostEvent {
5004
5057
  /**
5005
5058
  * Trigger the **Download** action on charts in
5006
5059
  * the embedded view.
5060
+ * Use {@link HostEvent.DownloadAsPng} instead.
5061
+ *
5062
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5063
+ *
5064
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5007
5065
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
5008
5066
  * @example
5009
5067
  * ```js
@@ -5022,9 +5080,6 @@ export declare enum HostEvent {
5022
5080
  *
5023
5081
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
5024
5082
  * ```
5025
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5026
- * Use {@link DownloadAsPng}
5027
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5028
5083
  */
5029
5084
  Download = "downloadAsPng",
5030
5085
  /**
@@ -5231,8 +5286,9 @@ export declare enum HostEvent {
5231
5286
  /**
5232
5287
  * Update one or several filters applied on a Liveboard.
5233
5288
  * @param - Includes the following keys:
5234
- * - `filter`: A single filter object containing column name, filter operator, and values.
5235
- * - `filters`: Multiple filter objects with column name, filter operator, and values for each.
5289
+ * - `filter`: A single filter object containing column name, filter operator, and
5290
+ * values. - `filters`: Multiple filter objects with column name, filter operator,
5291
+ * and values for each.
5236
5292
  *
5237
5293
  * Each filter object must include the following attributes:
5238
5294
  *
@@ -5462,8 +5518,8 @@ export declare enum HostEvent {
5462
5518
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5463
5519
  * console.log('parameters', parameter);
5464
5520
  * });
5465
- *```
5466
- *```js
5521
+ * ```
5522
+ * ```js
5467
5523
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
5468
5524
  * let latestSpotterVizId = '';
5469
5525
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -5471,7 +5527,7 @@ export declare enum HostEvent {
5471
5527
  * });
5472
5528
  *
5473
5529
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
5474
- *```
5530
+ * ```
5475
5531
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5476
5532
  */
5477
5533
  GetParameters = "GetParameters",
@@ -5488,7 +5544,7 @@ export declare enum HostEvent {
5488
5544
  * Notify when info call is completed successfully
5489
5545
  * ```js
5490
5546
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5491
- *```
5547
+ * ```
5492
5548
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5493
5549
  */
5494
5550
  InfoSuccess = "InfoSuccess",
@@ -5501,8 +5557,8 @@ export declare enum HostEvent {
5501
5557
  * triggered with a modal to prompt users to
5502
5558
  * add a name and description for the Answer.
5503
5559
  * @param - Includes the following keys:
5504
- * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.
5505
- * - `name`: Optional. Name string for the Answer.
5560
+ * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
5561
+ * embed. - `name`: Optional. Name string for the Answer.
5506
5562
  * - `description`: Optional. Description text for the Answer.
5507
5563
  * @example
5508
5564
  * ```js
@@ -5591,7 +5647,7 @@ export declare enum HostEvent {
5591
5647
  * ```js
5592
5648
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
5593
5649
  *
5594
- *```
5650
+ * ```
5595
5651
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5596
5652
  */
5597
5653
  AddToCoaching = "addToCoaching",
@@ -5633,7 +5689,7 @@ export declare enum HostEvent {
5633
5689
  * });
5634
5690
  *
5635
5691
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
5636
- *```
5692
+ * ```
5637
5693
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5638
5694
  */
5639
5695
  AnswerChartSwitcher = "answerChartSwitcher",
@@ -5643,7 +5699,7 @@ export declare enum HostEvent {
5643
5699
  * This is automatically triggered by the SDK when fullscreen mode is exited.
5644
5700
  * ```js
5645
5701
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
5646
- *```
5702
+ * ```
5647
5703
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5648
5704
  */
5649
5705
  ExitPresentMode = "exitPresentMode",
@@ -5697,8 +5753,9 @@ export declare enum HostEvent {
5697
5753
  /**
5698
5754
  * Triggers a new conversation in Spotter embed.
5699
5755
  *
5700
- * This feature is available only when chat history is enabled on your ThoughtSpot instance.
5701
- * Contact your admin or ThoughtSpot Support to enable chat history on your instance.
5756
+ * This feature is available only when chat history is enabled on your ThoughtSpot
5757
+ * instance. Contact your admin or ThoughtSpot Support to enable chat history on your
5758
+ * instance.
5702
5759
  *
5703
5760
  * @example
5704
5761
  * ```js
@@ -5894,14 +5951,14 @@ export declare enum Action {
5894
5951
  * ```js
5895
5952
  * disabledActions: [Action.CollapseDataPanel]
5896
5953
  * ```
5897
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5954
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5898
5955
  */
5899
5956
  CollapseDataSources = "collapseDataSources",
5900
5957
  /**
5901
5958
  * The **Collapse data panel** icon on the Search page.
5902
5959
  * Collapses the data panel view.
5903
5960
  *
5904
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5961
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5905
5962
  *
5906
5963
  * @example
5907
5964
  * ```js
@@ -6348,13 +6405,12 @@ export declare enum Action {
6348
6405
  */
6349
6406
  CreateMonitor = "createMonitor",
6350
6407
  /**
6351
- * @deprecated
6352
- * Reports errors
6408
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
6409
+ * @deprecated This action is deprecated. It was used for reporting errors.
6353
6410
  * @example
6354
6411
  * ```js
6355
6412
  * disabledActions: [Action.ReportError]
6356
6413
  * ```
6357
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
6358
6414
  */
6359
6415
  ReportError = "reportError",
6360
6416
  /**
@@ -6364,7 +6420,7 @@ export declare enum Action {
6364
6420
  * ```js
6365
6421
  * disabledActions: [Action.SyncToSheets]
6366
6422
  * ```
6367
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6423
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6368
6424
  */
6369
6425
  SyncToSheets = "sync-to-sheets",
6370
6426
  /**
@@ -6375,7 +6431,7 @@ export declare enum Action {
6375
6431
  * ```js
6376
6432
  * disabledActions: [Action.SyncToOtherApps]
6377
6433
  * ```
6378
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6434
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6379
6435
  */
6380
6436
  SyncToOtherApps = "sync-to-other-apps",
6381
6437
  /**
@@ -6385,7 +6441,7 @@ export declare enum Action {
6385
6441
  * ```js
6386
6442
  * disabledActions: [Action.ManagePipelines]
6387
6443
  * ```
6388
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6444
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6389
6445
  */
6390
6446
  ManagePipelines = "manage-pipeline",
6391
6447
  /**
@@ -6697,7 +6753,7 @@ export declare enum Action {
6697
6753
  * ```js
6698
6754
  * disabledActions: [Action.PersonalisedViewsDropdown]
6699
6755
  * ```
6700
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6756
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6701
6757
  */
6702
6758
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
6703
6759
  /**
@@ -6707,7 +6763,7 @@ export declare enum Action {
6707
6763
  * ```js
6708
6764
  * disabledActions: [Action.LiveboardUsers]
6709
6765
  * ```
6710
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6766
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6711
6767
  */
6712
6768
  LiveboardUsers = "liveboardUsers",
6713
6769
  /**
@@ -6725,7 +6781,7 @@ export declare enum Action {
6725
6781
  * hiddenAction: [Action.TML] // hide all TML actions
6726
6782
  * disabledActions: [Action.TML] // to disable all TML actions
6727
6783
  * ```
6728
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6784
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6729
6785
  */
6730
6786
  TML = "tml",
6731
6787
  /**
@@ -6771,7 +6827,7 @@ export declare enum Action {
6771
6827
  * ```js
6772
6828
  * disabledActions: [Action.AddToWatchlist]
6773
6829
  * ```
6774
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6830
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6775
6831
  */
6776
6832
  AddToWatchlist = "addToWatchlist",
6777
6833
  /**
@@ -6781,7 +6837,7 @@ export declare enum Action {
6781
6837
  * ```js
6782
6838
  * disabledActions: [Action.RemoveFromWatchlist]
6783
6839
  * ```
6784
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6840
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
6785
6841
  */
6786
6842
  RemoveFromWatchlist = "removeFromWatchlist",
6787
6843
  /**
@@ -6792,7 +6848,7 @@ export declare enum Action {
6792
6848
  * ```js
6793
6849
  * disabledActions: [Action.OrganiseFavourites]
6794
6850
  * ```
6795
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6851
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
6796
6852
  */
6797
6853
  OrganiseFavourites = "organiseFavourites",
6798
6854
  /**
@@ -6853,7 +6909,7 @@ export declare enum Action {
6853
6909
  * ```js
6854
6910
  * disabledActions: [Action.ManageTags]
6855
6911
  * ```
6856
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6912
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6857
6913
  */
6858
6914
  ManageTags = "manageTags",
6859
6915
  /**
@@ -7505,15 +7561,16 @@ declare enum EmbedErrorCodes {
7505
7561
  /**
7506
7562
  * Error event object emitted when an error occurs in an embedded component.
7507
7563
  *
7508
- * This interface defines the structure of error objects returned by the {@link EmbedEvent.Error}
7509
- * event. It provides detailed information about what went wrong, including the error type,
7510
- * a human-readable message, and a machine-readable error code.
7564
+ * This interface defines the structure of error objects returned by the {@link
7565
+ * EmbedEvent.Error} event. It provides detailed information about what went wrong,
7566
+ * including the error type, a human-readable message, and a machine-readable error code.
7511
7567
  *
7512
7568
  * ## Properties
7513
7569
  *
7514
7570
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
7515
- * - **message**: Human-readable error description (string or array of strings for multiple errors)
7516
- * - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
7571
+ * - **message**: Human-readable error description (string or array of strings for
7572
+ * multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
7573
+ * values
7517
7574
  * - **[key: string]**: Additional context-specific for backward compatibility
7518
7575
  *
7519
7576
  * ## Usage
@@ -7614,14 +7671,14 @@ export type ApiInterceptFlags = {
7614
7671
  /**
7615
7672
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
7616
7673
  *
7617
- * Can be used for Serach and App Embed from SDK 1.29.0
7674
+ * Can be used for Search and App Embed from SDK 1.29.0
7618
7675
  *
7619
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7676
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7620
7677
  */
7621
7678
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
7622
7679
  /**
7623
7680
  * This allows to intercept the urls passed, once intercepted the api will only
7624
- * run based on the reponse from the responder of ApiIntercept event.
7681
+ * run based on the response from the responder of ApiIntercept event.
7625
7682
  *
7626
7683
  * @example
7627
7684
  * ```js
@@ -7632,7 +7689,7 @@ export type ApiInterceptFlags = {
7632
7689
  * })
7633
7690
  * ```
7634
7691
  *
7635
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7692
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7636
7693
  */
7637
7694
  interceptUrls?: (string | InterceptedApiType)[];
7638
7695
  /**
@@ -7649,7 +7706,7 @@ export type ApiInterceptFlags = {
7649
7706
  * })
7650
7707
  * ```
7651
7708
  *
7652
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7709
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7653
7710
  */
7654
7711
  interceptTimeout?: number;
7655
7712
  };
@@ -7788,20 +7845,45 @@ export declare enum AuthFailureType {
7788
7845
  */
7789
7846
  export declare enum AuthStatus {
7790
7847
  /**
7791
- * Emits when the SDK fails to authenticate
7848
+ * Emits when the SDK fails to authenticate.
7792
7849
  */
7793
7850
  FAILURE = "FAILURE",
7794
7851
  /**
7795
- * Emits when the SDK authenticates successfully
7852
+ * Emits when the SDK authentication step completes
7853
+ * successfully (e.g., token exchange, cookie set).
7854
+ * This fires before any iframe is rendered. Use
7855
+ * this to know that auth passed and it is safe to
7856
+ * proceed with rendering. The callback receives no
7857
+ * arguments.
7858
+ * @example
7859
+ * ```js
7860
+ * const authEE = init({ ... });
7861
+ * authEE.on(AuthStatus.SDK_SUCCESS, () => {
7862
+ * // Auth done, iframe not loaded yet
7863
+ * });
7864
+ * ```
7796
7865
  */
7797
7866
  SDK_SUCCESS = "SDK_SUCCESS",
7798
7867
  /**
7799
7868
  * @hidden
7800
- * Emits when iframe is loaded and session info is available
7869
+ * Emits when iframe is loaded and session
7870
+ * information is available.
7801
7871
  */
7802
7872
  SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
7803
7873
  /**
7804
- * Emits when the app sends an authentication success message
7874
+ * Emits when the ThoughtSpot app inside the
7875
+ * embedded iframe confirms its session is active.
7876
+ * This fires after the iframe loads and sends back an `AuthInit` event.
7877
+ * @param sessionInfo Information about the user session, with details like `userGUID`.
7878
+ * @see EmbedEvent.AuthInit
7879
+ * @example
7880
+ * ```js
7881
+ * const authEE = init({ ... });
7882
+ * authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
7883
+ * // App is loaded and authenticated
7884
+ * console.log(sessionInfo.userGUID);
7885
+ * });
7886
+ * ```
7805
7887
  */
7806
7888
  SUCCESS = "SUCCESS",
7807
7889
  /**
@@ -8037,9 +8119,9 @@ declare class TsEmbed {
8037
8119
  */
8038
8120
  private isPreRendered;
8039
8121
  /**
8040
- * Should we encode URL Query Params using base64 encoding which thoughtspot
8122
+ * Should we encode URL Query Params using base64 encoding which ThoughtSpot
8041
8123
  * will generate for embedding. This provides additional security to
8042
- * thoughtspot clusters against Cross site scripting attacks.
8124
+ * ThoughtSpot clusters against Cross site scripting attacks.
8043
8125
  * @default false
8044
8126
  */
8045
8127
  private shouldEncodeUrlQueryParams;
@@ -8405,7 +8487,7 @@ declare class TsEmbed {
8405
8487
  * Returns the answerService which can be used to make arbitrary graphql calls on top
8406
8488
  * session.
8407
8489
  * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
8408
- * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
8490
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
8409
8491
  */
8410
8492
  getAnswerService(vizId?: string): Promise<AnswerService>;
8411
8493
  /**
@@ -8492,7 +8574,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8492
8574
  * but can be expanded manually.
8493
8575
  *
8494
8576
  * Supported embed types: `SearchEmbed`
8495
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8577
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8496
8578
  * @example
8497
8579
  * ```js
8498
8580
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8507,7 +8589,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8507
8589
  * but can be expanded manually.
8508
8590
  *
8509
8591
  * Supported embed types: `SearchEmbed`
8510
- * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
8592
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
8511
8593
  * @example
8512
8594
  * ```js
8513
8595
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8521,7 +8603,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8521
8603
  * Show or hide the data sources panel.
8522
8604
  *
8523
8605
  * Supported embed types: `SearchEmbed`
8524
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8606
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8525
8607
  * @example
8526
8608
  * ```js
8527
8609
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8537,7 +8619,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8537
8619
  * using raw answer data.
8538
8620
  *
8539
8621
  * Supported embed types: `SearchEmbed`
8540
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8622
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8541
8623
  * @example
8542
8624
  * ```js
8543
8625
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8566,7 +8648,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8566
8648
  * format for presenting search data.
8567
8649
  *
8568
8650
  * Supported embed types: `SearchEmbed`
8569
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8651
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8570
8652
  * @example
8571
8653
  * ```js
8572
8654
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8579,6 +8661,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8579
8661
  /**
8580
8662
  * The array of data source GUIDs to set on load.
8581
8663
  * Only a single data source is supported currently.
8664
+ * Use {@link dataSource} instead.
8582
8665
  * @deprecated Use `dataSource` instead.
8583
8666
  *
8584
8667
  * Supported embed types: `SearchEmbed`
@@ -8592,10 +8675,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8592
8675
  */
8593
8676
  dataSources?: string[];
8594
8677
  /**
8595
- * The array of data source GUIDs to set on load.
8678
+ * The data source GUID to set on load.
8596
8679
  *
8597
8680
  * Supported embed types: `SearchEmbed`
8598
- * @version: SDK: 1.19.0
8681
+ * @version SDK: 1.19.0
8599
8682
  * @example
8600
8683
  * ```js
8601
8684
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8607,9 +8690,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8607
8690
  dataSource?: string;
8608
8691
  /**
8609
8692
  * The initial search query to load the answer with.
8693
+ * Use {@link searchOptions} instead.
8610
8694
  * @deprecated
8611
8695
  *
8612
- * Use {@link searchOptions} instead.
8613
8696
  */
8614
8697
  searchQuery?: string;
8615
8698
  /**
@@ -8638,7 +8721,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8638
8721
  * If set to true, the search token string is not appended to the URL.
8639
8722
  *
8640
8723
  * Supported embed types: `SearchEmbed`
8641
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8724
+ * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8642
8725
  * @example
8643
8726
  * ```js
8644
8727
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8655,7 +8738,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8655
8738
  * The GUID of a saved answer to load initially.
8656
8739
  *
8657
8740
  * Supported embed types: `SearchEmbed`
8658
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8741
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8659
8742
  * @example
8660
8743
  * ```js
8661
8744
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8684,14 +8767,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8684
8767
  * Flag to set if last selected dataSource should be used
8685
8768
  *
8686
8769
  * Supported embed types: `SearchEmbed`
8687
- * @version: SDK: 1.24.0
8770
+ * @version SDK: 1.24.0
8688
8771
  */
8689
8772
  useLastSelectedSources?: boolean;
8690
8773
  /**
8691
8774
  * To set the initial state of the search bar in case of saved-answers.
8692
- * @default false
8693
8775
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
8694
8776
  * @deprecated Use {@link collapseSearchBar} instead
8777
+ * @default false
8695
8778
  */
8696
8779
  collapseSearchBarInitially?: boolean;
8697
8780
  /**
@@ -8775,8 +8858,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8775
8858
  * Only a single data source is supported currently.
8776
8859
  *
8777
8860
  * Supported embed types: `SearchBarEmbed`
8861
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
8778
8862
  * @deprecated Use `dataSource` instead
8779
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
8780
8863
  * @example
8781
8864
  * ```js
8782
8865
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8790,7 +8873,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8790
8873
  * Pass the ID of the source to be selected.
8791
8874
  *
8792
8875
  * Supported embed types: `SearchBarEmbed`
8793
- * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
8876
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
8794
8877
  * @example
8795
8878
  * ```js
8796
8879
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8804,7 +8887,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8804
8887
  * Boolean to define if the last selected data source should be used
8805
8888
  *
8806
8889
  * Supported embed types: `SearchBarEmbed`
8807
- * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
8890
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
8808
8891
  * @example
8809
8892
  * ```js
8810
8893
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8826,7 +8909,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8826
8909
  * the token string in the search bar.
8827
8910
  *
8828
8911
  * Supported embed types: `SearchBarEmbed`
8829
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
8912
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
8830
8913
  * @example
8831
8914
  * ```js
8832
8915
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8844,10 +8927,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8844
8927
  * If set to true, the search token string is not appended to the URL.
8845
8928
  *
8846
8929
  * Supported embed types: `SearchBarEmbed`
8847
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8930
+ * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8848
8931
  * @example
8849
8932
  * ```js
8850
- * const embed = new SearchEmbed('#tsEmbed', {
8933
+ * const embed = new SearchBarEmbed('#tsEmbed', {
8851
8934
  * searchOptions: {
8852
8935
  * searchTokenString: '[quantity purchased] [region]',
8853
8936
  * executeSearch: true,
@@ -8900,7 +8983,7 @@ interface SearchOptions$1 {
8900
8983
  /**
8901
8984
  * The configuration attributes for the embedded Natural language search view. Based on
8902
8985
  * GPT and LLM.
8903
- * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8986
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8904
8987
  *
8905
8988
  * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
8906
8989
  * @group Embed components
@@ -8954,14 +9037,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8954
9037
  hideAutocompleteSuggestions?: boolean;
8955
9038
  /**
8956
9039
  * Show or hide autocomplete suggestions for the search query string.
9040
+ * You can use {@link hideAutocompleteSuggestions} instead.
8957
9041
  * @deprecated
8958
9042
  * Currently, the object suggestions will not be shown for Natural Language Search.
8959
- * You can use {@link hideAutocompleteSuggestions} instead.
8960
9043
  */
8961
9044
  showObjectSuggestions?: boolean;
8962
9045
  /**
8963
9046
  * Show or hide sample questions.
8964
- * The sample questions are autogenerated based on the data Model.
9047
+ * The sample questions are autogenerated based on the data model
8965
9048
  * selected for the search operation.
8966
9049
  *
8967
9050
  * Supported embed types: `SageEmbed`
@@ -8991,6 +9074,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8991
9074
  * the token string in the search bar.
8992
9075
  *
8993
9076
  * Supported embed types: `SageEmbed`
9077
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8994
9078
  * @example
8995
9079
  * ```js
8996
9080
  * searchOptions: {
@@ -8998,7 +9082,6 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8998
9082
  * executeSearch: true,
8999
9083
  * }
9000
9084
  * ```
9001
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
9002
9085
  */
9003
9086
  searchOptions?: SearchOptions$1;
9004
9087
  }
@@ -9038,81 +9121,81 @@ interface SearchOptions$2 {
9038
9121
  * Configuration for the Spotter sidebar.
9039
9122
  * Can be used in SpotterEmbed and AppEmbed.
9040
9123
  * @group Embed components
9041
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9124
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9042
9125
  */
9043
9126
  export interface SpotterSidebarViewConfig {
9044
9127
  /**
9045
9128
  * Controls the visibility of the past conversations sidebar.
9046
9129
  * @default false
9047
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9130
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9048
9131
  */
9049
9132
  enablePastConversationsSidebar?: boolean;
9050
9133
  /**
9051
9134
  * Custom title text for the sidebar header.
9052
9135
  * Defaults to translated "Spotter" text.
9053
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9136
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9054
9137
  */
9055
9138
  spotterSidebarTitle?: string;
9056
9139
  /**
9057
9140
  * Boolean to set the default expanded state of the sidebar.
9058
9141
  * @default false
9059
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9142
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9060
9143
  */
9061
9144
  spotterSidebarDefaultExpanded?: boolean;
9062
9145
  /**
9063
9146
  * Custom label text for the rename action in the conversation edit menu.
9064
9147
  * Defaults to translated "Rename" text.
9065
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9148
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9066
9149
  */
9067
9150
  spotterChatRenameLabel?: string;
9068
9151
  /**
9069
9152
  * Custom label text for the delete action in the conversation edit menu.
9070
9153
  * Defaults to translated "DELETE" text.
9071
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9154
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9072
9155
  */
9073
9156
  spotterChatDeleteLabel?: string;
9074
9157
  /**
9075
9158
  * Custom title text for the delete conversation confirmation modal.
9076
9159
  * Defaults to translated "Delete chat" text.
9077
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9160
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9078
9161
  */
9079
9162
  spotterDeleteConversationModalTitle?: string;
9080
9163
  /**
9081
9164
  * Custom message text for the past conversation banner alert.
9082
9165
  * Defaults to translated alert message.
9083
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9166
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9084
9167
  */
9085
9168
  spotterPastConversationAlertMessage?: string;
9086
9169
  /**
9087
9170
  * Custom URL for the documentation/best practices link.
9088
9171
  * Defaults to ThoughtSpot docs URL based on release version.
9089
9172
  * Note: URL must include the protocol (e.g., `https://www.example.com`).
9090
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9173
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9091
9174
  */
9092
9175
  spotterDocumentationUrl?: string;
9093
9176
  /**
9094
9177
  * Custom label text for the best practices button in the footer.
9095
9178
  * Defaults to translated "Best Practices" text.
9096
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9179
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9097
9180
  */
9098
9181
  spotterBestPracticesLabel?: string;
9099
9182
  /**
9100
9183
  * Number of conversations to fetch per batch when loading conversation history.
9101
9184
  * @default 30
9102
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9185
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9103
9186
  */
9104
9187
  spotterConversationsBatchSize?: number;
9105
9188
  /**
9106
9189
  * Custom title text for the "New Chat" button in the sidebar.
9107
9190
  * Defaults to translated "New Chat" text.
9108
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9191
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9109
9192
  */
9110
9193
  spotterNewChatButtonTitle?: string;
9111
9194
  }
9112
9195
  /**
9113
9196
  * Configuration for customizing Spotter chat UI branding.
9114
- * @group Embed components
9115
9197
  * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9198
+ * @group Embed components
9116
9199
  */
9117
9200
  export interface SpotterChatViewConfig {
9118
9201
  /**
@@ -9151,6 +9234,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9151
9234
  * but still display the selected data source.
9152
9235
  *
9153
9236
  * Supported embed types: `SpotterEmbed`
9237
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9154
9238
  * @example
9155
9239
  * ```js
9156
9240
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9158,13 +9242,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9158
9242
  * disableSourceSelection : true,
9159
9243
  * })
9160
9244
  * ```
9161
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9162
9245
  */
9163
9246
  disableSourceSelection?: boolean;
9164
9247
  /**
9165
9248
  * hideSourceSelection : Hide data source selection
9166
9249
  *
9167
9250
  * Supported embed types: `SpotterEmbed`
9251
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9168
9252
  * @example
9169
9253
  * ```js
9170
9254
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9172,15 +9256,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9172
9256
  * hideSourceSelection : true,
9173
9257
  * })
9174
9258
  * ```
9175
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9176
9259
  */
9177
9260
  hideSourceSelection?: boolean;
9178
9261
  /**
9179
9262
  * Flag to control Data panel experience
9180
9263
  *
9181
9264
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
9265
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
9182
9266
  * @default true
9183
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
9184
9267
  * @example
9185
9268
  * ```js
9186
9269
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -9197,6 +9280,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9197
9280
  * default is false.
9198
9281
  *
9199
9282
  * Supported embed types: `SpotterEmbed`
9283
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
9200
9284
  * @example
9201
9285
  * ```js
9202
9286
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9204,7 +9288,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9204
9288
  * showSpotterLimitations : true,
9205
9289
  * })
9206
9290
  * ```
9207
- * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
9208
9291
  */
9209
9292
  showSpotterLimitations?: boolean;
9210
9293
  /**
@@ -9212,6 +9295,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9212
9295
  * the initial screen of the conversation.
9213
9296
  *
9214
9297
  * Supported embed types: `SpotterEmbed`
9298
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9215
9299
  * @example
9216
9300
  * ```js
9217
9301
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9219,7 +9303,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9219
9303
  * hideSampleQuestions : true,
9220
9304
  * })
9221
9305
  * ```
9222
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9223
9306
  */
9224
9307
  hideSampleQuestions?: boolean;
9225
9308
  /**
@@ -9227,6 +9310,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9227
9310
  * visualization, or Liveboard.
9228
9311
  *
9229
9312
  * Supported embed types: `SpotterEmbed`
9313
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9230
9314
  * @example
9231
9315
  * ```js
9232
9316
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9240,7 +9324,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9240
9324
  * ],
9241
9325
  * })
9242
9326
  * ```
9243
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9244
9327
  */
9245
9328
  runtimeFilters?: RuntimeFilter[];
9246
9329
  /**
@@ -9251,14 +9334,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9251
9334
  * (default behavior before SDK 1.45.0).
9252
9335
  *
9253
9336
  * Supported embed types: `SpotterEmbed`
9254
- * @default true
9255
9337
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9338
+ * @default true
9256
9339
  */
9257
9340
  excludeRuntimeFiltersfromURL?: boolean;
9258
9341
  /**
9259
9342
  * The list of runtime parameters to apply to the conversation.
9260
9343
  *
9261
9344
  * Supported embed types: `SpotterEmbed`
9345
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9262
9346
  * @example
9263
9347
  * ```js
9264
9348
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9271,7 +9355,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9271
9355
  * ],
9272
9356
  * })
9273
9357
  * ```
9274
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9275
9358
  */
9276
9359
  runtimeParameters?: RuntimeParameter[];
9277
9360
  /**
@@ -9282,14 +9365,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9282
9365
  * the iframe URL instead (default behavior before SDK 1.45.0).
9283
9366
  *
9284
9367
  * Supported embed types: `SpotterEmbed`
9285
- * @default true
9286
9368
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9369
+ * @default true
9287
9370
  */
9288
9371
  excludeRuntimeParametersfromURL?: boolean;
9289
9372
  /**
9290
9373
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9291
9374
  *
9292
9375
  * Supported embed types: `SpotterEmbed`
9376
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9293
9377
  * @default false
9294
9378
  * @example
9295
9379
  * ```js
@@ -9298,17 +9382,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9298
9382
  * updatedSpotterChatPrompt : true,
9299
9383
  * })
9300
9384
  * ```
9301
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9302
9385
  */
9303
9386
  updatedSpotterChatPrompt?: boolean;
9387
+ /**
9388
+ * Controls the visibility of the past conversations sidebar.
9389
+ *
9390
+ * Supported embed types: `SpotterEmbed`
9391
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9392
+ * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9393
+ * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
9394
+ * @default false
9395
+ */
9396
+ enablePastConversationsSidebar?: boolean;
9304
9397
  /**
9305
9398
  * Configuration for the Spotter sidebar UI customization.
9306
9399
  *
9307
9400
  * Supported embed types: `SpotterEmbed`, `AppEmbed`
9401
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9308
9402
  * @example
9309
9403
  * ```js
9310
9404
  * const embed = new SpotterEmbed('#tsEmbed', {
9311
- * ... //other embed view config
9405
+ * worksheetId: 'worksheet-id',
9406
+ * // Deprecated standalone flag (backward compatibility)
9407
+ * enablePastConversationsSidebar: false,
9408
+ * // Recommended config; this value takes precedence
9312
9409
  * spotterSidebarConfig: {
9313
9410
  * enablePastConversationsSidebar: true,
9314
9411
  * spotterSidebarTitle: 'My Conversations',
@@ -9316,7 +9413,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9316
9413
  * },
9317
9414
  * })
9318
9415
  * ```
9319
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9320
9416
  */
9321
9417
  spotterSidebarConfig?: SpotterSidebarViewConfig;
9322
9418
  /**
@@ -9324,6 +9420,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9324
9420
  * branding in tool response cards.
9325
9421
  *
9326
9422
  * Supported embed types: `SpotterEmbed`
9423
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9327
9424
  * @example
9328
9425
  * ```js
9329
9426
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9334,14 +9431,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9334
9431
  * },
9335
9432
  * })
9336
9433
  * ```
9337
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9338
9434
  */
9339
9435
  spotterChatConfig?: SpotterChatViewConfig;
9340
9436
  }
9341
9437
  /**
9342
9438
  * The configuration for the embedded spotterEmbed options.
9343
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9344
9439
  * Use {@link SpotterEmbedViewConfig} instead
9440
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9345
9441
  * @group Embed components
9346
9442
  */
9347
9443
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
@@ -9454,7 +9550,7 @@ declare enum ListPage {
9454
9550
  */
9455
9551
  export interface DiscoveryExperience {
9456
9552
  /**
9457
- * primaryNavbarVersion determines the version of the navigation version.
9553
+ * primaryNavbarVersion determines the version of the primary navigation bar.
9458
9554
  */
9459
9555
  primaryNavbarVersion?: PrimaryNavbarVersion;
9460
9556
  /**
@@ -9477,8 +9573,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9477
9573
  * This flag also controls the homepage left navigation bar.
9478
9574
  *
9479
9575
  * Supported embed types: `AppEmbed`
9480
- * @default true
9481
9576
  * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9577
+ * @default true
9482
9578
  * @example
9483
9579
  * ```js
9484
9580
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9499,8 +9595,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9499
9595
  * **Note**: This attribute is not supported in the classic (V1) experience.
9500
9596
  *
9501
9597
  * Supported embed types: `AppEmbed`
9502
- * @default false
9503
9598
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9599
+ * @default false
9504
9600
  * @example
9505
9601
  * ```js
9506
9602
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9517,8 +9613,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9517
9613
  * navigation bar is not hidden via `showPrimaryNavbar`.
9518
9614
  *
9519
9615
  * Supported embed types: `AppEmbed`
9520
- * @default false
9521
9616
  * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9617
+ * @default false
9522
9618
  * @example
9523
9619
  * ```js
9524
9620
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9529,12 +9625,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9529
9625
  */
9530
9626
  disableProfileAndHelp?: boolean;
9531
9627
  /**
9532
- * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
9533
- * @default true
9534
9628
  * Whether the help menu in the top navigation bar should be served
9535
9629
  * from Pendo or ThoughtSpot's internal help items.
9536
9630
  *
9537
9631
  * Supported embed types: `AppEmbed`
9632
+ * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
9633
+ * @default true
9538
9634
  * @example
9539
9635
  * ```js
9540
9636
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9549,8 +9645,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9549
9645
  * the top navigation bar in the V3 navigation experience.
9550
9646
  *
9551
9647
  * Supported embed types: `AppEmbed`
9552
- * @default false
9553
9648
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9649
+ * @default false
9554
9650
  * @example
9555
9651
  * ```js
9556
9652
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9569,8 +9665,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9569
9665
  * in the classic (V1) experience.
9570
9666
  *
9571
9667
  * Supported embed types: `AppEmbed`
9572
- * @default true
9573
9668
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9669
+ * @default true
9574
9670
  * @example
9575
9671
  * ```js
9576
9672
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9588,8 +9684,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9588
9684
  * in the classic (V1) and V2 experience modes.
9589
9685
  *
9590
9686
  * Supported embed types: `AppEmbed`
9591
- * @default true
9592
9687
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9688
+ * @default true
9593
9689
  * @example
9594
9690
  * ```js
9595
9691
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9605,7 +9701,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9605
9701
  * In the V3 experience, it shows or hides application selection
9606
9702
  * icons on the left navigation panel.
9607
9703
  * By default, the application selection menu and icons are
9608
- * shown in the UI
9704
+ * shown in the UI.
9609
9705
  *
9610
9706
  * **Note**: This attribute is not supported in the classic (V1) experience.
9611
9707
  *
@@ -9645,7 +9741,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9645
9741
  * takes precedence. This is the path post the `#/` in the URL of the standalone
9646
9742
  * ThoughtSpot app. Use this to open the embedded view to a specific path.
9647
9743
  *
9648
- * For eg, if you want the component to open to a specific Liveboard
9744
+ * For example, if you want the component to open to a specific Liveboard
9649
9745
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
9650
9746
  *
9651
9747
  * Supported embed types: `AppEmbed`
@@ -9663,7 +9759,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9663
9759
  * The application page to set as the start page
9664
9760
  * in the embedded view.
9665
9761
  *
9666
- * Use this to open to particular page in the app. To open to a specific
9762
+ * Use this to open to a particular page in the app. To open to a specific
9667
9763
  * path within the app, use the `path` attribute which is more flexible.
9668
9764
  *
9669
9765
  * Supported embed types: `AppEmbed`
@@ -9743,8 +9839,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9743
9839
  * If set to true, the Search Assist feature is enabled.
9744
9840
  *
9745
9841
  * Supported embed types: `AppEmbed`
9746
- * @default true
9747
9842
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
9843
+ * @default true
9748
9844
  * @example
9749
9845
  * ```js
9750
9846
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9782,8 +9878,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9782
9878
  * For more information,
9783
9879
  * see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
9784
9880
  * Supported embed types: `AppEmbed`
9785
- * @default false
9786
9881
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9882
+ * @default false
9787
9883
  * @example
9788
9884
  * ```js
9789
9885
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9798,8 +9894,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9798
9894
  * For more information, see
9799
9895
  * link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
9800
9896
  * Supported embed types: `AppEmbed`
9801
- * @default false
9802
9897
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9898
+ * @default false
9803
9899
  * @example
9804
9900
  * ```js
9805
9901
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9814,10 +9910,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9814
9910
  */
9815
9911
  discoveryExperience?: DiscoveryExperience;
9816
9912
  /**
9817
- * To set the initial state of the search bar in case of saved-answers.
9913
+ * To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
9818
9914
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
9915
+ * @deprecated This flag is deprecated.
9819
9916
  * @default false
9820
- * @deprecated Use {@link collapseSearchBar} instead
9821
9917
  */
9822
9918
  collapseSearchBarInitially?: boolean;
9823
9919
  /**
@@ -9845,14 +9941,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9845
9941
  * Flag to use home page search bar mode
9846
9942
  *
9847
9943
  * Supported embed types: `AppEmbed`
9848
- * @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
9944
+ * @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
9849
9945
  */
9850
9946
  homePageSearchBarMode?: HomePageSearchBarMode;
9851
9947
  /**
9852
9948
  * This flag is used to enable unified search experience for full app embed.
9853
9949
  *
9854
9950
  * Supported embed types: `AppEmbed`
9855
- * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
9951
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
9856
9952
  * @default true
9857
9953
  * @example
9858
9954
  * ```js
@@ -9864,7 +9960,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9864
9960
  */
9865
9961
  isUnifiedSearchExperienceEnabled?: boolean;
9866
9962
  /**
9867
- * This flag is used to enable/disable the styling and grouping in a Liveboard
9963
+ * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
9964
+ * @deprecated This flag is deprecated.
9868
9965
  *
9869
9966
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
9870
9967
  * @type {boolean}
@@ -9880,7 +9977,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9880
9977
  */
9881
9978
  isLiveboardStylingAndGroupingEnabled?: boolean;
9882
9979
  /**
9883
- * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
9980
+ * This flag is used to enable/disable the png embedding of liveboard in scheduled
9981
+ * mails
9884
9982
  *
9885
9983
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
9886
9984
  * @type {boolean}
@@ -9930,6 +10028,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9930
10028
  /**
9931
10029
  * This flag is used to enable the full height lazy load data.
9932
10030
  *
10031
+ * @type {boolean}
10032
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10033
+ * @default false
9933
10034
  * @example
9934
10035
  * ```js
9935
10036
  * const embed = new AppEmbed('#embed-container', {
@@ -9938,39 +10039,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9938
10039
  * lazyLoadingForFullHeight: true,
9939
10040
  * })
9940
10041
  * ```
9941
- *
9942
- * @type {boolean}
9943
- * @default false
9944
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
9945
10042
  */
9946
10043
  lazyLoadingForFullHeight?: boolean;
9947
10044
  /**
9948
10045
  * The margin to be used for lazy loading.
9949
10046
  *
9950
10047
  * For example, if the margin is set to '10px',
9951
- * the visualization will be loaded 10px before the its top edge is visible in the
10048
+ * the visualization will be loaded 10px before its top edge is visible in the
9952
10049
  * viewport.
9953
10050
  *
9954
10051
  * The format is similar to CSS margin.
9955
10052
  *
10053
+ * @type {string}
10054
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
9956
10055
  * @example
9957
10056
  * ```js
9958
10057
  * const embed = new AppEmbed('#embed-container', {
9959
10058
  * // ...other options
9960
10059
  * fullHeight: true,
9961
10060
  * lazyLoadingForFullHeight: true,
9962
- * // Using 0px, the visualization will be only loaded when its visible in the viewport.
10061
+ * // Using 0px, the visualization will be only loaded when it's visible in the viewport.
9963
10062
  * lazyLoadingMargin: '0px',
9964
10063
  * })
9965
10064
  * ```
9966
- * @type {string}
9967
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
9968
10065
  */
9969
10066
  lazyLoadingMargin?: string;
9970
10067
  /**
9971
10068
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9972
10069
  *
9973
10070
  * Supported embed types: `AppEmbed`
10071
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9974
10072
  * @default false
9975
10073
  * @example
9976
10074
  * ```js
@@ -9979,25 +10077,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9979
10077
  * updatedSpotterChatPrompt : true,
9980
10078
  * })
9981
10079
  * ```
9982
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9983
10080
  */
9984
10081
  updatedSpotterChatPrompt?: boolean;
10082
+ /**
10083
+ * Controls the visibility of the past conversations sidebar.
10084
+ *
10085
+ * Supported embed types: `AppEmbed`
10086
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
10087
+ * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
10088
+ * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
10089
+ * @default false
10090
+ */
10091
+ enablePastConversationsSidebar?: boolean;
9985
10092
  /**
9986
10093
  * Configuration for the Spotter sidebar UI customization.
9987
10094
  * Only applicable when navigating to Spotter within the app.
9988
10095
  *
9989
10096
  * Supported embed types: `AppEmbed`
10097
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9990
10098
  * @example
9991
10099
  * ```js
9992
10100
  * const embed = new AppEmbed('#tsEmbed', {
9993
- * ... //other embed view config
10101
+ * // Deprecated standalone flag (backward compatibility)
10102
+ * enablePastConversationsSidebar: false,
10103
+ * // Recommended config; this value takes precedence
9994
10104
  * spotterSidebarConfig: {
9995
10105
  * enablePastConversationsSidebar: true,
9996
10106
  * spotterSidebarTitle: 'My Conversations',
9997
10107
  * },
9998
10108
  * })
9999
10109
  * ```
10000
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
10001
10110
  */
10002
10111
  spotterSidebarConfig?: SpotterSidebarViewConfig;
10003
10112
  /**
@@ -10005,6 +10114,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10005
10114
  * branding in tool response cards.
10006
10115
  *
10007
10116
  * Supported embed types: `AppEmbed`
10117
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10008
10118
  * @example
10009
10119
  * ```js
10010
10120
  * const embed = new AppEmbed('#tsEmbed', {
@@ -10015,7 +10125,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10015
10125
  * },
10016
10126
  * })
10017
10127
  * ```
10018
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10019
10128
  */
10020
10129
  spotterChatConfig?: SpotterChatViewConfig;
10021
10130
  /**
@@ -10035,6 +10144,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10035
10144
  * ```
10036
10145
  */
10037
10146
  minimumHeight?: number;
10147
+ /**
10148
+ * To enable the homepage announcement banner.
10149
+ * Controls the visibility of the announcement section
10150
+ * on the homepage.
10151
+ *
10152
+ * Supported embed types: `AppEmbed`
10153
+ * @example
10154
+ * ```js
10155
+ * const embed = new AppEmbed('#tsEmbed', {
10156
+ * ... // other embed view config
10157
+ * enableHomepageAnnouncement: true,
10158
+ * })
10159
+ * ```
10160
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10161
+ */
10162
+ enableHomepageAnnouncement?: boolean;
10038
10163
  }
10039
10164
  declare class AppEmbed extends V1Embed {
10040
10165
  protected viewConfig: AppViewConfig;
@@ -10121,9 +10246,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10121
10246
  * Setting `fullHeight` to `false` fetches visualizations
10122
10247
  * incrementally as users scroll the page to view the charts and tables.
10123
10248
  *
10124
- * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
10125
10249
  *
10126
10250
  * Supported embed types: `LiveboardEmbed`
10251
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
10127
10252
  * @example
10128
10253
  * ```js
10129
10254
  * const embed = new LiveboardEmbed('#embed', {
@@ -10134,14 +10259,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10134
10259
  */
10135
10260
  fullHeight?: boolean;
10136
10261
  /**
10137
- * This is the minimum height(in pixels) for a full-height Liveboard.
10262
+ * This is the minimum height (in pixels) for a full-height Liveboard.
10138
10263
  * Setting this height helps resolve issues with empty Liveboards and
10139
10264
  * other screens navigable from a Liveboard.
10140
10265
  *
10141
10266
  * Supported embed types: `LiveboardEmbed`
10142
10267
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
10143
- * @default 500
10144
10268
  * @deprecated Use `minimumHeight` instead.
10269
+ * @default 500
10145
10270
  * @example
10146
10271
  * ```js
10147
10272
  * const embed = new LiveboardEmbed('#embed', {
@@ -10170,7 +10295,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10170
10295
  */
10171
10296
  minimumHeight?: number;
10172
10297
  /**
10173
- * @Deprecated If set to true, the context menu in visualizations will be enabled.
10298
+ * If set to true, the context menu in visualizations will be enabled.
10299
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
10300
+ * @deprecated this option is deprecated.
10174
10301
  * @example
10175
10302
  * ```js
10176
10303
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10178,7 +10305,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10178
10305
  * enableVizTransformations:true,
10179
10306
  * })
10180
10307
  * ```
10181
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
10182
10308
  */
10183
10309
  enableVizTransformations?: boolean;
10184
10310
  /**
@@ -10191,8 +10317,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10191
10317
  * ```js
10192
10318
  * const embed = new LiveboardEmbed('#tsEmbed', {
10193
10319
  * ... //other embed view config
10194
- * liveboardId:id of liveboard,
10320
+ * liveboardId:'id of liveboard',
10195
10321
  * })
10322
+ * ```
10196
10323
  */
10197
10324
  liveboardId?: string;
10198
10325
  /**
@@ -10245,6 +10372,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10245
10372
  * 'f547ec54-2a37-4516-a222-2b06719af726'
10246
10373
  * ]
10247
10374
  * })
10375
+ * ```
10248
10376
  */
10249
10377
  visibleVizs?: string[];
10250
10378
  /**
@@ -10272,6 +10400,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10272
10400
  * Specify the tab ID.
10273
10401
  *
10274
10402
  * Supported embed types: `LiveboardEmbed`
10403
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
10275
10404
  * @example
10276
10405
  * ```js
10277
10406
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10279,7 +10408,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10279
10408
  * activeTabId:'id-1234',
10280
10409
  * })
10281
10410
  * ```
10282
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
10283
10411
  */
10284
10412
  activeTabId?: string;
10285
10413
  /**
@@ -10288,6 +10416,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10288
10416
  * that includes specific filter selections.
10289
10417
  *
10290
10418
  * Supported embed types: `LiveboardEmbed`
10419
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10291
10420
  * @example
10292
10421
  * ```js
10293
10422
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10296,7 +10425,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10296
10425
  * activeTabId: 'tab-guid',
10297
10426
  * })
10298
10427
  * ```
10299
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10300
10428
  */
10301
10429
  personalizedViewId?: string;
10302
10430
  /**
@@ -10317,13 +10445,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10317
10445
  * Show a preview image of the visualization before the visualization loads.
10318
10446
  * Only works for visualizations embeds with a viz id.
10319
10447
  *
10320
- * Also, viz snashot should be enabled in the ThoughtSpot instance.
10448
+ * Also, viz snapshot should be enabled in the ThoughtSpot instance.
10321
10449
  * Contact ThoughtSpot support to enable this feature.
10322
10450
  *
10323
- * Since, this will show preview images, be careful that it may show
10451
+ * Since this will show preview images, be careful that it may show
10324
10452
  * undesired data to the user when using row level security.
10325
10453
  *
10326
10454
  * Supported embed types: `LiveboardEmbed`
10455
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
10327
10456
  * @example
10328
10457
  * ```js
10329
10458
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10333,7 +10462,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10333
10462
  * });
10334
10463
  * embed.render();
10335
10464
  * ```
10336
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
10337
10465
  */
10338
10466
  showPreviewLoader?: boolean;
10339
10467
  /**
@@ -10341,13 +10469,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10341
10469
  *
10342
10470
  * Supported embed types: `LiveboardEmbed`
10343
10471
  * @hidden
10344
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10472
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10345
10473
  * @example
10346
10474
  * ```js
10347
10475
  * const embed = new LiveboardEmbed('#tsEmbed', {
10348
10476
  * ... //other embed view config
10349
- * oAuthPollingInterval: value in milliseconds,
10477
+ * oAuthPollingInterval: 30000,
10350
10478
  * })
10479
+ * ```
10351
10480
  */
10352
10481
  oAuthPollingInterval?: number;
10353
10482
  /**
@@ -10355,35 +10484,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10355
10484
  *
10356
10485
  * Supported embed types: `LiveboardEmbed`
10357
10486
  * @hidden
10358
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10487
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10359
10488
  * @example
10360
10489
  * ```js
10361
10490
  * const embed = new LiveboardEmbed('#tsEmbed', {
10362
10491
  * ... //other embed view config
10363
10492
  * isForceRedirect: false,
10364
10493
  * })
10494
+ * ```
10365
10495
  */
10366
10496
  isForceRedirect?: boolean;
10367
10497
  /**
10368
10498
  * The source connection ID for authentication.
10369
- * @hidden
10370
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10371
10499
  *
10372
10500
  * Supported embed types: `LiveboardEmbed`
10501
+ * @hidden
10502
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10373
10503
  * @example
10374
10504
  * ```js
10375
10505
  * const embed = new LiveboardEmbed('#tsEmbed', {
10376
10506
  * ... //other embed view config
10377
10507
  * dataSourceId: '',
10378
10508
  * })
10509
+ * ```
10379
10510
  */
10380
10511
  dataSourceId?: string;
10381
10512
  /**
10382
- * The list of tab IDs to hide from the embedded.
10383
- * This Tabs will be hidden from their respective LBs.
10384
- * Use this to hide an tabID.
10513
+ * The list of tab IDs to hide from the embedded Liveboard.
10514
+ * These tabs will be hidden from their respective Liveboards.
10515
+ * Use this to hide a tab ID.
10385
10516
  *
10386
10517
  * Supported embed types: `LiveboardEmbed`
10518
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
10387
10519
  * @example
10388
10520
  * ```js
10389
10521
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10394,7 +10526,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10394
10526
  * ]
10395
10527
  * });
10396
10528
  * ```
10397
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
10398
10529
  */
10399
10530
  hiddenTabs?: string[];
10400
10531
  /**
@@ -10418,7 +10549,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10418
10549
  */
10419
10550
  visibleTabs?: string[];
10420
10551
  /**
10421
- * This flag is used to enable/disable the styling and grouping in a Liveboard
10552
+ * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
10553
+ * @deprecated This flag is deprecated.
10422
10554
  *
10423
10555
  * Supported embed types: `LiveboardEmbed`, `AppEmbed`
10424
10556
  * @type {boolean}
@@ -10434,7 +10566,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10434
10566
  */
10435
10567
  isLiveboardStylingAndGroupingEnabled?: boolean;
10436
10568
  /**
10437
- * This flag is used to enable/disable the png embedding of liveboard in scheduled mails
10569
+ * This flag is used to enable/disable the png embedding of liveboard in scheduled
10570
+ * mails
10438
10571
  *
10439
10572
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
10440
10573
  * @type {boolean}
@@ -10484,6 +10617,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10484
10617
  /**
10485
10618
  * This flag is used to enable the full height lazy load data.
10486
10619
  *
10620
+ * @type {boolean}
10621
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10622
+ * @default false
10487
10623
  * @example
10488
10624
  * ```js
10489
10625
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -10492,33 +10628,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10492
10628
  * lazyLoadingForFullHeight: true,
10493
10629
  * })
10494
10630
  * ```
10495
- *
10496
- * @type {boolean}
10497
- * @default false
10498
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
10499
10631
  */
10500
10632
  lazyLoadingForFullHeight?: boolean;
10501
10633
  /**
10502
10634
  * The margin to be used for lazy loading.
10503
10635
  *
10504
10636
  * For example, if the margin is set to '10px',
10505
- * the visualization will be loaded 10px before the its top edge is visible in the
10637
+ * the visualization will be loaded 10px before its top edge is visible in the
10506
10638
  * viewport.
10507
10639
  *
10508
10640
  * The format is similar to CSS margin.
10509
10641
  *
10642
+ * @type {string}
10643
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10510
10644
  * @example
10511
10645
  * ```js
10512
10646
  * const embed = new LiveboardEmbed('#embed-container', {
10513
10647
  * // ...other options
10514
10648
  * fullHeight: true,
10515
10649
  * lazyLoadingForFullHeight: true,
10516
- * // Using 0px, the visualization will be only loaded when its visible in the viewport.
10650
+ * // Using 0px, the visualization will be only loaded when it's visible in the viewport.
10517
10651
  * lazyLoadingMargin: '0px',
10518
10652
  * })
10519
10653
  * ```
10520
- * @type {string}
10521
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
10522
10654
  */
10523
10655
  lazyLoadingMargin?: string;
10524
10656
  /**
@@ -10526,6 +10658,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10526
10658
  * of the spotter underneath the chat input.
10527
10659
  * default is false.
10528
10660
  *
10661
+ * @type {boolean}
10662
+ * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
10529
10663
  * @example
10530
10664
  * ```js
10531
10665
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -10533,14 +10667,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10533
10667
  * showSpotterLimitations: true,
10534
10668
  * })
10535
10669
  * ```
10536
- * @type {boolean}
10537
- * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
10538
10670
  */
10539
10671
  showSpotterLimitations?: boolean;
10540
10672
  /**
10541
10673
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
10542
10674
  *
10543
10675
  * Supported embed types: `LiveboardEmbed`
10676
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
10544
10677
  * @default false
10545
10678
  * @example
10546
10679
  * ```js
@@ -10549,7 +10682,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10549
10682
  * updatedSpotterChatPrompt : true,
10550
10683
  * })
10551
10684
  * ```
10552
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
10553
10685
  */
10554
10686
  updatedSpotterChatPrompt?: boolean;
10555
10687
  /**
@@ -10557,6 +10689,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10557
10689
  * branding in tool response cards.
10558
10690
  *
10559
10691
  * Supported embed types: `LiveboardEmbed`
10692
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10560
10693
  * @example
10561
10694
  * ```js
10562
10695
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10567,7 +10700,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10567
10700
  * },
10568
10701
  * })
10569
10702
  * ```
10570
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10571
10703
  */
10572
10704
  spotterChatConfig?: SpotterChatViewConfig;
10573
10705
  }
@@ -10734,9 +10866,9 @@ export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null
10734
10866
  export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
10735
10867
  /**
10736
10868
  * Reloads the ThoughtSpot iframe.
10869
+ * @version SDK: 1.43.1
10737
10870
  * @param iFrame
10738
10871
  * @group Global methods
10739
- * @version SDK: 1.43.1
10740
10872
  */
10741
10873
  export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
10742
10874
  export type SessionInfo = {
@@ -10838,6 +10970,9 @@ export interface PreRenderProps {
10838
10970
  * PreRender id to be used for PreRendering the embed.
10839
10971
  * Use PreRender to render the embed in the background and then
10840
10972
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
10973
+ *
10974
+ * Use PreRendered react component for pre rendering embed components.
10975
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
10841
10976
  * @example
10842
10977
  * ```js
10843
10978
  * const embed = new LiveboardEmbed('#embed', {
@@ -10846,8 +10981,6 @@ export interface PreRenderProps {
10846
10981
  * });
10847
10982
  * embed.showPreRender();
10848
10983
  * ```
10849
- *
10850
- * Use PreRendered react component for pre rendering embed components.
10851
10984
  * @example
10852
10985
  * ```tsx
10853
10986
  * function LandingPageComponent() {
@@ -10858,7 +10991,6 @@ export interface PreRenderProps {
10858
10991
  * return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
10859
10992
  * }
10860
10993
  * ```
10861
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
10862
10994
  */
10863
10995
  preRenderId: string;
10864
10996
  }
@@ -10882,7 +11014,7 @@ export interface AppProps extends EmbedProps, AppViewConfig {
10882
11014
  * React component for Full app Embed.
10883
11015
  * @example
10884
11016
  * ```tsx
10885
- * function Search() {
11017
+ * function App() {
10886
11018
  * return <AppEmbed
10887
11019
  * showPrimaryNavbar={false}
10888
11020
  * pageId={Page.Liveboards}
@@ -10893,9 +11025,9 @@ export interface AppProps extends EmbedProps, AppViewConfig {
10893
11025
  */
10894
11026
  declare const AppEmbed$1: React$1.ForwardRefExoticComponent<AppProps & React$1.RefAttributes<AppEmbed>>;
10895
11027
  /**
10896
- * React component for PreRendered Liveboard embed.
11028
+ * React component for PreRendered App embed.
10897
11029
  *
10898
- * PreRenderedAppEmbed will preRender the SearchBarEmbed and will be hidden by
11030
+ * PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
10899
11031
  * default.
10900
11032
  *
10901
11033
  * AppEmbed with preRenderId passed will call showPreRender on the embed.
@@ -10936,7 +11068,7 @@ declare const LiveboardEmbed$1: React$1.ForwardRefExoticComponent<LiveboardProps
10936
11068
  * LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
10937
11069
  *
10938
11070
  * If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
10939
- * tries to preRender the LiveboardEmbed, so it is recommended to use pass the
11071
+ * tries to preRender the LiveboardEmbed, so it is recommended to pass the
10940
11072
  * liveboardId to both the components.
10941
11073
  * @example
10942
11074
  * ```tsx
@@ -10966,7 +11098,7 @@ export interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
10966
11098
  */
10967
11099
  declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & React$1.RefAttributes<SearchBarEmbed>>;
10968
11100
  /**
10969
- * React component for PreRendered Liveboard embed.
11101
+ * React component for PreRendered SearchBar embed.
10970
11102
  *
10971
11103
  * PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
10972
11104
  * default.
@@ -11000,9 +11132,9 @@ export interface SageEmbedProps extends EmbedProps, SageViewConfig {
11000
11132
  */
11001
11133
  declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
11002
11134
  /**
11003
- * React component for PreRendered Liveboard embed.
11135
+ * React component for PreRendered Sage embed.
11004
11136
  *
11005
- * PreRenderedSageEmbed will preRender the SearchBarEmbed and will be hidden by
11137
+ * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
11006
11138
  * default.
11007
11139
  *
11008
11140
  * SageEmbed with preRenderId passed will call showPreRender on the embed.
@@ -11040,8 +11172,8 @@ export interface ConversationEmbedProps extends EmbedProps, ConversationViewConf
11040
11172
  declare const SpotterEmbed$1: React$1.ForwardRefExoticComponent<SpotterEmbedProps & React$1.RefAttributes<SpotterEmbed>>;
11041
11173
  /**
11042
11174
  * React component for LLM based conversation BI.
11043
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
11044
11175
  * Use {@link SpotterEmbed} instead
11176
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
11045
11177
  * @example
11046
11178
  * ```tsx
11047
11179
  * function Sage() {
@@ -11070,6 +11202,7 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
11070
11202
  * This component renders a single message response from your ThoughtSpot conversation,
11071
11203
  * showing charts, visualizations, or text responses based on the user's query.
11072
11204
  *
11205
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
11073
11206
  * @example
11074
11207
  * ```tsx
11075
11208
  * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
@@ -11086,7 +11219,6 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
11086
11219
  * />
11087
11220
  * }
11088
11221
  * ```
11089
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
11090
11222
  */
11091
11223
  export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
11092
11224
  message: SpotterAgentMessageViewConfig;
@@ -11098,7 +11230,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
11098
11230
  * PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
11099
11231
  * default.
11100
11232
  *
11101
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
11233
+ * SpotterEmbed with preRenderId passed will call showPreRender on the embed.
11102
11234
  * @example
11103
11235
  * ```tsx
11104
11236
  * function LandingPageComponent() {
@@ -11131,6 +11263,7 @@ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof L
11131
11263
  export declare function useEmbedRef<T extends EmbedComponent>(): React$1.MutableRefObject<React$1.ComponentRef<T>>;
11132
11264
  /**
11133
11265
  *
11266
+ * @version SDK: 1.36.2 | ThoughtSpot: *
11134
11267
  * @param config - EmbedConfig
11135
11268
  * @returns AuthEventEmitter
11136
11269
  * @example
@@ -11140,7 +11273,6 @@ export declare function useEmbedRef<T extends EmbedComponent>(): React$1.Mutable
11140
11273
  * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
11141
11274
  * }
11142
11275
  * ```
11143
- * @version SDK: 1.36.2 | ThoughtSpot: *
11144
11276
  */
11145
11277
  export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<AuthEventEmitter>;
11146
11278
  /**
@@ -11149,6 +11281,7 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
11149
11281
  * This hook provides a sendMessage function that allows you to send natural language
11150
11282
  * queries to your data and get back AI-generated responses with visualizations.
11151
11283
  *
11284
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
11152
11285
  * @param config - Configuration object containing worksheetId and other options
11153
11286
  * @returns Object with sendMessage function that returns conversation results
11154
11287
  * @example
@@ -11166,7 +11299,6 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
11166
11299
  * }
11167
11300
  * };
11168
11301
  * ```
11169
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
11170
11302
  */
11171
11303
  export declare function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
11172
11304
  sendMessage: (query: string) => Promise<{