@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.41.0-pre-render-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.
- package/cjs/package.json +5 -4
- package/cjs/src/css-variables.d.ts +316 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +8 -0
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +12 -2
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/cjs/src/embed/bodyless-conversation.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +63 -2
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +10 -2
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +102 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +11 -2
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +21 -7
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +185 -4
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +22 -7
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +75 -46
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +173 -1
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +152 -44
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +139 -42
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/liveboardService/liveboardService.d.ts +21 -6
- package/cjs/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
- package/cjs/src/utils/liveboardService/liveboardService.js +21 -6
- package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
- package/dist/index-BDlM0f0T.js +7371 -0
- package/dist/src/css-variables.d.ts +316 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +63 -2
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +11 -2
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +22 -7
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +152 -44
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/liveboardService/liveboardService.d.ts +21 -6
- package/dist/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +256 -100
- package/dist/tsembed-react.js +255 -99
- package/dist/tsembed.es.js +277 -106
- package/dist/tsembed.js +276 -105
- package/dist/visual-embed-sdk-react-full.d.ts +575 -57
- package/dist/visual-embed-sdk-react.d.ts +575 -57
- package/dist/visual-embed-sdk.d.ts +575 -57
- package/lib/package.json +5 -4
- package/lib/src/css-variables.d.ts +316 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +8 -0
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +12 -2
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/lib/src/embed/bodyless-conversation.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +63 -2
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -3
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +104 -2
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +11 -2
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +21 -7
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +185 -4
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +22 -7
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +75 -46
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +173 -1
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +152 -44
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +139 -42
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/liveboardService/liveboardService.d.ts +21 -6
- package/lib/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
- package/lib/src/utils/liveboardService/liveboardService.js +21 -6
- package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +576 -58
- package/package.json +5 -4
- package/src/css-variables.ts +396 -1
- package/src/embed/app.spec.ts +17 -2
- package/src/embed/app.ts +8 -0
- package/src/embed/bodyless-conversation.ts +0 -1
- package/src/embed/conversation.spec.ts +131 -5
- package/src/embed/conversation.ts +89 -10
- package/src/embed/liveboard.spec.ts +236 -5
- package/src/embed/liveboard.ts +22 -7
- package/src/embed/sage.ts +1 -1
- package/src/embed/ts-embed.spec.ts +345 -113
- package/src/embed/ts-embed.ts +83 -56
- package/src/types.ts +199 -91
- package/src/utils/liveboardService/liveboardService.ts +21 -6
|
@@ -1154,6 +1154,16 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
1154
1154
|
*/
|
|
1155
1155
|
protected getEmbedParams(): string;
|
|
1156
1156
|
protected getEmbedParamsObject(): any;
|
|
1157
|
+
/**
|
|
1158
|
+
* @hidden
|
|
1159
|
+
* Internal state to track the current liveboard id.
|
|
1160
|
+
* This is used to navigate to the correct liveboard when the prerender is visible.
|
|
1161
|
+
*/
|
|
1162
|
+
currentLiveboardState: {
|
|
1163
|
+
liveboardId: string;
|
|
1164
|
+
vizId: string;
|
|
1165
|
+
activeTabId: string;
|
|
1166
|
+
};
|
|
1157
1167
|
protected beforePrerenderVisible(): void;
|
|
1158
1168
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
1159
1169
|
/**
|
|
@@ -1174,8 +1184,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
1174
1184
|
* visualization ID and the runtime filters.
|
|
1175
1185
|
*/
|
|
1176
1186
|
render(): Promise<LiveboardEmbed>;
|
|
1177
|
-
|
|
1178
|
-
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void): void;
|
|
1187
|
+
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
1179
1188
|
/**
|
|
1180
1189
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
1181
1190
|
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
@@ -1762,7 +1771,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
|
|
|
1762
1771
|
}
|
|
1763
1772
|
|
|
1764
1773
|
declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
|
|
1765
|
-
import { BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
|
|
1774
|
+
import { BaseViewConfig, RuntimeFilter, RuntimeParameter } from '@thoughtspot/visual-embed-sdk/types';
|
|
1766
1775
|
import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
|
|
1767
1776
|
/**
|
|
1768
1777
|
* Configuration for search options
|
|
@@ -1779,7 +1788,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
|
|
|
1779
1788
|
*/
|
|
1780
1789
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
1781
1790
|
/**
|
|
1782
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
1791
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
1792
|
+
* this object to query data and generate Answers.
|
|
1783
1793
|
*/
|
|
1784
1794
|
worksheetId: string;
|
|
1785
1795
|
/**
|
|
@@ -1862,6 +1872,66 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
|
|
|
1862
1872
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1863
1873
|
*/
|
|
1864
1874
|
hideSampleQuestions?: boolean;
|
|
1875
|
+
/**
|
|
1876
|
+
* The list of runtime filters to apply to a search Answer,
|
|
1877
|
+
* visualization, or Liveboard.
|
|
1878
|
+
*
|
|
1879
|
+
* Supported embed types: `SpotterEmbed`
|
|
1880
|
+
* @example
|
|
1881
|
+
* ```js
|
|
1882
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
1883
|
+
* // other embed view config
|
|
1884
|
+
* runtimeFilters: [
|
|
1885
|
+
* {
|
|
1886
|
+
* columnName: 'color',
|
|
1887
|
+
* operator: RuntimeFilterOp.EQ,
|
|
1888
|
+
* values: ['red'],
|
|
1889
|
+
* },
|
|
1890
|
+
* ],
|
|
1891
|
+
* })
|
|
1892
|
+
* ```
|
|
1893
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1894
|
+
*/
|
|
1895
|
+
runtimeFilters?: RuntimeFilter[];
|
|
1896
|
+
/**
|
|
1897
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
1898
|
+
* If true, filters will be passed via app initialization payload instead.
|
|
1899
|
+
* If false/undefined, filters will be added to URL (default behavior).
|
|
1900
|
+
*
|
|
1901
|
+
* Supported embed types: `SpotterEmbed`
|
|
1902
|
+
* @default false
|
|
1903
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1904
|
+
*/
|
|
1905
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
1906
|
+
/**
|
|
1907
|
+
* The list of runtime parameters to apply to the conversation.
|
|
1908
|
+
*
|
|
1909
|
+
* Supported embed types: `SpotterEmbed`
|
|
1910
|
+
* @example
|
|
1911
|
+
* ```js
|
|
1912
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
1913
|
+
* // other embed view config
|
|
1914
|
+
* runtimeParameters: [
|
|
1915
|
+
* {
|
|
1916
|
+
* name: 'Integer Param',
|
|
1917
|
+
* value: 10,
|
|
1918
|
+
* },
|
|
1919
|
+
* ],
|
|
1920
|
+
* })
|
|
1921
|
+
* ```
|
|
1922
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1923
|
+
*/
|
|
1924
|
+
runtimeParameters?: RuntimeParameter[];
|
|
1925
|
+
/**
|
|
1926
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
1927
|
+
* If true, parameters will be passed via app initialization payload instead.
|
|
1928
|
+
* If false/undefined, parameters will be added to URL (default behavior).
|
|
1929
|
+
*
|
|
1930
|
+
* Supported embed types: `SpotterEmbed`
|
|
1931
|
+
* @default false
|
|
1932
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1933
|
+
*/
|
|
1934
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
1865
1935
|
}
|
|
1866
1936
|
/**
|
|
1867
1937
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -3216,12 +3286,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3216
3286
|
* Hide list page columns
|
|
3217
3287
|
* For example: hiddenListColumns = [ListPageColumns.Author]
|
|
3218
3288
|
*
|
|
3219
|
-
* **Note**: This option is available only in full app embedding.
|
|
3289
|
+
* **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
|
|
3220
3290
|
*
|
|
3221
3291
|
* Supported embed types: `AppEmbed`
|
|
3222
3292
|
* @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
|
|
3223
3293
|
* @example
|
|
3224
3294
|
* ```js
|
|
3295
|
+
* import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
|
|
3296
|
+
*
|
|
3225
3297
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3226
3298
|
* ... //other embed view config
|
|
3227
3299
|
* hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
|
|
@@ -3236,11 +3308,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3236
3308
|
* **Note**: This option does not apply to the classic homepage.
|
|
3237
3309
|
* To access the updated modular homepage, set
|
|
3238
3310
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3311
|
+
* To use it, you need to import `HomepageModule` enum.
|
|
3239
3312
|
*
|
|
3240
3313
|
* Supported embed types: `AppEmbed`
|
|
3241
3314
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3242
3315
|
* @example
|
|
3243
3316
|
* ```js
|
|
3317
|
+
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
3318
|
+
*
|
|
3244
3319
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3245
3320
|
* ... //other embed view config
|
|
3246
3321
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
@@ -3255,11 +3330,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3255
3330
|
* **Note**: This option does not apply to the classic homepage.
|
|
3256
3331
|
* To access the updated modular homepage, set
|
|
3257
3332
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3333
|
+
* To use it, you need to import `HomepageModule` enum.
|
|
3258
3334
|
*
|
|
3259
3335
|
* Supported embed types: `AppEmbed`
|
|
3260
3336
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3261
3337
|
* @example
|
|
3262
3338
|
* ```js
|
|
3339
|
+
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
3340
|
+
*
|
|
3263
3341
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3264
3342
|
* ... //other embed view config
|
|
3265
3343
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
@@ -3275,6 +3353,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3275
3353
|
* Supported embed types: `AppEmbed`
|
|
3276
3354
|
* @example
|
|
3277
3355
|
* ```js
|
|
3356
|
+
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
3357
|
+
*
|
|
3278
3358
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3279
3359
|
* ... //other embed view config
|
|
3280
3360
|
* hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
|
|
@@ -3284,6 +3364,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
3284
3364
|
* **Note**: This option does not apply to the classic homepage.
|
|
3285
3365
|
* To access the updated modular homepage, set
|
|
3286
3366
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3367
|
+
* To use it, you need to import `HomeLeftNavItem` enum.
|
|
3287
3368
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3288
3369
|
*/
|
|
3289
3370
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -4492,7 +4573,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4492
4573
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4493
4574
|
* @example
|
|
4494
4575
|
*```js
|
|
4495
|
-
* liveboardEmbed.on(EmbedEvent.
|
|
4576
|
+
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
4496
4577
|
* console.log('Liveboard details', payload);
|
|
4497
4578
|
* })
|
|
4498
4579
|
*```
|
|
@@ -4867,58 +4948,58 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4867
4948
|
*/
|
|
4868
4949
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
4869
4950
|
/**
|
|
4870
|
-
* Emitted when
|
|
4951
|
+
* Emitted when Spotter response is text data
|
|
4871
4952
|
* @example
|
|
4872
4953
|
* ```js
|
|
4873
4954
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
4874
4955
|
* console.log('payload', payload);
|
|
4875
4956
|
* })
|
|
4876
4957
|
*```
|
|
4877
|
-
* @version SDK: 1.
|
|
4958
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4878
4959
|
*/
|
|
4879
4960
|
SpotterData = "SpotterData",
|
|
4880
4961
|
/**
|
|
4881
|
-
* Emitted when user opens up the worksheet preview modal in
|
|
4962
|
+
* Emitted when user opens up the worksheet preview modal in Spotter embed.
|
|
4882
4963
|
* @example
|
|
4883
4964
|
* ```js
|
|
4884
4965
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
4885
4966
|
* console.log('payload', payload);
|
|
4886
4967
|
* })
|
|
4887
4968
|
*```
|
|
4888
|
-
* @version SDK: 1.
|
|
4969
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4889
4970
|
*/
|
|
4890
4971
|
PreviewSpotterData = "PreviewSpotterData",
|
|
4891
4972
|
/**
|
|
4892
|
-
* Emitted when the
|
|
4973
|
+
* Emitted when the Spotter query is triggered in Spotter embed.
|
|
4893
4974
|
* @example
|
|
4894
4975
|
* ```js
|
|
4895
4976
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
4896
4977
|
* console.log('payload', payload);
|
|
4897
4978
|
* })
|
|
4898
4979
|
*```
|
|
4899
|
-
* @version SDK: 1.
|
|
4980
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4900
4981
|
*/
|
|
4901
4982
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
4902
4983
|
/**
|
|
4903
|
-
* Emitted when the last
|
|
4984
|
+
* Emitted when the last Spotter query is edited in Spotter embed.
|
|
4904
4985
|
* @example
|
|
4905
4986
|
* ```js
|
|
4906
4987
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
4907
4988
|
* console.log('payload', payload);
|
|
4908
4989
|
* })
|
|
4909
4990
|
*```
|
|
4910
|
-
* @version SDK: 1.
|
|
4991
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4911
4992
|
*/
|
|
4912
4993
|
LastPromptEdited = "LastPromptEdited",
|
|
4913
4994
|
/**
|
|
4914
|
-
* Emitted when the last
|
|
4995
|
+
* Emitted when the last Spotter query is deleted in Spotter embed.
|
|
4915
4996
|
* @example
|
|
4916
4997
|
* ```js
|
|
4917
4998
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
4918
4999
|
* console.log('payload', payload);
|
|
4919
5000
|
* })
|
|
4920
5001
|
*```
|
|
4921
|
-
* @version SDK: 1.
|
|
5002
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4922
5003
|
*/
|
|
4923
5004
|
LastPromptDeleted = "LastPromptDeleted",
|
|
4924
5005
|
/**
|
|
@@ -4929,7 +5010,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4929
5010
|
* console.log('payload', payload);
|
|
4930
5011
|
* })
|
|
4931
5012
|
*```
|
|
4932
|
-
* @version SDK: 1.
|
|
5013
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4933
5014
|
*/
|
|
4934
5015
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
4935
5016
|
/**
|
|
@@ -4942,7 +5023,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
4942
5023
|
*```
|
|
4943
5024
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4944
5025
|
*/
|
|
4945
|
-
SpotterInit = "
|
|
5026
|
+
SpotterInit = "spotterInit",
|
|
5027
|
+
/**
|
|
5028
|
+
* @hidden
|
|
5029
|
+
* Triggers when the embed listener is ready to receive events.
|
|
5030
|
+
* This is used to trigger events after the embed container is loaded.
|
|
5031
|
+
* @example
|
|
5032
|
+
* ```js
|
|
5033
|
+
* liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
|
|
5034
|
+
* console.log('EmbedListenerReady');
|
|
5035
|
+
* })
|
|
5036
|
+
* ```
|
|
5037
|
+
*/
|
|
5038
|
+
EmbedListenerReady = "EmbedListenerReady"
|
|
4946
5039
|
}
|
|
4947
5040
|
/**
|
|
4948
5041
|
* Event types that can be triggered by the host application
|
|
@@ -5030,6 +5123,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5030
5123
|
* done automatically on the most popular column.
|
|
5031
5124
|
* @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
|
|
5032
5125
|
* in case of a Liveboard.
|
|
5126
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5033
5127
|
* @example
|
|
5034
5128
|
* ```js
|
|
5035
5129
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -5349,12 +5443,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5349
5443
|
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
5350
5444
|
* visualization or Answer.
|
|
5351
5445
|
*
|
|
5446
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5447
|
+
*
|
|
5352
5448
|
* **NOTE**: The **Download** > **PDF** action is available on
|
|
5353
5449
|
* visualizations and Answers if the data is in tabular format.
|
|
5354
5450
|
* @example
|
|
5355
5451
|
* ```js
|
|
5356
5452
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
5357
5453
|
* ```
|
|
5454
|
+
* @example
|
|
5455
|
+
* ```js
|
|
5456
|
+
* spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
|
|
5457
|
+
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5458
|
+
* });
|
|
5459
|
+
* ```
|
|
5460
|
+
*
|
|
5358
5461
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5359
5462
|
*/
|
|
5360
5463
|
DownloadAsPdf = "downloadAsPdf",
|
|
@@ -5456,7 +5559,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5456
5559
|
* This event is not supported in visualization embed and search embed.
|
|
5457
5560
|
* @param - object - To trigger the action for a specific visualization
|
|
5458
5561
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
5459
|
-
*
|
|
5562
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5563
|
+
*
|
|
5460
5564
|
* @example
|
|
5461
5565
|
* ```js
|
|
5462
5566
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
@@ -5471,6 +5575,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5471
5575
|
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5472
5576
|
* });
|
|
5473
5577
|
* ```
|
|
5578
|
+
* @example
|
|
5579
|
+
* ```js
|
|
5580
|
+
* const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
|
|
5581
|
+
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5582
|
+
* });
|
|
5583
|
+
* ```
|
|
5474
5584
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5475
5585
|
*/
|
|
5476
5586
|
Edit = "edit",
|
|
@@ -5591,6 +5701,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5591
5701
|
/**
|
|
5592
5702
|
* Trigger the **Download** action on charts in
|
|
5593
5703
|
* the embedded view.
|
|
5704
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5594
5705
|
* @example
|
|
5595
5706
|
* ```js
|
|
5596
5707
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -5599,6 +5710,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5599
5710
|
* ```js
|
|
5600
5711
|
* embed.trigger(HostEvent.Download)
|
|
5601
5712
|
* ```
|
|
5713
|
+
* ```js
|
|
5714
|
+
* spotterEmbed.trigger(HostEvent.Download, {
|
|
5715
|
+
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5716
|
+
* });
|
|
5717
|
+
* ```
|
|
5602
5718
|
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5603
5719
|
* Use {@link DownloadAsPng}
|
|
5604
5720
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
@@ -5627,6 +5743,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5627
5743
|
/**
|
|
5628
5744
|
* Trigger the **Download** > **CSV** action on tables in
|
|
5629
5745
|
* the embedded view.
|
|
5746
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5630
5747
|
* @example
|
|
5631
5748
|
* ```js
|
|
5632
5749
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -5649,6 +5766,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5649
5766
|
/**
|
|
5650
5767
|
* Trigger the **Download** > **XLSX** action on tables
|
|
5651
5768
|
* in the embedded view.
|
|
5769
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5652
5770
|
* @example
|
|
5653
5771
|
* ```js
|
|
5654
5772
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -5684,7 +5802,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5684
5802
|
/**
|
|
5685
5803
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
5686
5804
|
* Saves the changes.
|
|
5687
|
-
* @param - `vizId` is required in Spotter
|
|
5805
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5688
5806
|
* @example
|
|
5689
5807
|
* ```js
|
|
5690
5808
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -5994,6 +6112,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
5994
6112
|
UpdateParameters = "UpdateParameters",
|
|
5995
6113
|
/**
|
|
5996
6114
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
6115
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5997
6116
|
* ```js
|
|
5998
6117
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5999
6118
|
* console.log('parameters', parameter);
|
|
@@ -6037,7 +6156,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6037
6156
|
* @param - optional attributes to set Answer properties.
|
|
6038
6157
|
* `name` - Name string for the Answer.
|
|
6039
6158
|
* `description` - Description text for the Answer.
|
|
6040
|
-
*
|
|
6159
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6041
6160
|
* @example
|
|
6042
6161
|
* ```js
|
|
6043
6162
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -6045,6 +6164,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6045
6164
|
* description: "Total sales by states in MidWest"
|
|
6046
6165
|
* });
|
|
6047
6166
|
* ```
|
|
6167
|
+
* @example
|
|
6168
|
+
* ```js
|
|
6169
|
+
* const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
|
|
6170
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c',
|
|
6171
|
+
* name: "Sales by states",
|
|
6172
|
+
* description: "Total sales by states in MidWest"
|
|
6173
|
+
* });
|
|
6174
|
+
* ```
|
|
6048
6175
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
6049
6176
|
*/
|
|
6050
6177
|
SaveAnswer = "saveAnswer",
|
|
@@ -6076,7 +6203,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6076
6203
|
/**
|
|
6077
6204
|
* Triggers a search operation with the search tokens specified in
|
|
6078
6205
|
* the search query string in spotter embed.
|
|
6079
|
-
* @param - `
|
|
6206
|
+
* @param - `query`: Text string in Natural Language format
|
|
6080
6207
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
6081
6208
|
* @example
|
|
6082
6209
|
* ```js
|
|
@@ -6085,6 +6212,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6085
6212
|
* executeSearch: true,
|
|
6086
6213
|
* })
|
|
6087
6214
|
* ```
|
|
6215
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6088
6216
|
*/
|
|
6089
6217
|
SpotterSearch = "SpotterSearch",
|
|
6090
6218
|
/**
|
|
@@ -6094,6 +6222,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6094
6222
|
* ```js
|
|
6095
6223
|
* spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
|
|
6096
6224
|
* ```
|
|
6225
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6097
6226
|
*/
|
|
6098
6227
|
EditLastPrompt = "EditLastPrompt",
|
|
6099
6228
|
/**
|
|
@@ -6102,6 +6231,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6102
6231
|
* ```js
|
|
6103
6232
|
* spotterEmbed.trigger(HostEvent.PreviewSpotterData);
|
|
6104
6233
|
* ```
|
|
6234
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6105
6235
|
*/
|
|
6106
6236
|
PreviewSpotterData = "PreviewSpotterData",
|
|
6107
6237
|
/**
|
|
@@ -6110,6 +6240,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6110
6240
|
* ```js
|
|
6111
6241
|
* spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
|
|
6112
6242
|
* ```
|
|
6243
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6113
6244
|
*/
|
|
6114
6245
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
6115
6246
|
/**
|
|
@@ -6118,17 +6249,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6118
6249
|
* ```js
|
|
6119
6250
|
* spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
|
|
6120
6251
|
* ```
|
|
6252
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6121
6253
|
*/
|
|
6122
6254
|
DeleteLastPrompt = "DeleteLastPrompt",
|
|
6123
6255
|
/**
|
|
6124
6256
|
* Toggle the visualization to chart or table view.
|
|
6125
|
-
* @param - `vizId `
|
|
6257
|
+
* @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
|
|
6126
6258
|
* @example
|
|
6127
6259
|
* ```js
|
|
6128
6260
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
|
|
6129
|
-
* vizId:
|
|
6261
|
+
* vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
|
|
6130
6262
|
* });
|
|
6131
6263
|
*```
|
|
6264
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6132
6265
|
*/
|
|
6133
6266
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
6134
6267
|
/**
|
|
@@ -6155,15 +6288,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6155
6288
|
*/
|
|
6156
6289
|
VisibleEmbedCoordinates = "visibleEmbedCoordinates",
|
|
6157
6290
|
/**
|
|
6158
|
-
* Trigger the *Ask
|
|
6291
|
+
* Trigger the *Ask Spotter* action for visualizations
|
|
6292
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6159
6293
|
* @example
|
|
6160
6294
|
* ```js
|
|
6161
|
-
*
|
|
6162
|
-
* {
|
|
6295
|
+
* spotterEmbed.trigger(HostEvent.AskSpotter,
|
|
6296
|
+
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
6163
6297
|
* ```
|
|
6164
6298
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
6165
6299
|
*/
|
|
6166
|
-
AskSpotter = "
|
|
6300
|
+
AskSpotter = "AskSpotter",
|
|
6167
6301
|
/**
|
|
6168
6302
|
* @hidden
|
|
6169
6303
|
* Triggers the update of the embed params.
|
|
@@ -6461,27 +6595,27 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
6461
6595
|
*/
|
|
6462
6596
|
ConfigureFilter = "configureFilter",
|
|
6463
6597
|
/**
|
|
6464
|
-
|
|
6465
|
-
|
|
6466
|
-
|
|
6467
|
-
|
|
6468
|
-
|
|
6469
|
-
|
|
6470
|
-
|
|
6471
|
-
|
|
6472
|
-
|
|
6598
|
+
* The **Collapse data sources** icon on the Search page.
|
|
6599
|
+
* Collapses the panel showing data sources.
|
|
6600
|
+
*
|
|
6601
|
+
* @example
|
|
6602
|
+
* ```js
|
|
6603
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
6604
|
+
* ```
|
|
6605
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
6606
|
+
*/
|
|
6473
6607
|
CollapseDataSources = "collapseDataSources",
|
|
6474
6608
|
/**
|
|
6475
|
-
|
|
6476
|
-
|
|
6477
|
-
|
|
6478
|
-
|
|
6479
|
-
|
|
6480
|
-
|
|
6481
|
-
|
|
6482
|
-
|
|
6483
|
-
|
|
6484
|
-
|
|
6609
|
+
* The **Collapse data panel** icon on the Search page.
|
|
6610
|
+
* Collapses the data panel view.
|
|
6611
|
+
*
|
|
6612
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6613
|
+
*
|
|
6614
|
+
* @example
|
|
6615
|
+
* ```js
|
|
6616
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
6617
|
+
* ```
|
|
6618
|
+
*/
|
|
6485
6619
|
CollapseDataPanel = "collapseDataPanel",
|
|
6486
6620
|
/**
|
|
6487
6621
|
* The **Choose sources** button on Search page.
|
|
@@ -7177,6 +7311,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
7177
7311
|
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
7178
7312
|
*/
|
|
7179
7313
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
7314
|
+
/**
|
|
7315
|
+
* Action ID to hide or disable Iterative Change Analysis option
|
|
7316
|
+
* on contextual change analysis Inisght charts context menu
|
|
7317
|
+
*
|
|
7318
|
+
* @example
|
|
7319
|
+
* ```js
|
|
7320
|
+
* disabledActions: [Action.EnableIterativeChangeAnalysis]
|
|
7321
|
+
* ```
|
|
7322
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
7323
|
+
*/
|
|
7324
|
+
EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
|
|
7180
7325
|
/**
|
|
7181
7326
|
* Action ID to hide or disable Natural Language Search query.
|
|
7182
7327
|
*
|
|
@@ -7545,7 +7690,40 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
7545
7690
|
* ```
|
|
7546
7691
|
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
7547
7692
|
*/
|
|
7548
|
-
InConversationTraining = "InConversationTraining"
|
|
7693
|
+
InConversationTraining = "InConversationTraining",
|
|
7694
|
+
/**
|
|
7695
|
+
* Action ID to hide the warnings banner in
|
|
7696
|
+
* Spotter results. It's an EA feature and
|
|
7697
|
+
* handled by LD.
|
|
7698
|
+
* @example
|
|
7699
|
+
* ```js
|
|
7700
|
+
* hiddenAction: [Action.SpotterWarningsBanner]
|
|
7701
|
+
* ```
|
|
7702
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
|
|
7703
|
+
*/
|
|
7704
|
+
SpotterWarningsBanner = "SpotterWarningsBanner",
|
|
7705
|
+
/**
|
|
7706
|
+
* Action ID to hide the warnings border on the knowledge
|
|
7707
|
+
* card in Spotter results. It's an EA feature and
|
|
7708
|
+
* handled by LD.
|
|
7709
|
+
* @example
|
|
7710
|
+
* ```js
|
|
7711
|
+
* hiddenAction: [Action.SpotterWarningsOnTokens]
|
|
7712
|
+
* ```
|
|
7713
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
|
|
7714
|
+
*/
|
|
7715
|
+
SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
|
|
7716
|
+
/**
|
|
7717
|
+
* Action ID to disable the click event handler on knowledge
|
|
7718
|
+
* card in Spotter results. It's an EA feature and
|
|
7719
|
+
* handled by LD.
|
|
7720
|
+
* @example
|
|
7721
|
+
* ```js
|
|
7722
|
+
* hiddenAction: [Action.SpotterTokenQuickEdit]
|
|
7723
|
+
* ```
|
|
7724
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
|
|
7725
|
+
*/
|
|
7726
|
+
SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
|
|
7549
7727
|
}
|
|
7550
7728
|
export interface AnswerServiceType {
|
|
7551
7729
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -8094,6 +8272,322 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
|
|
|
8094
8272
|
* Background color of checkbox.
|
|
8095
8273
|
*/
|
|
8096
8274
|
'--ts-var-checkbox-background-color'?: string;
|
|
8275
|
+
/**
|
|
8276
|
+
* Height of the tiles in the Liveboard.
|
|
8277
|
+
*/
|
|
8278
|
+
'--ts-var-viz-tile-height'?: string;
|
|
8279
|
+
/**
|
|
8280
|
+
* Background color of the layout in the Liveboard.
|
|
8281
|
+
*/
|
|
8282
|
+
'--ts-var-liveboard-layout-background'?: string;
|
|
8283
|
+
/**
|
|
8284
|
+
* Font color of the title of the layout in the Liveboard.
|
|
8285
|
+
*/
|
|
8286
|
+
'--ts-var-liveboard-layout-title-color'?: string;
|
|
8287
|
+
/**
|
|
8288
|
+
* Font size of the title of the layout in the Liveboard.
|
|
8289
|
+
*/
|
|
8290
|
+
'--ts-var-liveboard-layout-title-fontsize'?: string;
|
|
8291
|
+
/**
|
|
8292
|
+
* Background color of the header in the Liveboard.
|
|
8293
|
+
*/
|
|
8294
|
+
'--ts-var-liveboard-header-background'?: string;
|
|
8295
|
+
/**
|
|
8296
|
+
* Font size of the header in the Liveboard.
|
|
8297
|
+
*/
|
|
8298
|
+
'--ts-var-liveboard-header-fontsize'?: string;
|
|
8299
|
+
/**
|
|
8300
|
+
* Font color of the header in the Liveboard.
|
|
8301
|
+
*/
|
|
8302
|
+
'--ts-var-liveboard-header-font-color'?: string;
|
|
8303
|
+
/**
|
|
8304
|
+
* Border color of the tiles in the Liveboard.
|
|
8305
|
+
*/
|
|
8306
|
+
'--ts-var-liveboard-tile-border-color'?: string;
|
|
8307
|
+
/**
|
|
8308
|
+
* Background color of the tiles in the Liveboard.
|
|
8309
|
+
*/
|
|
8310
|
+
'--ts-var-liveboard-tile-background'?: string;
|
|
8311
|
+
/**
|
|
8312
|
+
* Border radius of the tiles in the Liveboard.
|
|
8313
|
+
*/
|
|
8314
|
+
'--ts-var-liveboard-tile-border-radius'?: string;
|
|
8315
|
+
/**
|
|
8316
|
+
* Padding of the tiles in the Liveboard.
|
|
8317
|
+
*/
|
|
8318
|
+
'--ts-var-liveboard-tile-padding'?: string;
|
|
8319
|
+
/**
|
|
8320
|
+
* Background color of the table header in the Liveboard.
|
|
8321
|
+
*/
|
|
8322
|
+
'--ts-var-liveboard-tile-table-header-background'?: string;
|
|
8323
|
+
/**
|
|
8324
|
+
* Padding of the groups in the Liveboard.
|
|
8325
|
+
*/
|
|
8326
|
+
'--ts-var-liveboard-group-padding'?: string;
|
|
8327
|
+
/**
|
|
8328
|
+
* Padding of the title of the groups in the Liveboard.
|
|
8329
|
+
*/
|
|
8330
|
+
'--ts-var-liveboard-group-title-padding'?: string;
|
|
8331
|
+
/**
|
|
8332
|
+
* Font size of the title of the groups in the Liveboard.
|
|
8333
|
+
*/
|
|
8334
|
+
'--ts-var-liveboard-group-title-font-size'?: string;
|
|
8335
|
+
/**
|
|
8336
|
+
* Font weight of the title of the groups in the Liveboard.
|
|
8337
|
+
*/
|
|
8338
|
+
'--ts-var-liveboard-group-title-font-weight'?: string;
|
|
8339
|
+
/**
|
|
8340
|
+
* Font size of the title of the tiles inside the groups in the Liveboard.
|
|
8341
|
+
*/
|
|
8342
|
+
'--ts-var-liveboard-group-tile-title-font-size'?: string;
|
|
8343
|
+
/**
|
|
8344
|
+
* Font weight of the title of the tiles inside the groups in the Liveboard.
|
|
8345
|
+
*/
|
|
8346
|
+
'--ts-var-liveboard-group-tile-title-font-weight'?: string;
|
|
8347
|
+
/**
|
|
8348
|
+
* Font size of the description of the groups in the Liveboard.
|
|
8349
|
+
*/
|
|
8350
|
+
'--ts-var-liveboard-group-description-font-size'?: string;
|
|
8351
|
+
/**
|
|
8352
|
+
* Font weight of the description of the groups in the Liveboard.
|
|
8353
|
+
*/
|
|
8354
|
+
'--ts-var-liveboard-group-description-font-weight'?: string;
|
|
8355
|
+
/**
|
|
8356
|
+
* Border of the tiles in the Liveboard.
|
|
8357
|
+
*/
|
|
8358
|
+
'--ts-var-liveboard-group-tile-border'?: string;
|
|
8359
|
+
/**
|
|
8360
|
+
* Padding of the tiles in the Liveboard.
|
|
8361
|
+
*/
|
|
8362
|
+
'--ts-var-liveboard-group-tile-padding'?: string;
|
|
8363
|
+
/**
|
|
8364
|
+
* Padding of the answer viz in the Liveboard.
|
|
8365
|
+
*/
|
|
8366
|
+
'--ts-var-liveboard-answer-viz-padding'?: string;
|
|
8367
|
+
/**
|
|
8368
|
+
* Background color of the groups in the Liveboard.
|
|
8369
|
+
*/
|
|
8370
|
+
'--ts-var-liveboard-group-background'?: string;
|
|
8371
|
+
/**
|
|
8372
|
+
* Border color of the groups in the Liveboard.
|
|
8373
|
+
*/
|
|
8374
|
+
'--ts-var-liveboard-group-border-color'?: string;
|
|
8375
|
+
/**
|
|
8376
|
+
* Font color of the heading of the note title in the Liveboard.
|
|
8377
|
+
*/
|
|
8378
|
+
'--ts-var-liveboard-notetitle-heading-font-color'?: string;
|
|
8379
|
+
/**
|
|
8380
|
+
* Font color of the body of the note title in the Liveboard.
|
|
8381
|
+
*/
|
|
8382
|
+
'--ts-var-liveboard-notetitle-body-font-color'?: string;
|
|
8383
|
+
/**
|
|
8384
|
+
* Font color of the title of the groups in the Liveboard.
|
|
8385
|
+
*/
|
|
8386
|
+
'--ts-var-liveboard-group-title-font-color'?: string;
|
|
8387
|
+
/**
|
|
8388
|
+
* Font color of the description of the groups in the Liveboard.
|
|
8389
|
+
*/
|
|
8390
|
+
'--ts-var-liveboard-group-description-font-color'?: string;
|
|
8391
|
+
/**
|
|
8392
|
+
* Font color of the title of the tiles inside the groups in the Liveboard.
|
|
8393
|
+
*/
|
|
8394
|
+
'--ts-var-liveboard-group-tile-title-font-color'?: string;
|
|
8395
|
+
/**
|
|
8396
|
+
* Background color of the tiles inside the groups in the Liveboard.
|
|
8397
|
+
*/
|
|
8398
|
+
'--ts-var-liveboard-group-tile-background'?: string;
|
|
8399
|
+
/**
|
|
8400
|
+
* Background color of the chips in the Liveboard.
|
|
8401
|
+
*/
|
|
8402
|
+
'--ts-var-liveboard-chip-background'?: string;
|
|
8403
|
+
/**
|
|
8404
|
+
* Font color of the chips in the Liveboard.
|
|
8405
|
+
*/
|
|
8406
|
+
'--ts-var-liveboard-chip-color'?: string;
|
|
8407
|
+
/**
|
|
8408
|
+
* Background color of the chips in the Liveboard on hover.
|
|
8409
|
+
*/
|
|
8410
|
+
'--ts-var-liveboard-chip--hover-background'?: string;
|
|
8411
|
+
/**
|
|
8412
|
+
* Font color of the chips in the Liveboard on hover.
|
|
8413
|
+
*/
|
|
8414
|
+
'--ts-var-liveboard-chip--hover-color'?: string;
|
|
8415
|
+
/**
|
|
8416
|
+
* Background color of the chips in the Liveboard on active.
|
|
8417
|
+
*/
|
|
8418
|
+
'--ts-var-liveboard-chip--active-background'?: string;
|
|
8419
|
+
/**
|
|
8420
|
+
* Font color of the chips in the Liveboard on active.
|
|
8421
|
+
*/
|
|
8422
|
+
'--ts-var-liveboard-chip--active-color'?: string;
|
|
8423
|
+
/**
|
|
8424
|
+
* Width of the side panel in the Liveboard.
|
|
8425
|
+
*/
|
|
8426
|
+
'--ts-var-side-panel-width'?: string;
|
|
8427
|
+
/**
|
|
8428
|
+
* Background color of the edit bar in the Liveboard.
|
|
8429
|
+
*/
|
|
8430
|
+
'--ts-var-liveboard-edit-bar-background'?: string;
|
|
8431
|
+
/**
|
|
8432
|
+
* Breakpoint for the dual column layout in the Liveboard.
|
|
8433
|
+
*/
|
|
8434
|
+
'--ts-var-liveboard-dual-column-breakpoint'?: string;
|
|
8435
|
+
/**
|
|
8436
|
+
* Breakpoint for the single column layout in the Liveboard.
|
|
8437
|
+
*/
|
|
8438
|
+
'--ts-var-liveboard-single-column-breakpoint'?: string;
|
|
8439
|
+
/**
|
|
8440
|
+
* Background color of the cross filter layout in the Liveboard.
|
|
8441
|
+
*/
|
|
8442
|
+
'--ts-var-liveboard-cross-filter-layout-background'?: string;
|
|
8443
|
+
/**
|
|
8444
|
+
* Border color of the active tab in the Liveboard.
|
|
8445
|
+
*/
|
|
8446
|
+
'--ts-var-liveboard-tab-active-border-color'?: string;
|
|
8447
|
+
/**
|
|
8448
|
+
* Font color of the hover tab in the Liveboard.
|
|
8449
|
+
*/
|
|
8450
|
+
'--ts-var-liveboard-tab-hover-color'?: string;
|
|
8451
|
+
/**
|
|
8452
|
+
* Font size of the title of the tiles in the Liveboard.
|
|
8453
|
+
*/
|
|
8454
|
+
'--ts-var-liveboard-tile-title-fontsize'?: string;
|
|
8455
|
+
/**
|
|
8456
|
+
* Font weight of the title of the tiles in the Liveboard.
|
|
8457
|
+
*/
|
|
8458
|
+
'--ts-var-liveboard-tile-title-fontweight'?: string;
|
|
8459
|
+
/**
|
|
8460
|
+
* Font weight of the description of the tiles in the Liveboard.
|
|
8461
|
+
*/
|
|
8462
|
+
'--ts-var-liveboard-tile-description-font-weight'?: string;
|
|
8463
|
+
/**
|
|
8464
|
+
* Opacity of the description of the tiles in the Liveboard.
|
|
8465
|
+
*/
|
|
8466
|
+
'--ts-var-liveboard-tile-description-opacity'?: string;
|
|
8467
|
+
/**
|
|
8468
|
+
* Background color of the parameter chips in the Liveboard.
|
|
8469
|
+
*/
|
|
8470
|
+
'--ts-var-parameter-chip-background'?: string;
|
|
8471
|
+
/**
|
|
8472
|
+
* Font color of the parameter chips in the Liveboard.
|
|
8473
|
+
*/
|
|
8474
|
+
'--ts-var-parameter-chip-text-color'?: string;
|
|
8475
|
+
/**
|
|
8476
|
+
* Background color of the parameter chips in the Liveboard on hover.
|
|
8477
|
+
*/
|
|
8478
|
+
'--ts-var-parameter-chip-hover-background'?: string;
|
|
8479
|
+
/**
|
|
8480
|
+
* Font color of the parameter chips in the Liveboard on hover.
|
|
8481
|
+
*/
|
|
8482
|
+
'--ts-var-parameter-chip-hover-text-color'?: string;
|
|
8483
|
+
/**
|
|
8484
|
+
* Background color of the parameter chips in the Liveboard on active.
|
|
8485
|
+
*/
|
|
8486
|
+
'--ts-var-parameter-chip-active-background'?: string;
|
|
8487
|
+
/**
|
|
8488
|
+
* Font color of the parameter chips in the Liveboard on active.
|
|
8489
|
+
*/
|
|
8490
|
+
'--ts-var-parameter-chip-active-text-color'?: string;
|
|
8491
|
+
/**
|
|
8492
|
+
* Background color of the action button in the Liveboard header.
|
|
8493
|
+
*/
|
|
8494
|
+
'--ts-var-liveboard-header-action-button-background'?: string;
|
|
8495
|
+
/**
|
|
8496
|
+
* Font color of the action button in the Liveboard header.
|
|
8497
|
+
*/
|
|
8498
|
+
'--ts-var-liveboard-header-action-button-font-color'?: string;
|
|
8499
|
+
/**
|
|
8500
|
+
* Font color of the action button in the Liveboard header on hover.
|
|
8501
|
+
*/
|
|
8502
|
+
'--ts-var-liveboard-header-action-button-hover-color'?: string;
|
|
8503
|
+
/**
|
|
8504
|
+
* Font color of the action button in the Liveboard header on active.
|
|
8505
|
+
*/
|
|
8506
|
+
'--ts-var-liveboard-header-action-button-active-color'?: string;
|
|
8507
|
+
/**
|
|
8508
|
+
* Background color of the badge in the Liveboard header.
|
|
8509
|
+
*/
|
|
8510
|
+
'--ts-var-liveboard-header-badge-background'?: string;
|
|
8511
|
+
/**
|
|
8512
|
+
* Font color of the badge in the Liveboard header.
|
|
8513
|
+
*/
|
|
8514
|
+
'--ts-var-liveboard-header-badge-font-color'?: string;
|
|
8515
|
+
/**
|
|
8516
|
+
* Background color of the modified badge in the Liveboard header.
|
|
8517
|
+
*/
|
|
8518
|
+
'--ts-var-liveboard-header-badge-modified-background'?: string;
|
|
8519
|
+
/**
|
|
8520
|
+
* Font color of the modified badge in the Liveboard header.
|
|
8521
|
+
*/
|
|
8522
|
+
'--ts-var-liveboard-header-badge-modified-font-color'?: string;
|
|
8523
|
+
/**
|
|
8524
|
+
* Font color of the badge in the Liveboard header on hover.
|
|
8525
|
+
*/
|
|
8526
|
+
'--ts-var-liveboard-header-badge-hover-color'?: string;
|
|
8527
|
+
/**
|
|
8528
|
+
* Font color of the badge in the Liveboard header on active.
|
|
8529
|
+
*/
|
|
8530
|
+
'--ts-var-liveboard-header-badge-active-color'?: string;
|
|
8531
|
+
/**
|
|
8532
|
+
* Font color of the hero text in the KPI widget.
|
|
8533
|
+
*/
|
|
8534
|
+
'--ts-var-kpi-hero-color'?: string;
|
|
8535
|
+
/**
|
|
8536
|
+
* Font color of the comparison text in the KPI widget.
|
|
8537
|
+
*/
|
|
8538
|
+
'--ts-var-kpi-comparison-color'?: string;
|
|
8539
|
+
/**
|
|
8540
|
+
* Font color of the analyze text in the KPI widget.
|
|
8541
|
+
*/
|
|
8542
|
+
'--ts-var-kpi-analyze-text-color'?: string;
|
|
8543
|
+
/**
|
|
8544
|
+
* Font color of the legend title in the heatmap chart.
|
|
8545
|
+
*/
|
|
8546
|
+
'--ts-var-chart-heatmap-legend-title-color'?: string;
|
|
8547
|
+
/**
|
|
8548
|
+
* Font color of the legend label in the heatmap chart.
|
|
8549
|
+
*/
|
|
8550
|
+
'--ts-var-chart-heatmap-legend-label-color'?: string;
|
|
8551
|
+
/**
|
|
8552
|
+
* Font color of the legend title in the treemap chart.
|
|
8553
|
+
*/
|
|
8554
|
+
'--ts-var-chart-treemap-legend-title-color'?: string;
|
|
8555
|
+
/**
|
|
8556
|
+
* Font color of the legend label in the treemap chart.
|
|
8557
|
+
*/
|
|
8558
|
+
'--ts-var-chart-treemap-legend-label-color'?: string;
|
|
8559
|
+
/**
|
|
8560
|
+
* Color of the positive change in the KPI.
|
|
8561
|
+
*/
|
|
8562
|
+
'--ts-var-kpi-positive-change-color'?: string;
|
|
8563
|
+
/**
|
|
8564
|
+
* Color of the negative change in the KPI.
|
|
8565
|
+
*/
|
|
8566
|
+
'--ts-var-kpi-negative-change-color'?: string;
|
|
8567
|
+
/**
|
|
8568
|
+
* Background color of the change analysis insights.
|
|
8569
|
+
*/
|
|
8570
|
+
'--ts-var-change-analysis-insights-background'?: string;
|
|
8571
|
+
/**
|
|
8572
|
+
* Background color of the forecasting card in the SpotIQ analyze.
|
|
8573
|
+
*/
|
|
8574
|
+
'--ts-var-spotiq-analyze-forecasting-card-background'?: string;
|
|
8575
|
+
/**
|
|
8576
|
+
* Background color of the outlier card in the SpotIQ analyze.
|
|
8577
|
+
*/
|
|
8578
|
+
'--ts-var-spotiq-analyze-outlier-card-background'?: string;
|
|
8579
|
+
/**
|
|
8580
|
+
* Background color of the trend card in the SpotIQ analyze.
|
|
8581
|
+
*/
|
|
8582
|
+
'--ts-var-spotiq-analyze-trend-card-background'?: string;
|
|
8583
|
+
/**
|
|
8584
|
+
* Background color of the crosscorrelation card in the SpotIQ analyze.
|
|
8585
|
+
*/
|
|
8586
|
+
'--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
|
|
8587
|
+
/**
|
|
8588
|
+
* Background color of the summary header in the CCA modal.
|
|
8589
|
+
*/
|
|
8590
|
+
'--ts-var-cca-modal-summary-header-background'?: string;
|
|
8097
8591
|
}
|
|
8098
8592
|
}
|
|
8099
8593
|
|
|
@@ -8603,16 +9097,31 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/nlsService/nls-answe
|
|
|
8603
9097
|
declare module '@thoughtspot/visual-embed-sdk/utils/liveboardService/liveboardService' {
|
|
8604
9098
|
import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
|
|
8605
9099
|
/**
|
|
8606
|
-
*
|
|
8607
|
-
*
|
|
8608
|
-
*
|
|
9100
|
+
* Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
|
|
9101
|
+
*
|
|
9102
|
+
* Each answer will be added as a visualization to the newly created Liveboard.
|
|
9103
|
+
*
|
|
9104
|
+
* @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
|
|
9105
|
+
* representing the answers to be added to the Liveboard.
|
|
9106
|
+
* @param {string} name - The name of the Liveboard to create.
|
|
8609
9107
|
* @returns result Promise
|
|
8610
9108
|
* @version SDK: 1.33.1 | ThoughtSpot: *
|
|
8611
9109
|
* @example
|
|
8612
9110
|
* ```js
|
|
8613
|
-
*
|
|
8614
|
-
*
|
|
8615
|
-
*
|
|
9111
|
+
* import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
|
|
9112
|
+
*
|
|
9113
|
+
* embed.on(EmbedEvent.Data, async () => {
|
|
9114
|
+
* try {
|
|
9115
|
+
* const answerService = await embed.getAnswerService();
|
|
9116
|
+
* const lb = await createLiveboardWithAnswers(
|
|
9117
|
+
* [answerService],
|
|
9118
|
+
* "My Liveboard"
|
|
9119
|
+
* );
|
|
9120
|
+
* console.log("Liveboard created:", lb);
|
|
9121
|
+
* } catch (err) {
|
|
9122
|
+
* console.error("Failed to create liveboard:", err);
|
|
9123
|
+
* }
|
|
9124
|
+
* });
|
|
8616
9125
|
* ```
|
|
8617
9126
|
*/
|
|
8618
9127
|
export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
|
|
@@ -8783,19 +9292,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
8783
9292
|
protected isRendered: boolean;
|
|
8784
9293
|
protected hostEventClient: HostEventClient;
|
|
8785
9294
|
protected isReadyForRenderPromise: Promise<void>;
|
|
8786
|
-
id: string;
|
|
8787
9295
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
8788
9296
|
/**
|
|
8789
9297
|
* Handles errors within the SDK
|
|
8790
9298
|
* @param error The error message or object
|
|
8791
9299
|
*/
|
|
8792
9300
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
8793
|
-
isEmbedContainerLoaded: boolean;
|
|
8794
9301
|
protected getAuthTokenForCookielessInit(): Promise<string>;
|
|
8795
9302
|
protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
|
|
8796
9303
|
protected getAppInitData(): Promise<DefaultAppInitData>;
|
|
8797
|
-
protected getPreRenderObj<T extends TsEmbed>(): T;
|
|
8798
|
-
protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
|
|
8799
9304
|
/**
|
|
8800
9305
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
8801
9306
|
* @param query
|
|
@@ -8909,6 +9414,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
8909
9414
|
* ```
|
|
8910
9415
|
*/
|
|
8911
9416
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
9417
|
+
/**
|
|
9418
|
+
* @hidden
|
|
9419
|
+
* Internal state to track if the embed container is loaded.
|
|
9420
|
+
* This is used to trigger events after the embed container is loaded.
|
|
9421
|
+
*/
|
|
9422
|
+
isEmbedContainerLoaded: boolean;
|
|
9423
|
+
protected getPreRenderObj<T extends TsEmbed>(): T;
|
|
9424
|
+
/**
|
|
9425
|
+
* Executes a callback after the embed container is loaded.
|
|
9426
|
+
* @param callback The callback to execute
|
|
9427
|
+
*/
|
|
9428
|
+
protected executeAfterEmbedContainerLoaded(callback: () => void): void;
|
|
9429
|
+
protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
|
|
8912
9430
|
/**
|
|
8913
9431
|
* Triggers an event to the embedded app
|
|
8914
9432
|
* @param {HostEvent} messageType The event type
|