Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/embed/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@
isPNGInScheduledEmailsEnabled?: boolean;

/**
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page

Check warning on line 629 in src/embed/app.ts

View workflow job for this annotation

GitHub Actions / build

Comments may not exceed 90 characters
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
*
Expand Down Expand Up @@ -1192,6 +1192,7 @@
spotterFileUploadEnabled,
spotterFileUploadFileTypes,
enableStarterPrompts,
openSpotterOnLiveboardByDefault,
} = spotterChatConfig;

setParamIfDefined(params, Param.HideToolResponseCardBranding, hideToolResponseCardBranding, true);
Expand All @@ -1205,6 +1206,12 @@
if (spotterFileUploadFileTypes !== undefined) {
params[Param.SpotterFileUploadFileTypes] = JSON.stringify(spotterFileUploadFileTypes);
}
setParamIfDefined(
params,
Param.OpenSpotterOnLiveboardByDefault,
openSpotterOnLiveboardByDefault,
true,
);
}

if (!isUndefined(updatedSpotterExperience)) {
Expand Down Expand Up @@ -1379,7 +1386,7 @@
this.iFrame,
this.viewConfig.enableScrollableContainerLazyLoading,
);
// this should be fired only if the lazyLoadingForFullHeight and fullHeight are true

Check warning on line 1389 in src/embed/app.ts

View workflow job for this annotation

GitHub Actions / build

Comments may not exceed 80 characters
if(this.viewConfig.lazyLoadingForFullHeight && this.viewConfig.fullHeight){
this.trigger(HostEvent.VisibleEmbedCoordinates, data);
}
Expand Down
20 changes: 18 additions & 2 deletions src/embed/conversation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -283,8 +283,9 @@ export interface StarterPreviewDataCategory {
* Category keys are fixed: `quick` (Basic Search), `research` (Deep Analysis)
* and `previewData` (Data Literacy).
*
* Note: this controls the Spotter chat interface only. The starter prompts on
* the Liveboard SpotterViz surface are configured separately through
* Note: the category keys control the Spotter chat interface, and `liveboard`
* controls the Spotter chat panel on a Liveboard. The starter prompts on the
* Liveboard SpotterViz surface are configured separately through
* {@link SpotterVizConfig.customStarterPrompts}.
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
* @group Embed components
Expand All @@ -305,6 +306,13 @@ export interface StarterPromptsConfig {
research?: StarterPromptCategory;
/** Data Literacy category configuration. */
previewData?: StarterPreviewDataCategory;
/**
* Starter prompt questions for the Spotter chat panel on a Liveboard.
*
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
*/
liveboard?: StarterPromptQuestion[];
}

/**
Expand Down Expand Up @@ -384,6 +392,14 @@ export interface SpotterChatViewConfig {
* ```
*/
starterPrompts?: StarterPromptsConfig;
/**
* Opens the Spotter chat panel on the Liveboard by default.
*
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
* @default false
*/
openSpotterOnLiveboardByDefault?: boolean;
}

/**
Expand Down
7 changes: 7 additions & 0 deletions src/embed/liveboard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -852,6 +852,7 @@ export class LiveboardEmbed extends V1Embed {
spotterFileUploadEnabled,
spotterFileUploadFileTypes,
enableStarterPrompts,
openSpotterOnLiveboardByDefault,
} = spotterChatConfig;

setParamIfDefined(params, Param.HideToolResponseCardBranding, hideToolResponseCardBranding, true);
Expand All @@ -865,6 +866,12 @@ export class LiveboardEmbed extends V1Embed {
if (spotterFileUploadFileTypes !== undefined) {
params[Param.SpotterFileUploadFileTypes] = JSON.stringify(spotterFileUploadFileTypes);
}
setParamIfDefined(
params,
Param.OpenSpotterOnLiveboardByDefault,
openSpotterOnLiveboardByDefault,
true,
);
}

if (isLinkParametersEnabled !== undefined) {
Expand Down
12 changes: 12 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6794,6 +6794,7 @@ export enum Param {
UpdatedSpotterExperience = 'updatedSpotterExperience',
SpotterDataSources = 'spotterDataSources',
AnalystId = 'analystId',
OpenSpotterOnLiveboardByDefault = 'openSpotterOnLiveboardByDefault',
}

/**
Expand Down Expand Up @@ -8597,6 +8598,17 @@ export enum Action {
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
*/
SpotterChatModeSwitcher = 'spotterChatModeSwitcher',
/**
* Controls visibility and disable state of the Spotter chat panel
* on an embedded Liveboard.
* @example
* ```js
* hiddenActions: [Action.SpotterOnLiveboard]
* disabledActions: [Action.SpotterOnLiveboard]
* ```
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
*/
SpotterOnLiveboard = 'spotterOnLiveboard',
/**
* The **Basic Search** starter prompt pill.
*
Expand Down
Loading
Loading