@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
|
@@ -1122,6 +1122,16 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
1122
1122
|
*/
|
|
1123
1123
|
protected getEmbedParams(): string;
|
|
1124
1124
|
protected getEmbedParamsObject(): any;
|
|
1125
|
+
/**
|
|
1126
|
+
* @hidden
|
|
1127
|
+
* Internal state to track the current liveboard id.
|
|
1128
|
+
* This is used to navigate to the correct liveboard when the prerender is visible.
|
|
1129
|
+
*/
|
|
1130
|
+
currentLiveboardState: {
|
|
1131
|
+
liveboardId: string;
|
|
1132
|
+
vizId: string;
|
|
1133
|
+
activeTabId: string;
|
|
1134
|
+
};
|
|
1125
1135
|
protected beforePrerenderVisible(): void;
|
|
1126
1136
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
1127
1137
|
/**
|
|
@@ -1142,8 +1152,7 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
1142
1152
|
* visualization ID and the runtime filters.
|
|
1143
1153
|
*/
|
|
1144
1154
|
render(): Promise<LiveboardEmbed>;
|
|
1145
|
-
|
|
1146
|
-
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void): void;
|
|
1155
|
+
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
1147
1156
|
/**
|
|
1148
1157
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
1149
1158
|
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
@@ -1730,7 +1739,8 @@ export interface SearchOptions {
|
|
|
1730
1739
|
*/
|
|
1731
1740
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
1732
1741
|
/**
|
|
1733
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
1742
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
1743
|
+
* this object to query data and generate Answers.
|
|
1734
1744
|
*/
|
|
1735
1745
|
worksheetId: string;
|
|
1736
1746
|
/**
|
|
@@ -1813,6 +1823,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
1813
1823
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1814
1824
|
*/
|
|
1815
1825
|
hideSampleQuestions?: boolean;
|
|
1826
|
+
/**
|
|
1827
|
+
* The list of runtime filters to apply to a search Answer,
|
|
1828
|
+
* visualization, or Liveboard.
|
|
1829
|
+
*
|
|
1830
|
+
* Supported embed types: `SpotterEmbed`
|
|
1831
|
+
* @example
|
|
1832
|
+
* ```js
|
|
1833
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
1834
|
+
* // other embed view config
|
|
1835
|
+
* runtimeFilters: [
|
|
1836
|
+
* {
|
|
1837
|
+
* columnName: 'color',
|
|
1838
|
+
* operator: RuntimeFilterOp.EQ,
|
|
1839
|
+
* values: ['red'],
|
|
1840
|
+
* },
|
|
1841
|
+
* ],
|
|
1842
|
+
* })
|
|
1843
|
+
* ```
|
|
1844
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1845
|
+
*/
|
|
1846
|
+
runtimeFilters?: RuntimeFilter[];
|
|
1847
|
+
/**
|
|
1848
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
1849
|
+
* If true, filters will be passed via app initialization payload instead.
|
|
1850
|
+
* If false/undefined, filters will be added to URL (default behavior).
|
|
1851
|
+
*
|
|
1852
|
+
* Supported embed types: `SpotterEmbed`
|
|
1853
|
+
* @default false
|
|
1854
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1855
|
+
*/
|
|
1856
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
1857
|
+
/**
|
|
1858
|
+
* The list of runtime parameters to apply to the conversation.
|
|
1859
|
+
*
|
|
1860
|
+
* Supported embed types: `SpotterEmbed`
|
|
1861
|
+
* @example
|
|
1862
|
+
* ```js
|
|
1863
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
1864
|
+
* // other embed view config
|
|
1865
|
+
* runtimeParameters: [
|
|
1866
|
+
* {
|
|
1867
|
+
* name: 'Integer Param',
|
|
1868
|
+
* value: 10,
|
|
1869
|
+
* },
|
|
1870
|
+
* ],
|
|
1871
|
+
* })
|
|
1872
|
+
* ```
|
|
1873
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1874
|
+
*/
|
|
1875
|
+
runtimeParameters?: RuntimeParameter[];
|
|
1876
|
+
/**
|
|
1877
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
1878
|
+
* If true, parameters will be passed via app initialization payload instead.
|
|
1879
|
+
* If false/undefined, parameters will be added to URL (default behavior).
|
|
1880
|
+
*
|
|
1881
|
+
* Supported embed types: `SpotterEmbed`
|
|
1882
|
+
* @default false
|
|
1883
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
1884
|
+
*/
|
|
1885
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
1816
1886
|
}
|
|
1817
1887
|
/**
|
|
1818
1888
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -3157,12 +3227,14 @@ export interface HomePageConfig {
|
|
|
3157
3227
|
* Hide list page columns
|
|
3158
3228
|
* For example: hiddenListColumns = [ListPageColumns.Author]
|
|
3159
3229
|
*
|
|
3160
|
-
* **Note**: This option is available only in full app embedding.
|
|
3230
|
+
* **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
|
|
3161
3231
|
*
|
|
3162
3232
|
* Supported embed types: `AppEmbed`
|
|
3163
3233
|
* @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
|
|
3164
3234
|
* @example
|
|
3165
3235
|
* ```js
|
|
3236
|
+
* import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
|
|
3237
|
+
*
|
|
3166
3238
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3167
3239
|
* ... //other embed view config
|
|
3168
3240
|
* hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
|
|
@@ -3177,11 +3249,14 @@ export interface HomePageConfig {
|
|
|
3177
3249
|
* **Note**: This option does not apply to the classic homepage.
|
|
3178
3250
|
* To access the updated modular homepage, set
|
|
3179
3251
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3252
|
+
* To use it, you need to import `HomepageModule` enum.
|
|
3180
3253
|
*
|
|
3181
3254
|
* Supported embed types: `AppEmbed`
|
|
3182
3255
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3183
3256
|
* @example
|
|
3184
3257
|
* ```js
|
|
3258
|
+
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
3259
|
+
*
|
|
3185
3260
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3186
3261
|
* ... //other embed view config
|
|
3187
3262
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
@@ -3196,11 +3271,14 @@ export interface HomePageConfig {
|
|
|
3196
3271
|
* **Note**: This option does not apply to the classic homepage.
|
|
3197
3272
|
* To access the updated modular homepage, set
|
|
3198
3273
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3274
|
+
* To use it, you need to import `HomepageModule` enum.
|
|
3199
3275
|
*
|
|
3200
3276
|
* Supported embed types: `AppEmbed`
|
|
3201
3277
|
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3202
3278
|
* @example
|
|
3203
3279
|
* ```js
|
|
3280
|
+
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
3281
|
+
*
|
|
3204
3282
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3205
3283
|
* ... //other embed view config
|
|
3206
3284
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
@@ -3216,6 +3294,8 @@ export interface HomePageConfig {
|
|
|
3216
3294
|
* Supported embed types: `AppEmbed`
|
|
3217
3295
|
* @example
|
|
3218
3296
|
* ```js
|
|
3297
|
+
* import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
|
|
3298
|
+
*
|
|
3219
3299
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
3220
3300
|
* ... //other embed view config
|
|
3221
3301
|
* hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
|
|
@@ -3225,6 +3305,7 @@ export interface HomePageConfig {
|
|
|
3225
3305
|
* **Note**: This option does not apply to the classic homepage.
|
|
3226
3306
|
* To access the updated modular homepage, set
|
|
3227
3307
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
3308
|
+
* To use it, you need to import `HomeLeftNavItem` enum.
|
|
3228
3309
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3229
3310
|
*/
|
|
3230
3311
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -4433,7 +4514,7 @@ export enum EmbedEvent {
|
|
|
4433
4514
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4434
4515
|
* @example
|
|
4435
4516
|
*```js
|
|
4436
|
-
* liveboardEmbed.on(EmbedEvent.
|
|
4517
|
+
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
4437
4518
|
* console.log('Liveboard details', payload);
|
|
4438
4519
|
* })
|
|
4439
4520
|
*```
|
|
@@ -4808,58 +4889,58 @@ export enum EmbedEvent {
|
|
|
4808
4889
|
*/
|
|
4809
4890
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
4810
4891
|
/**
|
|
4811
|
-
* Emitted when
|
|
4892
|
+
* Emitted when Spotter response is text data
|
|
4812
4893
|
* @example
|
|
4813
4894
|
* ```js
|
|
4814
4895
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
4815
4896
|
* console.log('payload', payload);
|
|
4816
4897
|
* })
|
|
4817
4898
|
*```
|
|
4818
|
-
* @version SDK: 1.
|
|
4899
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4819
4900
|
*/
|
|
4820
4901
|
SpotterData = "SpotterData",
|
|
4821
4902
|
/**
|
|
4822
|
-
* Emitted when user opens up the worksheet preview modal in
|
|
4903
|
+
* Emitted when user opens up the worksheet preview modal in Spotter embed.
|
|
4823
4904
|
* @example
|
|
4824
4905
|
* ```js
|
|
4825
4906
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
4826
4907
|
* console.log('payload', payload);
|
|
4827
4908
|
* })
|
|
4828
4909
|
*```
|
|
4829
|
-
* @version SDK: 1.
|
|
4910
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4830
4911
|
*/
|
|
4831
4912
|
PreviewSpotterData = "PreviewSpotterData",
|
|
4832
4913
|
/**
|
|
4833
|
-
* Emitted when the
|
|
4914
|
+
* Emitted when the Spotter query is triggered in Spotter embed.
|
|
4834
4915
|
* @example
|
|
4835
4916
|
* ```js
|
|
4836
4917
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
4837
4918
|
* console.log('payload', payload);
|
|
4838
4919
|
* })
|
|
4839
4920
|
*```
|
|
4840
|
-
* @version SDK: 1.
|
|
4921
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4841
4922
|
*/
|
|
4842
4923
|
SpotterQueryTriggered = "SpotterQueryTriggered",
|
|
4843
4924
|
/**
|
|
4844
|
-
* Emitted when the last
|
|
4925
|
+
* Emitted when the last Spotter query is edited in Spotter embed.
|
|
4845
4926
|
* @example
|
|
4846
4927
|
* ```js
|
|
4847
4928
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
4848
4929
|
* console.log('payload', payload);
|
|
4849
4930
|
* })
|
|
4850
4931
|
*```
|
|
4851
|
-
* @version SDK: 1.
|
|
4932
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4852
4933
|
*/
|
|
4853
4934
|
LastPromptEdited = "LastPromptEdited",
|
|
4854
4935
|
/**
|
|
4855
|
-
* Emitted when the last
|
|
4936
|
+
* Emitted when the last Spotter query is deleted in Spotter embed.
|
|
4856
4937
|
* @example
|
|
4857
4938
|
* ```js
|
|
4858
4939
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
4859
4940
|
* console.log('payload', payload);
|
|
4860
4941
|
* })
|
|
4861
4942
|
*```
|
|
4862
|
-
* @version SDK: 1.
|
|
4943
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4863
4944
|
*/
|
|
4864
4945
|
LastPromptDeleted = "LastPromptDeleted",
|
|
4865
4946
|
/**
|
|
@@ -4870,7 +4951,7 @@ export enum EmbedEvent {
|
|
|
4870
4951
|
* console.log('payload', payload);
|
|
4871
4952
|
* })
|
|
4872
4953
|
*```
|
|
4873
|
-
* @version SDK: 1.
|
|
4954
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
4874
4955
|
*/
|
|
4875
4956
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
4876
4957
|
/**
|
|
@@ -4883,7 +4964,19 @@ export enum EmbedEvent {
|
|
|
4883
4964
|
*```
|
|
4884
4965
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
4885
4966
|
*/
|
|
4886
|
-
SpotterInit = "
|
|
4967
|
+
SpotterInit = "spotterInit",
|
|
4968
|
+
/**
|
|
4969
|
+
* @hidden
|
|
4970
|
+
* Triggers when the embed listener is ready to receive events.
|
|
4971
|
+
* This is used to trigger events after the embed container is loaded.
|
|
4972
|
+
* @example
|
|
4973
|
+
* ```js
|
|
4974
|
+
* liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
|
|
4975
|
+
* console.log('EmbedListenerReady');
|
|
4976
|
+
* })
|
|
4977
|
+
* ```
|
|
4978
|
+
*/
|
|
4979
|
+
EmbedListenerReady = "EmbedListenerReady"
|
|
4887
4980
|
}
|
|
4888
4981
|
/**
|
|
4889
4982
|
* Event types that can be triggered by the host application
|
|
@@ -4971,6 +5064,7 @@ export enum HostEvent {
|
|
|
4971
5064
|
* done automatically on the most popular column.
|
|
4972
5065
|
* @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
|
|
4973
5066
|
* in case of a Liveboard.
|
|
5067
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
4974
5068
|
* @example
|
|
4975
5069
|
* ```js
|
|
4976
5070
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -5290,12 +5384,21 @@ export enum HostEvent {
|
|
|
5290
5384
|
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
5291
5385
|
* visualization or Answer.
|
|
5292
5386
|
*
|
|
5387
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5388
|
+
*
|
|
5293
5389
|
* **NOTE**: The **Download** > **PDF** action is available on
|
|
5294
5390
|
* visualizations and Answers if the data is in tabular format.
|
|
5295
5391
|
* @example
|
|
5296
5392
|
* ```js
|
|
5297
5393
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
5298
5394
|
* ```
|
|
5395
|
+
* @example
|
|
5396
|
+
* ```js
|
|
5397
|
+
* spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
|
|
5398
|
+
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5399
|
+
* });
|
|
5400
|
+
* ```
|
|
5401
|
+
*
|
|
5299
5402
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5300
5403
|
*/
|
|
5301
5404
|
DownloadAsPdf = "downloadAsPdf",
|
|
@@ -5397,7 +5500,8 @@ export enum HostEvent {
|
|
|
5397
5500
|
* This event is not supported in visualization embed and search embed.
|
|
5398
5501
|
* @param - object - To trigger the action for a specific visualization
|
|
5399
5502
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
5400
|
-
*
|
|
5503
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5504
|
+
*
|
|
5401
5505
|
* @example
|
|
5402
5506
|
* ```js
|
|
5403
5507
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
@@ -5412,6 +5516,12 @@ export enum HostEvent {
|
|
|
5412
5516
|
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5413
5517
|
* });
|
|
5414
5518
|
* ```
|
|
5519
|
+
* @example
|
|
5520
|
+
* ```js
|
|
5521
|
+
* const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
|
|
5522
|
+
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5523
|
+
* });
|
|
5524
|
+
* ```
|
|
5415
5525
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5416
5526
|
*/
|
|
5417
5527
|
Edit = "edit",
|
|
@@ -5532,6 +5642,7 @@ export enum HostEvent {
|
|
|
5532
5642
|
/**
|
|
5533
5643
|
* Trigger the **Download** action on charts in
|
|
5534
5644
|
* the embedded view.
|
|
5645
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5535
5646
|
* @example
|
|
5536
5647
|
* ```js
|
|
5537
5648
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -5540,6 +5651,11 @@ export enum HostEvent {
|
|
|
5540
5651
|
* ```js
|
|
5541
5652
|
* embed.trigger(HostEvent.Download)
|
|
5542
5653
|
* ```
|
|
5654
|
+
* ```js
|
|
5655
|
+
* spotterEmbed.trigger(HostEvent.Download, {
|
|
5656
|
+
* vizId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
5657
|
+
* });
|
|
5658
|
+
* ```
|
|
5543
5659
|
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
5544
5660
|
* Use {@link DownloadAsPng}
|
|
5545
5661
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
@@ -5568,6 +5684,7 @@ export enum HostEvent {
|
|
|
5568
5684
|
/**
|
|
5569
5685
|
* Trigger the **Download** > **CSV** action on tables in
|
|
5570
5686
|
* the embedded view.
|
|
5687
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5571
5688
|
* @example
|
|
5572
5689
|
* ```js
|
|
5573
5690
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -5590,6 +5707,7 @@ export enum HostEvent {
|
|
|
5590
5707
|
/**
|
|
5591
5708
|
* Trigger the **Download** > **XLSX** action on tables
|
|
5592
5709
|
* in the embedded view.
|
|
5710
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5593
5711
|
* @example
|
|
5594
5712
|
* ```js
|
|
5595
5713
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -5625,7 +5743,7 @@ export enum HostEvent {
|
|
|
5625
5743
|
/**
|
|
5626
5744
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
5627
5745
|
* Saves the changes.
|
|
5628
|
-
* @param - `vizId` is required in Spotter
|
|
5746
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5629
5747
|
* @example
|
|
5630
5748
|
* ```js
|
|
5631
5749
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -5935,6 +6053,7 @@ export enum HostEvent {
|
|
|
5935
6053
|
UpdateParameters = "UpdateParameters",
|
|
5936
6054
|
/**
|
|
5937
6055
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
6056
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5938
6057
|
* ```js
|
|
5939
6058
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
5940
6059
|
* console.log('parameters', parameter);
|
|
@@ -5978,7 +6097,7 @@ export enum HostEvent {
|
|
|
5978
6097
|
* @param - optional attributes to set Answer properties.
|
|
5979
6098
|
* `name` - Name string for the Answer.
|
|
5980
6099
|
* `description` - Description text for the Answer.
|
|
5981
|
-
*
|
|
6100
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
5982
6101
|
* @example
|
|
5983
6102
|
* ```js
|
|
5984
6103
|
* const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
|
|
@@ -5986,6 +6105,14 @@ export enum HostEvent {
|
|
|
5986
6105
|
* description: "Total sales by states in MidWest"
|
|
5987
6106
|
* });
|
|
5988
6107
|
* ```
|
|
6108
|
+
* @example
|
|
6109
|
+
* ```js
|
|
6110
|
+
* const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
|
|
6111
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c',
|
|
6112
|
+
* name: "Sales by states",
|
|
6113
|
+
* description: "Total sales by states in MidWest"
|
|
6114
|
+
* });
|
|
6115
|
+
* ```
|
|
5989
6116
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5990
6117
|
*/
|
|
5991
6118
|
SaveAnswer = "saveAnswer",
|
|
@@ -6017,7 +6144,7 @@ export enum HostEvent {
|
|
|
6017
6144
|
/**
|
|
6018
6145
|
* Triggers a search operation with the search tokens specified in
|
|
6019
6146
|
* the search query string in spotter embed.
|
|
6020
|
-
* @param - `
|
|
6147
|
+
* @param - `query`: Text string in Natural Language format
|
|
6021
6148
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
6022
6149
|
* @example
|
|
6023
6150
|
* ```js
|
|
@@ -6026,6 +6153,7 @@ export enum HostEvent {
|
|
|
6026
6153
|
* executeSearch: true,
|
|
6027
6154
|
* })
|
|
6028
6155
|
* ```
|
|
6156
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6029
6157
|
*/
|
|
6030
6158
|
SpotterSearch = "SpotterSearch",
|
|
6031
6159
|
/**
|
|
@@ -6035,6 +6163,7 @@ export enum HostEvent {
|
|
|
6035
6163
|
* ```js
|
|
6036
6164
|
* spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
|
|
6037
6165
|
* ```
|
|
6166
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6038
6167
|
*/
|
|
6039
6168
|
EditLastPrompt = "EditLastPrompt",
|
|
6040
6169
|
/**
|
|
@@ -6043,6 +6172,7 @@ export enum HostEvent {
|
|
|
6043
6172
|
* ```js
|
|
6044
6173
|
* spotterEmbed.trigger(HostEvent.PreviewSpotterData);
|
|
6045
6174
|
* ```
|
|
6175
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6046
6176
|
*/
|
|
6047
6177
|
PreviewSpotterData = "PreviewSpotterData",
|
|
6048
6178
|
/**
|
|
@@ -6051,6 +6181,7 @@ export enum HostEvent {
|
|
|
6051
6181
|
* ```js
|
|
6052
6182
|
* spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
|
|
6053
6183
|
* ```
|
|
6184
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6054
6185
|
*/
|
|
6055
6186
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
6056
6187
|
/**
|
|
@@ -6059,17 +6190,19 @@ export enum HostEvent {
|
|
|
6059
6190
|
* ```js
|
|
6060
6191
|
* spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
|
|
6061
6192
|
* ```
|
|
6193
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6062
6194
|
*/
|
|
6063
6195
|
DeleteLastPrompt = "DeleteLastPrompt",
|
|
6064
6196
|
/**
|
|
6065
6197
|
* Toggle the visualization to chart or table view.
|
|
6066
|
-
* @param - `vizId `
|
|
6198
|
+
* @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
|
|
6067
6199
|
* @example
|
|
6068
6200
|
* ```js
|
|
6069
6201
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
|
|
6070
|
-
* vizId:
|
|
6202
|
+
* vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
|
|
6071
6203
|
* });
|
|
6072
6204
|
*```
|
|
6205
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6073
6206
|
*/
|
|
6074
6207
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
6075
6208
|
/**
|
|
@@ -6096,15 +6229,16 @@ export enum HostEvent {
|
|
|
6096
6229
|
*/
|
|
6097
6230
|
VisibleEmbedCoordinates = "visibleEmbedCoordinates",
|
|
6098
6231
|
/**
|
|
6099
|
-
* Trigger the *Ask
|
|
6232
|
+
* Trigger the *Ask Spotter* action for visualizations
|
|
6233
|
+
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6100
6234
|
* @example
|
|
6101
6235
|
* ```js
|
|
6102
|
-
*
|
|
6103
|
-
* {
|
|
6236
|
+
* spotterEmbed.trigger(HostEvent.AskSpotter,
|
|
6237
|
+
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
6104
6238
|
* ```
|
|
6105
6239
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
6106
6240
|
*/
|
|
6107
|
-
AskSpotter = "
|
|
6241
|
+
AskSpotter = "AskSpotter",
|
|
6108
6242
|
/**
|
|
6109
6243
|
* @hidden
|
|
6110
6244
|
* Triggers the update of the embed params.
|
|
@@ -6402,27 +6536,27 @@ export enum Action {
|
|
|
6402
6536
|
*/
|
|
6403
6537
|
ConfigureFilter = "configureFilter",
|
|
6404
6538
|
/**
|
|
6405
|
-
|
|
6406
|
-
|
|
6407
|
-
|
|
6408
|
-
|
|
6409
|
-
|
|
6410
|
-
|
|
6411
|
-
|
|
6412
|
-
|
|
6413
|
-
|
|
6539
|
+
* The **Collapse data sources** icon on the Search page.
|
|
6540
|
+
* Collapses the panel showing data sources.
|
|
6541
|
+
*
|
|
6542
|
+
* @example
|
|
6543
|
+
* ```js
|
|
6544
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
6545
|
+
* ```
|
|
6546
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
6547
|
+
*/
|
|
6414
6548
|
CollapseDataSources = "collapseDataSources",
|
|
6415
6549
|
/**
|
|
6416
|
-
|
|
6417
|
-
|
|
6418
|
-
|
|
6419
|
-
|
|
6420
|
-
|
|
6421
|
-
|
|
6422
|
-
|
|
6423
|
-
|
|
6424
|
-
|
|
6425
|
-
|
|
6550
|
+
* The **Collapse data panel** icon on the Search page.
|
|
6551
|
+
* Collapses the data panel view.
|
|
6552
|
+
*
|
|
6553
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
6554
|
+
*
|
|
6555
|
+
* @example
|
|
6556
|
+
* ```js
|
|
6557
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
6558
|
+
* ```
|
|
6559
|
+
*/
|
|
6426
6560
|
CollapseDataPanel = "collapseDataPanel",
|
|
6427
6561
|
/**
|
|
6428
6562
|
* The **Choose sources** button on Search page.
|
|
@@ -7118,6 +7252,17 @@ export enum Action {
|
|
|
7118
7252
|
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
7119
7253
|
*/
|
|
7120
7254
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
7255
|
+
/**
|
|
7256
|
+
* Action ID to hide or disable Iterative Change Analysis option
|
|
7257
|
+
* on contextual change analysis Inisght charts context menu
|
|
7258
|
+
*
|
|
7259
|
+
* @example
|
|
7260
|
+
* ```js
|
|
7261
|
+
* disabledActions: [Action.EnableIterativeChangeAnalysis]
|
|
7262
|
+
* ```
|
|
7263
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
7264
|
+
*/
|
|
7265
|
+
EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
|
|
7121
7266
|
/**
|
|
7122
7267
|
* Action ID to hide or disable Natural Language Search query.
|
|
7123
7268
|
*
|
|
@@ -7486,7 +7631,40 @@ export enum Action {
|
|
|
7486
7631
|
* ```
|
|
7487
7632
|
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
7488
7633
|
*/
|
|
7489
|
-
InConversationTraining = "InConversationTraining"
|
|
7634
|
+
InConversationTraining = "InConversationTraining",
|
|
7635
|
+
/**
|
|
7636
|
+
* Action ID to hide the warnings banner in
|
|
7637
|
+
* Spotter results. It's an EA feature and
|
|
7638
|
+
* handled by LD.
|
|
7639
|
+
* @example
|
|
7640
|
+
* ```js
|
|
7641
|
+
* hiddenAction: [Action.SpotterWarningsBanner]
|
|
7642
|
+
* ```
|
|
7643
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
|
|
7644
|
+
*/
|
|
7645
|
+
SpotterWarningsBanner = "SpotterWarningsBanner",
|
|
7646
|
+
/**
|
|
7647
|
+
* Action ID to hide the warnings border on the knowledge
|
|
7648
|
+
* card in Spotter results. It's an EA feature and
|
|
7649
|
+
* handled by LD.
|
|
7650
|
+
* @example
|
|
7651
|
+
* ```js
|
|
7652
|
+
* hiddenAction: [Action.SpotterWarningsOnTokens]
|
|
7653
|
+
* ```
|
|
7654
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
|
|
7655
|
+
*/
|
|
7656
|
+
SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
|
|
7657
|
+
/**
|
|
7658
|
+
* Action ID to disable the click event handler on knowledge
|
|
7659
|
+
* card in Spotter results. It's an EA feature and
|
|
7660
|
+
* handled by LD.
|
|
7661
|
+
* @example
|
|
7662
|
+
* ```js
|
|
7663
|
+
* hiddenAction: [Action.SpotterTokenQuickEdit]
|
|
7664
|
+
* ```
|
|
7665
|
+
* @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
|
|
7666
|
+
*/
|
|
7667
|
+
SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
|
|
7490
7668
|
}
|
|
7491
7669
|
export interface AnswerServiceType {
|
|
7492
7670
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -8033,6 +8211,322 @@ export interface CustomCssVariables {
|
|
|
8033
8211
|
* Background color of checkbox.
|
|
8034
8212
|
*/
|
|
8035
8213
|
'--ts-var-checkbox-background-color'?: string;
|
|
8214
|
+
/**
|
|
8215
|
+
* Height of the tiles in the Liveboard.
|
|
8216
|
+
*/
|
|
8217
|
+
'--ts-var-viz-tile-height'?: string;
|
|
8218
|
+
/**
|
|
8219
|
+
* Background color of the layout in the Liveboard.
|
|
8220
|
+
*/
|
|
8221
|
+
'--ts-var-liveboard-layout-background'?: string;
|
|
8222
|
+
/**
|
|
8223
|
+
* Font color of the title of the layout in the Liveboard.
|
|
8224
|
+
*/
|
|
8225
|
+
'--ts-var-liveboard-layout-title-color'?: string;
|
|
8226
|
+
/**
|
|
8227
|
+
* Font size of the title of the layout in the Liveboard.
|
|
8228
|
+
*/
|
|
8229
|
+
'--ts-var-liveboard-layout-title-fontsize'?: string;
|
|
8230
|
+
/**
|
|
8231
|
+
* Background color of the header in the Liveboard.
|
|
8232
|
+
*/
|
|
8233
|
+
'--ts-var-liveboard-header-background'?: string;
|
|
8234
|
+
/**
|
|
8235
|
+
* Font size of the header in the Liveboard.
|
|
8236
|
+
*/
|
|
8237
|
+
'--ts-var-liveboard-header-fontsize'?: string;
|
|
8238
|
+
/**
|
|
8239
|
+
* Font color of the header in the Liveboard.
|
|
8240
|
+
*/
|
|
8241
|
+
'--ts-var-liveboard-header-font-color'?: string;
|
|
8242
|
+
/**
|
|
8243
|
+
* Border color of the tiles in the Liveboard.
|
|
8244
|
+
*/
|
|
8245
|
+
'--ts-var-liveboard-tile-border-color'?: string;
|
|
8246
|
+
/**
|
|
8247
|
+
* Background color of the tiles in the Liveboard.
|
|
8248
|
+
*/
|
|
8249
|
+
'--ts-var-liveboard-tile-background'?: string;
|
|
8250
|
+
/**
|
|
8251
|
+
* Border radius of the tiles in the Liveboard.
|
|
8252
|
+
*/
|
|
8253
|
+
'--ts-var-liveboard-tile-border-radius'?: string;
|
|
8254
|
+
/**
|
|
8255
|
+
* Padding of the tiles in the Liveboard.
|
|
8256
|
+
*/
|
|
8257
|
+
'--ts-var-liveboard-tile-padding'?: string;
|
|
8258
|
+
/**
|
|
8259
|
+
* Background color of the table header in the Liveboard.
|
|
8260
|
+
*/
|
|
8261
|
+
'--ts-var-liveboard-tile-table-header-background'?: string;
|
|
8262
|
+
/**
|
|
8263
|
+
* Padding of the groups in the Liveboard.
|
|
8264
|
+
*/
|
|
8265
|
+
'--ts-var-liveboard-group-padding'?: string;
|
|
8266
|
+
/**
|
|
8267
|
+
* Padding of the title of the groups in the Liveboard.
|
|
8268
|
+
*/
|
|
8269
|
+
'--ts-var-liveboard-group-title-padding'?: string;
|
|
8270
|
+
/**
|
|
8271
|
+
* Font size of the title of the groups in the Liveboard.
|
|
8272
|
+
*/
|
|
8273
|
+
'--ts-var-liveboard-group-title-font-size'?: string;
|
|
8274
|
+
/**
|
|
8275
|
+
* Font weight of the title of the groups in the Liveboard.
|
|
8276
|
+
*/
|
|
8277
|
+
'--ts-var-liveboard-group-title-font-weight'?: string;
|
|
8278
|
+
/**
|
|
8279
|
+
* Font size of the title of the tiles inside the groups in the Liveboard.
|
|
8280
|
+
*/
|
|
8281
|
+
'--ts-var-liveboard-group-tile-title-font-size'?: string;
|
|
8282
|
+
/**
|
|
8283
|
+
* Font weight of the title of the tiles inside the groups in the Liveboard.
|
|
8284
|
+
*/
|
|
8285
|
+
'--ts-var-liveboard-group-tile-title-font-weight'?: string;
|
|
8286
|
+
/**
|
|
8287
|
+
* Font size of the description of the groups in the Liveboard.
|
|
8288
|
+
*/
|
|
8289
|
+
'--ts-var-liveboard-group-description-font-size'?: string;
|
|
8290
|
+
/**
|
|
8291
|
+
* Font weight of the description of the groups in the Liveboard.
|
|
8292
|
+
*/
|
|
8293
|
+
'--ts-var-liveboard-group-description-font-weight'?: string;
|
|
8294
|
+
/**
|
|
8295
|
+
* Border of the tiles in the Liveboard.
|
|
8296
|
+
*/
|
|
8297
|
+
'--ts-var-liveboard-group-tile-border'?: string;
|
|
8298
|
+
/**
|
|
8299
|
+
* Padding of the tiles in the Liveboard.
|
|
8300
|
+
*/
|
|
8301
|
+
'--ts-var-liveboard-group-tile-padding'?: string;
|
|
8302
|
+
/**
|
|
8303
|
+
* Padding of the answer viz in the Liveboard.
|
|
8304
|
+
*/
|
|
8305
|
+
'--ts-var-liveboard-answer-viz-padding'?: string;
|
|
8306
|
+
/**
|
|
8307
|
+
* Background color of the groups in the Liveboard.
|
|
8308
|
+
*/
|
|
8309
|
+
'--ts-var-liveboard-group-background'?: string;
|
|
8310
|
+
/**
|
|
8311
|
+
* Border color of the groups in the Liveboard.
|
|
8312
|
+
*/
|
|
8313
|
+
'--ts-var-liveboard-group-border-color'?: string;
|
|
8314
|
+
/**
|
|
8315
|
+
* Font color of the heading of the note title in the Liveboard.
|
|
8316
|
+
*/
|
|
8317
|
+
'--ts-var-liveboard-notetitle-heading-font-color'?: string;
|
|
8318
|
+
/**
|
|
8319
|
+
* Font color of the body of the note title in the Liveboard.
|
|
8320
|
+
*/
|
|
8321
|
+
'--ts-var-liveboard-notetitle-body-font-color'?: string;
|
|
8322
|
+
/**
|
|
8323
|
+
* Font color of the title of the groups in the Liveboard.
|
|
8324
|
+
*/
|
|
8325
|
+
'--ts-var-liveboard-group-title-font-color'?: string;
|
|
8326
|
+
/**
|
|
8327
|
+
* Font color of the description of the groups in the Liveboard.
|
|
8328
|
+
*/
|
|
8329
|
+
'--ts-var-liveboard-group-description-font-color'?: string;
|
|
8330
|
+
/**
|
|
8331
|
+
* Font color of the title of the tiles inside the groups in the Liveboard.
|
|
8332
|
+
*/
|
|
8333
|
+
'--ts-var-liveboard-group-tile-title-font-color'?: string;
|
|
8334
|
+
/**
|
|
8335
|
+
* Background color of the tiles inside the groups in the Liveboard.
|
|
8336
|
+
*/
|
|
8337
|
+
'--ts-var-liveboard-group-tile-background'?: string;
|
|
8338
|
+
/**
|
|
8339
|
+
* Background color of the chips in the Liveboard.
|
|
8340
|
+
*/
|
|
8341
|
+
'--ts-var-liveboard-chip-background'?: string;
|
|
8342
|
+
/**
|
|
8343
|
+
* Font color of the chips in the Liveboard.
|
|
8344
|
+
*/
|
|
8345
|
+
'--ts-var-liveboard-chip-color'?: string;
|
|
8346
|
+
/**
|
|
8347
|
+
* Background color of the chips in the Liveboard on hover.
|
|
8348
|
+
*/
|
|
8349
|
+
'--ts-var-liveboard-chip--hover-background'?: string;
|
|
8350
|
+
/**
|
|
8351
|
+
* Font color of the chips in the Liveboard on hover.
|
|
8352
|
+
*/
|
|
8353
|
+
'--ts-var-liveboard-chip--hover-color'?: string;
|
|
8354
|
+
/**
|
|
8355
|
+
* Background color of the chips in the Liveboard on active.
|
|
8356
|
+
*/
|
|
8357
|
+
'--ts-var-liveboard-chip--active-background'?: string;
|
|
8358
|
+
/**
|
|
8359
|
+
* Font color of the chips in the Liveboard on active.
|
|
8360
|
+
*/
|
|
8361
|
+
'--ts-var-liveboard-chip--active-color'?: string;
|
|
8362
|
+
/**
|
|
8363
|
+
* Width of the side panel in the Liveboard.
|
|
8364
|
+
*/
|
|
8365
|
+
'--ts-var-side-panel-width'?: string;
|
|
8366
|
+
/**
|
|
8367
|
+
* Background color of the edit bar in the Liveboard.
|
|
8368
|
+
*/
|
|
8369
|
+
'--ts-var-liveboard-edit-bar-background'?: string;
|
|
8370
|
+
/**
|
|
8371
|
+
* Breakpoint for the dual column layout in the Liveboard.
|
|
8372
|
+
*/
|
|
8373
|
+
'--ts-var-liveboard-dual-column-breakpoint'?: string;
|
|
8374
|
+
/**
|
|
8375
|
+
* Breakpoint for the single column layout in the Liveboard.
|
|
8376
|
+
*/
|
|
8377
|
+
'--ts-var-liveboard-single-column-breakpoint'?: string;
|
|
8378
|
+
/**
|
|
8379
|
+
* Background color of the cross filter layout in the Liveboard.
|
|
8380
|
+
*/
|
|
8381
|
+
'--ts-var-liveboard-cross-filter-layout-background'?: string;
|
|
8382
|
+
/**
|
|
8383
|
+
* Border color of the active tab in the Liveboard.
|
|
8384
|
+
*/
|
|
8385
|
+
'--ts-var-liveboard-tab-active-border-color'?: string;
|
|
8386
|
+
/**
|
|
8387
|
+
* Font color of the hover tab in the Liveboard.
|
|
8388
|
+
*/
|
|
8389
|
+
'--ts-var-liveboard-tab-hover-color'?: string;
|
|
8390
|
+
/**
|
|
8391
|
+
* Font size of the title of the tiles in the Liveboard.
|
|
8392
|
+
*/
|
|
8393
|
+
'--ts-var-liveboard-tile-title-fontsize'?: string;
|
|
8394
|
+
/**
|
|
8395
|
+
* Font weight of the title of the tiles in the Liveboard.
|
|
8396
|
+
*/
|
|
8397
|
+
'--ts-var-liveboard-tile-title-fontweight'?: string;
|
|
8398
|
+
/**
|
|
8399
|
+
* Font weight of the description of the tiles in the Liveboard.
|
|
8400
|
+
*/
|
|
8401
|
+
'--ts-var-liveboard-tile-description-font-weight'?: string;
|
|
8402
|
+
/**
|
|
8403
|
+
* Opacity of the description of the tiles in the Liveboard.
|
|
8404
|
+
*/
|
|
8405
|
+
'--ts-var-liveboard-tile-description-opacity'?: string;
|
|
8406
|
+
/**
|
|
8407
|
+
* Background color of the parameter chips in the Liveboard.
|
|
8408
|
+
*/
|
|
8409
|
+
'--ts-var-parameter-chip-background'?: string;
|
|
8410
|
+
/**
|
|
8411
|
+
* Font color of the parameter chips in the Liveboard.
|
|
8412
|
+
*/
|
|
8413
|
+
'--ts-var-parameter-chip-text-color'?: string;
|
|
8414
|
+
/**
|
|
8415
|
+
* Background color of the parameter chips in the Liveboard on hover.
|
|
8416
|
+
*/
|
|
8417
|
+
'--ts-var-parameter-chip-hover-background'?: string;
|
|
8418
|
+
/**
|
|
8419
|
+
* Font color of the parameter chips in the Liveboard on hover.
|
|
8420
|
+
*/
|
|
8421
|
+
'--ts-var-parameter-chip-hover-text-color'?: string;
|
|
8422
|
+
/**
|
|
8423
|
+
* Background color of the parameter chips in the Liveboard on active.
|
|
8424
|
+
*/
|
|
8425
|
+
'--ts-var-parameter-chip-active-background'?: string;
|
|
8426
|
+
/**
|
|
8427
|
+
* Font color of the parameter chips in the Liveboard on active.
|
|
8428
|
+
*/
|
|
8429
|
+
'--ts-var-parameter-chip-active-text-color'?: string;
|
|
8430
|
+
/**
|
|
8431
|
+
* Background color of the action button in the Liveboard header.
|
|
8432
|
+
*/
|
|
8433
|
+
'--ts-var-liveboard-header-action-button-background'?: string;
|
|
8434
|
+
/**
|
|
8435
|
+
* Font color of the action button in the Liveboard header.
|
|
8436
|
+
*/
|
|
8437
|
+
'--ts-var-liveboard-header-action-button-font-color'?: string;
|
|
8438
|
+
/**
|
|
8439
|
+
* Font color of the action button in the Liveboard header on hover.
|
|
8440
|
+
*/
|
|
8441
|
+
'--ts-var-liveboard-header-action-button-hover-color'?: string;
|
|
8442
|
+
/**
|
|
8443
|
+
* Font color of the action button in the Liveboard header on active.
|
|
8444
|
+
*/
|
|
8445
|
+
'--ts-var-liveboard-header-action-button-active-color'?: string;
|
|
8446
|
+
/**
|
|
8447
|
+
* Background color of the badge in the Liveboard header.
|
|
8448
|
+
*/
|
|
8449
|
+
'--ts-var-liveboard-header-badge-background'?: string;
|
|
8450
|
+
/**
|
|
8451
|
+
* Font color of the badge in the Liveboard header.
|
|
8452
|
+
*/
|
|
8453
|
+
'--ts-var-liveboard-header-badge-font-color'?: string;
|
|
8454
|
+
/**
|
|
8455
|
+
* Background color of the modified badge in the Liveboard header.
|
|
8456
|
+
*/
|
|
8457
|
+
'--ts-var-liveboard-header-badge-modified-background'?: string;
|
|
8458
|
+
/**
|
|
8459
|
+
* Font color of the modified badge in the Liveboard header.
|
|
8460
|
+
*/
|
|
8461
|
+
'--ts-var-liveboard-header-badge-modified-font-color'?: string;
|
|
8462
|
+
/**
|
|
8463
|
+
* Font color of the badge in the Liveboard header on hover.
|
|
8464
|
+
*/
|
|
8465
|
+
'--ts-var-liveboard-header-badge-hover-color'?: string;
|
|
8466
|
+
/**
|
|
8467
|
+
* Font color of the badge in the Liveboard header on active.
|
|
8468
|
+
*/
|
|
8469
|
+
'--ts-var-liveboard-header-badge-active-color'?: string;
|
|
8470
|
+
/**
|
|
8471
|
+
* Font color of the hero text in the KPI widget.
|
|
8472
|
+
*/
|
|
8473
|
+
'--ts-var-kpi-hero-color'?: string;
|
|
8474
|
+
/**
|
|
8475
|
+
* Font color of the comparison text in the KPI widget.
|
|
8476
|
+
*/
|
|
8477
|
+
'--ts-var-kpi-comparison-color'?: string;
|
|
8478
|
+
/**
|
|
8479
|
+
* Font color of the analyze text in the KPI widget.
|
|
8480
|
+
*/
|
|
8481
|
+
'--ts-var-kpi-analyze-text-color'?: string;
|
|
8482
|
+
/**
|
|
8483
|
+
* Font color of the legend title in the heatmap chart.
|
|
8484
|
+
*/
|
|
8485
|
+
'--ts-var-chart-heatmap-legend-title-color'?: string;
|
|
8486
|
+
/**
|
|
8487
|
+
* Font color of the legend label in the heatmap chart.
|
|
8488
|
+
*/
|
|
8489
|
+
'--ts-var-chart-heatmap-legend-label-color'?: string;
|
|
8490
|
+
/**
|
|
8491
|
+
* Font color of the legend title in the treemap chart.
|
|
8492
|
+
*/
|
|
8493
|
+
'--ts-var-chart-treemap-legend-title-color'?: string;
|
|
8494
|
+
/**
|
|
8495
|
+
* Font color of the legend label in the treemap chart.
|
|
8496
|
+
*/
|
|
8497
|
+
'--ts-var-chart-treemap-legend-label-color'?: string;
|
|
8498
|
+
/**
|
|
8499
|
+
* Color of the positive change in the KPI.
|
|
8500
|
+
*/
|
|
8501
|
+
'--ts-var-kpi-positive-change-color'?: string;
|
|
8502
|
+
/**
|
|
8503
|
+
* Color of the negative change in the KPI.
|
|
8504
|
+
*/
|
|
8505
|
+
'--ts-var-kpi-negative-change-color'?: string;
|
|
8506
|
+
/**
|
|
8507
|
+
* Background color of the change analysis insights.
|
|
8508
|
+
*/
|
|
8509
|
+
'--ts-var-change-analysis-insights-background'?: string;
|
|
8510
|
+
/**
|
|
8511
|
+
* Background color of the forecasting card in the SpotIQ analyze.
|
|
8512
|
+
*/
|
|
8513
|
+
'--ts-var-spotiq-analyze-forecasting-card-background'?: string;
|
|
8514
|
+
/**
|
|
8515
|
+
* Background color of the outlier card in the SpotIQ analyze.
|
|
8516
|
+
*/
|
|
8517
|
+
'--ts-var-spotiq-analyze-outlier-card-background'?: string;
|
|
8518
|
+
/**
|
|
8519
|
+
* Background color of the trend card in the SpotIQ analyze.
|
|
8520
|
+
*/
|
|
8521
|
+
'--ts-var-spotiq-analyze-trend-card-background'?: string;
|
|
8522
|
+
/**
|
|
8523
|
+
* Background color of the crosscorrelation card in the SpotIQ analyze.
|
|
8524
|
+
*/
|
|
8525
|
+
'--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
|
|
8526
|
+
/**
|
|
8527
|
+
* Background color of the summary header in the CCA modal.
|
|
8528
|
+
*/
|
|
8529
|
+
'--ts-var-cca-modal-summary-header-background'?: string;
|
|
8036
8530
|
}
|
|
8037
8531
|
|
|
8038
8532
|
/**
|
|
@@ -8521,16 +9015,31 @@ export const getAnswerFromQuery: (query: string, worksheetId: string) => Promise
|
|
|
8521
9015
|
}>;
|
|
8522
9016
|
|
|
8523
9017
|
/**
|
|
8524
|
-
*
|
|
8525
|
-
*
|
|
8526
|
-
*
|
|
9018
|
+
* Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
|
|
9019
|
+
*
|
|
9020
|
+
* Each answer will be added as a visualization to the newly created Liveboard.
|
|
9021
|
+
*
|
|
9022
|
+
* @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
|
|
9023
|
+
* representing the answers to be added to the Liveboard.
|
|
9024
|
+
* @param {string} name - The name of the Liveboard to create.
|
|
8527
9025
|
* @returns result Promise
|
|
8528
9026
|
* @version SDK: 1.33.1 | ThoughtSpot: *
|
|
8529
9027
|
* @example
|
|
8530
9028
|
* ```js
|
|
8531
|
-
*
|
|
8532
|
-
*
|
|
8533
|
-
*
|
|
9029
|
+
* import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
|
|
9030
|
+
*
|
|
9031
|
+
* embed.on(EmbedEvent.Data, async () => {
|
|
9032
|
+
* try {
|
|
9033
|
+
* const answerService = await embed.getAnswerService();
|
|
9034
|
+
* const lb = await createLiveboardWithAnswers(
|
|
9035
|
+
* [answerService],
|
|
9036
|
+
* "My Liveboard"
|
|
9037
|
+
* );
|
|
9038
|
+
* console.log("Liveboard created:", lb);
|
|
9039
|
+
* } catch (err) {
|
|
9040
|
+
* console.error("Failed to create liveboard:", err);
|
|
9041
|
+
* }
|
|
9042
|
+
* });
|
|
8534
9043
|
* ```
|
|
8535
9044
|
*/
|
|
8536
9045
|
export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
|
|
@@ -8689,19 +9198,15 @@ export class TsEmbed {
|
|
|
8689
9198
|
protected isRendered: boolean;
|
|
8690
9199
|
protected hostEventClient: HostEventClient;
|
|
8691
9200
|
protected isReadyForRenderPromise: Promise<void>;
|
|
8692
|
-
id: string;
|
|
8693
9201
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
8694
9202
|
/**
|
|
8695
9203
|
* Handles errors within the SDK
|
|
8696
9204
|
* @param error The error message or object
|
|
8697
9205
|
*/
|
|
8698
9206
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
8699
|
-
isEmbedContainerLoaded: boolean;
|
|
8700
9207
|
protected getAuthTokenForCookielessInit(): Promise<string>;
|
|
8701
9208
|
protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
|
|
8702
9209
|
protected getAppInitData(): Promise<DefaultAppInitData>;
|
|
8703
|
-
protected getPreRenderObj<T extends TsEmbed>(): T;
|
|
8704
|
-
protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
|
|
8705
9210
|
/**
|
|
8706
9211
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
8707
9212
|
* @param query
|
|
@@ -8815,6 +9320,19 @@ export class TsEmbed {
|
|
|
8815
9320
|
* ```
|
|
8816
9321
|
*/
|
|
8817
9322
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
9323
|
+
/**
|
|
9324
|
+
* @hidden
|
|
9325
|
+
* Internal state to track if the embed container is loaded.
|
|
9326
|
+
* This is used to trigger events after the embed container is loaded.
|
|
9327
|
+
*/
|
|
9328
|
+
isEmbedContainerLoaded: boolean;
|
|
9329
|
+
protected getPreRenderObj<T extends TsEmbed>(): T;
|
|
9330
|
+
/**
|
|
9331
|
+
* Executes a callback after the embed container is loaded.
|
|
9332
|
+
* @param callback The callback to execute
|
|
9333
|
+
*/
|
|
9334
|
+
protected executeAfterEmbedContainerLoaded(callback: () => void): void;
|
|
9335
|
+
protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
|
|
8818
9336
|
/**
|
|
8819
9337
|
* Triggers an event to the embedded app
|
|
8820
9338
|
* @param {HostEvent} messageType The event type
|