@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.2

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 (173) 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 -4
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/css-variables.d.ts +17 -17
  7. package/cjs/src/embed/app.d.ts +60 -32
  8. package/cjs/src/embed/app.d.ts.map +1 -1
  9. package/cjs/src/embed/app.js +10 -3
  10. package/cjs/src/embed/app.js.map +1 -1
  11. package/cjs/src/embed/app.spec.js +34 -1
  12. package/cjs/src/embed/app.spec.js.map +1 -1
  13. package/cjs/src/embed/base.d.ts +2 -2
  14. package/cjs/src/embed/base.js +2 -2
  15. package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
  16. package/cjs/src/embed/bodyless-conversation.js +4 -4
  17. package/cjs/src/embed/conversation.d.ts +43 -30
  18. package/cjs/src/embed/conversation.d.ts.map +1 -1
  19. package/cjs/src/embed/conversation.js +10 -11
  20. package/cjs/src/embed/conversation.js.map +1 -1
  21. package/cjs/src/embed/conversation.spec.js +27 -0
  22. package/cjs/src/embed/conversation.spec.js.map +1 -1
  23. package/cjs/src/embed/liveboard.d.ts +40 -34
  24. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  25. package/cjs/src/embed/liveboard.js +1 -1
  26. package/cjs/src/embed/liveboard.js.map +1 -1
  27. package/cjs/src/embed/liveboard.spec.js +1 -1
  28. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  29. package/cjs/src/embed/sage.d.ts +5 -5
  30. package/cjs/src/embed/sage.js +1 -1
  31. package/cjs/src/embed/search-bar.d.ts +7 -7
  32. package/cjs/src/embed/search-bar.js +1 -1
  33. package/cjs/src/embed/search.d.ts +13 -12
  34. package/cjs/src/embed/search.d.ts.map +1 -1
  35. package/cjs/src/embed/search.js.map +1 -1
  36. package/cjs/src/embed/ts-embed.d.ts +3 -3
  37. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  38. package/cjs/src/embed/ts-embed.js +12 -6
  39. package/cjs/src/embed/ts-embed.js.map +1 -1
  40. package/cjs/src/embed/ts-embed.spec.js +35 -0
  41. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  42. package/cjs/src/react/index.d.ts +15 -15
  43. package/cjs/src/react/index.js +12 -12
  44. package/cjs/src/tokenizedFetch.d.ts +1 -1
  45. package/cjs/src/tokenizedFetch.js +1 -1
  46. package/cjs/src/types.d.ts +294 -255
  47. package/cjs/src/types.d.ts.map +1 -1
  48. package/cjs/src/types.js +206 -200
  49. package/cjs/src/types.js.map +1 -1
  50. package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
  51. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  52. package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
  53. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  54. package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
  55. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  56. package/cjs/src/utils.d.ts +9 -0
  57. package/cjs/src/utils.d.ts.map +1 -1
  58. package/cjs/src/utils.js +10 -1
  59. package/cjs/src/utils.js.map +1 -1
  60. package/dist/{index-Vyh6Ha5f.js → index-DkizS4xM.js} +1 -1
  61. package/dist/src/auth.d.ts +29 -4
  62. package/dist/src/auth.d.ts.map +1 -1
  63. package/dist/src/css-variables.d.ts +17 -17
  64. package/dist/src/embed/app.d.ts +60 -32
  65. package/dist/src/embed/app.d.ts.map +1 -1
  66. package/dist/src/embed/base.d.ts +2 -2
  67. package/dist/src/embed/bodyless-conversation.d.ts +5 -5
  68. package/dist/src/embed/conversation.d.ts +43 -30
  69. package/dist/src/embed/conversation.d.ts.map +1 -1
  70. package/dist/src/embed/liveboard.d.ts +40 -34
  71. package/dist/src/embed/liveboard.d.ts.map +1 -1
  72. package/dist/src/embed/sage.d.ts +5 -5
  73. package/dist/src/embed/search-bar.d.ts +7 -7
  74. package/dist/src/embed/search.d.ts +13 -12
  75. package/dist/src/embed/search.d.ts.map +1 -1
  76. package/dist/src/embed/ts-embed.d.ts +3 -3
  77. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  78. package/dist/src/react/index.d.ts +15 -15
  79. package/dist/src/tokenizedFetch.d.ts +1 -1
  80. package/dist/src/types.d.ts +294 -255
  81. package/dist/src/types.d.ts.map +1 -1
  82. package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
  83. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  84. package/dist/src/utils.d.ts +9 -0
  85. package/dist/src/utils.d.ts.map +1 -1
  86. package/dist/tsembed-react.es.js +307 -275
  87. package/dist/tsembed-react.js +306 -274
  88. package/dist/tsembed.es.js +299 -267
  89. package/dist/tsembed.js +298 -266
  90. package/dist/visual-embed-sdk-react-full.d.ts +520 -409
  91. package/dist/visual-embed-sdk-react.d.ts +518 -407
  92. package/dist/visual-embed-sdk.d.ts +519 -408
  93. package/lib/package.json +1 -1
  94. package/lib/src/auth.d.ts +29 -4
  95. package/lib/src/auth.d.ts.map +1 -1
  96. package/lib/src/auth.js +29 -4
  97. package/lib/src/auth.js.map +1 -1
  98. package/lib/src/css-variables.d.ts +17 -17
  99. package/lib/src/embed/app.d.ts +60 -32
  100. package/lib/src/embed/app.d.ts.map +1 -1
  101. package/lib/src/embed/app.js +11 -4
  102. package/lib/src/embed/app.js.map +1 -1
  103. package/lib/src/embed/app.spec.js +34 -1
  104. package/lib/src/embed/app.spec.js.map +1 -1
  105. package/lib/src/embed/base.d.ts +2 -2
  106. package/lib/src/embed/base.js +2 -2
  107. package/lib/src/embed/bodyless-conversation.d.ts +5 -5
  108. package/lib/src/embed/bodyless-conversation.js +4 -4
  109. package/lib/src/embed/conversation.d.ts +43 -30
  110. package/lib/src/embed/conversation.d.ts.map +1 -1
  111. package/lib/src/embed/conversation.js +11 -11
  112. package/lib/src/embed/conversation.js.map +1 -1
  113. package/lib/src/embed/conversation.spec.js +27 -0
  114. package/lib/src/embed/conversation.spec.js.map +1 -1
  115. package/lib/src/embed/liveboard.d.ts +40 -34
  116. package/lib/src/embed/liveboard.d.ts.map +1 -1
  117. package/lib/src/embed/liveboard.js +1 -1
  118. package/lib/src/embed/liveboard.js.map +1 -1
  119. package/lib/src/embed/liveboard.spec.js +1 -1
  120. package/lib/src/embed/liveboard.spec.js.map +1 -1
  121. package/lib/src/embed/sage.d.ts +5 -5
  122. package/lib/src/embed/sage.js +1 -1
  123. package/lib/src/embed/search-bar.d.ts +7 -7
  124. package/lib/src/embed/search-bar.js +1 -1
  125. package/lib/src/embed/search.d.ts +13 -12
  126. package/lib/src/embed/search.d.ts.map +1 -1
  127. package/lib/src/embed/search.js.map +1 -1
  128. package/lib/src/embed/ts-embed.d.ts +3 -3
  129. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  130. package/lib/src/embed/ts-embed.js +12 -6
  131. package/lib/src/embed/ts-embed.js.map +1 -1
  132. package/lib/src/embed/ts-embed.spec.js +35 -0
  133. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  134. package/lib/src/react/index.d.ts +15 -15
  135. package/lib/src/react/index.js +12 -12
  136. package/lib/src/tokenizedFetch.d.ts +1 -1
  137. package/lib/src/tokenizedFetch.js +1 -1
  138. package/lib/src/types.d.ts +294 -255
  139. package/lib/src/types.d.ts.map +1 -1
  140. package/lib/src/types.js +206 -200
  141. package/lib/src/types.js.map +1 -1
  142. package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
  143. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  144. package/lib/src/utils/graphql/answerService/answerService.js +5 -3
  145. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  146. package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
  147. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  148. package/lib/src/utils.d.ts +9 -0
  149. package/lib/src/utils.d.ts.map +1 -1
  150. package/lib/src/utils.js +8 -0
  151. package/lib/src/utils.js.map +1 -1
  152. package/package.json +1 -1
  153. package/src/auth.ts +29 -4
  154. package/src/css-variables.ts +17 -17
  155. package/src/embed/app.spec.ts +46 -1
  156. package/src/embed/app.ts +72 -35
  157. package/src/embed/base.ts +2 -2
  158. package/src/embed/bodyless-conversation.ts +5 -5
  159. package/src/embed/conversation.spec.ts +37 -0
  160. package/src/embed/conversation.ts +55 -38
  161. package/src/embed/liveboard.spec.ts +1 -1
  162. package/src/embed/liveboard.ts +40 -34
  163. package/src/embed/sage.ts +5 -5
  164. package/src/embed/search-bar.tsx +7 -7
  165. package/src/embed/search.ts +13 -12
  166. package/src/embed/ts-embed.spec.ts +42 -0
  167. package/src/embed/ts-embed.ts +11 -6
  168. package/src/react/index.tsx +15 -15
  169. package/src/tokenizedFetch.ts +1 -1
  170. package/src/types.ts +293 -254
  171. package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
  172. package/src/utils/graphql/answerService/answerService.ts +6 -3
  173. package/src/utils.ts +14 -0
package/src/types.ts CHANGED
@@ -10,7 +10,7 @@ import { CustomCssVariables } from './css-variables';
10
10
  import type { SessionInterface } from './utils/graphql/answerService/answerService';
