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