@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.40.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/cjs/package.json +7 -6
  2. package/cjs/src/css-variables.d.ts +316 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +6 -1
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +22 -0
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +39 -2
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/bodyless-conversation.d.ts +0 -1
  11. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/bodyless-conversation.js +3 -7
  13. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.d.ts +63 -3
  15. package/cjs/src/embed/conversation.d.ts.map +1 -1
  16. package/cjs/src/embed/conversation.js +11 -8
  17. package/cjs/src/embed/conversation.js.map +1 -1
  18. package/cjs/src/embed/conversation.spec.js +102 -0
  19. package/cjs/src/embed/conversation.spec.js.map +1 -1
  20. package/cjs/src/embed/liveboard.d.ts +11 -3
  21. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  22. package/cjs/src/embed/liveboard.js +23 -33
  23. package/cjs/src/embed/liveboard.js.map +1 -1
  24. package/cjs/src/embed/liveboard.spec.js +182 -29
  25. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  26. package/cjs/src/embed/sage.d.ts +0 -1
  27. package/cjs/src/embed/sage.d.ts.map +1 -1
  28. package/cjs/src/embed/sage.js +6 -10
  29. package/cjs/src/embed/sage.js.map +1 -1
  30. package/cjs/src/embed/search-bar.d.ts +0 -1
  31. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  32. package/cjs/src/embed/search-bar.js +7 -11
  33. package/cjs/src/embed/search-bar.js.map +1 -1
  34. package/cjs/src/embed/search.d.ts +0 -1
  35. package/cjs/src/embed/search.d.ts.map +1 -1
  36. package/cjs/src/embed/search.js +8 -7
  37. package/cjs/src/embed/search.js.map +1 -1
  38. package/cjs/src/embed/ts-embed.d.ts +22 -9
  39. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  40. package/cjs/src/embed/ts-embed.js +75 -59
  41. package/cjs/src/embed/ts-embed.js.map +1 -1
  42. package/cjs/src/embed/ts-embed.spec.js +173 -1
  43. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  44. package/cjs/src/types.d.ts +154 -54
  45. package/cjs/src/types.d.ts.map +1 -1
  46. package/cjs/src/types.js +140 -52
  47. package/cjs/src/types.js.map +1 -1
  48. package/cjs/src/utils/liveboardService/liveboardService.d.ts +21 -6
  49. package/cjs/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  50. package/cjs/src/utils/liveboardService/liveboardService.js +21 -6
  51. package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
  52. package/dist/{index-CmEQfuE3.js → index-P5YjBOuJ.js} +1 -1
  53. package/dist/src/css-variables.d.ts +316 -0
  54. package/dist/src/css-variables.d.ts.map +1 -1
  55. package/dist/src/embed/app.d.ts +6 -1
  56. package/dist/src/embed/app.d.ts.map +1 -1
  57. package/dist/src/embed/bodyless-conversation.d.ts +0 -1
  58. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  59. package/dist/src/embed/conversation.d.ts +63 -3
  60. package/dist/src/embed/conversation.d.ts.map +1 -1
  61. package/dist/src/embed/liveboard.d.ts +11 -3
  62. package/dist/src/embed/liveboard.d.ts.map +1 -1
  63. package/dist/src/embed/sage.d.ts +0 -1
  64. package/dist/src/embed/sage.d.ts.map +1 -1
  65. package/dist/src/embed/search-bar.d.ts +0 -1
  66. package/dist/src/embed/search-bar.d.ts.map +1 -1
  67. package/dist/src/embed/search.d.ts +0 -1
  68. package/dist/src/embed/search.d.ts.map +1 -1
  69. package/dist/src/embed/ts-embed.d.ts +22 -9
  70. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  71. package/dist/src/types.d.ts +154 -54
  72. package/dist/src/types.d.ts.map +1 -1
  73. package/dist/src/utils/liveboardService/liveboardService.d.ts +21 -6
  74. package/dist/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  75. package/dist/tsembed-react.es.js +298 -190
  76. package/dist/tsembed-react.js +297 -189
  77. package/dist/tsembed.es.js +319 -196
  78. package/dist/tsembed.js +318 -195
  79. package/dist/visual-embed-sdk-react-full.d.ts +583 -76
  80. package/dist/visual-embed-sdk-react.d.ts +583 -76
  81. package/dist/visual-embed-sdk.d.ts +583 -76
  82. package/lib/package.json +7 -6
  83. package/lib/src/css-variables.d.ts +316 -0
  84. package/lib/src/css-variables.d.ts.map +1 -1
  85. package/lib/src/embed/app.d.ts +6 -1
  86. package/lib/src/embed/app.d.ts.map +1 -1
  87. package/lib/src/embed/app.js +22 -0
  88. package/lib/src/embed/app.js.map +1 -1
  89. package/lib/src/embed/app.spec.js +39 -2
  90. package/lib/src/embed/app.spec.js.map +1 -1
  91. package/lib/src/embed/bodyless-conversation.d.ts +0 -1
  92. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  93. package/lib/src/embed/bodyless-conversation.js +3 -7
  94. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  95. package/lib/src/embed/conversation.d.ts +63 -3
  96. package/lib/src/embed/conversation.d.ts.map +1 -1
  97. package/lib/src/embed/conversation.js +12 -9
  98. package/lib/src/embed/conversation.js.map +1 -1
  99. package/lib/src/embed/conversation.spec.js +104 -2
  100. package/lib/src/embed/conversation.spec.js.map +1 -1
  101. package/lib/src/embed/liveboard.d.ts +11 -3
  102. package/lib/src/embed/liveboard.d.ts.map +1 -1
  103. package/lib/src/embed/liveboard.js +23 -33
  104. package/lib/src/embed/liveboard.js.map +1 -1
  105. package/lib/src/embed/liveboard.spec.js +182 -29
  106. package/lib/src/embed/liveboard.spec.js.map +1 -1
  107. package/lib/src/embed/sage.d.ts +0 -1
  108. package/lib/src/embed/sage.d.ts.map +1 -1
  109. package/lib/src/embed/sage.js +6 -10
  110. package/lib/src/embed/sage.js.map +1 -1
  111. package/lib/src/embed/search-bar.d.ts +0 -1
  112. package/lib/src/embed/search-bar.d.ts.map +1 -1
  113. package/lib/src/embed/search-bar.js +7 -11
  114. package/lib/src/embed/search-bar.js.map +1 -1
  115. package/lib/src/embed/search.d.ts +0 -1
  116. package/lib/src/embed/search.d.ts.map +1 -1
  117. package/lib/src/embed/search.js +8 -7
  118. package/lib/src/embed/search.js.map +1 -1
  119. package/lib/src/embed/ts-embed.d.ts +22 -9
  120. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  121. package/lib/src/embed/ts-embed.js +75 -59
  122. package/lib/src/embed/ts-embed.js.map +1 -1
  123. package/lib/src/embed/ts-embed.spec.js +173 -1
  124. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  125. package/lib/src/types.d.ts +154 -54
  126. package/lib/src/types.d.ts.map +1 -1
  127. package/lib/src/types.js +140 -52
  128. package/lib/src/types.js.map +1 -1
  129. package/lib/src/utils/liveboardService/liveboardService.d.ts +21 -6
  130. package/lib/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  131. package/lib/src/utils/liveboardService/liveboardService.js +21 -6
  132. package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
  133. package/lib/src/visual-embed-sdk.d.ts +584 -77
  134. package/package.json +7 -6
  135. package/src/css-variables.ts +396 -1
  136. package/src/embed/app.spec.ts +54 -2
  137. package/src/embed/app.ts +24 -0
  138. package/src/embed/bodyless-conversation.ts +3 -9
  139. package/src/embed/conversation.spec.ts +131 -5
  140. package/src/embed/conversation.ts +87 -23
  141. package/src/embed/liveboard.spec.ts +233 -32
  142. package/src/embed/liveboard.ts +24 -39
  143. package/src/embed/sage.ts +6 -11
  144. package/src/embed/search-bar.tsx +7 -14
  145. package/src/embed/search.ts +7 -18
  146. package/src/embed/ts-embed.spec.ts +344 -112
  147. package/src/embed/ts-embed.ts +82 -70
  148. package/src/types.ts +153 -54
  149. package/src/utils/liveboardService/liveboardService.ts +21 -6
  150. package/dist/index-D1pyb7RG.js +0 -7371
  151. package/dist/index-DeFzsyFF.js +0 -7371
  152. package/dist/index-Dpf0rd6w.js +0 -7371
  153. package/dist/index-UuEbsISo.js +0 -7447
  154. package/dist/index-e3Uw3YFO.js +0 -7371
  155. package/dist/index-k7pkZMhx.js +0 -7371