11
11
 
12
12
  /**
13
- * The authentication mechanism for allowing access to the
13
+ * The authentication mechanism for allowing access to
14
14
  * the embedded app
15
15
  * @group Authentication / Init
16
16
  */
@@ -36,6 +36,7 @@ export enum AuthType {
36
36
  * To use this:
37
37
  * Your SAML or OpenID provider must allow iframe redirects.
38
38
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
39
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
39
40
  * @example
40
41
  * ```js
41
42
  * init({
@@ -43,18 +44,17 @@ export enum AuthType {
43
44
  * authType: AuthType.EmbeddedSSO,
44
45
  * });
45
46
  * ```
46
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
47
47
  */
48
48
  EmbeddedSSO = 'EmbeddedSSO',
49
49
  /**
50
- * SSO using SAML
51
- * @deprecated Use {@link SAMLRedirect} instead
50
+ * SSO using SAML, Use {@link SAMLRedirect} instead
51
+ * @deprecated This option is deprecated.
52
52
  * @hidden
53
53
  */
54
54
  SSO = 'SSO_SAML',
55
55
  /**
56
- * SSO using SAML
57
- * @deprecated Use {@link SAMLRedirect} instead
56
+ * SSO using SAML, Use {@link SAMLRedirect} instead
57
+ * @deprecated This option is deprecated.
58
58
  * @hidden
59
59
  */
60
60
  SAML = 'SSO_SAML',
@@ -105,8 +105,9 @@ export enum AuthType {
105
105
  SAMLRedirect = 'SSO_SAML',
106
106
  /**
107
107
  * SSO using OIDC
108
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
109
+ * @deprecated This option is deprecated.
108
110
  * @hidden
109
- * @deprecated Use {@link OIDCRedirect} instead
110
111
  */
111
112
  OIDC = 'SSO_OIDC',
112
113
  /**
@@ -117,8 +118,9 @@ export enum AuthType {
117
118
  OIDCRedirect = 'SSO_OIDC',
118
119
  /**
119
120
  * Trusted authentication server
121
+ * Use {@link TrustedAuth} instead
122
+ * @deprecated This option is deprecated.
120
123
  * @hidden
121
- * @deprecated Use {@link TrustedAuth} instead
122
124
  */
123
125
  AuthServer = 'AuthServer',
124
126
  /**
@@ -145,6 +147,7 @@ export enum AuthType {
145
147
  * obtained from ThoughtSpot. This uses a cookieless authentication
146
148
  * approach, recommended to bypass the third-party cookie-blocking restriction
147
149
  * implemented by some browsers.
150
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
148
151
  * @example
149
152
  * ```js
150
153
  * init({
@@ -155,8 +158,8 @@ export enum AuthType {
155
158
  * .then((response) => response.json())
156
159
  * .then((data) => data.token);
157
160
  * }
161
+ * });
158
162
  * ```
159
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
160
163
  */
161
164
  TrustedAuthTokenCookieless = 'AuthServerCookieless',
162
165
  /**
@@ -177,43 +180,43 @@ export enum HomeLeftNavItem {
177
180
  /**
178
181
  * The *Search data* option in
179
182
  * the *Insights* left navigation panel.
180
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
183
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
181
184
  */
182
185
  SearchData = 'search-data',
183
186
  /**
184
187
  * The *Home* menu option in
185
188
  * the *Insights* left navigation panel.
186
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
189
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
187
190
  */
188
191
  Home = 'insights-home',
189
192
  /**
190
193
  * The *Liveboards* menu option in
191
194
  * the *Insights* left navigation panel.
192
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
195
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
193
196
  */
194
197
  Liveboards = 'liveboards',
195
198
  /**
196
199
  * The *Answers* menu option in
197
200
  * the *Insights* left navigation panel.
198
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
201
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
199
202
  */
200
203
  Answers = 'answers',
201
204
  /**
202
205
  * The *Monitor subscriptions* menu option in
203
206
  * the *Insights* left navigation panel.
204
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
207
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
205
208
  */
206
209
  MonitorSubscription = 'monitor-alerts',
207
210
  /**
208
211
  * The *SpotIQ analysis* menu option in
209
212
  * the *Insights* left navigation panel.
210
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
213
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
211
214
  */
212
215
  SpotIQAnalysis = 'spotiq-analysis',
213
216
  /**
214
217
  * The *Liveboard schedules* menu option in
215
218
  * the *Insights* left navigation panel.
216
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
219
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
217
220
  */
218
221
  LiveboardSchedules = 'liveboard-schedules',
219
222
  /**
@@ -390,8 +393,8 @@ export interface EmbedConfig {
390
393
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
391
394
  * open the SAML auth flow in a popup, instead of redirecting the browser in
392
395
  * place.
396
+ * @deprecated This option is deprecated.
393
397
  * @default false
394
- * @deprecated
395
398
  */
396
399
  noRedirect?: boolean;
397
400
 
@@ -401,8 +404,8 @@ export interface EmbedConfig {
401
404
  *
402
405
  * Need to use this with `authTriggerContainer`. Or manually trigger
403
406
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
404
- * @default false
405
407
  * @version SDK: 1.18.0
408
+ * @default false
406
409
  */
407
410
  inPopup?: boolean;
408
411
 
@@ -412,7 +415,7 @@ export interface EmbedConfig {
412
415
  * terminated.
413
416
  *
414
417
  * Eg: "/dashboard", "#/foo" [Do not include the host]
415
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
418
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
416
419
  */
417
420
  redirectPath?: string;
418
421
 
@@ -495,7 +498,7 @@ export interface EmbedConfig {
495
498
  detectCookieAccessSlow?: boolean;
496
499
  /**
497
500
  * Hide the `beta` alert warning message for SearchEmbed.
498
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
501
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
499
502
  */
500
503
  suppressSearchEmbedBetaWarning?: boolean;
501
504
  /**
@@ -512,6 +515,7 @@ export interface EmbedConfig {
512
515
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
513
516
  * button that the user can click to trigger the flow.
514
517
  * This attribute sets a containing element for that button.
518
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
515
519
  * @example
516
520
  * ```js
517
521
  * init({
@@ -520,7 +524,6 @@ export interface EmbedConfig {
520
524
  * authTriggerContainer: '#auth-trigger-container'
521
525
  * })
522
526
  * ```
523
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
524
527
  */
525
528
  authTriggerContainer?: string | HTMLElement;
526
529
  /**
@@ -537,11 +540,10 @@ export interface EmbedConfig {
537
540
  */
538
541
  authTriggerText?: string;
539
542
  /**
540
- * Prevent users from accessing the full application or ThoughtSpot application pages
541
- * access to the embedded application users
542
- * outside of the iframe.
543
- * @default true
543
+ * Prevent embedded application users from accessing ThoughtSpot
544
+ * application pages outside of the iframe.
544
545
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
546
+ * @default true
545
547
  */
546
548
  blockNonEmbedFullAppAccess?: boolean;
547
549
 
@@ -575,6 +577,7 @@ export interface EmbedConfig {
575
577
  * other logs such as warnings, information alerts,
576
578
  * and debug messages in the console output.
577
579
  *
580
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
578
581
  * @default LogLevel.ERROR
579
582
  * @example
580
583
  * ```js
@@ -583,7 +586,6 @@ export interface EmbedConfig {
583
586
  * logLevel: LogLevel.SILENT
584
587
  * })
585
588
  * ```
586
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
587
589
  */
588
590
  logLevel?: LogLevel;
589
591
  /**
@@ -611,6 +613,7 @@ export interface EmbedConfig {
611
613
  * This flag is used to disable the token verification in the SDK.
612
614
  * Enabling this flag will also disable the caching of the token.
613
615
  * @hidden
616
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
614
617
  * @example
615
618
  * ```js
616
619
  * init({
@@ -618,13 +621,12 @@ export interface EmbedConfig {
618
621
  * disableTokenVerification : true
619
622
  * })
620
623
  * ```
621
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
622
624
  */
623
625
  disableTokenVerification?: boolean;
624
626
 
625
627
  /**
626
628
  * This flag is used to disable showing the login failure page in the embedded app.
627
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
629
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
628
630
  */
629
631
  disableLoginFailurePage?: boolean;
630
632
  /**
@@ -634,6 +636,7 @@ export interface EmbedConfig {
634
636
  * Warning: This option is for advanced use only and is used internally
635
637
  * to control embed behavior in non-regular ways. We do not publish the
636
638
  * list of supported keys and values associated with each.
639
+ * @version SDK: 1.33.5 | ThoughtSpot: *
637
640
  * @example
638
641
  * ```js
639
642
  * const embed = new LiveboardEmbed('#embed', {
@@ -644,12 +647,12 @@ export interface EmbedConfig {
644
647
  * }
645
648
  * });
646
649
  * ```
647
- * @version SDK: 1.33.5 | ThoughtSpot: *
648
650
  */
649
651
  additionalFlags?: { [key: string]: string | number | boolean };
650
652
  /**
651
653
  * This is an object (key/val) for customVariables being
652
654
  * used by the third party tool's script.
655
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
653
656
  * @example
654
657
  * ```js
655
658
  * const embed = new LiveboardEmbed('#embed', {
@@ -660,7 +663,6 @@ export interface EmbedConfig {
660
663
  * }
661
664
  * });
662
665
  * ```
663
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
664
666
  */
665
667
  customVariablesForThirdPartyTools?: Record<string, any>;
666
668
 
@@ -669,8 +671,8 @@ export interface EmbedConfig {
669
671
  /**
670
672
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
671
673
  * and exiting fullscreen mode for embedded visualizations during presentations.
672
- * @default true (feature is disabled by default)
673
674
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
675
+ * @default true (feature is disabled by default)
674
676
  * @example
675
677
  * ```js
676
678
  * init({
@@ -880,7 +882,7 @@ export interface FrameParams {
880
882
  */
881
883
  loading?: 'lazy' | 'eager' | 'auto';
882
884
  /**
883
- * This parameters will be passed on the iframe
885
+ * These parameters will be passed to the iframe
884
886
  * as is.
885
887
  */
886
888
  [key: string]: string | number | boolean | undefined;
@@ -957,8 +959,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
957
959
  */
958
960
  disabledActionReason?: string;
959
961
  /**
960
- * The list of actions to hide from the embedded.
961
- * This actions will be hidden from the user.
962
+ * The list of actions to hide from the embedded view.
963
+ * These actions will be hidden from the user.
962
964
  * Use this to hide an action.
963
965
  *
964
966
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -999,7 +1001,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
999
1001
  * The locale settings to apply to the embedded view.
1000
1002
  *
1001
1003
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1002
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1004
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1003
1005
  * @example
1004
1006
  * ```js
1005
1007
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1014,12 +1016,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1014
1016
  * This is an object (key/val) of override flags which will be applied
1015
1017
  * to the internal embedded object. This can be used to add any
1016
1018
  * URL flag.
1017
- * If the same flags are passed in init, they will be overriden by the values here.
1019
+ * If the same flags are passed in init, they will be overridden by the values here.
1018
1020
  * Warning: This option is for advanced use only and is used internally
1019
1021
  * to control embed behavior in non-regular ways. We do not publish the
1020
1022
  * list of supported keys and values associated with each.
1021
1023
  *
1022
1024
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1025
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1023
1026
  * @example
1024
1027
  * ```js
1025
1028
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1031,7 +1034,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1031
1034
  * },
1032
1035
  * });
1033
1036
  * ```
1034
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1035
1037
  */
1036
1038
  additionalFlags?: { [key: string]: string | number | boolean };
1037
1039
  /**
@@ -1072,6 +1074,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1072
1074
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
1073
1075
  *
1074
1076
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1077
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1075
1078
  * @example
1076
1079
  * ```js
1077
1080
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1081,7 +1084,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1081
1084
  * });
1082
1085
  * embed.showPreRender();
1083
1086
  * ```
1084
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1085
1087
  */
1086
1088
  preRenderId?: string;
1087
1089
 
@@ -1092,7 +1094,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1092
1094
  * its dimensions based on changes to the size of the embedding element.
1093
1095
  * @type {boolean}
1094
1096
  * @default false
1095
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1097
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1096
1098
  * @example
1097
1099
  * ```js
1098
1100
  * // Disable tracking PreRender size in the configuration
@@ -1107,9 +1109,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1107
1109
  doNotTrackPreRenderSize?: boolean;
1108
1110
  /**
1109
1111
  * Enable the V2 shell. This can provide performance benefits
1110
- * due to a lighterweight shell.
1112
+ * due to a lighter-weight shell.
1111
1113
  *
1112
1114
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1115
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1113
1116
  * @example
1114
1117
  * ```js
1115
1118
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1118,7 +1121,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1118
1121
  * enableV2Shell_experimental: true,
1119
1122
  * });
1120
1123
  * ```
1121
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1122
1124
  */
1123
1125
 
1124
1126
  enableV2Shell_experimental?: boolean;
@@ -1138,6 +1140,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1138
1140
  * and disable redirection of links in a new tab.
1139
1141
  *
1140
1142
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1143
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1141
1144
  * @example
1142
1145
  * ```js
1143
1146
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1146,7 +1149,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1146
1149
  * disableRedirectionLinksInNewTab: true,
1147
1150
  * });
1148
1151
  * ```
1149
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1150
1152
  */
1151
1153
  disableRedirectionLinksInNewTab?: boolean;
1152
1154
  /**
@@ -1157,6 +1159,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1157
1159
  * Per Org URL feature is enabled on your ThoughtSpot instance.
1158
1160
  *
1159
1161
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1162
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1160
1163
  * @example
1161
1164
  * ```js
1162
1165
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1165,24 +1168,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1165
1168
  * overrideOrgId: 142536,
1166
1169
  * });
1167
1170
  * ```
1168
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1169
1171
  */
1170
1172
  overrideOrgId?: number;
1171
1173
  /**
1172
- * Flag to override the *Open Link in New Tab* context menu option.
1174
+ * Flag to override the *Open Link in New Tab* context
1175
+ * menu option.
1173
1176
  *
1174
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1177
+ * For improved link override handling, use
1178
+ * {@link enableLinkOverridesV2} instead.
1179
+ *
1180
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1181
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1182
+ * `SpotterEmbed`, `SearchBarEmbed`
1175
1183
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1176
1184
  * @example
1177
1185
  * ```js
1178
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
1179
- * const embed = new <EmbedComponent>('#tsEmbed', {
1186
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1180
1187
  * ... // other embed view config
1181
- * linkOverride:false,
1188
+ * linkOverride: true,
1182
1189
  * })
1183
1190
  * ```
1184
1191
  */
1185
1192
  linkOverride?: boolean;
1193
+ /**
1194
+ * Enables the V2 link override mechanism with improved
1195
+ * handling. When enabled, navigation links within the
1196
+ * embedded ThoughtSpot app are intercepted and routed
1197
+ * through the SDK via the `EmbedEvent.DialogOpen`
1198
+ * event.
1199
+ *
1200
+ * The SDK automatically sends {@link linkOverride}
1201
+ * alongside this flag for backward compatibility with
1202
+ * older ThoughtSpot versions.
1203
+ *
1204
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1205
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1206
+ * `SpotterEmbed`, `SearchBarEmbed`
1207
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
1208
+ * @example
1209
+ * ```js
1210
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1211
+ * ... // other embed view config
1212
+ * enableLinkOverridesV2: true,
1213
+ * });
1214
+ *
1215
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
1216
+ * console.log('Link clicked:', payload);
1217
+ * });
1218
+ * ```
1219
+ */
1220
+ enableLinkOverridesV2?: boolean;
1186
1221
  /**
1187
1222
  * The primary action to display on top of the viz for Liveboard and App Embed.
1188
1223
  * Use this to set the primary action.
@@ -1207,7 +1242,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1207
1242
  insertInToSlide?: boolean;
1208
1243
  /**
1209
1244
  * Show alert messages and toast messages in the embed.
1210
- * Supported embed in all embed types.
1245
+ * Supported in all embed types.
1211
1246
  *
1212
1247
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1213
1248
  * @example
@@ -1495,7 +1530,7 @@ export interface HomePageConfig {
1495
1530
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1496
1531
  *
1497
1532
  * Supported embed types: `AppEmbed`
1498
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1533
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1499
1534
  * @example
1500
1535
  * ```js
