@thoughtspot/visual-embed-sdk 1.36.7 → 1.36.9-PA
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 +23 -21
- package/cjs/src/embed/bodyless-conversation.d.ts +16 -0
- package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/cjs/src/embed/bodyless-conversation.js +1 -1
- package/cjs/src/embed/bodyless-conversation.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +15 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +25 -1
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +1 -1
- package/cjs/src/embed/search.d.ts +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +14 -2
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +111 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/pages/embed-test.page.d.ts +8 -0
- package/cjs/src/pages/embed-test.page.d.ts.map +1 -0
- package/cjs/src/pages/embed-test.page.js +20 -0
- package/cjs/src/pages/embed-test.page.js.map +1 -0
- package/cjs/src/pages/home.page.d.ts +6 -0
- package/cjs/src/pages/home.page.d.ts.map +1 -0
- package/cjs/src/pages/home.page.js +12 -0
- package/cjs/src/pages/home.page.js.map +1 -0
- package/cjs/src/pages/login.page.d.ts +15 -0
- package/cjs/src/pages/login.page.d.ts.map +1 -0
- package/cjs/src/pages/login.page.js +22 -0
- package/cjs/src/pages/login.page.js.map +1 -0
- package/cjs/src/react/index.d.ts +1 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +10 -5
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/util.d.ts +2 -0
- package/cjs/src/react/util.d.ts.map +1 -1
- package/cjs/src/react/util.js.map +1 -1
- package/cjs/src/tests/auth.test.d.ts +1 -0
- package/cjs/src/tests/auth.test.d.ts.map +1 -0
- package/cjs/src/tests/auth.test.js +1 -0
- package/cjs/src/tests/auth.test.js.map +1 -0
- package/cjs/src/tests/e2e/auth.spec.d.ts +2 -0
- package/cjs/src/tests/e2e/auth.spec.d.ts.map +1 -0
- package/cjs/src/tests/e2e/auth.spec.js +54 -0
- package/cjs/src/tests/e2e/auth.spec.js.map +1 -0
- package/cjs/src/types.d.ts +93 -11
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +56 -9
- package/cjs/src/types.js.map +1 -1
- package/dist/index-BEyovSez.js +7370 -0
- package/dist/{index-BratITNz.js → index-BJx3m5_V.js} +1 -1
- package/dist/index-CpzF_6NO.js +7440 -0
- package/dist/index-Dg18PU5Z.js +7370 -0
- package/dist/index-Do_T8J8z.js +7370 -0
- package/dist/index-KdQfn0ah.js +7440 -0
- package/dist/src/embed/bodyless-conversation.d.ts +16 -0
- package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +15 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +1 -1
- package/dist/src/embed/search.d.ts +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/pages/embed-test.page.d.ts +8 -0
- package/dist/src/pages/embed-test.page.d.ts.map +1 -0
- package/dist/src/pages/home.page.d.ts +6 -0
- package/dist/src/pages/home.page.d.ts.map +1 -0
- package/dist/src/pages/login.page.d.ts +15 -0
- package/dist/src/pages/login.page.d.ts.map +1 -0
- package/dist/src/react/index.d.ts +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/react/util.d.ts +2 -0
- package/dist/src/react/util.d.ts.map +1 -1
- package/dist/src/tests/auth.test.d.ts +1 -0
- package/dist/src/tests/auth.test.d.ts.map +1 -0
- package/dist/src/tests/e2e/auth.spec.d.ts +2 -0
- package/dist/src/tests/e2e/auth.spec.d.ts.map +1 -0
- package/dist/src/types.d.ts +93 -11
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +85 -19
- package/dist/tsembed-react.js +269 -133
- package/dist/tsembed.es.js +78 -16
- package/dist/tsembed.js +261 -129
- package/dist/visual-embed-sdk-react-full.d.ts +127 -14
- package/dist/visual-embed-sdk-react.d.ts +127 -14
- package/dist/visual-embed-sdk.d.ts +126 -14
- package/lib/package.json +23 -21
- package/lib/src/embed/bodyless-conversation.d.ts +16 -0
- package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/lib/src/embed/bodyless-conversation.js +1 -1
- package/lib/src/embed/bodyless-conversation.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +15 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +25 -1
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +1 -1
- package/lib/src/embed/search.d.ts +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +14 -2
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +111 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/pages/embed-test.page.d.ts +8 -0
- package/lib/src/pages/embed-test.page.d.ts.map +1 -0
- package/lib/src/pages/embed-test.page.js +16 -0
- package/lib/src/pages/embed-test.page.js.map +1 -0
- package/lib/src/pages/home.page.d.ts +6 -0
- package/lib/src/pages/home.page.d.ts.map +1 -0
- package/lib/src/pages/home.page.js +8 -0
- package/lib/src/pages/home.page.js.map +1 -0
- package/lib/src/pages/login.page.d.ts +15 -0
- package/lib/src/pages/login.page.d.ts.map +1 -0
- package/lib/src/pages/login.page.js +18 -0
- package/lib/src/pages/login.page.js.map +1 -0
- package/lib/src/react/index.d.ts +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +9 -5
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/util.d.ts +2 -0
- package/lib/src/react/util.d.ts.map +1 -1
- package/lib/src/react/util.js.map +1 -1
- package/lib/src/tests/auth.test.d.ts +1 -0
- package/lib/src/tests/auth.test.d.ts.map +1 -0
- package/lib/src/tests/auth.test.js +1 -0
- package/lib/src/tests/auth.test.js.map +1 -0
- package/lib/src/tests/e2e/auth.spec.d.ts +2 -0
- package/lib/src/tests/e2e/auth.spec.d.ts.map +1 -0
- package/lib/src/tests/e2e/auth.spec.js +52 -0
- package/lib/src/tests/e2e/auth.spec.js.map +1 -0
- package/lib/src/types.d.ts +93 -11
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +55 -8
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +128 -15
- package/package.json +23 -21
- package/src/embed/bodyless-conversation.ts +1 -1
- package/src/embed/liveboard.spec.ts +35 -7
- package/src/embed/liveboard.ts +21 -1
- package/src/embed/search-bar.tsx +1 -1
- package/src/embed/search.ts +1 -1
- package/src/embed/ts-embed.spec.ts +118 -0
- package/src/embed/ts-embed.ts +15 -0
- package/src/index.ts +2 -0
- package/src/react/index.tsx +12 -8
- package/src/react/util.ts +1 -0
- package/src/types.ts +94 -10
|
@@ -273,7 +273,7 @@ export function useInit(config: EmbedConfig): React.MutableRefObject<AuthEventEm
|
|
|
273
273
|
* @summary ThoughtSpot Visual Embed SDK
|
|
274
274
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
275
275
|
*/
|
|
276
|
-
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, };
|
|
276
|
+
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
|
|
277
277
|
|
|
278
278
|
export declare let loggedInStatus: boolean;
|
|
279
279
|
export declare let samlAuthWindow: Window;
|
|
@@ -518,7 +518,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
518
518
|
/**
|
|
519
519
|
* Exclude the search token string from the URL.
|
|
520
520
|
* If set to true, the search token string is not appended to the URL.
|
|
521
|
-
* @version: SDK: 1.35.7 | ThoughtSpot: 10.
|
|
521
|
+
* @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
522
522
|
* @example
|
|
523
523
|
* ```js
|
|
524
524
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -880,7 +880,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
880
880
|
/**
|
|
881
881
|
* Exclude the search token string from the URL.
|
|
882
882
|
* If set to true, the search token string is not appended to the URL.
|
|
883
|
-
* @version: SDK: 1.35.7 | ThoughtSpot: 10.
|
|
883
|
+
* @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
884
884
|
* @example
|
|
885
885
|
* ```js
|
|
886
886
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1876,6 +1876,21 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1876
1876
|
* })
|
|
1877
1877
|
*/
|
|
1878
1878
|
dataSourceId?: string;
|
|
1879
|
+
/**
|
|
1880
|
+
* This flag is for show/hide checkboxes for include or exclude
|
|
1881
|
+
* cover and filter pages in the Liveboard PDF
|
|
1882
|
+
* @type {boolean}
|
|
1883
|
+
* @default true
|
|
1884
|
+
* @version SDK: 1.38.0 | ThoughtSpot:10.8.0.cl
|
|
1885
|
+
* @example
|
|
1886
|
+
* ```js
|
|
1887
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1888
|
+
* ... // other options
|
|
1889
|
+
* coverAndFilterOptionInPDF: false,
|
|
1890
|
+
* })
|
|
1891
|
+
* ```
|
|
1892
|
+
*/
|
|
1893
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
1879
1894
|
}
|
|
1880
1895
|
/**
|
|
1881
1896
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -2219,6 +2234,8 @@ export interface CustomisationsInterface {
|
|
|
2219
2234
|
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
2220
2235
|
*/
|
|
2221
2236
|
strings?: Record<string, any>;
|
|
2237
|
+
stringIDs?: Record<string, string>;
|
|
2238
|
+
stringIDsUrl?: string;
|
|
2222
2239
|
[key: string]: any;
|
|
2223
2240
|
};
|
|
2224
2241
|
iconSpriteUrl?: string;
|
|
@@ -2529,7 +2546,7 @@ export interface EmbedConfig {
|
|
|
2529
2546
|
* }
|
|
2530
2547
|
* });
|
|
2531
2548
|
* ```
|
|
2532
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.
|
|
2549
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
2533
2550
|
*/
|
|
2534
2551
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2535
2552
|
disablePreauthCache?: boolean;
|
|
@@ -2608,6 +2625,19 @@ export interface ViewConfig {
|
|
|
2608
2625
|
* ```
|
|
2609
2626
|
*/
|
|
2610
2627
|
disabledActions?: Action[];
|
|
2628
|
+
/**
|
|
2629
|
+
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2630
|
+
* Use this to set the primary action.
|
|
2631
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
2632
|
+
* @example
|
|
2633
|
+
* ```js
|
|
2634
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
2635
|
+
* ... // other liveboard view config
|
|
2636
|
+
* primaryAction: Action.Download
|
|
2637
|
+
* });
|
|
2638
|
+
* ```
|
|
2639
|
+
*/
|
|
2640
|
+
primaryAction?: Action | string;
|
|
2611
2641
|
/**
|
|
2612
2642
|
* The tooltip to display for disabled actions.
|
|
2613
2643
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -2970,6 +3000,12 @@ export interface ViewConfig {
|
|
|
2970
3000
|
* });
|
|
2971
3001
|
*/
|
|
2972
3002
|
collapseSearchBar?: boolean;
|
|
3003
|
+
/**
|
|
3004
|
+
* This flag can be used to expose translation IDs on the embedded app.
|
|
3005
|
+
* @default false
|
|
3006
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
3007
|
+
*/
|
|
3008
|
+
exposeTranslationIDs?: boolean;
|
|
2973
3009
|
/**
|
|
2974
3010
|
* This flag can be used to disable links inside the embedded app,
|
|
2975
3011
|
* and disable redirection of links in a new tab.
|
|
@@ -3024,6 +3060,21 @@ export interface ViewConfig {
|
|
|
3024
3060
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
3025
3061
|
*/
|
|
3026
3062
|
overrideOrgId?: number;
|
|
3063
|
+
/**
|
|
3064
|
+
* Hide list page columns
|
|
3065
|
+
* For example: hiddenListColumns = [ListPageColumns.Author]
|
|
3066
|
+
*
|
|
3067
|
+
* **Note**: This option is appplicable only in full app embedding.
|
|
3068
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3069
|
+
* @example
|
|
3070
|
+
* ```js
|
|
3071
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3072
|
+
* ... // other options
|
|
3073
|
+
* hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
|
|
3074
|
+
* })
|
|
3075
|
+
* ```
|
|
3076
|
+
*/
|
|
3077
|
+
hiddenListColumns?: ListPageColumns[];
|
|
3027
3078
|
}
|
|
3028
3079
|
/**
|
|
3029
3080
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -3169,6 +3220,33 @@ export declare enum HomepageModule {
|
|
|
3169
3220
|
*/
|
|
3170
3221
|
Learning = "LEARNING"
|
|
3171
3222
|
}
|
|
3223
|
+
/**
|
|
3224
|
+
* List page columns that can be hidden.
|
|
3225
|
+
* **Note**: This option is applicable only in full app embedding.
|
|
3226
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3227
|
+
*/
|
|
3228
|
+
export declare enum ListPageColumns {
|
|
3229
|
+
/**
|
|
3230
|
+
* Favourite
|
|
3231
|
+
*/
|
|
3232
|
+
Favourite = "FAVOURITE",
|
|
3233
|
+
/**
|
|
3234
|
+
* Tags
|
|
3235
|
+
*/
|
|
3236
|
+
Tags = "TAGS",
|
|
3237
|
+
/**
|
|
3238
|
+
* Author
|
|
3239
|
+
*/
|
|
3240
|
+
Author = "AUTHOR",
|
|
3241
|
+
/**
|
|
3242
|
+
* Last viewed/Last modified
|
|
3243
|
+
*/
|
|
3244
|
+
DateSort = "DATE_SORT",
|
|
3245
|
+
/**
|
|
3246
|
+
* Share
|
|
3247
|
+
*/
|
|
3248
|
+
Share = "SHARE"
|
|
3249
|
+
}
|
|
3172
3250
|
/**
|
|
3173
3251
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
3174
3252
|
* visualizations at runtime.
|
|
@@ -4191,16 +4269,19 @@ export declare enum EmbedEvent {
|
|
|
4191
4269
|
/**
|
|
4192
4270
|
* Emits when a table visualization is rendered in
|
|
4193
4271
|
* the ThoughtSpot embedded app.
|
|
4272
|
+
*
|
|
4194
4273
|
* You can also use this event as a hook to trigger host events
|
|
4195
4274
|
* such as `HostEvent.TransformTableVizData` on the table visualization.
|
|
4196
4275
|
* The event payload contains the data used in the rendered table.
|
|
4197
4276
|
* You can extract the relevant data from the payload
|
|
4198
4277
|
* stored in `payload.data.data.columnDataLite`.
|
|
4278
|
+
*
|
|
4199
4279
|
* `columnDataLite` is a multidimensional array that contains
|
|
4200
4280
|
* data values for each column, which was used in the query to
|
|
4201
4281
|
* generate the table visualization. To find and modify specific cell data,
|
|
4202
4282
|
* you can either loop through the array or directly access a cell if
|
|
4203
4283
|
* you know its position and data index.
|
|
4284
|
+
*
|
|
4204
4285
|
* In the following code sample, the first cell in the first column
|
|
4205
4286
|
* (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
|
|
4206
4287
|
* Note that any changes made to the data in the payload will only update the
|
|
@@ -4210,6 +4291,7 @@ export declare enum EmbedEvent {
|
|
|
4210
4291
|
* payload in the `columnDataLite` is passed on to
|
|
4211
4292
|
* `HostEvent.TransformTableVizData` and trigger an update to
|
|
4212
4293
|
* the table visualization.
|
|
4294
|
+
*
|
|
4213
4295
|
* If the Row-Level Security (RLS) rules are applied on the
|
|
4214
4296
|
* Worksheet or Model, exercise caution when changing column
|
|
4215
4297
|
* or table cell values to maintain data security.
|
|
@@ -4224,7 +4306,7 @@ export declare enum EmbedEvent {
|
|
|
4224
4306
|
* searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
|
|
4225
4307
|
* })
|
|
4226
4308
|
* ```
|
|
4227
|
-
* @version SDK: 1.
|
|
4309
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
|
|
4228
4310
|
*/
|
|
4229
4311
|
TableVizRendered = "TableVizRendered",
|
|
4230
4312
|
/**
|
|
@@ -4237,7 +4319,7 @@ export declare enum EmbedEvent {
|
|
|
4237
4319
|
* console.log('payload', payload);
|
|
4238
4320
|
* })
|
|
4239
4321
|
*```
|
|
4240
|
-
* @version SDK : 1.
|
|
4322
|
+
* @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
|
|
4241
4323
|
*/
|
|
4242
4324
|
CreateLiveboard = "createLiveboard",
|
|
4243
4325
|
/**
|
|
@@ -4684,7 +4766,7 @@ export declare enum HostEvent {
|
|
|
4684
4766
|
* ```js
|
|
4685
4767
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4686
4768
|
* ```
|
|
4687
|
-
* @version SDK: 1.
|
|
4769
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
|
|
4688
4770
|
*/
|
|
4689
4771
|
Remove = "delete",
|
|
4690
4772
|
/**
|
|
@@ -5232,7 +5314,7 @@ export declare enum HostEvent {
|
|
|
5232
5314
|
* ```js
|
|
5233
5315
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5234
5316
|
*```
|
|
5235
|
-
* @version SDK: 1.36.0 |
|
|
5317
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5236
5318
|
*/
|
|
5237
5319
|
InfoSuccess = "InfoSuccess",
|
|
5238
5320
|
/**
|
|
@@ -5279,7 +5361,7 @@ export declare enum HostEvent {
|
|
|
5279
5361
|
* searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
|
|
5280
5362
|
* })
|
|
5281
5363
|
* ```
|
|
5282
|
-
* @version SDK: 1.
|
|
5364
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
|
|
5283
5365
|
*/
|
|
5284
5366
|
TransformTableVizData = "TransformTableVizData"
|
|
5285
5367
|
}
|
|
@@ -5330,6 +5412,7 @@ export declare enum Param {
|
|
|
5330
5412
|
livedBoardEmbed = "isLiveboardEmbed",
|
|
5331
5413
|
searchEmbed = "isSearchEmbed",
|
|
5332
5414
|
vizEmbed = "isVizEmbed",
|
|
5415
|
+
StringIDsUrl = "overrideStringIDsUrl",
|
|
5333
5416
|
Version = "sdkVersion",
|
|
5334
5417
|
ViewPortHeight = "viewPortHeight",
|
|
5335
5418
|
ViewPortWidth = "viewPortWidth",
|
|
@@ -5379,6 +5462,7 @@ export declare enum Param {
|
|
|
5379
5462
|
HideSageAnswerHeader = "hideSageAnswerHeader",
|
|
5380
5463
|
HideSearchBar = "hideSearchBar",
|
|
5381
5464
|
ClientLogLevel = "clientLogLevel",
|
|
5465
|
+
ExposeTranslationIDs = "exposeTranslationIDs",
|
|
5382
5466
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
5383
5467
|
enableAskSage = "enableAskSage",
|
|
5384
5468
|
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
@@ -5404,7 +5488,9 @@ export declare enum Param {
|
|
|
5404
5488
|
IsForceRedirect = "isForceRedirect",
|
|
5405
5489
|
DataSourceId = "dataSourceId",
|
|
5406
5490
|
preAuthCache = "preAuthCache",
|
|
5407
|
-
ShowSpotterLimitations = "showSpotterLimitations"
|
|
5491
|
+
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5492
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
5493
|
+
PrimaryAction = "primaryAction"
|
|
5408
5494
|
}
|
|
5409
5495
|
/**
|
|
5410
5496
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5569,7 +5655,7 @@ export declare enum Action {
|
|
|
5569
5655
|
* The **Collapse data panel** icon on the Search page.
|
|
5570
5656
|
* Collapses the data panel view.
|
|
5571
5657
|
*
|
|
5572
|
-
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5658
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5573
5659
|
*
|
|
5574
5660
|
* @example
|
|
5575
5661
|
* ```js
|
|
@@ -6613,7 +6699,17 @@ export declare enum Action {
|
|
|
6613
6699
|
* ```
|
|
6614
6700
|
* @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
6615
6701
|
*/
|
|
6616
|
-
ColumnRename = "columnRename"
|
|
6702
|
+
ColumnRename = "columnRename",
|
|
6703
|
+
/**
|
|
6704
|
+
* Action ID for hide checkboxes for include or exclude
|
|
6705
|
+
* cover and filter pages in the Liveboard PDF
|
|
6706
|
+
* @example
|
|
6707
|
+
* ```js
|
|
6708
|
+
* hiddenAction: [Action.CoverAndFilterOptionInPDF]
|
|
6709
|
+
* ```
|
|
6710
|
+
* @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
6711
|
+
*/
|
|
6712
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
|
|
6617
6713
|
}
|
|
6618
6714
|
export interface AnswerServiceType {
|
|
6619
6715
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -6625,8 +6721,8 @@ export declare enum PrefetchFeatures {
|
|
|
6625
6721
|
VizEmbed = "VizEmbed"
|
|
6626
6722
|
}
|
|
6627
6723
|
/**
|
|
6628
|
-
* Enum for options to change context trigger
|
|
6629
|
-
* BOTH_CLICKS option is
|
|
6724
|
+
* Enum for options to change context trigger.
|
|
6725
|
+
* The `BOTH_CLICKS` option is available from 10.8.0.cl.
|
|
6630
6726
|
*/
|
|
6631
6727
|
export declare enum ContextMenuTriggerOptions {
|
|
6632
6728
|
LEFT_CLICK = "left-click",
|
|
@@ -6767,6 +6863,7 @@ export interface DefaultAppInitData {
|
|
|
6767
6863
|
hostConfig: Record<string, any>;
|
|
6768
6864
|
hiddenHomeLeftNavItems: string[];
|
|
6769
6865
|
customVariablesForThirdPartyTools: Record<string, any>;
|
|
6866
|
+
hiddenListColumns: ListPageColumns[];
|
|
6770
6867
|
}
|
|
6771
6868
|
|
|
6772
6869
|
export type EmbedEventHandlers = {
|
|
@@ -6774,6 +6871,7 @@ export type EmbedEventHandlers = {
|
|
|
6774
6871
|
};
|
|
6775
6872
|
export interface EmbedProps extends ViewConfig, EmbedEventHandlers {
|
|
6776
6873
|
className?: string;
|
|
6874
|
+
style?: React.CSSProperties;
|
|
6777
6875
|
}
|
|
6778
6876
|
export interface ViewConfigAndListeners<T extends ViewConfig> {
|
|
6779
6877
|
viewConfig: T;
|
|
@@ -7048,6 +7146,18 @@ export interface BodylessConversationViewConfig extends ViewConfig {
|
|
|
7048
7146
|
*/
|
|
7049
7147
|
worksheetId: string;
|
|
7050
7148
|
}
|
|
7149
|
+
interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
|
|
7150
|
+
sessionId: string;
|
|
7151
|
+
genNo: number;
|
|
7152
|
+
acSessionId: string;
|
|
7153
|
+
acGenNo: number;
|
|
7154
|
+
}
|
|
7155
|
+
declare class ConversationMessage extends TsEmbed {
|
|
7156
|
+
protected viewConfig: ConversationMessageViewConfig;
|
|
7157
|
+
constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
|
|
7158
|
+
getIframeSrc(): string;
|
|
7159
|
+
render(): Promise<ConversationMessage>;
|
|
7160
|
+
}
|
|
7051
7161
|
/**
|
|
7052
7162
|
* Create a conversation embed, which can be integrated inside
|
|
7053
7163
|
* chatbots or other conversational interfaces.
|
|
@@ -7072,11 +7182,14 @@ export declare class BodylessConversation {
|
|
|
7072
7182
|
sendMessage(userMessage: string): Promise<{
|
|
7073
7183
|
error: any;
|
|
7074
7184
|
container?: undefined;
|
|
7185
|
+
viz?: undefined;
|
|
7075
7186
|
} | {
|
|
7076
7187
|
container: HTMLDivElement;
|
|
7188
|
+
viz: ConversationMessage;
|
|
7077
7189
|
error?: undefined;
|
|
7078
7190
|
}>;
|
|
7079
7191
|
}
|
|
7192
|
+
export {};
|
|
7080
7193
|
|
|
7081
7194
|
export type SessionInfo = {
|
|
7082
7195
|
releaseVersion: string;
|
|
@@ -508,7 +508,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
508
508
|
/**
|
|
509
509
|
* Exclude the search token string from the URL.
|
|
510
510
|
* If set to true, the search token string is not appended to the URL.
|
|
511
|
-
* @version: SDK: 1.35.7 | ThoughtSpot: 10.
|
|
511
|
+
* @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
512
512
|
* @example
|
|
513
513
|
* ```js
|
|
514
514
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -870,7 +870,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
870
870
|
/**
|
|
871
871
|
* Exclude the search token string from the URL.
|
|
872
872
|
* If set to true, the search token string is not appended to the URL.
|
|
873
|
-
* @version: SDK: 1.35.7 | ThoughtSpot: 10.
|
|
873
|
+
* @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
|
|
874
874
|
* @example
|
|
875
875
|
* ```js
|
|
876
876
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1866,6 +1866,21 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1866
1866
|
* })
|
|
1867
1867
|
*/
|
|
1868
1868
|
dataSourceId?: string;
|
|
1869
|
+
/**
|
|
1870
|
+
* This flag is for show/hide checkboxes for include or exclude
|
|
1871
|
+
* cover and filter pages in the Liveboard PDF
|
|
1872
|
+
* @type {boolean}
|
|
1873
|
+
* @default true
|
|
1874
|
+
* @version SDK: 1.38.0 | ThoughtSpot:10.8.0.cl
|
|
1875
|
+
* @example
|
|
1876
|
+
* ```js
|
|
1877
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1878
|
+
* ... // other options
|
|
1879
|
+
* coverAndFilterOptionInPDF: false,
|
|
1880
|
+
* })
|
|
1881
|
+
* ```
|
|
1882
|
+
*/
|
|
1883
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
1869
1884
|
}
|
|
1870
1885
|
/**
|
|
1871
1886
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -2209,6 +2224,8 @@ export interface CustomisationsInterface {
|
|
|
2209
2224
|
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
2210
2225
|
*/
|
|
2211
2226
|
strings?: Record<string, any>;
|
|
2227
|
+
stringIDs?: Record<string, string>;
|
|
2228
|
+
stringIDsUrl?: string;
|
|
2212
2229
|
[key: string]: any;
|
|
2213
2230
|
};
|
|
2214
2231
|
iconSpriteUrl?: string;
|
|
@@ -2519,7 +2536,7 @@ export interface EmbedConfig {
|
|
|
2519
2536
|
* }
|
|
2520
2537
|
* });
|
|
2521
2538
|
* ```
|
|
2522
|
-
* @version SDK 1.37.0 | ThoughtSpot: 10.
|
|
2539
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
2523
2540
|
*/
|
|
2524
2541
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
2525
2542
|
disablePreauthCache?: boolean;
|
|
@@ -2598,6 +2615,19 @@ export interface ViewConfig {
|
|
|
2598
2615
|
* ```
|
|
2599
2616
|
*/
|
|
2600
2617
|
disabledActions?: Action[];
|
|
2618
|
+
/**
|
|
2619
|
+
* The primary action to display on top of the viz for Liveboard and App Embed.
|
|
2620
|
+
* Use this to set the primary action.
|
|
2621
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
2622
|
+
* @example
|
|
2623
|
+
* ```js
|
|
2624
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
2625
|
+
* ... // other liveboard view config
|
|
2626
|
+
* primaryAction: Action.Download
|
|
2627
|
+
* });
|
|
2628
|
+
* ```
|
|
2629
|
+
*/
|
|
2630
|
+
primaryAction?: Action | string;
|
|
2601
2631
|
/**
|
|
2602
2632
|
* The tooltip to display for disabled actions.
|
|
2603
2633
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -2960,6 +2990,12 @@ export interface ViewConfig {
|
|
|
2960
2990
|
* });
|
|
2961
2991
|
*/
|
|
2962
2992
|
collapseSearchBar?: boolean;
|
|
2993
|
+
/**
|
|
2994
|
+
* This flag can be used to expose translation IDs on the embedded app.
|
|
2995
|
+
* @default false
|
|
2996
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
2997
|
+
*/
|
|
2998
|
+
exposeTranslationIDs?: boolean;
|
|
2963
2999
|
/**
|
|
2964
3000
|
* This flag can be used to disable links inside the embedded app,
|
|
2965
3001
|
* and disable redirection of links in a new tab.
|
|
@@ -3014,6 +3050,21 @@ export interface ViewConfig {
|
|
|
3014
3050
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
3015
3051
|
*/
|
|
3016
3052
|
overrideOrgId?: number;
|
|
3053
|
+
/**
|
|
3054
|
+
* Hide list page columns
|
|
3055
|
+
* For example: hiddenListColumns = [ListPageColumns.Author]
|
|
3056
|
+
*
|
|
3057
|
+
* **Note**: This option is appplicable only in full app embedding.
|
|
3058
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3059
|
+
* @example
|
|
3060
|
+
* ```js
|
|
3061
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
3062
|
+
* ... // other options
|
|
3063
|
+
* hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
|
|
3064
|
+
* })
|
|
3065
|
+
* ```
|
|
3066
|
+
*/
|
|
3067
|
+
hiddenListColumns?: ListPageColumns[];
|
|
3017
3068
|
}
|
|
3018
3069
|
/**
|
|
3019
3070
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -3159,6 +3210,33 @@ export declare enum HomepageModule {
|
|
|
3159
3210
|
*/
|
|
3160
3211
|
Learning = "LEARNING"
|
|
3161
3212
|
}
|
|
3213
|
+
/**
|
|
3214
|
+
* List page columns that can be hidden.
|
|
3215
|
+
* **Note**: This option is applicable only in full app embedding.
|
|
3216
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3217
|
+
*/
|
|
3218
|
+
export declare enum ListPageColumns {
|
|
3219
|
+
/**
|
|
3220
|
+
* Favourite
|
|
3221
|
+
*/
|
|
3222
|
+
Favourite = "FAVOURITE",
|
|
3223
|
+
/**
|
|
3224
|
+
* Tags
|
|
3225
|
+
*/
|
|
3226
|
+
Tags = "TAGS",
|
|
3227
|
+
/**
|
|
3228
|
+
* Author
|
|
3229
|
+
*/
|
|
3230
|
+
Author = "AUTHOR",
|
|
3231
|
+
/**
|
|
3232
|
+
* Last viewed/Last modified
|
|
3233
|
+
*/
|
|
3234
|
+
DateSort = "DATE_SORT",
|
|
3235
|
+
/**
|
|
3236
|
+
* Share
|
|
3237
|
+
*/
|
|
3238
|
+
Share = "SHARE"
|
|
3239
|
+
}
|
|
3162
3240
|
/**
|
|
3163
3241
|
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
3164
3242
|
* visualizations at runtime.
|
|
@@ -4181,16 +4259,19 @@ export declare enum EmbedEvent {
|
|
|
4181
4259
|
/**
|
|
4182
4260
|
* Emits when a table visualization is rendered in
|
|
4183
4261
|
* the ThoughtSpot embedded app.
|
|
4262
|
+
*
|
|
4184
4263
|
* You can also use this event as a hook to trigger host events
|
|
4185
4264
|
* such as `HostEvent.TransformTableVizData` on the table visualization.
|
|
4186
4265
|
* The event payload contains the data used in the rendered table.
|
|
4187
4266
|
* You can extract the relevant data from the payload
|
|
4188
4267
|
* stored in `payload.data.data.columnDataLite`.
|
|
4268
|
+
*
|
|
4189
4269
|
* `columnDataLite` is a multidimensional array that contains
|
|
4190
4270
|
* data values for each column, which was used in the query to
|
|
4191
4271
|
* generate the table visualization. To find and modify specific cell data,
|
|
4192
4272
|
* you can either loop through the array or directly access a cell if
|
|
4193
4273
|
* you know its position and data index.
|
|
4274
|
+
*
|
|
4194
4275
|
* In the following code sample, the first cell in the first column
|
|
4195
4276
|
* (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
|
|
4196
4277
|
* Note that any changes made to the data in the payload will only update the
|
|
@@ -4200,6 +4281,7 @@ export declare enum EmbedEvent {
|
|
|
4200
4281
|
* payload in the `columnDataLite` is passed on to
|
|
4201
4282
|
* `HostEvent.TransformTableVizData` and trigger an update to
|
|
4202
4283
|
* the table visualization.
|
|
4284
|
+
*
|
|
4203
4285
|
* If the Row-Level Security (RLS) rules are applied on the
|
|
4204
4286
|
* Worksheet or Model, exercise caution when changing column
|
|
4205
4287
|
* or table cell values to maintain data security.
|
|
@@ -4214,7 +4296,7 @@ export declare enum EmbedEvent {
|
|
|
4214
4296
|
* searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
|
|
4215
4297
|
* })
|
|
4216
4298
|
* ```
|
|
4217
|
-
* @version SDK: 1.
|
|
4299
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
|
|
4218
4300
|
*/
|
|
4219
4301
|
TableVizRendered = "TableVizRendered",
|
|
4220
4302
|
/**
|
|
@@ -4227,7 +4309,7 @@ export declare enum EmbedEvent {
|
|
|
4227
4309
|
* console.log('payload', payload);
|
|
4228
4310
|
* })
|
|
4229
4311
|
*```
|
|
4230
|
-
* @version SDK : 1.
|
|
4312
|
+
* @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
|
|
4231
4313
|
*/
|
|
4232
4314
|
CreateLiveboard = "createLiveboard",
|
|
4233
4315
|
/**
|
|
@@ -4674,7 +4756,7 @@ export declare enum HostEvent {
|
|
|
4674
4756
|
* ```js
|
|
4675
4757
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4676
4758
|
* ```
|
|
4677
|
-
* @version SDK: 1.
|
|
4759
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
|
|
4678
4760
|
*/
|
|
4679
4761
|
Remove = "delete",
|
|
4680
4762
|
/**
|
|
@@ -5222,7 +5304,7 @@ export declare enum HostEvent {
|
|
|
5222
5304
|
* ```js
|
|
5223
5305
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
5224
5306
|
*```
|
|
5225
|
-
* @version SDK: 1.36.0 |
|
|
5307
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
5226
5308
|
*/
|
|
5227
5309
|
InfoSuccess = "InfoSuccess",
|
|
5228
5310
|
/**
|
|
@@ -5269,7 +5351,7 @@ export declare enum HostEvent {
|
|
|
5269
5351
|
* searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
|
|
5270
5352
|
* })
|
|
5271
5353
|
* ```
|
|
5272
|
-
* @version SDK: 1.
|
|
5354
|
+
* @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
|
|
5273
5355
|
*/
|
|
5274
5356
|
TransformTableVizData = "TransformTableVizData"
|
|
5275
5357
|
}
|
|
@@ -5320,6 +5402,7 @@ export declare enum Param {
|
|
|
5320
5402
|
livedBoardEmbed = "isLiveboardEmbed",
|
|
5321
5403
|
searchEmbed = "isSearchEmbed",
|
|
5322
5404
|
vizEmbed = "isVizEmbed",
|
|
5405
|
+
StringIDsUrl = "overrideStringIDsUrl",
|
|
5323
5406
|
Version = "sdkVersion",
|
|
5324
5407
|
ViewPortHeight = "viewPortHeight",
|
|
5325
5408
|
ViewPortWidth = "viewPortWidth",
|
|
@@ -5369,6 +5452,7 @@ export declare enum Param {
|
|
|
5369
5452
|
HideSageAnswerHeader = "hideSageAnswerHeader",
|
|
5370
5453
|
HideSearchBar = "hideSearchBar",
|
|
5371
5454
|
ClientLogLevel = "clientLogLevel",
|
|
5455
|
+
ExposeTranslationIDs = "exposeTranslationIDs",
|
|
5372
5456
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
5373
5457
|
enableAskSage = "enableAskSage",
|
|
5374
5458
|
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
@@ -5394,7 +5478,9 @@ export declare enum Param {
|
|
|
5394
5478
|
IsForceRedirect = "isForceRedirect",
|
|
5395
5479
|
DataSourceId = "dataSourceId",
|
|
5396
5480
|
preAuthCache = "preAuthCache",
|
|
5397
|
-
ShowSpotterLimitations = "showSpotterLimitations"
|
|
5481
|
+
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5482
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
5483
|
+
PrimaryAction = "primaryAction"
|
|
5398
5484
|
}
|
|
5399
5485
|
/**
|
|
5400
5486
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -5559,7 +5645,7 @@ export declare enum Action {
|
|
|
5559
5645
|
* The **Collapse data panel** icon on the Search page.
|
|
5560
5646
|
* Collapses the data panel view.
|
|
5561
5647
|
*
|
|
5562
|
-
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5648
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
5563
5649
|
*
|
|
5564
5650
|
* @example
|
|
5565
5651
|
* ```js
|
|
@@ -6603,7 +6689,17 @@ export declare enum Action {
|
|
|
6603
6689
|
* ```
|
|
6604
6690
|
* @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
6605
6691
|
*/
|
|
6606
|
-
ColumnRename = "columnRename"
|
|
6692
|
+
ColumnRename = "columnRename",
|
|
6693
|
+
/**
|
|
6694
|
+
* Action ID for hide checkboxes for include or exclude
|
|
6695
|
+
* cover and filter pages in the Liveboard PDF
|
|
6696
|
+
* @example
|
|
6697
|
+
* ```js
|
|
6698
|
+
* hiddenAction: [Action.CoverAndFilterOptionInPDF]
|
|
6699
|
+
* ```
|
|
6700
|
+
* @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
6701
|
+
*/
|
|
6702
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
|
|
6607
6703
|
}
|
|
6608
6704
|
export interface AnswerServiceType {
|
|
6609
6705
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -6615,8 +6711,8 @@ export declare enum PrefetchFeatures {
|
|
|
6615
6711
|
VizEmbed = "VizEmbed"
|
|
6616
6712
|
}
|
|
6617
6713
|
/**
|
|
6618
|
-
* Enum for options to change context trigger
|
|
6619
|
-
* BOTH_CLICKS option is
|
|
6714
|
+
* Enum for options to change context trigger.
|
|
6715
|
+
* The `BOTH_CLICKS` option is available from 10.8.0.cl.
|
|
6620
6716
|
*/
|
|
6621
6717
|
export declare enum ContextMenuTriggerOptions {
|
|
6622
6718
|
LEFT_CLICK = "left-click",
|
|
@@ -6757,6 +6853,7 @@ export interface DefaultAppInitData {
|
|
|
6757
6853
|
hostConfig: Record<string, any>;
|
|
6758
6854
|
hiddenHomeLeftNavItems: string[];
|
|
6759
6855
|
customVariablesForThirdPartyTools: Record<string, any>;
|
|
6856
|
+
hiddenListColumns: ListPageColumns[];
|
|
6760
6857
|
}
|
|
6761
6858
|
|
|
6762
6859
|
export type EmbedEventHandlers = {
|
|
@@ -6764,6 +6861,7 @@ export type EmbedEventHandlers = {
|
|
|
6764
6861
|
};
|
|
6765
6862
|
export interface EmbedProps extends ViewConfig, EmbedEventHandlers {
|
|
6766
6863
|
className?: string;
|
|
6864
|
+
style?: React.CSSProperties;
|
|
6767
6865
|
}
|
|
6768
6866
|
export interface ViewConfigAndListeners<T extends ViewConfig> {
|
|
6769
6867
|
viewConfig: T;
|
|
@@ -6895,7 +6993,7 @@ export declare class ConversationEmbed extends TsEmbed {
|
|
|
6895
6993
|
* @summary ThoughtSpot Visual Embed SDK
|
|
6896
6994
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
6897
6995
|
*/
|
|
6898
|
-
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, };
|
|
6996
|
+
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
|
|
6899
6997
|
|
|
6900
6998
|
/**
|
|
6901
6999
|
* Copyright (c) 2022
|
|
@@ -8001,6 +8099,18 @@ export interface BodylessConversationViewConfig extends ViewConfig {
|
|
|
8001
8099
|
*/
|
|
8002
8100
|
worksheetId: string;
|
|
8003
8101
|
}
|
|
8102
|
+
interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
|
|
8103
|
+
sessionId: string;
|
|
8104
|
+
genNo: number;
|
|
8105
|
+
acSessionId: string;
|
|
8106
|
+
acGenNo: number;
|
|
8107
|
+
}
|
|
8108
|
+
declare class ConversationMessage extends TsEmbed {
|
|
8109
|
+
protected viewConfig: ConversationMessageViewConfig;
|
|
8110
|
+
constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
|
|
8111
|
+
getIframeSrc(): string;
|
|
8112
|
+
render(): Promise<ConversationMessage>;
|
|
8113
|
+
}
|
|
8004
8114
|
/**
|
|
8005
8115
|
* Create a conversation embed, which can be integrated inside
|
|
8006
8116
|
* chatbots or other conversational interfaces.
|
|
@@ -8025,11 +8135,14 @@ export declare class BodylessConversation {
|
|
|
8025
8135
|
sendMessage(userMessage: string): Promise<{
|
|
8026
8136
|
error: any;
|
|
8027
8137
|
container?: undefined;
|
|
8138
|
+
viz?: undefined;
|
|
8028
8139
|
} | {
|
|
8029
8140
|
container: HTMLDivElement;
|
|
8141
|
+
viz: ConversationMessage;
|
|
8030
8142
|
error?: undefined;
|
|
8031
8143
|
}>;
|
|
8032
8144
|
}
|
|
8145
|
+
export {};
|
|
8033
8146
|
|
|
8034
8147
|
export type SessionInfo = {
|
|
8035
8148
|
releaseVersion: string;
|