@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
@@ -8,7 +8,7 @@
8
8
  import { CustomCssVariables } from './css-variables';
9
9
  import type { SessionInterface } from './utils/graphql/answerService/answerService';
10
10
  /**
11
- * The authentication mechanism for allowing access to the
11
+ * The authentication mechanism for allowing access to
12
12
  * the embedded app
13
13
  * @group Authentication / Init
14
14
  */
@@ -33,6 +33,7 @@ export declare enum AuthType {
33
33
  * To use this:
34
34
  * Your SAML or OpenID provider must allow iframe redirects.
35
35
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
36
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
36
37
  * @example
37
38
  * ```js
38
39
  * init({
@@ -40,18 +41,17 @@ export declare enum AuthType {
40
41
  * authType: AuthType.EmbeddedSSO,
41
42
  * });
42
43
  * ```
43
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
44
44
  */
45
45
  EmbeddedSSO = "EmbeddedSSO",
46
46
  /**
47
- * SSO using SAML
48
- * @deprecated Use {@link SAMLRedirect} instead
47
+ * SSO using SAML, Use {@link SAMLRedirect} instead
48
+ * @deprecated This option is deprecated.
49
49
  * @hidden
50
50
  */
51
51
  SSO = "SSO_SAML",
52
52
  /**
53
- * SSO using SAML
54
- * @deprecated Use {@link SAMLRedirect} instead
53
+ * SSO using SAML, Use {@link SAMLRedirect} instead
54
+ * @deprecated This option is deprecated.
55
55
  * @hidden
56
56
  */
57
57
  SAML = "SSO_SAML",
@@ -102,8 +102,9 @@ export declare enum AuthType {
102
102
  SAMLRedirect = "SSO_SAML",
103
103
  /**
104
104
  * SSO using OIDC
105
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
106
+ * @deprecated This option is deprecated.
105
107
  * @hidden
106
- * @deprecated Use {@link OIDCRedirect} instead
107
108
  */
108
109
  OIDC = "SSO_OIDC",
109
110
  /**
@@ -114,8 +115,9 @@ export declare enum AuthType {
114
115
  OIDCRedirect = "SSO_OIDC",
115
116
  /**
116
117
  * Trusted authentication server
118
+ * Use {@link TrustedAuth} instead
119
+ * @deprecated This option is deprecated.
117
120
  * @hidden
118
- * @deprecated Use {@link TrustedAuth} instead
119
121
  */
120
122
  AuthServer = "AuthServer",
121
123
  /**
@@ -142,6 +144,7 @@ export declare enum AuthType {
142
144
  * obtained from ThoughtSpot. This uses a cookieless authentication
143
145
  * approach, recommended to bypass the third-party cookie-blocking restriction
144
146
  * implemented by some browsers.
147
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
145
148
  * @example
146
149
  * ```js
147
150
  * init({
@@ -152,8 +155,8 @@ export declare enum AuthType {
152
155
  * .then((response) => response.json())
153
156
  * .then((data) => data.token);
154
157
  * }
158
+ * });
155
159
  * ```
156
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
157
160
  */
158
161
  TrustedAuthTokenCookieless = "AuthServerCookieless",
159
162
  /**
@@ -173,43 +176,43 @@ export declare enum HomeLeftNavItem {
173
176
  /**
174
177
  * The *Search data* option in
175
178
  * the *Insights* left navigation panel.
176
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
179
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
177
180
  */
178
181
  SearchData = "search-data",
179
182
  /**
180
183
  * The *Home* menu option in
181
184
  * the *Insights* left navigation panel.
182
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
185
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
183
186
  */
184
187
  Home = "insights-home",
185
188
  /**
186
189
  * The *Liveboards* menu option in
187
190
  * the *Insights* left navigation panel.
188
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
191
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
189
192
  */
190
193
  Liveboards = "liveboards",
191
194
  /**
192
195
  * The *Answers* menu option in
193
196
  * the *Insights* left navigation panel.
194
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
197
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
195
198
  */
196
199
  Answers = "answers",
197
200
  /**
198
201
  * The *Monitor subscriptions* menu option in
199
202
  * the *Insights* left navigation panel.
200
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
203
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
201
204
  */
202
205
  MonitorSubscription = "monitor-alerts",
203
206
  /**
204
207
  * The *SpotIQ analysis* menu option in
205
208
  * the *Insights* left navigation panel.
206
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
209
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
207
210
  */
208
211
  SpotIQAnalysis = "spotiq-analysis",
209
212
  /**
210
213
  * The *Liveboard schedules* menu option in
211
214
  * the *Insights* left navigation panel.
212
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
215
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
213
216
  */
214
217
  LiveboardSchedules = "liveboard-schedules",
215
218
  /**
@@ -380,8 +383,8 @@ export interface EmbedConfig {
380
383
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
381
384
  * open the SAML auth flow in a popup, instead of redirecting the browser in
382
385
  * place.
386
+ * @deprecated This option is deprecated.
383
387
  * @default false
384
- * @deprecated
385
388
  */
386
389
  noRedirect?: boolean;
387
390
  /**
@@ -390,8 +393,8 @@ export interface EmbedConfig {
390
393
  *
391
394
  * Need to use this with `authTriggerContainer`. Or manually trigger
392
395
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
393
- * @default false
394
396
  * @version SDK: 1.18.0
397
+ * @default false
395
398
  */
396
399
  inPopup?: boolean;
397
400
  /**
@@ -400,7 +403,7 @@ export interface EmbedConfig {
400
403
  * terminated.
401
404
  *
402
405
  * Eg: "/dashboard", "#/foo" [Do not include the host]
403
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
406
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
404
407
  */
405
408
  redirectPath?: string;
406
409
  /** @internal */
@@ -473,7 +476,7 @@ export interface EmbedConfig {
473
476
  detectCookieAccessSlow?: boolean;
474
477
  /**
475
478
  * Hide the `beta` alert warning message for SearchEmbed.
476
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
479
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
477
480
  */
478
481
  suppressSearchEmbedBetaWarning?: boolean;
479
482
  /**
@@ -490,6 +493,7 @@ export interface EmbedConfig {
490
493
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
491
494
  * button that the user can click to trigger the flow.
492
495
  * This attribute sets a containing element for that button.
496
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
493
497
  * @example
494
498
  * ```js
495
499
  * init({
@@ -498,7 +502,6 @@ export interface EmbedConfig {
498
502
  * authTriggerContainer: '#auth-trigger-container'
499
503
  * })
500
504
  * ```
501
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
502
505
  */
503
506
  authTriggerContainer?: string | HTMLElement;
504
507
  /**
@@ -515,11 +518,10 @@ export interface EmbedConfig {
515
518
  */
516
519
  authTriggerText?: string;
517
520
  /**
518
- * Prevent users from accessing the full application or ThoughtSpot application pages
519
- * access to the embedded application users
520
- * outside of the iframe.
521
- * @default true
521
+ * Prevent embedded application users from accessing ThoughtSpot
522
+ * application pages outside of the iframe.
522
523
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
524
+ * @default true
523
525
  */
524
526
  blockNonEmbedFullAppAccess?: boolean;
525
527
  /**
@@ -549,6 +551,7 @@ export interface EmbedConfig {
549
551
  * other logs such as warnings, information alerts,
550
552
  * and debug messages in the console output.
551
553
  *
554
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
552
555
  * @default LogLevel.ERROR
553
556
  * @example
554
557
  * ```js
@@ -557,7 +560,6 @@ export interface EmbedConfig {
557
560
  * logLevel: LogLevel.SILENT
558
561
  * })
559
562
  * ```
560
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
561
563
  */
562
564
  logLevel?: LogLevel;
563
565
  /**
@@ -584,6 +586,7 @@ export interface EmbedConfig {
584
586
  * This flag is used to disable the token verification in the SDK.
585
587
  * Enabling this flag will also disable the caching of the token.
586
588
  * @hidden
589
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
587
590
  * @example
588
591
  * ```js
589
592
  * init({
@@ -591,12 +594,11 @@ export interface EmbedConfig {
591
594
  * disableTokenVerification : true
592
595
  * })
593
596
  * ```
594
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
595
597
  */
596
598
  disableTokenVerification?: boolean;
597
599
  /**
598
600
  * This flag is used to disable showing the login failure page in the embedded app.
599
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
601
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
600
602
  */
601
603
  disableLoginFailurePage?: boolean;
602
604
  /**
@@ -606,6 +608,7 @@ export interface EmbedConfig {
606
608
  * Warning: This option is for advanced use only and is used internally
607
609
  * to control embed behavior in non-regular ways. We do not publish the
608
610
  * list of supported keys and values associated with each.
611
+ * @version SDK: 1.33.5 | ThoughtSpot: *
609
612
  * @example
610
613
  * ```js
611
614
  * const embed = new LiveboardEmbed('#embed', {
@@ -616,7 +619,6 @@ export interface EmbedConfig {
616
619
  * }
617
620
  * });
618
621
  * ```
619
- * @version SDK: 1.33.5 | ThoughtSpot: *
620
622
  */
621
623
  additionalFlags?: {
622
624
  [key: string]: string | number | boolean;
@@ -624,6 +626,7 @@ export interface EmbedConfig {
624
626
  /**
625
627
  * This is an object (key/val) for customVariables being
626
628
  * used by the third party tool's script.
629
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
627
630
  * @example
628
631
  * ```js
629
632
  * const embed = new LiveboardEmbed('#embed', {
@@ -634,15 +637,14 @@ export interface EmbedConfig {
634
637
  * }
635
638
  * });
636
639
  * ```
637
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
638
640
  */
639
641
  customVariablesForThirdPartyTools?: Record<string, any>;
640
642
  disablePreauthCache?: boolean;
641
643
  /**
642
644
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
643
645
  * and exiting fullscreen mode for embedded visualizations during presentations.
644
- * @default true (feature is disabled by default)
645
646
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
647
+ * @default true (feature is disabled by default)
646
648
  * @example
647
649
  * ```js
648
650
  * init({
@@ -848,7 +850,7 @@ export interface FrameParams {
848
850
  */
849
851
  loading?: 'lazy' | 'eager' | 'auto';
850
852
  /**
851
- * This parameters will be passed on the iframe
853
+ * These parameters will be passed to the iframe
852
854
  * as is.
853
855
  */
854
856
  [key: string]: string | number | boolean | undefined;
@@ -923,8 +925,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
923
925
  */
924
926
  disabledActionReason?: string;
925
927
  /**
926
- * The list of actions to hide from the embedded.
927
- * This actions will be hidden from the user.
928
+ * The list of actions to hide from the embedded view.
929
+ * These actions will be hidden from the user.
928
930
  * Use this to hide an action.
929
931
  *
930
932
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -965,7 +967,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
965
967
  * The locale settings to apply to the embedded view.
966
968
  *
967
969
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
968
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
970
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
969
971
  * @example
970
972
  * ```js
971
973
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -980,12 +982,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
980
982
  * This is an object (key/val) of override flags which will be applied
981
983
  * to the internal embedded object. This can be used to add any
982
984
  * URL flag.
983
- * If the same flags are passed in init, they will be overriden by the values here.
985
+ * If the same flags are passed in init, they will be overridden by the values here.
984
986
  * Warning: This option is for advanced use only and is used internally
985
987
  * to control embed behavior in non-regular ways. We do not publish the
986
988
  * list of supported keys and values associated with each.
987
989
  *
988
990
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
991
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
989
992
  * @example
990
993
  * ```js
991
994
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -997,7 +1000,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
997
1000
  * },
998
1001
  * });
999
1002
  * ```
1000
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1001
1003
  */
1002
1004
  additionalFlags?: {
1003
1005
  [key: string]: string | number | boolean;
@@ -1040,6 +1042,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1040
1042
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
1041
1043
  *
1042
1044
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1045
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1043
1046
  * @example
1044
1047
  * ```js
1045
1048
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1049,7 +1052,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1049
1052
  * });
1050
1053
  * embed.showPreRender();
1051
1054
  * ```
1052
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1053
1055
  */
1054
1056
  preRenderId?: string;
1055
1057
  /**
@@ -1059,7 +1061,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1059
1061
  * its dimensions based on changes to the size of the embedding element.
1060
1062
  * @type {boolean}
1061
1063
  * @default false
1062
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1064
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1063
1065
  * @example
1064
1066
  * ```js
1065
1067
  * // Disable tracking PreRender size in the configuration
@@ -1074,9 +1076,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1074
1076
  doNotTrackPreRenderSize?: boolean;
1075
1077
  /**
1076
1078
  * Enable the V2 shell. This can provide performance benefits
1077
- * due to a lighterweight shell.
1079
+ * due to a lighter-weight shell.
1078
1080
  *
1079
1081
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1082
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1080
1083
  * @example
1081
1084
  * ```js
1082
1085
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1085,7 +1088,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1085
1088
  * enableV2Shell_experimental: true,
1086
1089
  * });
1087
1090
  * ```
1088
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1089
1091
  */
1090
1092
  enableV2Shell_experimental?: boolean;
1091
1093
  /**
@@ -1104,6 +1106,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1104
1106
  * and disable redirection of links in a new tab.
1105
1107
  *
1106
1108
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1109
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1107
1110
  * @example
1108
1111
  * ```js
1109
1112
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1112,7 +1115,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1112
1115
  * disableRedirectionLinksInNewTab: true,
1113
1116
  * });
1114
1117
  * ```
1115
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1116
1118
  */
1117
1119
  disableRedirectionLinksInNewTab?: boolean;
1118
1120
  /**
@@ -1123,6 +1125,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1123
1125
  * Per Org URL feature is enabled on your ThoughtSpot instance.
1124
1126
  *
1125
1127
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1128
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1126
1129
  * @example
1127
1130
  * ```js
1128
1131
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1131,24 +1134,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1131
1134
  * overrideOrgId: 142536,
1132
1135
  * });
1133
1136
  * ```
1134
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
1135
1137
  */
1136
1138
  overrideOrgId?: number;
1137
1139
  /**
1138
- * Flag to override the *Open Link in New Tab* context menu option.
1140
+ * Flag to override the *Open Link in New Tab* context
1141
+ * menu option.
1139
1142
  *
1140
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1143
+ * For improved link override handling, use
1144
+ * {@link enableLinkOverridesV2} instead.
1145
+ *
1146
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1147
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1148
+ * `SpotterEmbed`, `SearchBarEmbed`
1141
1149
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1142
1150
  * @example
1143
1151
  * ```js
1144
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
1145
- * const embed = new <EmbedComponent>('#tsEmbed', {
1152
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1146
1153
  * ... // other embed view config
1147
- * linkOverride:false,
1154
+ * linkOverride: true,
1148
1155
  * })
1149
1156
  * ```
1150
1157
  */
1151
1158
  linkOverride?: boolean;
1159
+ /**
1160
+ * Enables the V2 link override mechanism with improved
1161
+ * handling. When enabled, navigation links within the
1162
+ * embedded ThoughtSpot app are intercepted and routed
1163
+ * through the SDK via the `EmbedEvent.DialogOpen`
1164
+ * event.
1165
+ *
1166
+ * The SDK automatically sends {@link linkOverride}
1167
+ * alongside this flag for backward compatibility with
1168
+ * older ThoughtSpot versions.
1169
+ *
1170
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
1171
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
1172
+ * `SpotterEmbed`, `SearchBarEmbed`
1173
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
1174
+ * @example
1175
+ * ```js
1176
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1177
+ * ... // other embed view config
1178
+ * enableLinkOverridesV2: true,
1179
+ * });
1180
+ *
1181
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
1182
+ * console.log('Link clicked:', payload);
1183
+ * });
1184
+ * ```
1185
+ */
1186
+ enableLinkOverridesV2?: boolean;
1152
1187
  /**
1153
1188
  * The primary action to display on top of the viz for Liveboard and App Embed.
1154
1189
  * Use this to set the primary action.
@@ -1173,7 +1208,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1173
1208
  insertInToSlide?: boolean;
1174
1209
  /**
1175
1210
  * Show alert messages and toast messages in the embed.
1176
- * Supported embed in all embed types.
1211
+ * Supported in all embed types.
1177
1212
  *
1178
1213
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1179
1214
  * @example
@@ -1457,7 +1492,7 @@ export interface HomePageConfig {
1457
1492
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1458
1493
  *
1459
1494
  * Supported embed types: `AppEmbed`
1460
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1495
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1461
1496
  * @example
1462
1497
  * ```js
1463
1498
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -1478,6 +1513,7 @@ export interface HomePageConfig {
1478
1513
  * **Note**: This attribute is not supported in the classic (v1) homepage.
1479
1514
  *
1480
1515
  * Supported embed types: `AppEmbed`
1516
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1481
1517
  * @example
1482
1518
  * ```js
1483
1519
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -1488,7 +1524,6 @@ export interface HomePageConfig {
1488
1524
  * ... //other embed view configuration attributes
1489
1525
  * })
1490
1526
  * ```
1491
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1492
1527
  */
1493
1528
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
1494
1529
  }
@@ -1501,7 +1536,7 @@ export interface SearchLiveboardCommonViewConfig {
1501
1536
  * visualization, or Liveboard.
1502
1537
  *
1503
1538
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1504
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1539
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1505
1540
  * @example
1506
1541
  * ```js
1507
1542
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1519,11 +1554,11 @@ export interface SearchLiveboardCommonViewConfig {
1519
1554
  */
1520
1555
  runtimeFilters?: RuntimeFilter[];
1521
1556
  /**
1522
- * The list of parameter override to apply to a search Answer,
1557
+ * The list of parameter overrides to apply to a search Answer,
1523
1558
  * visualization, or Liveboard.
1524
1559
  *
1525
1560
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
1526
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1561
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1527
1562
  * @example
1528
1563
  * ```js
1529
1564
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1543,6 +1578,7 @@ export interface SearchLiveboardCommonViewConfig {
1543
1578
  * flag to set ContextMenu Trigger to either left or right click.
1544
1579
  *
1545
1580
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
1581
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1546
1582
  * @example
1547
1583
  * ```js
1548
1584
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -1551,7 +1587,6 @@ export interface SearchLiveboardCommonViewConfig {
1551
1587
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
1552
1588
  * })
1553
1589
  * ```
1554
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
1555
1590
  */
1556
1591
  contextMenuTrigger?: ContextMenuTriggerOptions;
1557
1592
  /**
@@ -1574,7 +1609,7 @@ export interface SearchLiveboardCommonViewConfig {
1574
1609
  * when set to false, runtime parameters will be included in the URL
1575
1610
  * (default behavior before SDK 1.45.0).
1576
1611
  *
1577
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
1612
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
1578
1613
  * embedded view.
1579
1614
  * @default true
1580
1615
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -1593,14 +1628,15 @@ export interface SearchLiveboardCommonViewConfig {
1593
1628
  * ... // other embed view config
1594
1629
  * collapseSearchBar: true,
1595
1630
  * });
1631
+ * ```
1596
1632
  */
1597
1633
  collapseSearchBar?: boolean;
1598
1634
  /**
1599
1635
  * Flag to control Data panel experience
1600
1636
  *
1601
1637
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1638
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1602
1639
  * @default true
1603
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
1604
1640
  * @example
1605
1641
  * ```js
1606
1642
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -1633,6 +1669,7 @@ export interface SearchLiveboardCommonViewConfig {
1633
1669
  * the current time period in filter results.
1634
1670
  *
1635
1671
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1672
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1636
1673
  * @example
1637
1674
  * ```js
1638
1675
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -1640,7 +1677,6 @@ export interface SearchLiveboardCommonViewConfig {
1640
1677
  * isThisPeriodInDateFiltersEnabled: true,
1641
1678
  * })
1642
1679
  * ```
1643
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
1644
1680
  */
1645
1681
  isThisPeriodInDateFiltersEnabled?: boolean;
1646
1682
  }
@@ -1700,6 +1736,7 @@ export interface LiveboardAppEmbedViewConfig {
1700
1736
  * Boolean to control if Liveboard header is sticky or not.
1701
1737
  *
1702
1738
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1739
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1703
1740
  * @example
1704
1741
  * ```js
1705
1742
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1708,7 +1745,6 @@ export interface LiveboardAppEmbedViewConfig {
1708
1745
  * isLiveboardHeaderSticky: true,
1709
1746
  * });
1710
1747
  * ```
1711
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
1712
1748
  */
1713
1749
  isLiveboardHeaderSticky?: boolean;
1714
1750
  /**
@@ -1716,8 +1752,8 @@ export interface LiveboardAppEmbedViewConfig {
1716
1752
  *
1717
1753
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1718
1754
  * @type {boolean}
1755
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
1719
1756
  * @default false
1720
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1721
1757
  * @example
1722
1758
  * ```js
1723
1759
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1733,8 +1769,8 @@ export interface LiveboardAppEmbedViewConfig {
1733
1769
  *
1734
1770
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1735
1771
  * @type {boolean}
1772
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
1736
1773
  * @default false
1737
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1738
1774
  * @example
1739
1775
  * ```js
1740
1776
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -1750,7 +1786,7 @@ export interface LiveboardAppEmbedViewConfig {
1750
1786
  * header.
1751
1787
  *
1752
1788
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1753
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1789
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1754
1790
  * @default true
1755
1791
  * @example
1756
1792
  * ```js
@@ -1768,7 +1804,7 @@ export interface LiveboardAppEmbedViewConfig {
1768
1804
  * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
1769
1805
  *
1770
1806
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1771
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
1807
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1772
1808
  * @default false
1773
1809
  * @example
1774
1810
  * ```js
@@ -1786,7 +1822,7 @@ export interface LiveboardAppEmbedViewConfig {
1786
1822
  * compact header
1787
1823
  *
1788
1824
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1789
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1825
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
1790
1826
  * @default true
1791
1827
  * @example
1792
1828
  * ```js
@@ -1819,7 +1855,7 @@ export interface LiveboardAppEmbedViewConfig {
1819
1855
  * the cover and filters pages in the Liveboard PDF.
1820
1856
  *
1821
1857
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1822
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
1858
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
1823
1859
  * @example
1824
1860
  * ```js
1825
1861
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2038,7 +2074,7 @@ export declare enum HomepageModule {
2038
2074
  */
2039
2075
  Search = "SEARCH",
2040
2076
  /**
2041
- * kPI watchlist module
2077
+ * KPI watchlist module
2042
2078
  */
2043
2079
  Watchlist = "WATCHLIST",
2044
2080
  /**
@@ -2069,7 +2105,8 @@ export declare enum ListPageColumns {
2069
2105
  */
2070
2106
  Favorites = "FAVOURITE",
2071
2107
  /**
2072
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2108
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2109
+ * @deprecated This option is deprecated.
2073
2110
  */
2074
2111
  Favourite = "FAVOURITE",
2075
2112
  /**
@@ -2170,13 +2207,13 @@ export declare enum EmbedEvent {
2170
2207
  /**
2171
2208
  * Rendering has initialized.
2172
2209
  * @example
2173
- *```js
2210
+ * ```js
2174
2211
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
2175
2212
  * //show a loader
2176
2213
  * function showLoader() {
2177
2214
  * document.getElementById("loader");
2178
2215
  * }
2179
- *```
2216
+ * ```
2180
2217
  * @returns timestamp - The timestamp when the event was generated.
2181
2218
  */
2182
2219
  Init = "init",
@@ -2184,11 +2221,11 @@ export declare enum EmbedEvent {
2184
2221
  * Authentication has either succeeded or failed.
2185
2222
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2186
2223
  * @example
2187
- *```js
2224
+ * ```js
2188
2225
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
2189
2226
  * console.log('AuthInit', payload);
2190
2227
  * })
2191
- *```
2228
+ * ```
2192
2229
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
2193
2230
  */
2194
2231
  AuthInit = "authInit",
@@ -2197,13 +2234,13 @@ export declare enum EmbedEvent {
2197
2234
  * @returns timestamp - The timestamp when the event was generated.
2198
2235
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2199
2236
  * @example
2200
- *```js
2237
+ * ```js
2201
2238
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
2202
2239
  * //hide loader
2203
2240
  * function hideLoader() {
2204
2241
  * document.getElementById("loader");
2205
2242
  * }
2206
- *```
2243
+ * ```
2207
2244
  */
2208
2245
  Load = "load",
2209
2246
  /**
@@ -2212,11 +2249,11 @@ export declare enum EmbedEvent {
2212
2249
  * @return data - Answer of Liveboard data
2213
2250
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2214
2251
  * @example
2215
- *```js
2252
+ * ```js
2216
2253
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
2217
2254
  * console.log('data', payload);
2218
2255
  * })
2219
- *```
2256
+ * ```
2220
2257
  * @important
2221
2258
  */
2222
2259
  Data = "data",
@@ -2224,9 +2261,9 @@ export declare enum EmbedEvent {
2224
2261
  * Search query has been updated by the user.
2225
2262
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2226
2263
  * @example
2227
- *```js
2264
+ * ```js
2228
2265
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
2229
- *```
2266
+ * ```
2230
2267
  */
2231
2268
  QueryChanged = "queryChanged",
2232
2269
  /**
@@ -2236,7 +2273,7 @@ export declare enum EmbedEvent {
2236
2273
  * @returns drillDownColumns - The columns on which drill down was performed
2237
2274
  * @returns nonFilteredColumns - The columns that were not filtered
2238
2275
  * @example
2239
- *```js
2276
+ * ```js
2240
2277
  * searchEmbed.on(EmbedEvent.DrillDown, {
2241
2278
  * points: {
2242
2279
  * clickedPoint,
@@ -2244,12 +2281,12 @@ export declare enum EmbedEvent {
2244
2281
  * },
2245
2282
  * autoDrillDown: true,
2246
2283
  * })
2247
- *```
2284
+ * ```
2248
2285
  * In this example, `VizPointDoubleClick` event is used for
2249
2286
  * triggering the `DrillDown` event when an area or specific
2250
2287
  * data point on a table or chart is double-clicked.
2251
2288
  * @example
2252
- *```js
2289
+ * ```js
2253
2290
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
2254
2291
  * console.log(payload);
2255
2292
  * const clickedPoint = payload.data.clickedPoint;
@@ -2263,7 +2300,7 @@ export declare enum EmbedEvent {
2263
2300
  * autoDrillDown: true,
2264
2301
  * })
2265
2302
  * })
2266
- *```
2303
+ * ```
2267
2304
  */
2268
2305
  Drilldown = "drillDown",
2269
2306
  /**
@@ -2388,13 +2425,13 @@ export declare enum EmbedEvent {
2388
2425
  * The ThoughtSpot authentication session has expired.
2389
2426
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
2390
2427
  * @example
2391
- *```js
2428
+ * ```js
2392
2429
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
2393
2430
  * //show auth expired banner
2394
2431
  * function showAuthExpired() {
2395
2432
  * document.getElementById("authExpiredBanner");
2396
2433
  * }
2397
- *```
2434
+ * ```
2398
2435
  */
2399
2436
  AuthExpire = "ThoughtspotAuthExpired",
2400
2437
  /**
@@ -2429,22 +2466,22 @@ export declare enum EmbedEvent {
2429
2466
  * Applicable to `SearchBarEmbed` only.
2430
2467
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2431
2468
  * @example
2432
- *```js
2469
+ * ```js
2433
2470
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
2434
2471
  * .then(data => {
2435
2472
  * console.log('Answer Data:', data);
2436
2473
  * })
2437
- *```
2474
+ * ```
2438
2475
  */
2439
2476
  GetDataClick = "getDataClick",
2440
2477
  /**
2441
2478
  * Detects the route change.
2442
2479
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
2443
2480
  * @example
2444
- *```js
2481
+ * ```js
2445
2482
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
2446
2483
  * console.log('data', payload))
2447
- *```
2484
+ * ```
2448
2485
  */
2449
2486
  RouteChange = "ROUTE_CHANGE",
2450
2487
  /**
@@ -2454,12 +2491,12 @@ export declare enum EmbedEvent {
2454
2491
  V1Data = "exportVizDataToParent",
2455
2492
  /**
2456
2493
  * Emitted when the embed does not have cookie access. This happens
2457
- * when Safari and other Web browsers block third-party cookies
2458
- * are blocked by default. `NoCookieAccess` can trigger.
2494
+ * when third-party cookies are blocked by Safari or other
2495
+ * web browsers. `NoCookieAccess` can trigger.
2459
2496
  * @example
2460
- *```js
2497
+ * ```js
2461
2498
  * appEmbed.on(EmbedEvent.NoCookieAccess)
2462
- *```
2499
+ * ```
2463
2500
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
2464
2501
  */
2465
2502
  NoCookieAccess = "noCookieAccess",
@@ -2473,22 +2510,22 @@ export declare enum EmbedEvent {
2473
2510
  * Emitted when any modal is opened in the app
2474
2511
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2475
2512
  * @example
2476
- *```js
2513
+ * ```js
2477
2514
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
2478
2515
  * console.log('dialog open', payload);
2479
2516
  * })
2480
- *```
2517
+ * ```
2481
2518
  */
2482
2519
  DialogOpen = "dialog-open",
2483
2520
  /**
2484
2521
  * Emitted when any modal is closed in the app
2485
2522
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2486
2523
  * @example
2487
- *```js
2524
+ * ```js
2488
2525
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
2489
2526
  * console.log('dialog close', payload);
2490
2527
  * })
2491
- *```
2528
+ * ```
2492
2529
  */
2493
2530
  DialogClose = "dialog-close",
2494
2531
  /**
@@ -2497,39 +2534,39 @@ export declare enum EmbedEvent {
2497
2534
  * other events on the rendered Liveboard.
2498
2535
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2499
2536
  * @example
2500
- *```js
2537
+ * ```js
2501
2538
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
2502
2539
  console.log('Liveboard is rendered', payload);
2503
2540
  })
2504
- *```
2541
+ * ```
2505
2542
  * The following example shows how to trigger
2506
2543
  * `SetVisibleVizs` event using LiveboardRendered embed event:
2507
2544
  * @example
2508
- *```js
2545
+ * ```js
2509
2546
  * const embedRef = useEmbedRef();
2510
2547
  * const onLiveboardRendered = () => {
2511
2548
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
2512
2549
  * };
2513
- *```
2550
+ * ```
2514
2551
  */
2515
2552
  LiveboardRendered = "PinboardRendered",
2516
2553
  /**
2517
2554
  * Emits all events.
2518
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2555
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2519
2556
  * @example
2520
- *```js
2557
+ * ```js
2521
2558
  * appEmbed.on(EmbedEvent.ALL, payload => {
2522
2559
  * console.log('Embed Events', payload)
2523
2560
  * })
2524
- *```
2561
+ * ```
2525
2562
  */
2526
2563
  ALL = "*",
2527
2564
  /**
2528
2565
  * Emitted when an Answer is saved in the app.
2529
2566
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
2530
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2567
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2531
2568
  * @example
2532
- *```js
2569
+ * ```js
2533
2570
  * //Emit when action starts
2534
2571
  * searchEmbed.on(EmbedEvent.Save, payload => {
2535
2572
  * console.log('Save', payload)
@@ -2540,7 +2577,7 @@ export declare enum EmbedEvent {
2540
2577
  * searchEmbed.on(EmbedEvent.Save, payload => {
2541
2578
  * console.log('Save', payload)
2542
2579
  * })
2543
- *```
2580
+ * ```
2544
2581
  */
2545
2582
  Save = "save",
2546
2583
  /**
@@ -2552,11 +2589,11 @@ export declare enum EmbedEvent {
2552
2589
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
2553
2590
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2554
2591
  * @example
2555
- *```js
2592
+ * ```js
2556
2593
  * liveboardEmbed.on(EmbedEvent.Download, {
2557
2594
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
2558
2595
  * })
2559
- *```
2596
+ * ```
2560
2597
  */
2561
2598
  Download = "download",
2562
2599
  /**
@@ -2564,14 +2601,14 @@ export declare enum EmbedEvent {
2564
2601
  * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
2565
2602
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2566
2603
  * @example
2567
- *```js
2604
+ * ```js
2568
2605
  * //emit when action starts
2569
2606
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2570
2607
  * console.log('download PNG', payload)}, {start: true })
2571
2608
  * //emit when action ends
2572
2609
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2573
2610
  * console.log('download PNG', payload)})
2574
- *```
2611
+ * ```
2575
2612
  */
2576
2613
  DownloadAsPng = "downloadAsPng",
2577
2614
  /**
@@ -2579,14 +2616,14 @@ export declare enum EmbedEvent {
2579
2616
  * 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.
2580
2617
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2581
2618
  * @example
2582
- *```js
2619
+ * ```js
2583
2620
  * //emit when action starts
2584
2621
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2585
2622
  * console.log('download PDF', payload)}, {start: true })
2586
2623
  * //emit when action ends
2587
2624
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2588
2625
  * console.log('download PDF', payload)})
2589
- *```
2626
+ * ```
2590
2627
  */
2591
2628
  DownloadAsPdf = "downloadAsPdf",
2592
2629
  /**
@@ -2594,14 +2631,14 @@ export declare enum EmbedEvent {
2594
2631
  * 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.
2595
2632
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2596
2633
  * @example
2597
- *```js
2634
+ * ```js
2598
2635
  * //emit when action starts
2599
2636
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2600
2637
  * console.log('download CSV', payload)}, {start: true })
2601
2638
  * //emit when action ends
2602
2639
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
2603
2640
  * console.log('download CSV', payload)})
2604
- *```
2641
+ * ```
2605
2642
  */
2606
2643
  DownloadAsCsv = "downloadAsCsv",
2607
2644
  /**
@@ -2609,14 +2646,14 @@ export declare enum EmbedEvent {
2609
2646
  * 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.
2610
2647
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2611
2648
  * @example
2612
- *```js
2649
+ * ```js
2613
2650
  * //emit when action starts
2614
2651
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2615
2652
  * console.log('download Xlsx', payload)}, { start: true })
2616
2653
  * //emit when action ends
2617
2654
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
2618
2655
  * console.log('download Xlsx', payload)})
2619
- *```
2656
+ * ```
2620
2657
  */
2621
2658
  DownloadAsXlsx = "downloadAsXlsx",
2622
2659
  /**
@@ -2624,25 +2661,25 @@ export declare enum EmbedEvent {
2624
2661
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
2625
2662
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2626
2663
  * @example
2627
- *```js
2664
+ * ```js
2628
2665
  * //emit when action starts
2629
2666
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2630
2667
  * console.log('delete answer', payload)}, {start: true })
2631
2668
  * //trigger when action is completed
2632
2669
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
2633
2670
  * console.log('delete answer', payload)})
2634
- *```
2671
+ * ```
2635
2672
  */
2636
2673
  AnswerDelete = "answerDelete",
2637
2674
  /**
2638
2675
  * Emitted when the AI Highlights action is triggered on a Liveboard
2639
2676
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
2640
2677
  * @example
2641
- *```js
2678
+ * ```js
2642
2679
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
2643
2680
  * console.log('AI Highlights', payload);
2644
2681
  * })
2645
- *```
2682
+ * ```
2646
2683
  */
2647
2684
  AIHighlights = "AIHighlights",
2648
2685
  /**
@@ -2651,7 +2688,7 @@ export declare enum EmbedEvent {
2651
2688
  * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
2652
2689
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2653
2690
  * @example
2654
- *```js
2691
+ * ```js
2655
2692
  * //emit when action starts
2656
2693
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2657
2694
  * console.log('pin', payload)
@@ -2662,14 +2699,14 @@ export declare enum EmbedEvent {
2662
2699
  * searchEmbed.on(EmbedEvent.Pin, payload => {
2663
2700
  * console.log('pin', payload)
2664
2701
  * })
2665
- *```
2702
+ * ```
2666
2703
  */
2667
2704
  Pin = "pin",
2668
2705
  /**
2669
2706
  * Emitted when SpotIQ analysis is triggered
2670
2707
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2671
2708
  * @example
2672
- *```js
2709
+ * ```js
2673
2710
  * //emit when action starts
2674
2711
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2675
2712
  * console.log('SpotIQAnalyze', payload)
@@ -2680,14 +2717,14 @@ export declare enum EmbedEvent {
2680
2717
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
2681
2718
  * console.log('SpotIQ analyze', payload)
2682
2719
  * })
2683
- *```
2720
+ * ```
2684
2721
  */
2685
2722
  SpotIQAnalyze = "spotIQAnalyze",
2686
2723
  /**
2687
2724
  * Emitted when a user shares an object with another user or group
2688
2725
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2689
2726
  * @example
2690
- *```js
2727
+ * ```js
2691
2728
  * //emit when action starts
2692
2729
  * searchEmbed.on(EmbedEvent.Share, payload => {
2693
2730
  * console.log('Share', payload)
@@ -2698,7 +2735,7 @@ export declare enum EmbedEvent {
2698
2735
  * searchEmbed.on(EmbedEvent.Share, payload => {
2699
2736
  * console.log('Share', payload)
2700
2737
  * })
2701
- *```
2738
+ * ```
2702
2739
  */
2703
2740
  Share = "share",
2704
2741
  /**
@@ -2706,11 +2743,11 @@ export declare enum EmbedEvent {
2706
2743
  * data on a chart or table.
2707
2744
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2708
2745
  * @example
2709
- *```js
2746
+ * ```js
2710
2747
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
2711
2748
  * console.log('Drill include', payload);
2712
2749
  * })
2713
- *```
2750
+ * ```
2714
2751
  */
2715
2752
  DrillInclude = "context-menu-item-include",
2716
2753
  /**
@@ -2718,22 +2755,22 @@ export declare enum EmbedEvent {
2718
2755
  * data on a chart or table
2719
2756
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2720
2757
  * @example
2721
- *```js
2758
+ * ```js
2722
2759
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
2723
2760
  * console.log('Drill exclude', payload);
2724
2761
  * })
2725
- *```
2762
+ * ```
2726
2763
  */
2727
2764
  DrillExclude = "context-menu-item-exclude",
2728
2765
  /**
2729
2766
  * Emitted when a column value is copied in the embedded app.
2730
2767
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2731
2768
  * @example
2732
- *```js
2733
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2769
+ * ```js
2770
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
2734
2771
  * console.log('copy to clipboard', payload);
2735
2772
  * })
2736
- *```
2773
+ * ```
2737
2774
  */
2738
2775
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
2739
2776
  /**
@@ -2741,10 +2778,10 @@ export declare enum EmbedEvent {
2741
2778
  * embedded Liveboard.
2742
2779
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2743
2780
  * @example
2744
- *```js
2781
+ * ```js
2745
2782
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
2746
2783
  * })
2747
- *```
2784
+ * ```
2748
2785
  */
2749
2786
  UpdateTML = "updateTSL",
2750
2787
  /**
@@ -2752,11 +2789,11 @@ export declare enum EmbedEvent {
2752
2789
  * on an embedded Liveboard.
2753
2790
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2754
2791
  * @example
2755
- *```js
2792
+ * ```js
2756
2793
  * appEmbed.on(EmbedEvent.EditTML, payload => {
2757
2794
  * console.log('Edit TML', payload);
2758
2795
  * })
2759
- *```
2796
+ * ```
2760
2797
  */
2761
2798
  EditTML = "editTSL",
2762
2799
  /**
@@ -2765,25 +2802,25 @@ export declare enum EmbedEvent {
2765
2802
  * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
2766
2803
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2767
2804
  * @example
2768
- *```js
2805
+ * ```js
2769
2806
  * //emit when action starts
2770
2807
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2771
2808
  * console.log('Export TML', payload)}, { start: true })
2772
2809
  * //emit when action ends
2773
2810
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
2774
2811
  * console.log('Export TML', payload)})
2775
- *```
2812
+ * ```
2776
2813
  */
2777
2814
  ExportTML = "exportTSL",
2778
2815
  /**
2779
2816
  * Emitted when an Answer is saved as a View.
2780
2817
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2781
2818
  * @example
2782
- *```js
2819
+ * ```js
2783
2820
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
2784
2821
  * console.log('View', payload);
2785
2822
  * })
2786
- *```
2823
+ * ```
2787
2824
  */
2788
2825
  SaveAsView = "saveAsView",
2789
2826
  /**
@@ -2791,36 +2828,36 @@ export declare enum EmbedEvent {
2791
2828
  * 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.
2792
2829
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2793
2830
  * @example
2794
- *```js
2831
+ * ```js
2795
2832
  * //emit when action starts
2796
2833
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2797
2834
  * console.log('Copy and edit', payload)}, {start: true })
2798
2835
  * //emit when action ends
2799
2836
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
2800
2837
  * console.log('Copy and edit', payload)})
2801
- *```
2838
+ * ```
2802
2839
  */
2803
2840
  CopyAEdit = "copyAEdit",
2804
2841
  /**
2805
2842
  * Emitted when a user clicks *Show underlying data* on an Answer.
2806
2843
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2807
2844
  * @example
2808
- *```js
2845
+ * ```js
2809
2846
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
2810
2847
  * console.log('show data', payload);
2811
2848
  * })
2812
- *```
2849
+ * ```
2813
2850
  */
2814
2851
  ShowUnderlyingData = "showUnderlyingData",
2815
2852
  /**
2816
2853
  * Emitted when an Answer is switched to a chart or table view.
2817
2854
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2818
2855
  * @example
2819
- *```js
2856
+ * ```js
2820
2857
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2821
2858
  * console.log('switch view', payload);
2822
2859
  * })
2823
- *```
2860
+ * ```
2824
2861
  */
2825
2862
  AnswerChartSwitcher = "answerChartSwitcher",
2826
2863
  /**
@@ -2837,118 +2874,118 @@ export declare enum EmbedEvent {
2837
2874
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
2838
2875
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2839
2876
  * @example
2840
- *```js
2877
+ * ```js
2841
2878
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
2842
2879
  * console.log('Liveboard details', payload);
2843
2880
  * })
2844
- *```
2881
+ * ```
2845
2882
  */
2846
2883
  LiveboardInfo = "pinboardInfo",
2847
2884
  /**
2848
2885
  * Emitted when a user clicks on the Favorite icon on a Liveboard
2849
2886
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2850
2887
  * @example
2851
- *```js
2888
+ * ```js
2852
2889
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
2853
2890
  * console.log('favorites', payload);
2854
2891
  * })
2855
- *```
2892
+ * ```
2856
2893
  */
2857
2894
  AddToFavorites = "addToFavorites",
2858
2895
  /**
2859
2896
  * Emitted when a user clicks **Schedule** on a Liveboard
2860
2897
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2861
2898
  * @example
2862
- *```js
2899
+ * ```js
2863
2900
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
2864
- * console.log(`Liveboard schedule', payload);
2901
+ * console.log('Liveboard schedule', payload);
2865
2902
  * })
2866
- *```
2903
+ * ```
2867
2904
  */
2868
2905
  Schedule = "subscription",
2869
2906
  /**
2870
2907
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
2871
2908
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2872
2909
  * @example
2873
- *```js
2910
+ * ```js
2874
2911
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
2875
- * console.log(`Liveboard edit', payload);
2912
+ * console.log('Liveboard edit', payload);
2876
2913
  * })
2877
- *```
2914
+ * ```
2878
2915
  */
2879
2916
  Edit = "edit",
2880
2917
  /**
2881
2918
  * Emitted when a user clicks *Make a copy* on a Liveboard
2882
2919
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2883
2920
  * @example
2884
- *```js
2921
+ * ```js
2885
2922
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
2886
- * console.log(`Copy', payload);
2923
+ * console.log('Copy', payload);
2887
2924
  * })
2888
- *```
2925
+ * ```
2889
2926
  */
2890
2927
  MakeACopy = "makeACopy",
2891
2928
  /**
2892
2929
  * Emitted when a user clicks **Present** on a Liveboard or visualization
2893
2930
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2894
2931
  * @example
2895
- *```js
2932
+ * ```js
2896
2933
  * liveboardEmbed.on(EmbedEvent.Present)
2897
- *```
2934
+ * ```
2898
2935
  * @example
2899
- *```js
2936
+ * ```js
2900
2937
  * liveboardEmbed.on(EmbedEvent.Present, {
2901
2938
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2902
2939
  * })
2903
- *```
2940
+ * ```
2904
2941
  */
2905
2942
  Present = "present",
2906
2943
  /**
2907
2944
  * Emitted when a user clicks **Delete** on a visualization
2908
2945
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2909
2946
  * @example
2910
- *```js
2947
+ * ```js
2911
2948
  * liveboardEmbed.on(EmbedEvent.Delete,
2912
2949
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2913
- *```
2950
+ * ```
2914
2951
  */
2915
2952
  Delete = "delete",
2916
2953
  /**
2917
2954
  * Emitted when a user clicks Manage schedules on a Liveboard
2918
2955
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2919
2956
  * @example
2920
- *```js
2957
+ * ```js
2921
2958
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
2922
- *```
2959
+ * ```
2923
2960
  */
2924
2961
  SchedulesList = "schedule-list",
2925
2962
  /**
2926
2963
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
2927
2964
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2928
2965
  * @example
2929
- *```js
2966
+ * ```js
2930
2967
  * liveboardEmbed.on(EmbedEvent.Cancel)
2931
- *```
2968
+ * ```
2932
2969
  */
2933
2970
  Cancel = "cancel",
2934
2971
  /**
2935
2972
  * Emitted when a user clicks **Explore** on a visualization
2936
2973
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2937
2974
  * @example
2938
- *```js
2975
+ * ```js
2939
2976
  * liveboardEmbed.on(EmbedEvent.Explore, {
2940
2977
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2941
- *```
2978
+ * ```
2942
2979
  */
2943
2980
  Explore = "explore",
2944
2981
  /**
2945
2982
  * Emitted when a user clicks **Copy link** action on a visualization.
2946
2983
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2947
2984
  * @example
2948
- *```js
2985
+ * ```js
2949
2986
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
2950
2987
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2951
- *```
2988
+ * ```
2952
2989
  */
2953
2990
  CopyLink = "embedDocument",
2954
2991
  /**
@@ -2956,21 +2993,21 @@ export declare enum EmbedEvent {
2956
2993
  * visualization or Liveboard.
2957
2994
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2958
2995
  * @example
2959
- *```js
2996
+ * ```js
2960
2997
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
2961
2998
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
2962
- *```
2999
+ * ```
2963
3000
  */
2964
3001
  CrossFilterChanged = "cross-filter-changed",
2965
3002
  /**
2966
3003
  * Emitted when a user right clicks on a visualization (chart or table)
2967
3004
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2968
3005
  * @example
2969
- *```js
3006
+ * ```js
2970
3007
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
2971
3008
  * console.log('VizPointClick', payload)
2972
3009
  * })
2973
- *```
3010
+ * ```
2974
3011
  */
2975
3012
  VizPointRightClick = "vizPointRightClick",
2976
3013
  /**
@@ -2984,35 +3021,35 @@ export declare enum EmbedEvent {
2984
3021
  * filter details.
2985
3022
  * @example
2986
3023
  *
2987
- *```js
3024
+ * ```js
2988
3025
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
2989
3026
  * console.log('payload', payload);
2990
3027
  * })
2991
- *
3028
+ * ```
2992
3029
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
2993
3030
  */
2994
3031
  FilterChanged = "filterChanged",
2995
3032
  /**
2996
3033
  * Emitted when a user clicks the **Go** button to initiate
2997
3034
  * a Natural Language Search query
2998
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3035
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
2999
3036
  */
3000
3037
  SageEmbedQuery = "sageEmbedQuery",
3001
3038
  /**
3002
3039
  * Emitted when a user selects a data source on the embedded
3003
3040
  * Natural Language Search interface.
3004
3041
  *
3005
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3042
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3006
3043
  */
3007
3044
  SageWorksheetUpdated = "sageWorksheetUpdated",
3008
3045
  /**
3009
3046
  * Emitted when a user updates a connection on the **Data** page
3010
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3047
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3011
3048
  */
3012
3049
  UpdateConnection = "updateConnection",
3013
3050
  /**
3014
3051
  * Emitted when a user updates a connection on the **Data** page
3015
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3052
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3016
3053
  */
3017
3054
  CreateConnection = "createConnection",
3018
3055
  /**
@@ -3022,7 +3059,7 @@ export declare enum EmbedEvent {
3022
3059
  * @returns viewId: string
3023
3060
  * @returns liveboardId: string
3024
3061
  * @returns isPublic: boolean
3025
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3062
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3026
3063
  */
3027
3064
  UpdatePersonalisedView = "updatePersonalisedView",
3028
3065
  /**
@@ -3031,7 +3068,7 @@ export declare enum EmbedEvent {
3031
3068
  * @returns viewId: string
3032
3069
  * @returns liveboardId: string
3033
3070
  * @returns isPublic: boolean
3034
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3071
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3035
3072
  */
3036
3073
  SavePersonalisedView = "savePersonalisedView",
3037
3074
  /**
@@ -3040,19 +3077,19 @@ export declare enum EmbedEvent {
3040
3077
  * @returns viewId: string
3041
3078
  * @returns liveboardId: string
3042
3079
  * @returns isPublic: boolean
3043
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3080
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3044
3081
  */
3045
3082
  ResetLiveboard = "resetLiveboard",
3046
3083
  /**
3047
3084
  * Emitted when a PersonalisedView is deleted.
3048
3085
  * @returns views: string[]
3049
3086
  * @returns liveboardId: string
3050
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3087
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3051
3088
  */
3052
3089
  DeletePersonalisedView = "deletePersonalisedView",
3053
3090
  /**
3054
3091
  * Emitted when a user creates a Worksheet.
3055
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3092
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3056
3093
  */
3057
3094
  CreateWorksheet = "createWorksheet",
3058
3095
  /**
@@ -3061,12 +3098,12 @@ export declare enum EmbedEvent {
3061
3098
  * @returns viewId: string
3062
3099
  * @returns liveboardId: string
3063
3100
  * @returns isPublic: boolean
3064
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3101
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3065
3102
  */
3066
3103
  AskSageInit = "AskSageInit",
3067
3104
  /**
3068
3105
  * Emitted when a Liveboard or visualization is renamed.
3069
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3106
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3070
3107
  */
3071
3108
  Rename = "rename",
3072
3109
  /**
@@ -3089,7 +3126,7 @@ export declare enum EmbedEvent {
3089
3126
  * - `error` - Developers can customize the user-facing error message when `execute`
3090
3127
  * is `false` by using the `error` parameters in `responder`.
3091
3128
  * - `errorText` - The error message text shown to the user.
3092
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3129
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3093
3130
  * @example
3094
3131
  *
3095
3132
  * This example blocks search operation and returns a custom error message:
@@ -3141,8 +3178,8 @@ export declare enum EmbedEvent {
3141
3178
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3142
3179
  * console.log('payload', payload);
3143
3180
  * })
3144
- *```
3145
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
3181
+ * ```
3182
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3146
3183
  */
3147
3184
  ParameterChanged = "parameterChanged",
3148
3185
  /**
@@ -3197,24 +3234,24 @@ export declare enum EmbedEvent {
3197
3234
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
3198
3235
  * console.log('payload', payload);
3199
3236
  * })
3200
- *```
3201
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3237
+ * ```
3238
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3202
3239
  */
3203
3240
  CreateLiveboard = "createLiveboard",
3204
3241
  /**
3205
3242
  * Emitted when a user creates a Model.
3206
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
3243
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
3207
3244
  */
3208
3245
  CreateModel = "createModel",
3209
3246
  /**
3210
3247
  * @hidden
3211
3248
  * Emitted when a user exits present mode.
3212
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
3249
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3213
3250
  */
3214
3251
  ExitPresentMode = "exitPresentMode",
3215
3252
  /**
3216
3253
  * Emitted when a user requests the full height lazy load data.
3217
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
3254
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3218
3255
  * @hidden
3219
3256
  */
3220
3257
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
@@ -3225,7 +3262,7 @@ export declare enum EmbedEvent {
3225
3262
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
3226
3263
  * console.log('payload', payload);
3227
3264
  * })
3228
- *```
3265
+ * ```
3229
3266
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3230
3267
  */
3231
3268
  SpotterData = "SpotterData",
@@ -3236,7 +3273,7 @@ export declare enum EmbedEvent {
3236
3273
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
3237
3274
  * console.log('payload', payload);
3238
3275
  * })
3239
- *```
3276
+ * ```
3240
3277
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3241
3278
  */
3242
3279
  PreviewSpotterData = "PreviewSpotterData",
@@ -3247,7 +3284,7 @@ export declare enum EmbedEvent {
3247
3284
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
3248
3285
  * console.log('payload', payload);
3249
3286
  * })
3250
- *```
3287
+ * ```
3251
3288
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3252
3289
  */
3253
3290
  AddToCoaching = "addToCoaching",
@@ -3269,7 +3306,7 @@ export declare enum EmbedEvent {
3269
3306
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
3270
3307
  * console.log('payload', payload);
3271
3308
  * })
3272
- *```
3309
+ * ```
3273
3310
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3274
3311
  */
3275
3312
  SpotterQueryTriggered = "SpotterQueryTriggered",
@@ -3280,7 +3317,7 @@ export declare enum EmbedEvent {
3280
3317
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
3281
3318
  * console.log('payload', payload);
3282
3319
  * })
3283
- *```
3320
+ * ```
3284
3321
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3285
3322
  */
3286
3323
  LastPromptEdited = "LastPromptEdited",
@@ -3291,18 +3328,18 @@ export declare enum EmbedEvent {
3291
3328
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (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
  LastPromptDeleted = "LastPromptDeleted",
3298
3335
  /**
3299
- * Emitted when the coversation is reset in spotter embed.
3336
+ * Emitted when the conversation is reset in Spotter embed.
3300
3337
  * @example
3301
3338
  * ```js
3302
3339
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (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
  ResetSpotterConversation = "ResetSpotterConversation",
@@ -3313,7 +3350,7 @@ export declare enum EmbedEvent {
3313
3350
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
3314
3351
  * console.log('payload', payload);
3315
3352
  * })
3316
- *```
3353
+ * ```
3317
3354
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
3318
3355
  */
3319
3356
  SpotterInit = "spotterInit",
@@ -3324,7 +3361,7 @@ export declare enum EmbedEvent {
3324
3361
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
3325
3362
  * console.log('payload', payload);
3326
3363
  * })
3327
- *```
3364
+ * ```
3328
3365
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
3329
3366
  */
3330
3367
  SpotterLoadComplete = "spotterLoadComplete",
@@ -3678,7 +3715,7 @@ export declare enum HostEvent {
3678
3715
  * ```js
3679
3716
  * appEmbed.navigateToPage(-1)
3680
3717
  * ```
3681
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
3718
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
3682
3719
  */
3683
3720
  Navigate = "Navigate",
3684
3721
  /**
@@ -3811,9 +3848,9 @@ export declare enum HostEvent {
3811
3848
  * Trigger the **Show Liveboard details** action
3812
3849
  * on an embedded Liveboard.
3813
3850
  * @example
3814
- *```js
3851
+ * ```js
3815
3852
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
3816
- *```
3853
+ * ```
3817
3854
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3818
3855
  */
3819
3856
  LiveboardInfo = "pinboardInfo",
@@ -3941,7 +3978,7 @@ export declare enum HostEvent {
3941
3978
  * appEmbed.trigger(HostEvent.Remove)
3942
3979
  * ```
3943
3980
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3944
- * * @example
3981
+ * @example
3945
3982
  * ```js
3946
3983
  * liveboardEmbed.trigger(HostEvent.Remove)
3947
3984
  * ```
@@ -4032,7 +4069,7 @@ export declare enum HostEvent {
4032
4069
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4033
4070
  * ```
4034
4071
  * ```js
4035
- * vizEmbed.trigger((HostEvent.CopyLink)
4072
+ * vizEmbed.trigger(HostEvent.CopyLink)
4036
4073
  * ```
4037
4074
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4038
4075
  */
@@ -4049,7 +4086,7 @@ export declare enum HostEvent {
4049
4086
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4050
4087
  * ```
4051
4088
  * ```js
4052
- * vizEmbed.trigger((HostEvent.Present)
4089
+ * vizEmbed.trigger(HostEvent.Present)
4053
4090
  * ```
4054
4091
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4055
4092
  */
@@ -4064,23 +4101,22 @@ export declare enum HostEvent {
4064
4101
  * );
4065
4102
  * })
4066
4103
  * ```
4067
- * * @example
4104
+ * @example
4068
4105
  * ```js
4069
-
4070
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
4071
- * let latestSpotterVizId = '';
4072
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4073
- * latestSpotterVizId = payload.data.id;
4074
- * });
4075
- *
4076
- * spotterEmbed.trigger(HostEvent.GetTML, {
4106
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4107
+ * let latestSpotterVizId = '';
4108
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4109
+ * latestSpotterVizId = payload.data.id;
4110
+ * });
4111
+ *
4112
+ * spotterEmbed.trigger(HostEvent.GetTML, {
4077
4113
  * vizId: latestSpotterVizId
4078
4114
  * }).then((tml) => {
4079
4115
  * console.log(
4080
4116
  * tml.answer.search_query // TML representation of the search query
4081
4117
  * );
4082
4118
  * })
4083
- * ```
4119
+ * ```
4084
4120
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4085
4121
  * @important
4086
4122
  */
@@ -4144,6 +4180,11 @@ export declare enum HostEvent {
4144
4180
  /**
4145
4181
  * Trigger the **Download** action on charts in
4146
4182
  * the embedded view.
4183
+ * Use {@link HostEvent.DownloadAsPng} instead.
4184
+ *
4185
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4186
+ *
4187
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
4147
4188
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
4148
4189
  * @example
4149
4190
  * ```js
@@ -4162,9 +4203,6 @@ export declare enum HostEvent {
4162
4203
  *
4163
4204
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
4164
4205
  * ```
4165
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
4166
- * Use {@link DownloadAsPng}
4167
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4168
4206
  */
4169
4207
  Download = "downloadAsPng",
4170
4208
  /**
@@ -4602,8 +4640,8 @@ export declare enum HostEvent {
4602
4640
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
4603
4641
  * console.log('parameters', parameter);
4604
4642
  * });
4605
- *```
4606
- *```js
4643
+ * ```
4644
+ * ```js
4607
4645
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
4608
4646
  * let latestSpotterVizId = '';
4609
4647
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -4611,7 +4649,7 @@ export declare enum HostEvent {
4611
4649
  * });
4612
4650
  *
4613
4651
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
4614
- *```
4652
+ * ```
4615
4653
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4616
4654
  */
4617
4655
  GetParameters = "GetParameters",
@@ -4628,7 +4666,7 @@ export declare enum HostEvent {
4628
4666
  * Notify when info call is completed successfully
4629
4667
  * ```js
4630
4668
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
4631
- *```
4669
+ * ```
4632
4670
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4633
4671
  */
4634
4672
  InfoSuccess = "InfoSuccess",
@@ -4731,7 +4769,7 @@ export declare enum HostEvent {
4731
4769
  * ```js
4732
4770
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
4733
4771
  *
4734
- *```
4772
+ * ```
4735
4773
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4736
4774
  */
4737
4775
  AddToCoaching = "addToCoaching",
@@ -4773,7 +4811,7 @@ export declare enum HostEvent {
4773
4811
  * });
4774
4812
  *
4775
4813
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
4776
- *```
4814
+ * ```
4777
4815
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4778
4816
  */
4779
4817
  AnswerChartSwitcher = "answerChartSwitcher",
@@ -4783,7 +4821,7 @@ export declare enum HostEvent {
4783
4821
  * This is automatically triggered by the SDK when fullscreen mode is exited.
4784
4822
  * ```js
4785
4823
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
4786
- *```
4824
+ * ```
4787
4825
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4788
4826
  */
4789
4827
  ExitPresentMode = "exitPresentMode",
@@ -4925,6 +4963,7 @@ export declare enum Param {
4925
4963
  cookieless = "cookieless",
4926
4964
  ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
4927
4965
  LinkOverride = "linkOverride",
4966
+ EnableLinkOverridesV2 = "enableLinkOverridesV2",
4928
4967
  blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
4929
4968
  ShowInsertToSlide = "insertInToSlide",
4930
4969
  PrimaryNavHidden = "primaryNavHidden",
@@ -5018,7 +5057,8 @@ export declare enum Param {
5018
5057
  SpotterNewChatButtonTitle = "spotterNewChatButtonTitle",
5019
5058
  IsThisPeriodInDateFiltersEnabled = "isThisPeriodInDateFiltersEnabled",
5020
5059
  HideToolResponseCardBranding = "hideToolResponseCardBranding",
5021
- ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel"
5060
+ ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel",
5061
+ EnableHomepageAnnouncement = "enableHomepageAnnouncement"
5022
5062
  }
5023
5063
  /**
5024
5064
  * ThoughtSpot application pages include actions and menu commands
@@ -5177,14 +5217,14 @@ export declare enum Action {
5177
5217
  * ```js
5178
5218
  * disabledActions: [Action.CollapseDataPanel]
5179
5219
  * ```
5180
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5220
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5181
5221
  */
5182
5222
  CollapseDataSources = "collapseDataSources",
5183
5223
  /**
5184
5224
  * The **Collapse data panel** icon on the Search page.
5185
5225
  * Collapses the data panel view.
5186
5226
  *
5187
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5227
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5188
5228
  *
5189
5229
  * @example
5190
5230
  * ```js
@@ -5631,13 +5671,12 @@ export declare enum Action {
5631
5671
  */
5632
5672
  CreateMonitor = "createMonitor",
5633
5673
  /**
5634
- * @deprecated
5635
- * Reports errors
5674
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5675
+ * @deprecated This action is deprecated. It was used for reporting errors.
5636
5676
  * @example
5637
5677
  * ```js
5638
5678
  * disabledActions: [Action.ReportError]
5639
5679
  * ```
5640
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5641
5680
  */
5642
5681
  ReportError = "reportError",
5643
5682
  /**
@@ -5647,7 +5686,7 @@ export declare enum Action {
5647
5686
  * ```js
5648
5687
  * disabledActions: [Action.SyncToSheets]
5649
5688
  * ```
5650
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5689
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5651
5690
  */
5652
5691
  SyncToSheets = "sync-to-sheets",
5653
5692
  /**
@@ -5658,7 +5697,7 @@ export declare enum Action {
5658
5697
  * ```js
5659
5698
  * disabledActions: [Action.SyncToOtherApps]
5660
5699
  * ```
5661
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5700
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5662
5701
  */
5663
5702
  SyncToOtherApps = "sync-to-other-apps",
5664
5703
  /**
@@ -5668,7 +5707,7 @@ export declare enum Action {
5668
5707
  * ```js
5669
5708
  * disabledActions: [Action.ManagePipelines]
5670
5709
  * ```
5671
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5710
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5672
5711
  */
5673
5712
  ManagePipelines = "manage-pipeline",
5674
5713
  /**
@@ -5980,7 +6019,7 @@ export declare enum Action {
5980
6019
  * ```js
5981
6020
  * disabledActions: [Action.PersonalisedViewsDropdown]
5982
6021
  * ```
5983
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6022
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5984
6023
  */
5985
6024
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
5986
6025
  /**
@@ -5990,7 +6029,7 @@ export declare enum Action {
5990
6029
  * ```js
5991
6030
  * disabledActions: [Action.LiveboardUsers]
5992
6031
  * ```
5993
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6032
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
5994
6033
  */
5995
6034
  LiveboardUsers = "liveboardUsers",
5996
6035
  /**
@@ -6008,7 +6047,7 @@ export declare enum Action {
6008
6047
  * hiddenAction: [Action.TML] // hide all TML actions
6009
6048
  * disabledActions: [Action.TML] // to disable all TML actions
6010
6049
  * ```
6011
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6050
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6012
6051
  */
6013
6052
  TML = "tml",
6014
6053
  /**
@@ -6054,7 +6093,7 @@ export declare enum Action {
6054
6093
  * ```js
6055
6094
  * disabledActions: [Action.AddToWatchlist]
6056
6095
  * ```
6057
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6096
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6058
6097
  */
6059
6098
  AddToWatchlist = "addToWatchlist",
6060
6099
  /**
@@ -6064,7 +6103,7 @@ export declare enum Action {
6064
6103
  * ```js
6065
6104
  * disabledActions: [Action.RemoveFromWatchlist]
6066
6105
  * ```
6067
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6106
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
6068
6107
  */
6069
6108
  RemoveFromWatchlist = "removeFromWatchlist",
6070
6109
  /**
@@ -6075,7 +6114,7 @@ export declare enum Action {
6075
6114
  * ```js
6076
6115
  * disabledActions: [Action.OrganiseFavourites]
6077
6116
  * ```
6078
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6117
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
6079
6118
  */
6080
6119
  OrganiseFavourites = "organiseFavourites",
6081
6120
  /**
@@ -6136,7 +6175,7 @@ export declare enum Action {
6136
6175
  * ```js
6137
6176
  * disabledActions: [Action.ManageTags]
6138
6177
  * ```
6139
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6178
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6140
6179
  */
6141
6180
  ManageTags = "manageTags",
6142
6181
  /**
@@ -6991,14 +7030,14 @@ export type ApiInterceptFlags = {
6991
7030
  /**
6992
7031
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
6993
7032
  *
6994
- * Can be used for Serach and App Embed from SDK 1.29.0
7033
+ * Can be used for Search and App Embed from SDK 1.29.0
6995
7034
  *
6996
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7035
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
6997
7036
  */
6998
7037
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
6999
7038
  /**
7000
7039
  * This allows to intercept the urls passed, once intercepted the api will only
7001
- * run based on the reponse from the responder of ApiIntercept event.
7040
+ * run based on the response from the responder of ApiIntercept event.
7002
7041
  *
7003
7042
  * @example
7004
7043
  * ```js
@@ -7009,7 +7048,7 @@ export type ApiInterceptFlags = {
7009
7048
  * })
7010
7049
  * ```
7011
7050
  *
7012
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7051
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7013
7052
  */
7014
7053
  interceptUrls?: (string | InterceptedApiType)[];
7015
7054
  /**
@@ -7026,7 +7065,7 @@ export type ApiInterceptFlags = {
7026
7065
  * })
7027
7066
  * ```
7028
7067
  *
7029
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7068
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7030
7069
  */
7031
7070
  interceptTimeout?: number;
7032
7071
  };