@@ -652,7 +652,6 @@ export declare class SearchBarEmbed extends TsEmbed {
652
652
  protected viewConfig: SearchBarViewConfig;
653
653
  protected embedComponentType: string;
654
654
  constructor(domSelector: string, viewConfig: SearchBarViewConfig);
655
- protected getEmbedParamsObject(): Record<any, any>;
656
655
  /**
657
656
  * Render the embedded ThoughtSpot search
658
657
  */
@@ -805,7 +804,6 @@ export declare class SageEmbed extends V1Embed {
805
804
  */
806
805
  protected viewConfig: SageViewConfig;
807
806
  constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
808
- protected getEmbedParamsObject(): Record<any, any>;
809
807
  /**
810
808
  * Constructs a map of parameters to be passed on to the
811
809
  * embedded Eureka or Sage search page.
@@ -1143,7 +1141,6 @@ export declare class SearchEmbed extends TsEmbed {
1143
1141
  };
1144
1142
  };
1145
1143
  protected getAppInitData(): Promise<SearchAppInitData>;
1146
- protected getEmbedParamsObject(): Record<any, any>;
1147
1144
  protected getEmbedParams(): string;
1148
1145
  /**
1149
1146
  * Construct the URL of the embedded ThoughtSpot search to be
@@ -1248,7 +1245,12 @@ export declare enum HomePage {
1248
1245
  * Modular (v2) introduces the updated Modular Home Experience.
1249
1246
  * It serves as the foundational version of the home page.
1250
1247
  */
1251
- Modular = "v2"
1248
+ Modular = "v2",
1249
+ /**
1250
+ * ModularWithStylingChanges (v3) introduces Modular Home Experience
1251
+ * with styling changes.
1252
+ */
1253
+ ModularWithStylingChanges = "v3"
1252
1254
  }
1253
1255
  /**
1254
1256
  * Define the version of the list page
@@ -2124,7 +2126,16 @@ export declare class LiveboardEmbed extends V1Embed {
2124
2126
  * embedded Liveboard or visualization.
2125
2127
  */
2126
2128
  protected getEmbedParams(): string;
2127
- protected getEmbedParamsObject(): any;
2129
+ /**
2130
+ * @hidden
2131
+ * Internal state to track the current liveboard id.
2132
+ * This is used to navigate to the correct liveboard when the prerender is visible.
2133
+ */
2134
+ currentLiveboardState: {
2135
+ liveboardId: string;
2136
+ vizId: string;
2137
+ activeTabId: string;
2138
+ };
2128
2139
  protected beforePrerenderVisible(): void;
2129
2140
  protected handleRenderForPrerender(): Promise<TsEmbed>;
2130
2141
  /**
@@ -2145,8 +2156,7 @@ export declare class LiveboardEmbed extends V1Embed {
2145
2156
  * visualization ID and the runtime filters.
2146
2157
  */
2147
2158
  render(): Promise<LiveboardEmbed>;
2148
- currentLiveboardId: string;
2149
- navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void): void;
2159
+ navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
2150
2160
  /**
2151
2161
  * Returns the full url of the Liveboard/visualization which can be used to open
2152
2162
  * this Liveboard inside the full ThoughtSpot application in a new tab.
@@ -2189,7 +2199,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
2189
2199
  export declare class ConversationMessage extends TsEmbed {
2190
2200
  protected viewConfig: SpotterAgentMessageViewConfig;
2191
2201
  constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
2192
- protected getEmbedParamsObject(): Record<any, any>;
2193
2202
  getIframeSrc(): string;
2194
2203
  render(): Promise<ConversationMessage>;
2195
2204
  }
@@ -3274,12 +3283,15 @@ export interface HomePageConfig {
3274
3283
  * Hide list page columns
3275
3284
  * For example: hiddenListColumns = [ListPageColumns.Author]
3276
3285
  *
3277
- * **Note**: This option is available only in full app embedding.
3286
+ * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
3287
+ * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
3278
3288
  *
3279
3289
  * Supported embed types: `AppEmbed`
3280
3290
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3281
3291
  * @example
3282
3292
  * ```js
3293
+ * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
3294
+ *
3283
3295
  * const embed = new AppEmbed('#tsEmbed', {
3284
3296
  * ... //other embed view config
3285
3297
  * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -3294,11 +3306,14 @@ export interface HomePageConfig {
3294
3306
  * **Note**: This option does not apply to the classic homepage.
3295
3307
  * To access the updated modular homepage, set
3296
3308
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3309
+ * To use it, you need to import `HomepageModule` enum.
3297
3310
  *
3298
3311
  * Supported embed types: `AppEmbed`
3299
3312
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3300
3313
  * @example
3301
3314
  * ```js
3315
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3316
+ *
3302
3317
  * const embed = new AppEmbed('#tsEmbed', {
3303
3318
  * ... //other embed view config
3304
3319
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -3313,11 +3328,14 @@ export interface HomePageConfig {
3313
3328
  * **Note**: This option does not apply to the classic homepage.
3314
3329
  * To access the updated modular homepage, set
3315
3330
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3331
+ * To use it, you need to import `HomepageModule` enum.
3316
3332
  *
3317
3333
  * Supported embed types: `AppEmbed`
3318
3334
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3319
3335
  * @example
3320
3336
  * ```js
3337
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3338
+ *
3321
3339
  * const embed = new AppEmbed('#tsEmbed', {
3322
3340
  * ... //other embed view config
3323
3341
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -3333,6 +3351,8 @@ export interface HomePageConfig {
3333
3351
  * Supported embed types: `AppEmbed`
3334
3352
  * @example
3335
3353
  * ```js
3354
+ * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
3355
+ *
3336
3356
  * const embed = new AppEmbed('#tsEmbed', {
3337
3357
  * ... //other embed view config
3338
3358
  * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -3342,6 +3362,7 @@ export interface HomePageConfig {
3342
3362
  * **Note**: This option does not apply to the classic homepage.
3343
3363
  * To access the updated modular homepage, set
3344
3364
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3365
+ * To use it, you need to import `HomeLeftNavItem` enum.
3345
3366
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3346
3367
  */