1501
1536
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -1516,6 +1551,7 @@ export interface HomePageConfig {
1516
1551
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1517
1552
  *
1518
1553
  * Supported embed types: `AppEmbed`
1554
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1519
1555
  * @example
1520
1556
  * ```js
1521
1557
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -1526,7 +1562,6 @@ export interface HomePageConfig {
1526
1562
  * ... //other embed view configuration attributes
1527
1563
  * })
1528
1564
  * ```
1529
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1530
1565
  */
1531
1566
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1532
1567
  }
@@ -1540,7 +1575,7 @@ export interface SearchLiveboardCommonViewConfig {
1540
1575
  * visualization, or Liveboard.
1541
1576
  *
1542
1577
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1543
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1578
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1544
1579
  * @example
1545
1580
  * ```js
1546
1581
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1558,11 +1593,11 @@ export interface SearchLiveboardCommonViewConfig {
1558
1593
  */
1559
1594
  runtimeFilters?: RuntimeFilter[];
1560
1595
  /**
1561
- * The list of parameter override to apply to a search Answer,
1596
+ * The list of parameter overrides to apply to a search Answer,
1562
1597
  * visualization, or Liveboard.
1563
1598
  *
1564
1599
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1565
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1600
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1566
1601
  * @example
1567
1602
  * ```js
1568
1603
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1582,6 +1617,7 @@ export interface SearchLiveboardCommonViewConfig {
1582
1617
  * flag to set ContextMenu Trigger to either left or right click.
1583
1618
  *
1584
1619
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
1620
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1585
1621
  * @example
1586
1622
  * ```js
1587
1623
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -1590,7 +1626,6 @@ export interface SearchLiveboardCommonViewConfig {
1590
1626
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
1591
1627
  * })
1592
1628
  * ```
1593
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1594
1629
  */
1595
1630
  contextMenuTrigger?: ContextMenuTriggerOptions;
1596
1631
  /**
@@ -1613,7 +1648,7 @@ export interface SearchLiveboardCommonViewConfig {
1613
1648
  * when set to false, runtime parameters will be included in the URL
1614
1649
  * (default behavior before SDK 1.45.0).
1615
1650
  *
1616
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
1651
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
1617
1652
  * embedded view.
1618
1653
  * @default true
1619
1654
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -1632,14 +1667,15 @@ export interface SearchLiveboardCommonViewConfig {
1632
1667
  * ... // other embed view config
1633
1668
  * collapseSearchBar: true,
1634
1669
  * });
1670
+ * ```
1635
1671
  */
1636
1672
  collapseSearchBar?: boolean;
1637
1673
  /**
1638
1674
  * Flag to control Data panel experience
1639
1675
  *
1640
1676
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1677
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1641
1678
  * @default true
1642
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1643
1679
  * @example
1644
1680
  * ```js
1645
1681
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1672,6 +1708,7 @@ export interface SearchLiveboardCommonViewConfig {
1672
1708
  * the current time period in filter results.
1673
1709
  *
1674
1710
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1711
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1675
1712
  * @example
1676
1713
  * ```js
1677
1714
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -1679,7 +1716,6 @@ export interface SearchLiveboardCommonViewConfig {
1679
1716
  * isThisPeriodInDateFiltersEnabled: true,
1680
1717
  * })
1681
1718
  * ```
1682
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1683
1719
  */
1684
1720
  isThisPeriodInDateFiltersEnabled?: boolean;
1685
1721
  }
@@ -1740,6 +1776,7 @@ export interface LiveboardAppEmbedViewConfig {
1740
1776
  * Boolean to control if Liveboard header is sticky or not.
1741
1777
  *
1742
1778
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1779
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1743
1780
  * @example
1744
1781
  * ```js
1745
1782
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1748,7 +1785,6 @@ export interface LiveboardAppEmbedViewConfig {
1748
1785
  * isLiveboardHeaderSticky: true,
1749
1786
  * });
1750
1787
  * ```
1751
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1752
1788
  */
1753
1789
  isLiveboardHeaderSticky?: boolean;
1754
1790
  /**
@@ -1756,8 +1792,8 @@ export interface LiveboardAppEmbedViewConfig {
1756
1792
  *
1757
1793
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1758
1794
  * @type {boolean}
1795
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
1759
1796
  * @default false
1760
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1761
1797
  * @example
1762
1798
  * ```js
1763
1799
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1773,8 +1809,8 @@ export interface LiveboardAppEmbedViewConfig {
1773
1809
  *
1774
1810
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1775
1811
  * @type {boolean}
1812
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
1776
1813
  * @default false
1777
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1778
1814
  * @example
1779
1815
  * ```js
1780
1816
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1790,7 +1826,7 @@ export interface LiveboardAppEmbedViewConfig {
1790
1826
  * header.
1791
1827
  *
1792
1828
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1793
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1829
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1794
1830
  * @default true
1795
1831
  * @example
1796
1832
  * ```js
@@ -1808,7 +1844,7 @@ export interface LiveboardAppEmbedViewConfig {
1808
1844
  * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
1809
1845
  *
1810
1846
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1811
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
1847
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1812
1848
  * @default false
1813
1849
  * @example
1814
1850
  * ```js
@@ -1826,7 +1862,7 @@ export interface LiveboardAppEmbedViewConfig {
1826
1862
  * compact header
1827
1863
  *
1828
1864
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1829
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1865
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1830
1866
  * @default true
1831
1867
  * @example
1832
1868
  * ```js
@@ -1859,7 +1895,7 @@ export interface LiveboardAppEmbedViewConfig {
1859
1895
  * the cover and filters pages in the Liveboard PDF.
1860
1896
  *
1861
1897
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1862
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
1898
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
1863
1899
  * @example
1864
1900
  * ```js
1865
1901
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2097,7 +2133,7 @@ export enum HomepageModule {
2097
2133
  */
2098
2134
  Search = 'SEARCH',
2099
2135
  /**
2100
- * kPI watchlist module
2136
+ * KPI watchlist module
2101
2137
  */
2102
2138
  Watchlist = 'WATCHLIST',
2103
2139
  /**
@@ -2130,7 +2166,8 @@ export enum ListPageColumns {
2130
2166
  */
2131
2167
  Favorites = 'FAVOURITE',
2132
2168
  /**
2133
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2169
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2170
+ * @deprecated This option is deprecated.
2134
2171
  */
2135
2172
  Favourite = Favorites,
2136
2173
  /**
@@ -2234,13 +2271,13 @@ export enum EmbedEvent {
2234
2271
  /**
2235
2272
  * Rendering has initialized.
2236
2273
  * @example
2237
- *```js
2274
+ * ```js
2238
2275
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
2239
2276
  * //show a loader
2240
2277
  * function showLoader() {
2241
2278
  * document.getElementById("loader");
2242
2279
  * }
2243
- *```
2280
+ * ```
2244
2281
  * @returns timestamp - The timestamp when the event was generated.
2245
2282
  */
2246
2283
  Init = 'init',
@@ -2248,11 +2285,11 @@ export enum EmbedEvent {
2248
2285
  * Authentication has either succeeded or failed.
2249
2286
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2250
2287
  * @example
2251
- *```js
2288
+ * ```js
2252
2289
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
2253
2290
  * console.log('AuthInit', payload);
2254
2291
  * })
2255
- *```
2292
+ * ```
2256
2293
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
2257
2294
  */
2258
2295
  AuthInit = 'authInit',
@@ -2261,13 +2298,13 @@ export enum EmbedEvent {
2261
2298
  * @returns timestamp - The timestamp when the event was generated.
2262
2299
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2263
2300
  * @example
2264
- *```js
2301
+ * ```js
2265
2302
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
2266
2303
  * //hide loader
2267
2304
  * function hideLoader() {
2268
2305
  * document.getElementById("loader");
2269
2306
  * }
2270
- *```
2307
+ * ```
2271
2308
  */
2272
2309
  Load = 'load',
2273
2310
  /**
@@ -2276,11 +2313,11 @@ export enum EmbedEvent {
2276
2313
  * @return data - Answer of Liveboard data
2277
2314
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2278
2315
  * @example
2279
- *```js
2316
+ * ```js
2280
2317
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
2281
2318
  * console.log('data', payload);
2282
2319
  * })
2283
- *```
2320
+ * ```
2284
2321
  * @important
2285
2322
  */
2286
2323
  Data = 'data',
@@ -2288,9 +2325,9 @@ export enum EmbedEvent {
2288
2325
  * Search query has been updated by the user.
2289
2326
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2290
2327
  * @example
2291
- *```js
2328
+ * ```js
2292
2329
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
2293
- *```
2330
+ * ```
2294
2331
  */
2295
2332
  QueryChanged = 'queryChanged',
2296
2333
  /**
@@ -2300,7 +2337,7 @@ export enum EmbedEvent {
2300
2337
  * @returns drillDownColumns - The columns on which drill down was performed
2301
2338
  * @returns nonFilteredColumns - The columns that were not filtered
2302
2339
  * @example
2303
- *```js
2340
+ * ```js
2304
2341
  * searchEmbed.on(EmbedEvent.DrillDown, {
2305
2342
  * points: {
2306
2343
  * clickedPoint,
@@ -2308,12 +2345,12 @@ export enum EmbedEvent {
2308
2345
  * },
2309
2346
  * autoDrillDown: true,
2310
2347
  * })
2311
- *```
2348
+ * ```
2312
2349
  * In this example, `VizPointDoubleClick` event is used for
2313
2350
  * triggering the `DrillDown` event when an area or specific
2314
2351
  * data point on a table or chart is double-clicked.
2315
2352
  * @example
2316
- *```js
2353
+ * ```js
2317
2354
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
2318
2355
  * console.log(payload);
2319
2356
  * const clickedPoint = payload.data.clickedPoint;
@@ -2327,7 +2364,7 @@ export enum EmbedEvent {
2327
2364
  * autoDrillDown: true,
2328
2365
  * })
2329
2366
  * })
2330
- *```
2367
+ * ```
2331
2368
  */
2332
2369
  Drilldown = 'drillDown',
2333
2370
  /**
@@ -2452,13 +2489,13 @@ export enum EmbedEvent {
2452
2489
  * The ThoughtSpot authentication session has expired.
2453
2490
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2454
2491
  * @example
2455
- *```js
2492
+ * ```js
2456
2493
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
2457
2494
  * //show auth expired banner
2458
2495
  * function showAuthExpired() {
2459
2496
  * document.getElementById("authExpiredBanner");
2460
2497
  * }
2461
- *```
2498
+ * ```
2462
2499
  */
2463
2500
  AuthExpire = 'ThoughtspotAuthExpired',
2464
2501
  /**
@@ -2495,22 +2532,22 @@ export enum EmbedEvent {
2495
2532
  * Applicable to `SearchBarEmbed` only.
2496
2533
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2497
2534
  * @example
2498
- *```js
2535
+ * ```js
2499
2536
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
2500
2537
  * .then(data => {
2501
2538
  * console.log('Answer Data:', data);
2502
2539
  * })
2503
- *```
2540
+ * ```
2504
2541
  */
2505
2542
  GetDataClick = 'getDataClick',
2506
2543
  /**
2507
2544
  * Detects the route change.
2508
2545
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
2509
2546
  * @example
2510
- *```js
2547
+ * ```js
2511
2548
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
2512
2549
  * console.log('data', payload))
2513
- *```
2550
+ * ```
2514
2551
  */
2515
2552
  RouteChange = 'ROUTE_CHANGE',
2516
2553
  /**
@@ -2520,12 +2557,12 @@ export enum EmbedEvent {
2520
2557
  V1Data = 'exportVizDataToParent',
2521
2558
  /**
2522
2559
  * Emitted when the embed does not have cookie access. This happens
2523
- * when Safari and other Web browsers block third-party cookies
2524
- * are blocked by default. `NoCookieAccess` can trigger.
2560
+ * when third-party cookies are blocked by Safari or other
2561
+ * web browsers. `NoCookieAccess` can trigger.
2525
2562
  * @example
2526
- *```js
2563
+ * ```js
2527
2564
  * appEmbed.on(EmbedEvent.NoCookieAccess)
2528
- *```
2565
+ * ```
2529
2566
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
2530
2567
  */
2531
2568
  NoCookieAccess = 'noCookieAccess',
@@ -2539,22 +2576,22 @@ export enum EmbedEvent {
2539
2576
  * Emitted when any modal is opened in the app
2540
2577
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2541
2578
  * @example
2542
- *```js
2579
+ * ```js
2543
2580
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
2544
2581
  * console.log('dialog open', payload);
2545
2582
  * })
2546
- *```
2583
+ * ```
2547
2584
  */
2548
2585
  DialogOpen = 'dialog-open',
2549
2586
  /**
2550
2587
  * Emitted when any modal is closed in the app
2551
2588
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2552
2589
  * @example
2553
- *```js
2590
+ * ```js
2554
2591
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
2555
2592
  * console.log('dialog close', payload);
2556
2593
  * })
2557
- *```
2594
+ * ```
2558
2595
  */
2559
2596
  DialogClose = 'dialog-close',
2560
2597
  /**
@@ -2563,39 +2600,39 @@ export enum EmbedEvent {
2563
2600
  * other events on the rendered Liveboard.
2564
2601
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2565
2602
  * @example
2566
- *```js
2603
+ * ```js
2567
2604
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
2568
2605
  console.log('Liveboard is rendered', payload);
2569
2606
  })
2570
- *```
2607
+ * ```
2571
2608
  * The following example shows how to trigger
2572
2609
  * `SetVisibleVizs` event using LiveboardRendered embed event:
2573
2610
  * @example
2574
- *```js
2611
+ * ```js
2575
2612
  * const embedRef = useEmbedRef();
2576
2613
  * const onLiveboardRendered = () => {
2577
2614
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
2578
2615
  * };
2579
- *```
2616
+ * ```
2580
2617
  */
2581
2618
  LiveboardRendered = 'PinboardRendered',
2582
2619
  /**
2583
2620
  * Emits all events.
2584
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2621
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2585
2622
  * @example
2586
- *```js
2623
+ * ```js
2587
2624
  * appEmbed.on(EmbedEvent.ALL, payload => {
2588
2625
  * console.log('Embed Events', payload)
2589
2626
  * })
2590
- *```
2627
+ * ```
2591
2628
  */
2592
2629
  ALL = '*',
2593
2630
  /**
2594
2631
  * Emitted when an Answer is saved in the app.
2595
2632
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
2596
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2633
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2597
2634
  * @example
2598
- *```js
2635
+ * ```js
2599
2636
  * //Emit when action starts
2600
2637
  * searchEmbed.on(EmbedEvent.Save, payload => {
2601
2638
  * console.log('Save', payload)
@@ -2606,7 +2643,7 @@ export enum EmbedEvent {
2606
2643
  * searchEmbed.on(EmbedEvent.Save, payload => {
2607
2644
  * console.log('Save', payload)
2608
2645
  * })
2609
- *```
2646
+ * ```
2610
2647
  */
2611
2648
  Save = 'save',
2612
2649
  /**
@@ -2618,11 +2655,11 @@ export enum EmbedEvent {
2618
2655
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
2619
2656
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2620
2657
  * @example
2621
- *```js
2658
+ * ```js
2622
2659
  * liveboardEmbed.on(EmbedEvent.Download, {
2623
2660
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2624
2661
  * })
2625
- *```
2662
+ * ```
2626
2663
  */
2627
2664
  Download = 'download',
2628
2665
  /**
@@ -2630,14 +2667,14 @@ export enum EmbedEvent {
2630
2667
  * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
2631
2668
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2632
2669
  * @example
2633
- *```js
2670
+ * ```js
2634
2671
  * //emit when action starts
2635
2672
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2636
2673
  * console.log('download PNG', payload)}, {start: true })
2637
2674
  * //emit when action ends
2638
2675
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2639
2676
  * console.log('download PNG', payload)})
2640
- *```
2677
+ * ```
2641
2678
  */
2642
2679
  DownloadAsPng = 'downloadAsPng',
2643
2680
  /**
@@ -2645,14 +2682,14 @@ export enum EmbedEvent {
2645
2682
  * 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.
2646
2683
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2647
2684
  * @example
2648
- *```js
2685
+ * ```js
2649
2686
  * //emit when action starts
2650
2687
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2651
2688
  * console.log('download PDF', payload)}, {start: true })
2652
2689
  * //emit when action ends
2653
2690
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2654
2691
  * console.log('download PDF', payload)})
2655
- *```
2692
+ * ```
2656
2693
  */
2657
2694
  DownloadAsPdf = 'downloadAsPdf',
2658
2695
  /**
@@ -2660,14 +2697,14 @@ export enum EmbedEvent {
2660
2697
  * 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.
2661
2698
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2662
2699
  * @example
2663
- *```js
2700
+ * ```js
2664
2701
  * //emit when action starts
2665
2702
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2666
2703
  * console.log('download CSV', payload)}, {start: true })
2667
2704
  * //emit when action ends
2668
2705
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2669
2706
  * console.log('download CSV', payload)})
2670
- *```
2707
+ * ```
2671
2708
  */
2672
2709
  DownloadAsCsv = 'downloadAsCsv',
2673
2710
  /**
@@ -2675,14 +2712,14 @@ export enum EmbedEvent {
2675
2712
  * 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.
2676
2713
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2677
2714
  * @example
2678
- *```js
2715
+ * ```js
2679
2716
  * //emit when action starts
2680
2717
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2681
2718
  * console.log('download Xlsx', payload)}, { start: true })
2682
2719
  * //emit when action ends
2683
2720
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2684
2721
  * console.log('download Xlsx', payload)})
2685
- *```
2722
+ * ```
2686
2723
  */
2687
2724
  DownloadAsXlsx = 'downloadAsXlsx',
2688
2725
  /**
@@ -2690,25 +2727,25 @@ export enum EmbedEvent {
2690
2727
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
2691
2728
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2692
2729
  * @example
2693
- *```js
2730
+ * ```js
2694
2731
  * //emit when action starts
2695
2732
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2696
2733
  * console.log('delete answer', payload)}, {start: true })
2697
2734
  * //trigger when action is completed
2698
2735
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2699
2736
  * console.log('delete answer', payload)})
2700
- *```
2737
+ * ```
2701
2738
  */
2702
2739
  AnswerDelete = 'answerDelete',
2703
2740
  /**
2704
2741
  * Emitted when the AI Highlights action is triggered on a Liveboard
2705
2742
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
2706
2743
  * @example
2707
- *```js
2744
+ * ```js
2708
2745
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
2709
2746
  * console.log('AI Highlights', payload);
2710
2747
  * })
2711
- *```
2748
+ * ```
2712
2749
  */
2713
2750
  AIHighlights = 'AIHighlights',
2714
2751
  /**
@@ -2717,7 +2754,7 @@ export enum EmbedEvent {
2717
2754
  * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
2718
2755
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2719
2756
  * @example
2720
- *```js
2757
+ * ```js
2721
2758
  * //emit when action starts
2722
2759
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2723
2760
  * console.log('pin', payload)
@@ -2728,14 +2765,14 @@ export enum EmbedEvent {
2728
2765
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2729
2766
  * console.log('pin', payload)
2730
2767
  * })
2731
- *```
2768
+ * ```
2732
2769
  */
2733
2770
  Pin = 'pin',
2734
2771
  /**
2735
2772
  * Emitted when SpotIQ analysis is triggered
2736
2773
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2737
2774
  * @example
2738
- *```js
2775
+ * ```js
2739
2776
  * //emit when action starts
2740
2777
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2741
2778
  * console.log('SpotIQAnalyze', payload)
@@ -2746,14 +2783,14 @@ export enum EmbedEvent {
2746
2783
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2747
2784
  * console.log('SpotIQ analyze', payload)
2748
2785
  * })
2749
- *```
2786
+ * ```
2750
2787
  */
2751
2788
  SpotIQAnalyze = 'spotIQAnalyze',
2752
2789
  /**
2753
2790
  * Emitted when a user shares an object with another user or group
2754
2791
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2755
2792
  * @example
2756
- *```js
2793
+ * ```js
2757
2794
  * //emit when action starts
2758
2795
  * searchEmbed.on(EmbedEvent.Share, payload => {
2759
2796
  * console.log('Share', payload)
@@ -2764,7 +2801,7 @@ export enum EmbedEvent {
2764
2801
  * searchEmbed.on(EmbedEvent.Share, payload => {
2765
2802
  * console.log('Share', payload)
2766
2803
  * })
2767
- *```
2804
+ * ```
2768
2805
  */
2769
2806
  Share = 'share',
2770
2807
  /**
@@ -2772,11 +2809,11 @@ export enum EmbedEvent {
2772
2809
  * data on a chart or table.
2773
2810
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2774
2811
  * @example
2775
- *```js
2812
+ * ```js
2776
2813
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
2777
2814
  * console.log('Drill include', payload);
2778
2815
  * })
2779
- *```
2816
+ * ```
2780
2817
  */
2781
2818
  DrillInclude = 'context-menu-item-include',
2782
2819
  /**
@@ -2784,22 +2821,22 @@ export enum EmbedEvent {
2784
2821
  * data on a chart or table
2785
2822
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2786
2823
  * @example
2787
- *```js
2824
+ * ```js
2788
2825
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
2789
2826
  * console.log('Drill exclude', payload);
2790
2827
  * })
2791
- *```
2828
+ * ```
2792
2829
  */
2793
2830
  DrillExclude = 'context-menu-item-exclude',
2794
2831
  /**
2795
2832
  * Emitted when a column value is copied in the embedded app.
2796
2833
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2797
2834
  * @example
2798
- *```js
2799
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2835
+ * ```js
2836
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2800
2837
  * console.log('copy to clipboard', payload);
2801
2838
  * })
2802
- *```
2839
+ * ```
2803
2840
  */
2804
2841
  CopyToClipboard = 'context-menu-item-copy-to-clipboard',
2805
2842
  /**
@@ -2807,10 +2844,10 @@ export enum EmbedEvent {
2807
2844
  * embedded Liveboard.
2808
2845
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2809
2846
  * @example
2810
- *```js
2847
+ * ```js
2811
2848
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
2812
2849
  * })
2813
- *```
2850
+ * ```
2814
2851
  */
2815
2852
  UpdateTML = 'updateTSL',
2816
2853
  /**
@@ -2818,11 +2855,11 @@ export enum EmbedEvent {
2818
2855
  * on an embedded Liveboard.
2819
2856
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2820
2857
  * @example
2821
- *```js
2858
+ * ```js
2822
2859
  * appEmbed.on(EmbedEvent.EditTML, payload => {
2823
2860
  * console.log('Edit TML', payload);
2824
2861
  * })
2825
- *```
2862
+ * ```
2826
2863
  */
2827
2864
  EditTML = 'editTSL',
2828
2865
  /**
@@ -2831,25 +2868,25 @@ export enum EmbedEvent {
2831
2868
  * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
2832
2869
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2833
2870
  * @example
2834
- *```js
2871
+ * ```js
2835
2872
  * //emit when action starts
2836
2873
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2837
2874
  * console.log('Export TML', payload)}, { start: true })
2838
2875
  * //emit when action ends
2839
2876
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2840
2877
  * console.log('Export TML', payload)})
2841
- *```
2878
+ * ```
2842
2879
  */
2843
2880
  ExportTML = 'exportTSL',
2844
2881
  /**
2845
2882
  * Emitted when an Answer is saved as a View.
2846
2883
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2847
2884
  * @example
2848
- *```js
2885
+ * ```js
2849
2886
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
2850
2887
  * console.log('View', payload);
2851
2888
  * })
2852
- *```
2889
+ * ```
2853
2890
  */
2854
2891
  SaveAsView = 'saveAsView',
2855
2892
  /**
@@ -2857,36 +2894,36 @@ export enum EmbedEvent {
2857
2894
  * 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.
2858
2895
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2859
2896
  * @example
2860
- *```js
2897
+ * ```js
2861
2898
  * //emit when action starts
2862
2899
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2863
2900
  * console.log('Copy and edit', payload)}, {start: true })
2864
2901
  * //emit when action ends
2865
2902
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2866
2903
  * console.log('Copy and edit', payload)})
2867
- *```
2904
+ * ```
2868
2905
  */
2869
2906
  CopyAEdit = 'copyAEdit',
2870
2907
  /**
2871
2908
  * Emitted when a user clicks *Show underlying data* on an Answer.
2872
2909
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2873
2910
  * @example
2874
- *```js
2911
+ * ```js
2875
2912
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
2876
2913
  * console.log('show data', payload);
2877
2914
  * })
2878
- *```
2915
+ * ```
2879
2916
  */
2880
2917
  ShowUnderlyingData = 'showUnderlyingData',
2881
2918
  /**
2882
2919
  * Emitted when an Answer is switched to a chart or table view.
2883
2920
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2884
2921
  * @example
2885
- *```js
2922
+ * ```js
2886
2923
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2887
2924
  * console.log('switch view', payload);
2888
2925
  * })
2889
- *```
2926
+ * ```
2890
2927
  */
2891
2928
  AnswerChartSwitcher = 'answerChartSwitcher',
2892
2929
  /**
@@ -2903,118 +2940,118 @@ export enum EmbedEvent {
2903
2940
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
2904
2941
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2905
2942
  * @example
2906
- *```js
2943
+ * ```js
2907
2944
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
2908
2945
  * console.log('Liveboard details', payload);
2909
2946
  * })
2910
- *```
2947
+ * ```
2911
2948
  */
2912
2949
  LiveboardInfo = 'pinboardInfo',
2913
2950
  /**
2914
2951
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2915
2952
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2916
2953
  * @example
2917
- *```js
2954
+ * ```js
2918
2955
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
2919
2956
  * console.log('favorites', payload);
2920
2957
  * })
2921
- *```
2958
+ * ```
2922
2959
  */
2923
2960
  AddToFavorites = 'addToFavorites',
2924
2961
  /**
2925
2962
  * Emitted when a user clicks **Schedule** on a Liveboard
2926
2963
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2927
2964
  * @example
2928
- *```js
2965
+ * ```js
2929
2966
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
2930
- * console.log(`Liveboard schedule', payload);
2967
+ * console.log('Liveboard schedule', payload);
2931
2968
  * })
2932
- *```
2969
+ * ```
2933
2970
  */
2934
2971
  Schedule = 'subscription',
2935
2972
  /**
2936
2973
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
2937
2974
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2938
2975
  * @example
2939
- *```js
2976
+ * ```js
2940
2977
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
2941
- * console.log(`Liveboard edit', payload);
2978
+ * console.log('Liveboard edit', payload);
2942
2979
  * })
2943
- *```
2980
+ * ```
2944
2981
  */
2945
2982
  Edit = 'edit',
2946
2983
  /**
2947
2984
  * Emitted when a user clicks *Make a copy* on a Liveboard
2948
2985
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2949
2986
  * @example
2950
- *```js
2987
+ * ```js
2951
2988
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
2952
- * console.log(`Copy', payload);
2989
+ * console.log('Copy', payload);
2953
2990
  * })
2954
- *```
2991
+ * ```
2955
2992
  */
2956
2993
  MakeACopy = 'makeACopy',
2957
2994
  /**
2958
2995
  * Emitted when a user clicks **Present** on a Liveboard or visualization
2959
2996
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2960
2997
  * @example
2961
- *```js
2998
+ * ```js
2962
2999
  * liveboardEmbed.on(EmbedEvent.Present)
2963
- *```
3000
+ * ```
2964
3001
  * @example
2965
- *```js
3002
+ * ```js
2966
3003
  * liveboardEmbed.on(EmbedEvent.Present, {
2967
3004
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2968
3005
  * })
2969
- *```
3006
+ * ```
2970
3007
  */
2971
3008
  Present = 'present',
2972
3009
  /**
2973
3010
  * Emitted when a user clicks **Delete** on a visualization
2974
3011
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2975
3012
  * @example
2976
- *```js
3013
+ * ```js
2977
3014
  * liveboardEmbed.on(EmbedEvent.Delete,
2978
3015
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2979
- *```
3016
+ * ```
2980
3017
  */
2981
3018
  Delete = 'delete',
2982
3019
  /**
2983
3020
  * Emitted when a user clicks Manage schedules on a Liveboard
2984
3021
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2985
3022
  * @example
2986
- *```js
3023
+ * ```js
2987
3024
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
2988
- *```
3025
+ * ```
2989
3026
  */
2990
3027
  SchedulesList = 'schedule-list',
2991
3028
  /**
2992
3029
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
2993
3030
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2994
3031
  * @example
2995
- *```js
3032
+ * ```js
2996
3033
  * liveboardEmbed.on(EmbedEvent.Cancel)
2997
- *```
3034
+ * ```
2998
3035
  */
2999
3036
  Cancel = 'cancel',
3000
3037
  /**
3001
3038
  * Emitted when a user clicks **Explore** on a visualization
3002
3039
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3003
3040
  * @example
3004
- *```js
3041
+ * ```js
3005
3042
  * liveboardEmbed.on(EmbedEvent.Explore, {
3006
3043
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3007
- *```
3044
+ * ```
3008
3045
  */
3009
3046
  Explore = 'explore',
3010
3047
  /**
3011
3048
  * Emitted when a user clicks **Copy link** action on a visualization.
3012
3049
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3013
3050
  * @example
3014
- *```js
3051
+ * ```js
3015
3052
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
3016
3053
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3017
- *```
3054
+ * ```
3018
3055
  */
3019
3056
  CopyLink = 'embedDocument',
3020
3057
  /**
@@ -3022,21 +3059,21 @@ export enum EmbedEvent {
3022
3059
  * visualization or Liveboard.
3023
3060
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3024
3061
  * @example
3025
- *```js
3062
+ * ```js
3026
3063
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3027
3064
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3028
- *```
3065
+ * ```
3029
3066
  */
3030
3067
  CrossFilterChanged = 'cross-filter-changed',
3031
3068
  /**
3032
3069
  * Emitted when a user right clicks on a visualization (chart or table)
3033
3070
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3034
3071
  * @example
3035
- *```js
3072
+ * ```js
3036
3073
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
3037
3074
  * console.log('VizPointClick', payload)
3038
3075
  * })
3039
- *```
3076
+ * ```
3040
3077
  */
3041
3078
  VizPointRightClick = 'vizPointRightClick',
3042
3079
  /**
@@ -3050,35 +3087,35 @@ export enum EmbedEvent {
3050
3087
  * filter details.
3051
3088
  * @example
3052
3089
  *
3053
- *```js
3090
+ * ```js
3054
3091
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3055
3092
  * console.log('payload', payload);
3056
3093
  * })
3057
- *
3094
+ * ```
3058
3095
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3059
3096
  */
3060
3097
  FilterChanged = 'filterChanged',
3061
3098
  /**
3062
3099
  * Emitted when a user clicks the **Go** button to initiate
3063
3100
  * a Natural Language Search query
3064
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3101
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3065
3102
  */
3066
3103
  SageEmbedQuery = 'sageEmbedQuery',
3067
3104
  /**
3068
3105
  * Emitted when a user selects a data source on the embedded
3069
3106
  * Natural Language Search interface.
3070
3107
  *
3071
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3108
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3072
3109
  */
3073
3110
  SageWorksheetUpdated = 'sageWorksheetUpdated',
3074
3111
  /**
3075
3112
  * Emitted when a user updates a connection on the **Data** page
3076
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3113
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3077
3114
  */
3078
3115
  UpdateConnection = 'updateConnection',
3079
3116
  /**
3080
3117
  * Emitted when a user updates a connection on the **Data** page
3081
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3118
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3082
3119
  */
3083
3120
  CreateConnection = 'createConnection',
3084
3121
  /**
@@ -3088,7 +3125,7 @@ export enum EmbedEvent {
3088
3125
  * @returns viewId: string
3089
3126
  * @returns liveboardId: string
3090
3127
  * @returns isPublic: boolean
3091
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3128
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3092
3129
  */
3093
3130
  UpdatePersonalisedView = 'updatePersonalisedView',
3094
3131
  /**
@@ -3097,7 +3134,7 @@ export enum EmbedEvent {
3097
3134
  * @returns viewId: string
3098
3135
  * @returns liveboardId: string
3099
3136
  * @returns isPublic: boolean
3100
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3137
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3101
3138
  */
3102
3139
  SavePersonalisedView = 'savePersonalisedView',
3103
3140
  /**
@@ -3106,19 +3143,19 @@ export enum EmbedEvent {
3106
3143
  * @returns viewId: string
3107
3144
  * @returns liveboardId: string
3108
3145
  * @returns isPublic: boolean
3109
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3146
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3110
3147
  */
3111
3148
  ResetLiveboard = 'resetLiveboard',
3112
3149
  /**
3113
3150
  * Emitted when a PersonalisedView is deleted.
3114
3151
  * @returns views: string[]
3115
3152
  * @returns liveboardId: string
3116
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3153
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3117
3154
  */
3118
3155
  DeletePersonalisedView = 'deletePersonalisedView',
3119
3156
  /**
3120
3157
  * Emitted when a user creates a Worksheet.
3121
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3158
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3122
3159
  */
3123
3160
  CreateWorksheet = 'createWorksheet',
3124
3161
  /**
@@ -3127,12 +3164,12 @@ export enum EmbedEvent {
3127
3164
  * @returns viewId: string
3128
3165
  * @returns liveboardId: string
3129
3166
  * @returns isPublic: boolean
3130
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3167
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3131
3168
  */
3132
3169
  AskSageInit = 'AskSageInit',
3133
3170
  /**
3134
3171
  * Emitted when a Liveboard or visualization is renamed.
3135
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3172
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3136
3173
  */
3137
3174
  Rename = 'rename',
3138
3175
  /**
@@ -3155,7 +3192,7 @@ export enum EmbedEvent {
3155
3192
  * - `error` - Developers can customize the user-facing error message when `execute`
3156
3193
  * is `false` by using the `error` parameters in `responder`.
3157
3194
  * - `errorText` - The error message text shown to the user.
3158
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3195
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3159
3196
  * @example
3160
3197
  *
3161
3198
  * This example blocks search operation and returns a custom error message:
@@ -3207,8 +3244,8 @@ export enum EmbedEvent {
3207
3244
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3208
3245
  * console.log('payload', payload);
3209
3246
  * })
3210
- *```
3211
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3247
+ * ```
3248
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3212
3249
  */
3213
3250
  ParameterChanged = 'parameterChanged',
3214
3251
  /**
@@ -3263,24 +3300,24 @@ export enum EmbedEvent {
3263
3300
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
3264
3301
  * console.log('payload', payload);
3265
3302
  * })
3266
- *```
3267
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3303
+ * ```
3304
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3268
3305
  */
3269
3306
  CreateLiveboard = 'createLiveboard',
3270
3307
  /**
3271
3308
  * Emitted when a user creates a Model.
3272
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3309
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3273
3310
  */
3274
3311
  CreateModel = 'createModel',
3275
3312
  /**
3276
3313
  * @hidden
3277
3314
  * Emitted when a user exits present mode.
3278
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
3315
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3279
3316
  */
3280
3317
  ExitPresentMode = 'exitPresentMode',
3281
3318
  /**
3282
3319
  * Emitted when a user requests the full height lazy load data.
3283
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
3320
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3284
3321
  * @hidden
3285
3322
  */
3286
3323
  RequestVisibleEmbedCoordinates = 'requestVisibleEmbedCoordinates',
@@ -3291,7 +3328,7 @@ export enum EmbedEvent {
3291
3328
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
3292
3329
  * console.log('payload', payload);
3293
3330
  * })
3294
- *```
3331
+ * ```
3295
3332
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3296
3333
  */
3297
3334
  SpotterData = 'SpotterData',
@@ -3302,7 +3339,7 @@ export enum EmbedEvent {
3302
3339
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
3303
3340
  * console.log('payload', payload);
3304
3341
  * })
3305
- *```
3342
+ * ```
3306
3343
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3307
3344
  */
3308
3345
  PreviewSpotterData = 'PreviewSpotterData',
@@ -3313,7 +3350,7 @@ export enum EmbedEvent {
3313
3350
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
3314
3351
  * console.log('payload', payload);
3315
3352
  * })
3316
- *```
3353
+ * ```
3317
3354
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3318
3355
  */
3319
3356
  AddToCoaching = 'addToCoaching',
@@ -3335,7 +3372,7 @@ export enum EmbedEvent {
3335
3372
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
3336
3373
  * console.log('payload', payload);
3337
3374
  * })
3338
- *```
3375
+ * ```
3339
3376
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3340
3377
  */
3341
3378
  SpotterQueryTriggered = 'SpotterQueryTriggered',
@@ -3346,7 +3383,7 @@ export enum EmbedEvent {
3346
3383
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
3347
3384
  * console.log('payload', payload);
3348
3385
  * })
3349
- *```
3386
+ * ```
3350
3387
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3351
3388
  */
3352
3389
  LastPromptEdited = 'LastPromptEdited',
@@ -3357,18 +3394,18 @@ export enum EmbedEvent {
3357
3394
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
3358
3395
  * console.log('payload', payload);
3359
3396
  * })