3347
3368
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -4550,7 +4571,7 @@ export declare enum EmbedEvent {
4550
4571
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4551
4572
  * @example
4552
4573
  *```js
4553
- * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
4574
+ * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
4554
4575
  * console.log('Liveboard details', payload);
4555
4576
  * })
4556
4577
  *```
@@ -4925,58 +4946,58 @@ export declare enum EmbedEvent {
4925
4946
  */
4926
4947
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
4927
4948
  /**
4928
- * Emitted when spotter response is text data
4949
+ * Emitted when Spotter response is text data
4929
4950
  * @example
4930
4951
  * ```js
4931
4952
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
4932
4953
  * console.log('payload', payload);
4933
4954
  * })
4934
4955
  *```
4935
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4956
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4936
4957
  */
4937
4958
  SpotterData = "SpotterData",
4938
4959
  /**
4939
- * Emitted when user opens up the worksheet preview modal in spotter embed.
4960
+ * Emitted when user opens up the worksheet preview modal in Spotter embed.
4940
4961
  * @example
4941
4962
  * ```js
4942
4963
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
4943
4964
  * console.log('payload', payload);
4944
4965
  * })
4945
4966
  *```
4946
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4967
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4947
4968
  */
4948
4969
  PreviewSpotterData = "PreviewSpotterData",
4949
4970
  /**
4950
- * Emitted when the spotter query is triggered in spotter embed.
4971
+ * Emitted when the Spotter query is triggered in Spotter embed.
4951
4972
  * @example
4952
4973
  * ```js
4953
4974
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
4954
4975
  * console.log('payload', payload);
4955
4976
  * })
4956
4977
  *```
4957
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4978
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4958
4979
  */
4959
4980
  SpotterQueryTriggered = "SpotterQueryTriggered",
4960
4981
  /**
4961
- * Emitted when the last spotter query is edited in spotter embed.
4982
+ * Emitted when the last Spotter query is edited in Spotter embed.
4962
4983
  * @example
4963
4984
  * ```js
4964
4985
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
4965
4986
  * console.log('payload', payload);
4966
4987
  * })
4967
4988
  *```
4968
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4989
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4969
4990
  */
4970
4991
  LastPromptEdited = "LastPromptEdited",
4971
4992
  /**
4972
- * Emitted when the last spotter query is deleted in spotter embed.
4993
+ * Emitted when the last Spotter query is deleted in Spotter embed.
4973
4994
  * @example
4974
4995
  * ```js
4975
4996
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
4976
4997
  * console.log('payload', payload);
4977
4998
  * })
4978
4999
  *```
4979
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5000
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4980
5001
  */
4981
5002
  LastPromptDeleted = "LastPromptDeleted",
4982
5003
  /**
@@ -4987,7 +5008,7 @@ export declare enum EmbedEvent {
4987
5008
  * console.log('payload', payload);
4988
5009
  * })
4989
5010
  *```
4990
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5011
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4991
5012
  */
4992
5013
  ResetSpotterConversation = "ResetSpotterConversation",
4993
5014
  /**
@@ -5000,7 +5021,19 @@ export declare enum EmbedEvent {
5000
5021
  *```
5001
5022
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5002
5023
  */
5003
- SpotterInit = "SpotterInit"
5024
+ SpotterInit = "spotterInit",
5025
+ /**
5026
+ * @hidden
5027
+ * Triggers when the embed listener is ready to receive events.
5028
+ * This is used to trigger events after the embed container is loaded.
5029
+ * @example
5030
+ * ```js
5031
+ * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
5032
+ * console.log('EmbedListenerReady');
5033
+ * })
5034
+ * ```
5035
+ */
5036
+ EmbedListenerReady = "EmbedListenerReady"
5004
5037
  }
5005
5038
  /**
5006
5039
  * Event types that can be triggered by the host application
@@ -5088,6 +5121,7 @@ export declare enum HostEvent {
5088
5121
  * done automatically on the most popular column.
5089
5122
  * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
5090
5123
  * in case of a Liveboard.
5124
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5091
5125
  * @example
5092
5126
  * ```js
5093
5127
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -5407,12 +5441,21 @@ export declare enum HostEvent {
5407
5441
  * Trigger the **Download PDF** action on an embedded Liveboard,
5408
5442
  * visualization or Answer.
5409
5443
  *
5444
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5445
+ *
5410
5446
  * **NOTE**: The **Download** > **PDF** action is available on
5411
5447
  * visualizations and Answers if the data is in tabular format.
5412
5448
  * @example
5413
5449
  * ```js
5414
5450
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
5415
5451
  * ```
5452
+ * @example
5453
+ * ```js
5454
+ * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
5455
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5456
+ * });
5457
+ * ```
5458
+ *
5416
5459
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5417
5460
  */
5418
5461
  DownloadAsPdf = "downloadAsPdf",
@@ -5514,7 +5557,8 @@ export declare enum HostEvent {
5514
5557
  * This event is not supported in visualization embed and search embed.
5515
5558
  * @param - object - To trigger the action for a specific visualization
5516
5559
  * in Liveboard embed, pass in `vizId` as a key.
5517
- * **Required** in Spotter embed.
5560
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5561
+ *
5518
5562
  * @example
5519
5563
  * ```js
5520
5564
  * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5529,6 +5573,12 @@ export declare enum HostEvent {
5529
5573
  * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5530
5574
  * });
5531
5575
  * ```
5576
+ * @example
5577
+ * ```js
5578
+ * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
5579
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5580
+ * });
5581
+ * ```
5532
5582
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5533
5583
  */
5534
5584
  Edit = "edit",
@@ -5649,6 +5699,7 @@ export declare enum HostEvent {
5649
5699
  /**
5650
5700
  * Trigger the **Download** action on charts in
5651
5701
  * the embedded view.
5702
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5652
5703
  * @example
5653
5704
  * ```js
5654
5705
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -5657,6 +5708,11 @@ export declare enum HostEvent {
5657
5708
  * ```js
5658
5709
  * embed.trigger(HostEvent.Download)
5659
5710
  * ```
5711
+ * ```js
5712
+ * spotterEmbed.trigger(HostEvent.Download, {
5713
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5714
+ * });
5715
+ * ```
5660
5716
  * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5661
5717
  * Use {@link DownloadAsPng}
5662
5718
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -5685,6 +5741,7 @@ export declare enum HostEvent {
5685
5741
  /**
5686
5742
  * Trigger the **Download** > **CSV** action on tables in
5687
5743
  * the embedded view.
5744
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5688
5745
  * @example
5689
5746
  * ```js
5690
5747
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -5707,6 +5764,7 @@ export declare enum HostEvent {
5707
5764
  /**
5708
5765
  * Trigger the **Download** > **XLSX** action on tables
5709
5766
  * in the embedded view.
5767
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5710
5768
  * @example
5711
5769
  * ```js
5712
5770
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -5742,7 +5800,7 @@ export declare enum HostEvent {
5742
5800
  /**
5743
5801
  * Trigger the **Save** action on a Liveboard or Answer.
5744
5802
  * Saves the changes.
5745
- * @param - `vizId` is required in Spotter Embed.
5803
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5746
5804
  * @example
5747
5805
  * ```js
5748
5806
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -6052,6 +6110,7 @@ export declare enum HostEvent {
6052
6110
  UpdateParameters = "UpdateParameters",
6053
6111
  /**
6054
6112
  * Triggers GetParameters to fetch the runtime Parameters.
6113
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6055
6114
  * ```js
6056
6115
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
6057
6116
  * console.log('parameters', parameter);
@@ -6095,7 +6154,7 @@ export declare enum HostEvent {
6095
6154
  * @param - optional attributes to set Answer properties.
6096
6155
  * `name` - Name string for the Answer.
6097
6156
  * `description` - Description text for the Answer.
6098
- *
6157
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6099
6158
  * @example
6100
6159
  * ```js
6101
6160
  * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -6103,6 +6162,14 @@ export declare enum HostEvent {
6103
6162
  * description: "Total sales by states in MidWest"
6104
6163
  * });
6105
6164
  * ```
6165
+ * @example
6166
+ * ```js
6167
+ * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
6168
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c',
6169
+ * name: "Sales by states",
6170
+ * description: "Total sales by states in MidWest"
6171
+ * });
6172
+ * ```
6106
6173
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
6107
6174
  */
6108
6175
  SaveAnswer = "saveAnswer",
@@ -6134,7 +6201,7 @@ export declare enum HostEvent {
6134
6201
  /**
6135
6202
  * Triggers a search operation with the search tokens specified in
6136
6203
  * the search query string in spotter embed.
6137
- * @param - `queryString`: Text string in Natural Language format
6204
+ * @param - `query`: Text string in Natural Language format
6138
6205
  * @param - `executeSearch`: Boolean to execute search and update search query
6139
6206
  * @example
6140
6207
  * ```js
@@ -6143,6 +6210,7 @@ export declare enum HostEvent {
6143
6210
  * executeSearch: true,
6144
6211
  * })
6145
6212
  * ```
6213
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6146
6214
  */
6147
6215
  SpotterSearch = "SpotterSearch",
6148
6216
  /**
@@ -6152,6 +6220,7 @@ export declare enum HostEvent {
6152
6220
  * ```js
6153
6221
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
6154
6222
  * ```
6223
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6155
6224
  */
6156
6225
  EditLastPrompt = "EditLastPrompt",
6157
6226
  /**
@@ -6160,6 +6229,7 @@ export declare enum HostEvent {
6160
6229
  * ```js
6161
6230
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
6162
6231
  * ```
6232
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6163
6233
  */
6164
6234
  PreviewSpotterData = "PreviewSpotterData",
6165
6235
  /**
@@ -6168,6 +6238,7 @@ export declare enum HostEvent {
6168
6238
  * ```js
6169
6239
  * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
6170
6240
  * ```
6241
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6171
6242
  */
6172
6243
  ResetSpotterConversation = "ResetSpotterConversation",
6173
6244
  /**
@@ -6176,17 +6247,19 @@ export declare enum HostEvent {
6176
6247
  * ```js
6177
6248
  * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
6178
6249
  * ```
6250
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6179
6251
  */
6180
6252
  DeleteLastPrompt = "DeleteLastPrompt",
6181
6253
  /**
6182
6254
  * Toggle the visualization to chart or table view.
6183
- * @param - `vizId ` In Spotter Embed, vizId is required.
6255
+ * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
6184
6256
  * @example
6185
6257
  * ```js
6186
6258
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
6187
- * vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
6259
+ * vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
6188
6260
  * });
6189
6261
  *```
6262
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6190
6263
  */
6191
6264
  AnswerChartSwitcher = "answerChartSwitcher",
6192
6265
  /**
@@ -6213,25 +6286,16 @@ export declare enum HostEvent {
6213
6286
  */
6214
6287
  VisibleEmbedCoordinates = "visibleEmbedCoordinates",
6215
6288
  /**
6216
- * Trigger the *Ask Sage* action for visualizations
6289
+ * Trigger the *Ask Spotter* action for visualizations
6290
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6217
6291
  * @example
6218
6292
  * ```js
6219
- * liveboardEmbed.trigger(HostEvent.AskSpotter,
6220
- * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
6293
+ * spotterEmbed.trigger(HostEvent.AskSpotter,
6294
+ * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
6221
6295
  * ```
6222
6296
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
6223
6297
  */
6224
- AskSpotter = "askSpotter",
6225
- /**
6226
- * @hidden
6227
- * Triggers the update of the embed params.
6228
- *
6229
- * @example
6230
- * ```js
6231
- * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
6232
- * ```
6233
- */
6234
- UpdateEmbedParams = "updateEmbedParams"
6298
+ AskSpotter = "AskSpotter"
6235
6299
  }
6236
6300
  /**
6237
6301
  * The different visual modes that the data sources panel within
@@ -6327,6 +6391,7 @@ export declare enum Param {
6327
6391
  Query = "query",
6328
6392
  HideHomepageLeftNav = "hideHomepageLeftNav",
6329
6393
  ModularHomeExperienceEnabled = "modularHomeExperience",
6394
+ HomepageVersion = "homepageVersion",
6330
6395
  ListPageVersion = "listpageVersion",
6331
6396
  PendoTrackingKey = "additionalPendoKey",
6332
6397
  LiveboardHeaderSticky = "isLiveboardHeaderSticky",
@@ -6519,27 +6584,27 @@ export declare enum Action {
6519
6584
  */
6520
6585
  ConfigureFilter = "configureFilter",
6521
6586
  /**
6522
- * The **Collapse data sources** icon on the Search page.
6523
- * Collapses the panel showing data sources.
6524
- *
6525
- * @example
6526
- * ```js
6527
- * disabledActions: [Action.CollapseDataPanel]
6528
- * ```
6529
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6530
- */
6587
+ * The **Collapse data sources** icon on the Search page.
6588
+ * Collapses the panel showing data sources.
6589
+ *
6590
+ * @example
6591
+ * ```js
6592
+ * disabledActions: [Action.CollapseDataPanel]
6593
+ * ```
6594
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6595
+ */
6531
6596
  CollapseDataSources = "collapseDataSources",
6532
6597
  /**
6533
- * The **Collapse data panel** icon on the Search page.
6534
- * Collapses the data panel view.
6535
- *
6536
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6537
- *
6538
- * @example
6539
- * ```js
6540
- * disabledActions: [Action.CollapseDataPanel]
6541
- * ```
6542
- */
6598
+ * The **Collapse data panel** icon on the Search page.
6599
+ * Collapses the data panel view.
6600
+ *
6601
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6602
+ *
6603
+ * @example
6604
+ * ```js
6605
+ * disabledActions: [Action.CollapseDataPanel]
6606
+ * ```
6607
+ */
6543
6608
  CollapseDataPanel = "collapseDataPanel",
6544
6609
  /**
6545
6610
  * The **Choose sources** button on Search page.
@@ -7235,6 +7300,17 @@ export declare enum Action {
7235
7300
  * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
7236
7301
  */
7237
7302
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
7303
+ /**
7304
+ * Action ID to hide or disable Iterative Change Analysis option
7305
+ * on contextual change analysis Inisght charts context menu
7306
+ *
7307
+ * @example
7308
+ * ```js
7309
+ * disabledActions: [Action.EnableIterativeChangeAnalysis]
7310
+ * ```
7311
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
7312
+ */
7313
+ EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
7238
7314
  /**
7239
7315
  * Action ID to hide or disable Natural Language Search query.
7240
7316
  *
@@ -7603,7 +7679,40 @@ export declare enum Action {
7603
7679
  * ```
7604
7680
  * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
7605
7681
  */
7606
- InConversationTraining = "InConversationTraining"
7682
+ InConversationTraining = "InConversationTraining",
7683
+ /**
7684
+ * Action ID to hide the warnings banner in
7685
+ * Spotter results. It's an EA feature and
7686
+ * handled by LD.
7687
+ * @example
7688
+ * ```js
7689
+ * hiddenAction: [Action.SpotterWarningsBanner]
7690
+ * ```
7691
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7692
+ */
7693
+ SpotterWarningsBanner = "SpotterWarningsBanner",
7694
+ /**
7695
+ * Action ID to hide the warnings border on the knowledge
7696
+ * card in Spotter results. It's an EA feature and
7697
+ * handled by LD.
7698
+ * @example
7699
+ * ```js
7700
+ * hiddenAction: [Action.SpotterWarningsOnTokens]
7701
+ * ```
7702
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7703
+ */
7704
+ SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
7705
+ /**
7706
+ * Action ID to disable the click event handler on knowledge
7707
+ * card in Spotter results. It's an EA feature and
7708
+ * handled by LD.
7709
+ * @example
7710
+ * ```js
7711
+ * hiddenAction: [Action.SpotterTokenQuickEdit]
7712
+ * ```
7713
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7714
+ */
7715
+ SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
7607
7716
  }
7608
7717
  export interface AnswerServiceType {
7609
7718
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -7797,7 +7906,8 @@ export interface SearchOptions {
7797
7906
  */
7798
7907
  export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
7799
7908
  /**
7800
- * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
7909
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses
7910
+ * this object to query data and generate Answers.
7801
7911
  */
7802
7912
  worksheetId: string;
7803
7913
  /**
@@ -7880,6 +7990,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
7880
7990
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
7881
7991
  */
7882
7992
  hideSampleQuestions?: boolean;
7993
+ /**
7994
+ * The list of runtime filters to apply to a search Answer,
7995
+ * visualization, or Liveboard.
7996
+ *
7997
+ * Supported embed types: `SpotterEmbed`
7998
+ * @example
7999
+ * ```js
8000
+ * const embed = new SpotterEmbed('#tsEmbed', {
8001
+ * // other embed view config
8002
+ * runtimeFilters: [
8003
+ * {
8004
+ * columnName: 'color',
8005
+ * operator: RuntimeFilterOp.EQ,
8006
+ * values: ['red'],
8007
+ * },
8008
+ * ],
8009
+ * })
8010
+ * ```
8011
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8012
+ */
8013
+ runtimeFilters?: RuntimeFilter[];
8014
+ /**
8015
+ * Flag to control whether runtime filters should be included in the URL.
8016
+ * If true, filters will be passed via app initialization payload instead.
8017
+ * If false/undefined, filters will be added to URL (default behavior).
8018
+ *
8019
+ * Supported embed types: `SpotterEmbed`
8020
+ * @default false
8021
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8022
+ */
8023
+ excludeRuntimeFiltersfromURL?: boolean;
8024
+ /**
8025
+ * The list of runtime parameters to apply to the conversation.
8026
+ *
8027
+ * Supported embed types: `SpotterEmbed`
8028
+ * @example
8029
+ * ```js
8030
+ * const embed = new SpotterEmbed('#tsEmbed', {
8031
+ * // other embed view config
8032
+ * runtimeParameters: [
8033
+ * {
8034
+ * name: 'Integer Param',
8035
+ * value: 10,
8036
+ * },
8037
+ * ],
8038
+ * })
8039
+ * ```
8040
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8041
+ */
8042
+ runtimeParameters?: RuntimeParameter[];
8043
+ /**
8044
+ * Flag to control whether runtime parameters should be included in the URL.
8045
+ * If true, parameters will be passed via app initialization payload instead.
8046
+ * If false/undefined, parameters will be added to URL (default behavior).
8047
+ *
8048
+ * Supported embed types: `SpotterEmbed`
8049
+ * @default false
8050
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8051
+ */
8052
+ excludeRuntimeParametersfromURL?: boolean;
7883
8053
  }
7884
8054
  /**
7885
8055
  * The configuration for the embedded spotterEmbed options.
@@ -7907,7 +8077,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
7907
8077
  export declare class SpotterEmbed extends TsEmbed {
7908
8078
  protected viewConfig: SpotterEmbedViewConfig;
7909
8079
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
7910
- protected getEmbedParamsObject(): Record<any, any>;
7911
8080
  getIframeSrc(): string;
7912
8081
  render(): Promise<SpotterEmbed>;
7913
8082
  }
@@ -8003,25 +8172,20 @@ export declare class TsEmbed {
8003
8172
  protected isRendered: boolean;
8004
8173
  protected hostEventClient: HostEventClient;
8005
8174
  protected isReadyForRenderPromise: Promise<void>;
8006
- id: string;
8007
8175
  constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
8008
8176
  /**
8009
8177
  * Handles errors within the SDK
8010
8178
  * @param error The error message or object
8011
8179
  */
8012
8180
  protected handleError(error: string | Record<string, unknown>): void;
8013
- isEmbedContainerLoaded: boolean;
8014
8181
  protected getAuthTokenForCookielessInit(): Promise<string>;
8015
8182
  protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
8016
8183
  protected getAppInitData(): Promise<DefaultAppInitData>;
8017
- protected getPreRenderObj<T extends TsEmbed>(): T;
8018
- protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
8019
8184
  /**
8020
8185
  * Constructs the base URL string to load the ThoughtSpot app.
8021
8186
  * @param query
8022
8187
  */
8023
8188
  protected getEmbedBasePath(query: string): string;
8024
- protected getUpdateEmbedParamsObject(): Record<any, any>;
8025
8189
  /**
8026
8190
  * Common query params set for all the embed modes.
8027
8191
  * @param queryParams
@@ -8037,7 +8201,6 @@ export declare class TsEmbed {
8037
8201
  */
8038
8202
  protected getV1EmbedBasePath(queryString: string): string;
8039
8203
  protected getEmbedParams(): string;
8040
- protected getEmbedParamsObject(): Record<any, any>;
8041
8204
  protected getRootIframeSrc(): string;
8042
8205
  protected createIframeEl(frameSrc: string): HTMLIFrameElement;
8043
8206
  protected handleInsertionIntoDOM(child: string | Node): void;
@@ -8129,6 +8292,19 @@ export declare class TsEmbed {
8129
8292
  * ```
8130
8293
  */
8131
8294
  off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
8295
+ /**
8296
+ * @hidden
8297
+ * Internal state to track if the embed container is loaded.
8298
+ * This is used to trigger events after the embed container is loaded.
8299
+ */
8300
+ isEmbedContainerLoaded: boolean;
8301
+ protected getPreRenderObj<T extends TsEmbed>(): T;
8302
+ /**
8303
+ * Executes a callback after the embed container is loaded.
8304
+ * @param callback The callback to execute
8305
+ */
8306
+ protected executeAfterEmbedContainerLoaded(callback: () => void): void;
8307
+ protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
8132
8308
  /**
8133
8309
  * Triggers an event to the embedded app
8134
8310
  * @param {HostEvent} messageType The event type
@@ -8730,6 +8906,322 @@ export interface CustomCssVariables {
8730
8906
  * Background color of checkbox.
8731
8907
  */
8732
8908
  '--ts-var-checkbox-background-color'?: string;
8909
+ /**
8910
+ * Height of the tiles in the Liveboard.
8911
+ */
8912
+ '--ts-var-viz-tile-height'?: string;
8913
+ /**
8914
+ * Background color of the layout in the Liveboard.
8915
+ */
8916
+ '--ts-var-liveboard-layout-background'?: string;
8917
+ /**
8918
+ * Font color of the title of the layout in the Liveboard.
8919
+ */
8920
+ '--ts-var-liveboard-layout-title-color'?: string;
8921
+ /**
8922
+ * Font size of the title of the layout in the Liveboard.
8923
+ */
8924
+ '--ts-var-liveboard-layout-title-fontsize'?: string;
8925
+ /**
8926
+ * Background color of the header in the Liveboard.
8927
+ */
8928
+ '--ts-var-liveboard-header-background'?: string;
8929
+ /**
8930
+ * Font size of the header in the Liveboard.
8931
+ */
8932
+ '--ts-var-liveboard-header-fontsize'?: string;
8933
+ /**
8934
+ * Font color of the header in the Liveboard.
8935
+ */
8936
+ '--ts-var-liveboard-header-font-color'?: string;
8937
+ /**
8938
+ * Border color of the tiles in the Liveboard.
8939
+ */
8940
+ '--ts-var-liveboard-tile-border-color'?: string;
8941
+ /**
8942
+ * Background color of the tiles in the Liveboard.
8943
+ */
8944
+ '--ts-var-liveboard-tile-background'?: string;
8945
+ /**
8946
+ * Border radius of the tiles in the Liveboard.
8947
+ */
8948
+ '--ts-var-liveboard-tile-border-radius'?: string;
8949
+ /**
8950
+ * Padding of the tiles in the Liveboard.
8951
+ */
8952
+ '--ts-var-liveboard-tile-padding'?: string;
8953
+ /**
8954
+ * Background color of the table header in the Liveboard.
8955
+ */
8956
+ '--ts-var-liveboard-tile-table-header-background'?: string;
8957
+ /**
8958
+ * Padding of the groups in the Liveboard.
8959
+ */
8960
+ '--ts-var-liveboard-group-padding'?: string;
8961
+ /**
8962
+ * Padding of the title of the groups in the Liveboard.
8963
+ */
8964
+ '--ts-var-liveboard-group-title-padding'?: string;
8965
+ /**
8966
+ * Font size of the title of the groups in the Liveboard.
8967
+ */
8968
+ '--ts-var-liveboard-group-title-font-size'?: string;
8969
+ /**
8970
+ * Font weight of the title of the groups in the Liveboard.
8971
+ */
8972
+ '--ts-var-liveboard-group-title-font-weight'?: string;
8973
+ /**
8974
+ * Font size of the title of the tiles inside the groups in the Liveboard.
8975
+ */
8976
+ '--ts-var-liveboard-group-tile-title-font-size'?: string;
8977
+ /**
8978
+ * Font weight of the title of the tiles inside the groups in the Liveboard.
8979
+ */
8980
+ '--ts-var-liveboard-group-tile-title-font-weight'?: string;
8981
+ /**
8982
+ * Font size of the description of the groups in the Liveboard.
8983
+ */
8984
+ '--ts-var-liveboard-group-description-font-size'?: string;
8985
+ /**
8986
+ * Font weight of the description of the groups in the Liveboard.
8987
+ */
8988
+ '--ts-var-liveboard-group-description-font-weight'?: string;
8989
+ /**
8990
+ * Border of the tiles in the Liveboard.
8991
+ */
8992
+ '--ts-var-liveboard-group-tile-border'?: string;
8993
+ /**
8994
+ * Padding of the tiles in the Liveboard.
8995
+ */
8996
+ '--ts-var-liveboard-group-tile-padding'?: string;
8997
+ /**
8998
+ * Padding of the answer viz in the Liveboard.
8999
+ */
9000
+ '--ts-var-liveboard-answer-viz-padding'?: string;
9001
+ /**
9002
+ * Background color of the groups in the Liveboard.
9003
+ */
9004
+ '--ts-var-liveboard-group-background'?: string;
9005
+ /**
9006
+ * Border color of the groups in the Liveboard.
9007
+ */
9008
+ '--ts-var-liveboard-group-border-color'?: string;
9009
+ /**
9010
+ * Font color of the heading of the note title in the Liveboard.
9011
+ */
9012
+ '--ts-var-liveboard-notetitle-heading-font-color'?: string;
9013
+ /**
9014
+ * Font color of the body of the note title in the Liveboard.
9015
+ */
9016
+ '--ts-var-liveboard-notetitle-body-font-color'?: string;
9017
+ /**
9018
+ * Font color of the title of the groups in the Liveboard.
9019
+ */
9020
+ '--ts-var-liveboard-group-title-font-color'?: string;
9021
+ /**
9022
+ * Font color of the description of the groups in the Liveboard.
9023
+ */
9024
+ '--ts-var-liveboard-group-description-font-color'?: string;
9025
+ /**
9026
+ * Font color of the title of the tiles inside the groups in the Liveboard.
9027
+ */
9028
+ '--ts-var-liveboard-group-tile-title-font-color'?: string;
9029
+ /**
9030
+ * Background color of the tiles inside the groups in the Liveboard.
9031
+ */
9032
+ '--ts-var-liveboard-group-tile-background'?: string;
9033
+ /**
9034
+ * Background color of the chips in the Liveboard.
9035
+ */
9036
+ '--ts-var-liveboard-chip-background'?: string;
9037
+ /**
9038
+ * Font color of the chips in the Liveboard.
9039
+ */
9040
+ '--ts-var-liveboard-chip-color'?: string;
9041
+ /**
9042
+ * Background color of the chips in the Liveboard on hover.
9043
+ */
9044
+ '--ts-var-liveboard-chip--hover-background'?: string;
9045
+ /**
9046
+ * Font color of the chips in the Liveboard on hover.
9047
+ */
9048
+ '--ts-var-liveboard-chip--hover-color'?: string;
9049
+ /**
9050
+ * Background color of the chips in the Liveboard on active.
9051
+ */
9052
+ '--ts-var-liveboard-chip--active-background'?: string;
9053
+ /**
9054
+ * Font color of the chips in the Liveboard on active.
9055
+ */
9056
+ '--ts-var-liveboard-chip--active-color'?: string;
9057
+ /**
9058
+ * Width of the side panel in the Liveboard.
9059
+ */
9060
+ '--ts-var-side-panel-width'?: string;
9061
+ /**
9062
+ * Background color of the edit bar in the Liveboard.
9063
+ */
9064
+ '--ts-var-liveboard-edit-bar-background'?: string;
9065
+ /**
9066
+ * Breakpoint for the dual column layout in the Liveboard.
9067
+ */
9068
+ '--ts-var-liveboard-dual-column-breakpoint'?: string;
9069
+ /**
9070
+ * Breakpoint for the single column layout in the Liveboard.
9071
+ */
9072
+ '--ts-var-liveboard-single-column-breakpoint'?: string;
9073
+ /**
9074
+ * Background color of the cross filter layout in the Liveboard.
9075
+ */
9076
+ '--ts-var-liveboard-cross-filter-layout-background'?: string;
9077
+ /**
9078
+ * Border color of the active tab in the Liveboard.
9079
+ */
9080
+ '--ts-var-liveboard-tab-active-border-color'?: string;
9081
+ /**
9082
+ * Font color of the hover tab in the Liveboard.
9083
+ */
9084
+ '--ts-var-liveboard-tab-hover-color'?: string;
9085
+ /**
9086
+ * Font size of the title of the tiles in the Liveboard.
9087
+ */
9088
+ '--ts-var-liveboard-tile-title-fontsize'?: string;
9089
+ /**
9090
+ * Font weight of the title of the tiles in the Liveboard.
9091
+ */
9092
+ '--ts-var-liveboard-tile-title-fontweight'?: string;
9093
+ /**
9094
+ * Font weight of the description of the tiles in the Liveboard.
9095
+ */
9096
+ '--ts-var-liveboard-tile-description-font-weight'?: string;
9097
+ /**
9098
+ * Opacity of the description of the tiles in the Liveboard.
9099
+ */
9100
+ '--ts-var-liveboard-tile-description-opacity'?: string;
9101
+ /**
9102
+ * Background color of the parameter chips in the Liveboard.
9103
+ */
9104
+ '--ts-var-parameter-chip-background'?: string;
9105
+ /**
9106
+ * Font color of the parameter chips in the Liveboard.
9107
+ */
9108
+ '--ts-var-parameter-chip-text-color'?: string;
9109
+ /**
9110
+ * Background color of the parameter chips in the Liveboard on hover.
9111
+ */
9112
+ '--ts-var-parameter-chip-hover-background'?: string;
9113
+ /**
9114
+ * Font color of the parameter chips in the Liveboard on hover.
9115
+ */
9116
+ '--ts-var-parameter-chip-hover-text-color'?: string;
9117
+ /**
9118
+ * Background color of the parameter chips in the Liveboard on active.
9119
+ */
9120
+ '--ts-var-parameter-chip-active-background'?: string;
9121
+ /**
9122
+ * Font color of the parameter chips in the Liveboard on active.
9123
+ */
9124
+ '--ts-var-parameter-chip-active-text-color'?: string;
9125
+ /**
9126
+ * Background color of the action button in the Liveboard header.
9127
+ */
9128
+ '--ts-var-liveboard-header-action-button-background'?: string;
9129
+ /**
9130
+ * Font color of the action button in the Liveboard header.
9131
+ */
9132
+ '--ts-var-liveboard-header-action-button-font-color'?: string;
9133
+ /**
9134
+ * Font color of the action button in the Liveboard header on hover.
9135
+ */
9136
+ '--ts-var-liveboard-header-action-button-hover-color'?: string;
9137
+ /**
9138
+ * Font color of the action button in the Liveboard header on active.
9139
+ */
9140
+ '--ts-var-liveboard-header-action-button-active-color'?: string;
9141
+ /**
9142
+ * Background color of the badge in the Liveboard header.
9143
+ */
9144
+ '--ts-var-liveboard-header-badge-background'?: string;
9145
+ /**
9146
+ * Font color of the badge in the Liveboard header.
9147
+ */
9148
+ '--ts-var-liveboard-header-badge-font-color'?: string;
9149
+ /**
9150
+ * Background color of the modified badge in the Liveboard header.
9151
+ */
9152
+ '--ts-var-liveboard-header-badge-modified-background'?: string;
9153
+ /**
9154
+ * Font color of the modified badge in the Liveboard header.
9155
+ */
9156
+ '--ts-var-liveboard-header-badge-modified-font-color'?: string;
9157
+ /**
9158
+ * Font color of the badge in the Liveboard header on hover.
9159
+ */
9160
+ '--ts-var-liveboard-header-badge-hover-color'?: string;
9161
+ /**
9162
+ * Font color of the badge in the Liveboard header on active.
9163
+ */
9164
+ '--ts-var-liveboard-header-badge-active-color'?: string;
9165
+ /**
9166
+ * Font color of the hero text in the KPI widget.
9167
+ */
9168
+ '--ts-var-kpi-hero-color'?: string;
9169
+ /**
9170
+ * Font color of the comparison text in the KPI widget.
9171
+ */
9172
+ '--ts-var-kpi-comparison-color'?: string;
9173
+ /**
9174
+ * Font color of the analyze text in the KPI widget.
9175
+ */
9176
+ '--ts-var-kpi-analyze-text-color'?: string;
9177
+ /**
9178
+ * Font color of the legend title in the heatmap chart.
9179
+ */
9180
+ '--ts-var-chart-heatmap-legend-title-color'?: string;
9181
+ /**
9182
+ * Font color of the legend label in the heatmap chart.
9183
+ */
9184
+ '--ts-var-chart-heatmap-legend-label-color'?: string;
9185
+ /**
9186
+ * Font color of the legend title in the treemap chart.
9187
+ */
9188
+ '--ts-var-chart-treemap-legend-title-color'?: string;
9189
+ /**
9190
+ * Font color of the legend label in the treemap chart.
9191
+ */
9192
+ '--ts-var-chart-treemap-legend-label-color'?: string;
9193
+ /**
9194
+ * Color of the positive change in the KPI.
9195
+ */
9196
+ '--ts-var-kpi-positive-change-color'?: string;
9197
+ /**
9198
+ * Color of the negative change in the KPI.
9199
+ */
9200
+ '--ts-var-kpi-negative-change-color'?: string;
9201
+ /**
9202
+ * Background color of the change analysis insights.
9203
+ */
9204
+ '--ts-var-change-analysis-insights-background'?: string;
9205
+ /**
9206
+ * Background color of the forecasting card in the SpotIQ analyze.
9207
+ */
9208
+ '--ts-var-spotiq-analyze-forecasting-card-background'?: string;
9209
+ /**
9210
+ * Background color of the outlier card in the SpotIQ analyze.
9211
+ */
9212
+ '--ts-var-spotiq-analyze-outlier-card-background'?: string;
9213
+ /**
9214
+ * Background color of the trend card in the SpotIQ analyze.
9215
+ */
9216
+ '--ts-var-spotiq-analyze-trend-card-background'?: string;
9217
+ /**
9218
+ * Background color of the crosscorrelation card in the SpotIQ analyze.
9219
+ */
9220
+ '--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
9221
+ /**
9222
+ * Background color of the summary header in the CCA modal.
9223
+ */
9224
+ '--ts-var-cca-modal-summary-header-background'?: string;
8733
9225
  }
8734
9226
 
8735
9227
  export interface SessionInterface {
@@ -9301,16 +9793,31 @@ export declare const getAnswerFromQuery: (query: string, worksheetId: string) =>
9301
9793
  }>;
9302
9794
 
9303
9795
  /**
9304
- * Create a liveboard with the given answers
9305
- * @param answers AnswerService[]
9306
- * @param name string
9796
+ * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
9797
+ *
9798
+ * Each answer will be added as a visualization to the newly created Liveboard.
9799
+ *
9800
+ * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
9801
+ * representing the answers to be added to the Liveboard.
9802
+ * @param {string} name - The name of the Liveboard to create.
9307
9803
  * @returns result Promise
9308
9804
  * @version SDK: 1.33.1 | ThoughtSpot: *
9309
9805
  * @example
9310
9806
  * ```js
9311
- * const lb = createLiveboardWithAnswers([
9312
- * new AnswerService(session, null, 'tshost'),
9313
- * ], "my-liveboard");
9807
+ * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
9808
+ *
9809
+ * embed.on(EmbedEvent.Data, async () => {
9810
+ * try {
9811
+ * const answerService = await embed.getAnswerService();
9812
+ * const lb = await createLiveboardWithAnswers(
9813
+ * [answerService],
9814
+ * "My Liveboard"
9815
+ * );
9816
+ * console.log("Liveboard created:", lb);
9817
+ * } catch (err) {
9818
+ * console.error("Failed to create liveboard:", err);
9819
+ * }
9820
+ * });
9314
9821
  * ```
9315
9822
  */
9316
9823
  export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;