3360
- *```
3397
+ * ```
3361
3398
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3362
3399
  */
3363
3400
  LastPromptDeleted = 'LastPromptDeleted',
3364
3401
  /**
3365
- * Emitted when the coversation is reset in spotter embed.
3402
+ * Emitted when the conversation is reset in Spotter embed.
3366
3403
  * @example
3367
3404
  * ```js
3368
3405
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
3369
3406
  * console.log('payload', payload);
3370
3407
  * })
3371
- *```
3408
+ * ```
3372
3409
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3373
3410
  */
3374
3411
  ResetSpotterConversation = 'ResetSpotterConversation',
@@ -3379,7 +3416,7 @@ export enum EmbedEvent {
3379
3416
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
3380
3417
  * console.log('payload', payload);
3381
3418
  * })
3382
- *```
3419
+ * ```
3383
3420
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
3384
3421
  */
3385
3422
  SpotterInit = 'spotterInit',
@@ -3390,7 +3427,7 @@ export enum EmbedEvent {
3390
3427
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
3391
3428
  * console.log('payload', payload);
3392
3429
  * })
3393
- *```
3430
+ * ```
3394
3431
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
3395
3432
  */
3396
3433
  SpotterLoadComplete = 'spotterLoadComplete',
@@ -3747,7 +3784,7 @@ export enum HostEvent {
3747
3784
  * ```js
3748
3785
  * appEmbed.navigateToPage(-1)
3749
3786
  * ```
3750
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
3787
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
3751
3788
  */
3752
3789
  Navigate = 'Navigate',
3753
3790
  /**
@@ -3880,9 +3917,9 @@ export enum HostEvent {
3880
3917
  * Trigger the **Show Liveboard details** action
3881
3918
  * on an embedded Liveboard.
3882
3919
  * @example
3883
- *```js
3920
+ * ```js
3884
3921
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
3885
- *```
3922
+ * ```
3886
3923
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3887
3924
  */
3888
3925
  LiveboardInfo = 'pinboardInfo',
@@ -4010,7 +4047,7 @@ export enum HostEvent {
4010
4047
  * appEmbed.trigger(HostEvent.Remove)
4011
4048
  * ```
4012
4049
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4013
- * * @example
4050
+ * @example
4014
4051
  * ```js
4015
4052
  * liveboardEmbed.trigger(HostEvent.Remove)
4016
4053
  * ```
@@ -4101,7 +4138,7 @@ export enum HostEvent {
4101
4138
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4102
4139
  * ```
4103
4140
  * ```js
4104
- * vizEmbed.trigger((HostEvent.CopyLink)
4141
+ * vizEmbed.trigger(HostEvent.CopyLink)
4105
4142
  * ```
4106
4143
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4107
4144
  */
@@ -4118,7 +4155,7 @@ export enum HostEvent {
4118
4155
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4119
4156
  * ```
4120
4157
  * ```js
4121
- * vizEmbed.trigger((HostEvent.Present)
4158
+ * vizEmbed.trigger(HostEvent.Present)
4122
4159
  * ```
4123
4160
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4124
4161
  */
@@ -4133,23 +4170,22 @@ export enum HostEvent {
4133
4170
  * );
4134
4171
  * })
4135
4172
  * ```
4136
- * * @example
4173
+ * @example
4137
4174
  * ```js
4138
-
4139
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
4140
- * let latestSpotterVizId = '';
4141
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4142
- * latestSpotterVizId = payload.data.id;
4143
- * });
4144
- *
4145
- * spotterEmbed.trigger(HostEvent.GetTML, {
4175
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4176
+ * let latestSpotterVizId = '';
4177
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4178
+ * latestSpotterVizId = payload.data.id;
4179
+ * });
4180
+ *
4181
+ * spotterEmbed.trigger(HostEvent.GetTML, {
4146
4182
  * vizId: latestSpotterVizId
4147
4183
  * }).then((tml) => {
4148
4184
  * console.log(
4149
4185
  * tml.answer.search_query // TML representation of the search query
4150
4186
  * );
4151
4187
  * })
4152
- * ```
4188
+ * ```
4153
4189
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4154
4190
  * @important
4155
4191
  */
@@ -4213,6 +4249,11 @@ export enum HostEvent {
4213
4249
  /**
4214
4250
  * Trigger the **Download** action on charts in
4215
4251
  * the embedded view.
4252
+ * Use {@link HostEvent.DownloadAsPng} instead.
4253
+ *
4254
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4255
+ *
4256
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
4216
4257
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
4217
4258
  * @example
4218
4259
  * ```js
@@ -4231,9 +4272,6 @@ export enum HostEvent {
4231
4272
  *
4232
4273
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
4233
4274
  * ```
4234
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
4235
- * Use {@link DownloadAsPng}
4236
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4237
4275
  */
4238
4276
  Download = 'downloadAsPng',
4239
4277
  /**
@@ -4671,8 +4709,8 @@ export enum HostEvent {
4671
4709
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
4672
4710
  * console.log('parameters', parameter);
4673
4711
  * });
4674
- *```
4675
- *```js
4712
+ * ```
4713
+ * ```js
4676
4714
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
4677
4715
  * let latestSpotterVizId = '';
4678
4716
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -4680,7 +4718,7 @@ export enum HostEvent {
4680
4718
  * });
4681
4719
  *
4682
4720
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
4683
- *```
4721
+ * ```
4684
4722
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4685
4723
  */
4686
4724
  GetParameters = 'GetParameters',
@@ -4697,7 +4735,7 @@ export enum HostEvent {
4697
4735
  * Notify when info call is completed successfully
4698
4736
  * ```js
4699
4737
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
4700
- *```
4738
+ * ```
4701
4739
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4702
4740
  */
4703
4741
  InfoSuccess = 'InfoSuccess',
@@ -4800,7 +4838,7 @@ export enum HostEvent {
4800
4838
  * ```js
4801
4839
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
4802
4840
  *
4803
- *```
4841
+ * ```
4804
4842
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4805
4843
  */
4806
4844
  AddToCoaching = 'addToCoaching',
@@ -4842,7 +4880,7 @@ export enum HostEvent {
4842
4880
  * });
4843
4881
  *
4844
4882
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
4845
- *```
4883
+ * ```
4846
4884
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4847
4885
  */
4848
4886
  AnswerChartSwitcher = 'answerChartSwitcher',
@@ -4852,7 +4890,7 @@ export enum HostEvent {
4852
4890
  * This is automatically triggered by the SDK when fullscreen mode is exited.
4853
4891
  * ```js
4854
4892
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
4855
- *```
4893
+ * ```
4856
4894
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4857
4895
  */
4858
4896
  ExitPresentMode = 'exitPresentMode',
@@ -5006,6 +5044,7 @@ export enum Param {
5006
5044
  // 'both' clicks in `contextMenuTrigger` configuration.
5007
5045
  ContextMenuTrigger = 'contextMenuEnabledOnWhichClick',
5008
5046
  LinkOverride = 'linkOverride',
5047
+ EnableLinkOverridesV2 = 'enableLinkOverridesV2',
5009
5048
  blockNonEmbedFullAppAccess = 'blockNonEmbedFullAppAccess',
5010
5049
  ShowInsertToSlide = 'insertInToSlide',
5011
5050
  PrimaryNavHidden = 'primaryNavHidden',
@@ -5100,6 +5139,7 @@ export enum Param {
5100
5139
  IsThisPeriodInDateFiltersEnabled = 'isThisPeriodInDateFiltersEnabled',
5101
5140
  HideToolResponseCardBranding = 'hideToolResponseCardBranding',
5102
5141
  ToolResponseCardBrandingLabel = 'toolResponseCardBrandingLabel',
5142
+ EnableHomepageAnnouncement = 'enableHomepageAnnouncement',
5103
5143
  }
5104
5144
 
5105
5145
  /**
@@ -5260,14 +5300,14 @@ export enum Action {
5260
5300
  * ```js
5261
5301
  * disabledActions: [Action.CollapseDataPanel]
5262
5302
  * ```
5263
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5303
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5264
5304
  */
5265
5305
  CollapseDataSources = 'collapseDataSources',
5266
5306
  /**
5267
5307
  * The **Collapse data panel** icon on the Search page.
5268
5308
  * Collapses the data panel view.
5269
5309
  *
5270
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5310
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5271
5311
  *
5272
5312
  * @example
5273
5313
  * ```js
@@ -5715,13 +5755,12 @@ export enum Action {
5715
5755
  */
5716
5756
  CreateMonitor = 'createMonitor',
5717
5757
  /**
5718
- * @deprecated
5719
- * Reports errors
5758
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5759
+ * @deprecated This action is deprecated. It was used for reporting errors.
5720
5760
  * @example
5721
5761
  * ```js
5722
5762
  * disabledActions: [Action.ReportError]
5723
5763
  * ```
5724
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5725
5764
  */
5726
5765
  ReportError = 'reportError',
5727
5766
  /**
@@ -5731,7 +5770,7 @@ export enum Action {
5731
5770
  * ```js
5732
5771
  * disabledActions: [Action.SyncToSheets]
5733
5772
  * ```
5734
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5773
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5735
5774
  */
5736
5775
  SyncToSheets = 'sync-to-sheets',
5737
5776
  /**
@@ -5742,7 +5781,7 @@ export enum Action {
5742
5781
  * ```js
5743
5782
  * disabledActions: [Action.SyncToOtherApps]
5744
5783
  * ```
5745
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5784
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5746
5785
  */
5747
5786
  SyncToOtherApps = 'sync-to-other-apps',
5748
5787
  /**
@@ -5752,7 +5791,7 @@ export enum Action {
5752
5791
  * ```js
5753
5792
  * disabledActions: [Action.ManagePipelines]
5754
5793
  * ```
5755
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5794
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5756
5795
  */
5757
5796
  ManagePipelines = 'manage-pipeline',
5758
5797
  /**
@@ -6064,7 +6103,7 @@ export enum Action {
6064
6103
  * ```js
6065
6104
  * disabledActions: [Action.PersonalisedViewsDropdown]
6066
6105
  * ```
6067
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6106
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6068
6107
  */
6069
6108
  PersonalisedViewsDropdown = 'personalisedViewsDropdown',
6070
6109
  /**
@@ -6074,7 +6113,7 @@ export enum Action {
6074
6113
  * ```js
6075
6114
  * disabledActions: [Action.LiveboardUsers]
6076
6115
  * ```
6077
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6116
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6078
6117
  */
6079
6118
  LiveboardUsers = 'liveboardUsers',
6080
6119
 
@@ -6093,7 +6132,7 @@ export enum Action {
6093
6132
  * hiddenAction: [Action.TML] // hide all TML actions
6094
6133
  * disabledActions: [Action.TML] // to disable all TML actions
6095
6134
  * ```
6096
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6135
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6097
6136
  */
6098
6137
  TML = 'tml',
6099
6138
  /**
@@ -6142,7 +6181,7 @@ export enum Action {
6142
6181
  * ```js
6143
6182
  * disabledActions: [Action.AddToWatchlist]
6144
6183
  * ```
6145
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6184
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6146
6185
  */
6147
6186
  AddToWatchlist = 'addToWatchlist',
6148
6187
 
@@ -6153,7 +6192,7 @@ export enum Action {
6153
6192
  * ```js
6154
6193
  * disabledActions: [Action.RemoveFromWatchlist]
6155
6194
  * ```
6156
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6195
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
6157
6196
  */
6158
6197
  RemoveFromWatchlist = 'removeFromWatchlist',
6159
6198
  /**
@@ -6164,7 +6203,7 @@ export enum Action {
6164
6203
  * ```js
6165
6204
  * disabledActions: [Action.OrganiseFavourites]
6166
6205
  * ```
6167
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6206
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
6168
6207
  */
6169
6208
  OrganiseFavourites = 'organiseFavourites',
6170
6209
 
@@ -6231,7 +6270,7 @@ export enum Action {
6231
6270
  * ```js
6232
6271
  * disabledActions: [Action.ManageTags]
6233
6272
  * ```
6234
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6273
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6235
6274
  */
6236
6275
  ManageTags = 'manageTags',
6237
6276
 
@@ -7126,14 +7165,14 @@ export type ApiInterceptFlags = {
7126
7165
  /**
7127
7166
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
7128
7167
  *
7129
- * Can be used for Serach and App Embed from SDK 1.29.0
7168
+ * Can be used for Search and App Embed from SDK 1.29.0
7130
7169
  *
7131
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7170
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7132
7171
  */
7133
7172
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
7134
7173
  /**
7135
7174
  * This allows to intercept the urls passed, once intercepted the api will only
7136
- * run based on the reponse from the responder of ApiIntercept event.
7175
+ * run based on the response from the responder of ApiIntercept event.
7137
7176
  *
7138
7177
  * @example
7139
7178
  * ```js
@@ -7144,7 +7183,7 @@ export type ApiInterceptFlags = {
7144
7183
  * })
7145
7184
  * ```
7146
7185
  *
7147
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7186
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7148
7187
  */
7149
7188
  interceptUrls?: (string | InterceptedApiType)[];
7150
7189
  /**
@@ -7161,7 +7200,7 @@ export type ApiInterceptFlags = {
7161
7200
  * })
7162
7201
  * ```
7163
7202
  *
7164
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7203
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7165
7204
  */
7166
7205
  interceptTimeout?: number;
7167
7206
  };