UNPKG

@thoughtspot/visual-embed-sdk

Version:
1,606 lines (1,605 loc) 435 kB
declare module '@thoughtspot/visual-embed-sdk' { // Generated by dts-bundle-generator v9.5.1 /** * The list of customization css variables. These * are the only allowed variables possible. */ export interface CustomCssVariables { /** * Background color of the Liveboard, visualization, Search, and Answer pages. */ "--ts-var-root-background"?: string; /** * Color of the text on application pages. */ "--ts-var-root-color"?: string; /** * Font type for the text on application pages. */ "--ts-var-root-font-family"?: string; /** * Text transformation specification for UI elements in the app. */ "--ts-var-root-text-transform"?: string; /** * Font color of the text on toggle buttons such as * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience), * the text color of the chart and table tiles on Home page (New modular Homepage * experience), title text on the AI-generated charts and tables, and object titles on * list pages such as *Liveboards* and *Answers*. * The default color code is #2770EF. * */ "--ts-var-application-color"?: string; /** * Background color of the top navigation panel. */ "--ts-var-nav-background"?: string; /** * Font color of the top navigation panel. */ "--ts-var-nav-color"?: string; /** * Background color of the *Search data* button. */ "--ts-var-search-data-button-background"?: string; /** * Color of the text on the *Search data* button. */ "--ts-var-search-data-button-font-color"?: string; /** * Font of the text on the *Search data* button. */ "--ts-var-search-data-button-font-family"?: string; /** * Font color of the text in the Search bar. */ "--ts-var-search-bar-text-font-color"?: string; /** * Font of the text in the Search bar. */ "--ts-var-search-bar-text-font-family"?: string; /** * Font style of the text in the Search bar. */ "--ts-var-search-bar-text-font-style"?: string; /** * Background color of the search bar. */ "--ts-var-search-bar-background"?: string; /** * Background color of the search suggestions panel. */ "--ts-var-search-auto-complete-background"?: string; /** * Background color of the navigation panel that allows you to undo, redo, and reset * search operations. */ "--ts-var-search-navigation-button-background"?: string; /** * Background color of the navigation help text that appears at the bottom of the * search suggestions panel. */ "--ts-var-search-bar-navigation-help-text-background"?: string; /** * Background color of the search suggestion block on hover. */ "--ts-var-search-bar-auto-complete-hover-background"?: string; /** * Font color of the text in the search suggestion panel. */ "--ts-var-search-auto-complete-font-color"?: string; /** * Font color of the sub-text that appears below the keyword in the search suggestion * panel. */ "--ts-var-search-auto-complete-subtext-font-color"?: string; /** * Background color of the input box in the Spotter page. */ "--ts-var-spotter-input-background"?: string; /** * Background color of the previously asked prompt message in the Spotter page. */ "--ts-var-spotter-prompt-background"?: string; /** * Background color of the data panel. */ "--ts-var-answer-data-panel-background-color"?: string; /** * Background color of the vertical panel on the right side of the Answer page, which * includes the options to edit charts and tables. */ "--ts-var-answer-edit-panel-background-color"?: string; /** * Background color of the chart switcher on search results and Answer pages. */ "--ts-var-answer-view-table-chart-switcher-background"?: string; /** * Background color of the currently selected chart type in the chart switcher. */ "--ts-var-answer-view-table-chart-switcher-active-background"?: string; /** * Border-radius of main buttons. * For example, the *Search data* button in the top navigation panel. */ "--ts-var-button-border-radius"?: string; /** * Border-radius of small buttons such as secondary buttons. * For example, share and favorite buttons. */ "--ts-var-button--icon-border-radius"?: string; /** * Font color of the text on primary buttons. For example, the primary buttons on * Liveboard*, Answer, *Data* workspace, *SpotIQ*, or *Home* page. */ "--ts-var-button--primary-color"?: string; /** * Font family specification for the text on primary buttons. */ "--ts-var-button--primary--font-family"?: string; /** * Background color of the primary buttons. For example, the primary buttons such as * Pin* and *Save*. */ "--ts-var-button--primary-background"?: string; /** * Background color of the primary buttons on hover. */ "--ts-var-button--primary--hover-background"?: string; /** * Backgroud color of the primary buttons when active. */ "--ts-var-button--primary--active-background"?: string; /** * Font color of the text on the secondary buttons. */ "--ts-var-button--secondary-color"?: string; /** * Font family specification for the text on the secondary buttons. */ "--ts-var-button--secondary--font-family"?: string; /** * Background color of the secondary buttons. */ "--ts-var-button--secondary-background"?: string; /** * Background color of the secondary button on hover. */ "--ts-var-button--secondary--hover-background"?: string; /** * Backgroud color of the secondary buttons when active. */ "--ts-var-button--secondary--active-background"?: string; /** * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset* * buttons on the *Search* page. */ "--ts-var-button--tertiary-color"?: string; /** * Background color of the tertiary button. */ "--ts-var-button--tertiary-background"?: string; /** * Background color of the tertiary button when a user hovers over these buttons. */ "--ts-var-button--tertiary--hover-background"?: string; /** * Backgroud color of the tertiary buttons when active. */ "--ts-var-button--tertiary--active-background"?: string; /** * Font color of the title text of a visualization or Answer. */ "--ts-var-viz-title-color"?: string; /** * Font family specification for the title text of a visualization/Answer. */ "--ts-var-viz-title-font-family"?: string; /** * Text transformation specification for visualization and Answer titles. */ "--ts-var-viz-title-text-transform"?: string; /** * Font color of the description text and subtitle of a visualization or Answer. */ "--ts-var-viz-description-color"?: string; /** * Font family specification of description text and subtitle of a visualization or * Answer. */ "--ts-var-viz-description-font-family"?: string; /** * Text transformation specification for description text and subtitle of a * visualization or Answer. */ "--ts-var-viz-description-text-transform"?: string; /** * Border-radius for the visualization tiles and header panel on a Liveboard. */ "--ts-var-viz-border-radius"?: string; /** * Box shadow property for the visualization tiles and header panel on a Liveboard. */ "--ts-var-viz-box-shadow"?: string; /** * Background color of the visualization tiles and header panel on a Liveboard. */ "--ts-var-viz-background"?: string; /** * Background color of the legend on a visualization or Answer. */ "--ts-var-viz-legend-hover-background"?: string; /** * Background color of the selected chart type on the chart selection widget. */ "--ts-var-answer-chart-select-background"?: string; /** * Background color of the chart type element when a user hovers over a chart type on * the chart selection widget. */ "--ts-var-answer-chart-hover-background"?: string; /** * Border-radius of filter chips. */ "--ts-var-chip-border-radius"?: string; /** * Shadow effect for filter chips. */ "--ts-var-chip-box-shadow"?: string; /** * Background color of filter chips. */ "--ts-var-chip-background"?: string; /** * Font color of the filter label when a filter chip is selected */ "--ts-var-chip--active-color"?: string; /** * Background color of the filter chips when selected. */ "--ts-var-chip--active-background"?: string; /** * Font color of the text on filter chips when hovered over. */ "--ts-var-chip--hover-color"?: string; /** * Background color of filter chips on hover. */ "--ts-var-chip--hover-background"?: string; /** * Font color of the text on filter chips. */ "--ts-var-chip-color"?: string; /** * Font family specification for the text on filter chips. */ "--ts-var-chip-title-font-family"?: string; /** * Font color of axis title on charts. */ "--ts-var-axis-title-color"?: string; /** * Font family specification for the X and Y axis title text. */ "--ts-var-axis-title-font-family"?: string; /** * Font color of the X and Y axis labels. */ "--ts-var-axis-data-label-color"?: string; /** * Font family specification for X and Y axis labels. */ "--ts-var-axis-data-label-font-family"?: string; /** * Font color of the menu items. */ "--ts-var-menu-color"?: string; /** * Background color of menu panels. */ "--ts-var-menu-background"?: string; /** * Font family specification for the menu items. */ "--ts-var-menu-font-family"?: string; /** * Text capitalization specification for the menu items. */ "--ts-var-menu-text-transform"?: string; /** * Background color for menu items on hover. */ "--ts-var-menu--hover-background"?: string; /** * Text color for selected menu items. */ "--ts-var-menu-selected-text-color"?: string; /** * Background color of the dialogs. */ "--ts-var-dialog-body-background"?: string; /** * Font color of the body text displayed on dialogs. */ "--ts-var-dialog-body-color"?: string; /** * Background color of the header text on dialogs. */ "--ts-var-dialog-header-background"?: string; /** * Font color of the header text on dialogs. */ "--ts-var-dialog-header-color"?: string; /** * Background color of the footer area on dialogs. */ "--ts-var-dialog-footer-background"?: string; /** * Background for selected state in list */ "--ts-var-list-selected-background"?: string; /** * Background for hover state in list */ "--ts-var-list-hover-background"?: string; /** * Background for hover state in segment control. */ "--ts-var-segment-control-hover-background"?: string; /** * Text color for slected item in modular home's watchlist. */ "--ts-var-home-watchlist-selected-text-color"?: string; /** * Text color for favorite carousel find your favorites card in modular home. */ "--ts-var-home-favorite-suggestion-card-text-color"?: string; /** * Icon color for favorite carousel find your favorites card in modular home. */ "--ts-var-home-favorite-suggestion-card-icon-color"?: string; /** * Background for favorite carousel find your favorites card in modular home. */ "--ts-var-home-favorite-suggestion-card-background"?: string; /** * Border color of checkbox in error state. */ "--ts-var-checkbox-error-border"?: string; /** * Border color of checkbox. */ "--ts-var-checkbox-border-color"?: string; /** * Border color of checkbox in hover state. */ "--ts-var-checkbox-hover-border"?: string; /** * Border and font color of checkbox in active state. */ "--ts-var-checkbox-active-color"?: string; /** * Border color and font color of checkbox in checked state. */ "--ts-var-checkbox-checked-color"?: string; /** * Border and font color of checkbox in disabled state. */ "--ts-var-checkbox-checked-disabled"?: string; /** * Background color of checkbox. */ "--ts-var-checkbox-background-color"?: string; /** * Background color of the layout in the Liveboard. */ "--ts-var-liveboard-layout-background"?: string; /** * Background color of the header in the Liveboard. */ "--ts-var-liveboard-header-background"?: string; /** * Font color of the header in the Liveboard. */ "--ts-var-liveboard-header-font-color"?: string; /** * Border color of the tiles in the Liveboard. */ "--ts-var-liveboard-tile-border-color"?: string; /** * Background color of the tiles in the Liveboard. */ "--ts-var-liveboard-tile-background"?: string; /** * Border radius of the tiles in the Liveboard. */ "--ts-var-liveboard-tile-border-radius"?: string; /** * Padding of the tiles in the Liveboard. */ "--ts-var-liveboard-tile-padding"?: string; /** * Background color of the table header in the Liveboard. */ "--ts-var-liveboard-tile-table-header-background"?: string; /** * Padding of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-padding"?: string; /** * Font size of the title of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-title-font-size"?: string; /** * Font weight of the title of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-title-font-weight"?: string; /** * Font size of the title of the tiles inside the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-tile-title-font-size"?: string; /** * Font weight of the title of the tiles inside the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-tile-title-font-weight"?: string; /** * Padding of the group tiles in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-tile-padding"?: string; /** * Padding of the answer viz in the Liveboard. */ "--ts-var-liveboard-answer-viz-padding"?: string; /** * Background color of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-background"?: string; /** * Border color of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-border-color"?: string; /** * Font color of the heading of the note title in the Liveboard. */ "--ts-var-liveboard-notetitle-heading-font-color"?: string; /** * Font color of the body of the note title in the Liveboard. */ "--ts-var-liveboard-notetitle-body-font-color"?: string; /** * Font color of the title of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-title-font-color"?: string; /** * Font color of the description of the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-description-font-color"?: string; /** * Font color of the title of the tiles inside the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-tile-title-font-color"?: string; /** * Font color of the description of the tiles inside the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-tile-description-font-color"?: string; /** * Background color of the tiles inside the groups in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-group-tile-background"?: string; /** * Background color of the filter chips in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-chip-background"?: string; /** * Font color of the filter chips in the Liveboard. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-chip-color"?: string; /** * Background color of the filter chips in the Liveboard on hover. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-chip--hover-background"?: string; /** * Background color of the filter chips in the Liveboard on active. * * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and * then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying * this CSS variable. */ "--ts-var-liveboard-chip--active-background"?: string; /** * Width of the side panel in the Liveboard. */ "--ts-var-side-panel-width"?: string; /** * Background color of the edit bar in the Liveboard. */ "--ts-var-liveboard-edit-bar-background"?: string; /** * Breakpoint for the dual column layout in the Liveboard. */ "--ts-var-liveboard-dual-column-breakpoint"?: string; /** * Breakpoint for the single column layout in the Liveboard. */ "--ts-var-liveboard-single-column-breakpoint"?: string; /** * Background color of the cross filter layout in the Liveboard. */ "--ts-var-liveboard-cross-filter-layout-background"?: string; /** * Border color of the active tab in the Liveboard. */ "--ts-var-liveboard-tab-active-border-color"?: string; /** * Font color of the hover tab in the Liveboard. */ "--ts-var-liveboard-tab-hover-color"?: string; /** * Font size of the title of the tiles in the Liveboard. */ "--ts-var-liveboard-tile-title-fontsize"?: string; /** * Font weight of the title of the tiles in the Liveboard. */ "--ts-var-liveboard-tile-title-fontweight"?: string; /** * Background color of the parameter chips in the Liveboard. */ "--ts-var-parameter-chip-background"?: string; /** * Font color of the parameter chips in the Liveboard. */ "--ts-var-parameter-chip-text-color"?: string; /** * Background color of the parameter chips in the Liveboard on hover. */ "--ts-var-parameter-chip-hover-background"?: string; /** * Font color of the parameter chips in the Liveboard on hover. */ "--ts-var-parameter-chip-hover-text-color"?: string; /** * Background color of the parameter chips in the Liveboard on active. */ "--ts-var-parameter-chip-active-background"?: string; /** * Font color of the parameter chips in the Liveboard on active. */ "--ts-var-parameter-chip-active-text-color"?: string; /** * Background color of the action button in the Liveboard header. */ "--ts-var-liveboard-header-action-button-background"?: string; /** * Font color of the action button in the Liveboard header. */ "--ts-var-liveboard-header-action-button-font-color"?: string; /** * Font color of the action button in the Liveboard header on hover. */ "--ts-var-liveboard-header-action-button-hover-color"?: string; /** * Font color of the action button in the Liveboard header on active. */ "--ts-var-liveboard-header-action-button-active-color"?: string; /** * Background color of the badge in the Liveboard header. */ "--ts-var-liveboard-header-badge-background"?: string; /** * Font color of the badge in the Liveboard header. */ "--ts-var-liveboard-header-badge-font-color"?: string; /** * Background color of the modified badge in the Liveboard header. */ "--ts-var-liveboard-header-badge-modified-background"?: string; /** * Font color of the modified badge in the Liveboard header. */ "--ts-var-liveboard-header-badge-modified-font-color"?: string; /** * Font color of the badge in the Liveboard header on hover. */ "--ts-var-liveboard-header-badge-hover-color"?: string; /** * Font color of the badge in the Liveboard header on active. */ "--ts-var-liveboard-header-badge-active-color"?: string; /** * Font color of the hero text in the KPI widget. */ "--ts-var-kpi-hero-color"?: string; /** * Font color of the comparison text in the KPI widget. */ "--ts-var-kpi-comparison-color"?: string; /** * Font color of the analyze text in the KPI widget. */ "--ts-var-kpi-analyze-text-color"?: string; /** * Font color of the legend title in the heatmap chart. */ "--ts-var-chart-heatmap-legend-title-color"?: string; /** * Font color of the legend label in the heatmap chart. */ "--ts-var-chart-heatmap-legend-label-color"?: string; /** * Font color of the legend title in the treemap chart. */ "--ts-var-chart-treemap-legend-title-color"?: string; /** * Font color of the legend label in the treemap chart. */ "--ts-var-chart-treemap-legend-label-color"?: string; /** * Color of the positive change in the KPI. */ "--ts-var-kpi-positive-change-color"?: string; /** * Color of the negative change in the KPI. */ "--ts-var-kpi-negative-change-color"?: string; /** * Background color of the change analysis insights. */ "--ts-var-change-analysis-insights-background"?: string; /** * Background color of the forecasting card in the SpotIQ analyze. */ "--ts-var-spotiq-analyze-forecasting-card-background"?: string; /** * Background color of the outlier card in the SpotIQ analyze. */ "--ts-var-spotiq-analyze-outlier-card-background"?: string; /** * Background color of the trend card in the SpotIQ analyze. */ "--ts-var-spotiq-analyze-trend-card-background"?: string; /** * Background color of the crosscorrelation card in the SpotIQ analyze. */ "--ts-var-spotiq-analyze-crosscorrelation-card-background"?: string; /** * Background color of the summary header in the CCA modal. */ "--ts-var-cca-modal-summary-header-background"?: string; /** * Width of the Spotter chat window. */ "--ts-var-spotter-chat-width"?: string; /** * Border color for the saved chats sidebar container. */ "--ts-var-saved-chats-border-color"?: string; /** * Background color for the saved chats sidebar container. */ "--ts-var-saved-chats-bg"?: string; /** * Text color for the saved chats sidebar container. */ "--ts-var-saved-chats-text-color"?: string; /** * Border color for the saved chats sidebar header. */ "--ts-var-saved-chats-header-border"?: string; /** * Color for the saved chats sidebar title text. */ "--ts-var-saved-chats-title-color"?: string; /** * Background color for buttons (new chat, toggle, footer) in the saved chats sidebar. */ "--ts-var-saved-chats-btn-bg"?: string; /** * Hover background color for buttons in the saved chats sidebar. */ "--ts-var-saved-chats-btn-hover-bg"?: string; /** * Text color for conversation items in the saved chats sidebar. */ "--ts-var-saved-chats-conv-text-color"?: string; /** * Background color for conversation items on hover in the saved chats sidebar. */ "--ts-var-saved-chats-conv-hover-bg"?: string; /** * Background color for the active/selected conversation in the saved chats sidebar. */ "--ts-var-saved-chats-conv-active-bg"?: string; /** * Border color for the saved chats sidebar footer. */ "--ts-var-saved-chats-footer-border"?: string; /** * Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar. */ "--ts-var-saved-chats-section-title-color"?: string; /** * Text color of the styling panel in the Liveboard. */ "--ts-var-liveboard-styling-panel-text-color"?: string; /** * Border color of the styling panel in the Liveboard. */ "--ts-var-liveboard-styling-panel-border-color"?: string; /** * Background color of the styling button in the Liveboard. */ "--ts-var-liveboard-styling-button-background"?: string; /** * Text color of the styling button in the Liveboard. */ "--ts-var-liveboard-styling-button-text-color"?: string; /** * Background color of the styling button in the Liveboard on hover. */ "--ts-var-liveboard-styling-button-hover-background"?: string; /** * Background color of the styling button in the Liveboard when active. */ "--ts-var-liveboard-styling-button-active-background"?: string; /** * Text color of the styling button in the Liveboard on hover. */ "--ts-var-liveboard-styling-button-hover-text-color"?: string; /** * Box shadow of the styling button in the Liveboard. */ "--ts-var-liveboard-styling-button-shadow"?: string; /** * Background color of the color palette in the Liveboard styling panel. */ "--ts-var-liveboard-styling-color-palette-background"?: string; /** * Main panel background of the SpotterViz. */ "--ts-var-spotterviz-panel-background"?: string; /** * Background color of the chat input field in SpotterViz. */ "--ts-var-spotterviz-input-background"?: string; /** * Placeholder text color of the chat input field in SpotterViz. */ "--ts-var-spotterviz-input-placeholder-color"?: string; /** * CTA color of the chat input field in SpotterViz. */ "--ts-var-spotterviz-input-cta-color"?: string; /** * CTA hover color of the chat input field in SpotterViz. */ "--ts-var-spotterviz-input-cta-hover-color"?: string; /** * Text color for the SpotterViz label in the empty state, displayed below * the SpotterViz icon. */ "--ts-var-spotterviz-emptystate-spotterviz-color"?: string; /** * Background color of the starter prompt cards in SpotterViz. */ "--ts-var-spotterviz-prompt-card-background"?: string; /** * Background hover color of the starter prompt cards in SpotterViz. */ "--ts-var-spotterviz-prompt-card-hover-background"?: string; /** * Primary text color in SpotterViz, also used for tool response text, * upvote/downvote buttons, and other primary content. */ "--ts-var-spotterviz-text-primary"?: string; /** * Secondary text color in SpotterViz. */ "--ts-var-spotterviz-text-secondary"?: string; /** * Background color of the user chat message bubble in SpotterViz. */ "--ts-var-spotterviz-message-background"?: string; /** * Hover color for the user chat message expand button in SpotterViz. */ "--ts-var-spotterviz-usermessage-icon-hover"?: string; /** * Background color of the user chat message expand button in SpotterViz. */ "--ts-var-spotterviz-usermessage-icon-background"?: string; /** * Color of the thinking step header when in progress in SpotterViz. */ "--ts-var-spotterviz-thinking-inprogress-header-color"?: string; /** * Color of the thinking step header when completed in SpotterViz. */ "--ts-var-spotterviz-thinking-completed-header-color"?: string; /** * Color of the final completion indicator icon shown when all work is done. * The last green dot which is shown when work is done. */ "--ts-var-spotterviz-thinking-work-done-icon-color"?: string; /** * Hover background color for the working/work done CTA in SpotterViz. */ "--ts-var-spotterviz-thinking-cta-hover-background"?: string; /** * Background color of tool call panels in SpotterViz. */ "--ts-var-spotterviz-tool-call-background"?: string; /** * Color of tool titles and icons in SpotterViz. */ "--ts-var-spotterviz-tool-title-color"?: string; /** * Border color of tool call panels in SpotterViz. */ "--ts-var-spotterviz-tool-border-color"?: string; /** * Background color of the JSON input panel inside a tool call in SpotterViz. */ "--ts-var-spotterviz-tool-json-input-background"?: string; /** * Background color of the upvote/downvote feedback buttons in SpotterViz. */ "--ts-var-spotterviz-tool-feedback-button-background"?: string; /** * Hover background color of the upvote/downvote feedback buttons in SpotterViz. */ "--ts-var-spotterviz-tool-feedback-button-hover"?: string; /** * Text color of the JSON input panel inside a tool call in SpotterViz. */ "--ts-var-spotterviz-tool-json-input-color"?: string; /** * Background color of the last checkpoint section in SpotterViz. */ "--ts-var-spotterviz-last-checkpoint-background"?: string; /** * Border color of the last checkpoint section in SpotterViz. */ "--ts-var-spotterviz-last-checkpoint-border"?: string; /** * Border color of the Liveboard edit header toolbar. */ "--ts-var-liveboard-edit-toolbar-border"?: string; /** * Background color of the selected section in the Liveboard edit header toolbar. */ "--ts-var-liveboard-edit-toolbar-selected-background"?: string; /** * Text color of the selected section in the Liveboard edit header toolbar. */ "--ts-var-liveboard-edit-toolbar-selected-text-color"?: string; /** * Text color of unselected items in the Liveboard edit header toolbar. */ "--ts-var-liveboard-edit-toolbar-text"?: string; /** * Hover background color of unselected items in the Liveboard edit header toolbar. */ "--ts-var-liveboard-edit-toolbar-hover-background"?: string; /** * Hover text color of unselected items in the Liveboard edit header toolbar. */ "--ts-var-liveboard-edit-toolbar-hover-text-color"?: string; /** * Text color of the SpotterViz footer. */ "--ts-var-spotterviz-footer-text-color"?: string; /** * Shared border color used throughout SpotterViz: input box, user message, * header underline, left panel border, thinking step connector and dots. */ "--ts-var-spotterviz-border-color"?: string; /** * Background color of the reference-mode toggle button in the SpotterViz * chat input when it is unselected and the user hovers over it. */ "--ts-var-spotterviz-reference-icon-hover-background"?: string; /** * Icon color for the reference-mode selected state — applies to * both the toggle button when active and the icon badge on each * referenced-entity chip in the chat input. */ "--ts-var-spotterviz-reference-icon-selected-color"?: string; /** * Background color for the reference-mode selected state — applies to * both the reference mode toggle button when active and the icon badge * on each referenced-entity chip in the chat input. */ "--ts-var-spotterviz-reference-icon-selected-background"?: string; } export interface SessionInterface { sessionId: string; genNo: number; acSession: { sessionId: string; genNo: number; }; } export interface UnderlyingDataPoint { columnId: string; dataValue: any; } /** * AnswerService provides a simple way to work with ThoughtSpot Answers. * * This service allows you to interact with ThoughtSpot Answers programmatically, * making it easy to customize visualizations, filter data, and extract insights * directly from your application. * * You can use this service to: * * - Add or remove columns from Answers (`addColumns`, `removeColumns`, * `addColumnsByName`) * - Apply filters to Answers (`addFilter`) * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, * `fetchCSVBlob`, `fetchPNGBlob`) * - Get data for specific points in visualizations * (`getUnderlyingDataForPoint`) * - Run custom queries (`executeQuery`) * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`) * * @example * ```js * // Get the answer service * embed.on(EmbedEvent.Data, async (e) => { * const service = await embed.getAnswerService(); * * // Add columns to the answer * await service.addColumnsByName(["Sales", "Region"]); * * // Get the data * const data = await service.fetchData(); * console.log(data); * }); * ``` * * @example * ```js * // Get data for a point in a visualization * embed.on(EmbedEvent.CustomAction, async (e) => { * const underlying = await e.answerService.getUnderlyingDataForPoint([ * 'Product Name', * 'Sales Amount' * ]); * * const data = await underlying.fetchData(0, 100); * console.log(data); * }); * ``` * * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl * @group Events */ export class AnswerService { private session; private thoughtSpotHost; private selectedPoints?; private answer; private tmlOverride; /** * Should not need to be called directly. * @param session * @param answer * @param thoughtSpotHost * @param selectedPoints */ constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]); /** * Get the details about the source used in the answer. * This can be used to get the list of all columns in the data source for example. */ getSourceDetail(): Promise<any>; /** * Remove columnIds and return updated answer session. * @param columnIds * @returns */ removeColumns(columnIds: string[]): Promise<any>; /** * Add columnIds and return updated answer session. * @param columnIds * @returns */ addColumns(columnIds: string[]): Promise<any>; /** * Add columns by names and return updated answer session. * @param columnNames * @returns * @example * ```js * embed.on(EmbedEvent.Data, async (e) => { * const service = await embed.getAnswerService(); * await service.addColumnsByName([ * "col name 1", * "col name 2" * ]); * console.log(await service.fetchData()); * }); * ``` */ addColumnsByName(columnNames: string[]): Promise<any>; /** * Add a filter to the answer. * @param columnName * @param operator * @param values * @returns */ addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter["values"]): Promise<any>; updateDisplayMode(displayMode?: string): Promise<any>; getSQLQuery(fetchSQLWithAllColumns?: boolean): Promise<string>; /** * Fetch data from the answer. * @param offset * @param size * @returns */ fetchData(offset?: number, size?: number): Promise<{ columns: any; data: any; }>; /** * Fetch the data for the answer as a CSV blob. This might be * quicker for larger data. * @param userLocale * @param includeInfo Include the CSV header in the output * @returns Response */ fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>; /** * Fetch the data for the answer as a PNG blob. This might be * quicker for larger data. * @param userLocale * @param includeInfo * @param omitBackground Omit the background in the PNG * @param deviceScaleFactor The scale factor for the PNG * @return Response */ fetchPNGBlob(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>; /** * Just get the internal URL for this answer's data * as a CSV blob. * @param userLocale * @param includeInfo * @returns */ getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string; /** * Just get the internal URL for this answer's data * as a PNG blob. * @param userLocale * @param omitBackground * @param deviceScaleFactor */ getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string; /** * Get underlying data given a point and the output column names. * In case of a context menu action, the selectedPoints are * automatically passed. * @param outputColumnNames * @param selectedPoints * @example * ```js * embed.on(EmbedEvent.CustomAction, e => { * const underlying = await e.answerService.getUnderlyingDataForPoint([ * 'col name 1' // The column should exist in the data source. * ]); * const data = await underlying.fetchData(0, 100); * }) * ``` * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl */ getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>; /** * Execute a custom graphql query in the context of the answer. * @param query graphql query * @param variables graphql variables * @returns */ executeQuery(query: string, variables: any): Promise<any>; /** * Get the internal session details for the answer. * @returns */ getSession(): SessionInterface; getAnswer(): Promise<any>; getTML(): Promise<any>; addDisplayedVizToLiveboard(liveboardId: string): Promise<any>; setTMLOverride(override: any): void; } /** * The authentication mechanism for allowing access to * the embedded app * @group Authentication / Init */ export enum AuthType { /** * No authentication on the SDK. Pass-through to the embedded App. Alias for * `Passthrough`. * @example * ```js * init({ * // ... * authType: AuthType.None, * }); * ``` */ None = "None", /** * Passthrough SSO to the embedded application within the iframe. Requires least * configuration, but may not be supported by all IDPs. This will behave like `None` * if SSO is not configured on ThoughtSpot. * * To use this: * Your SAML or OpenID provider must allow iframe redirects. * For example, if you are using Okta as IdP, you can enable iframe embedding. * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl * @example * ```js * init({ * // ... * authType: AuthType.EmbeddedSSO, * }); * ``` */ EmbeddedSSO = "EmbeddedSSO", /** * SSO using SAML, Use {@link SAMLRedirect} instead * @deprecated This option is deprecated. * @hidden */ SSO = "SSO_SAML", /** * SSO using SAML, Use {@link SAMLRedirect} instead * @deprecated This option is deprecated. * @hidden */ SAML = "SSO_SAML", /** * SSO using SAML * Makes the host application redirect to the SAML IdP. Use this * if your IdP does not allow itself to be embedded. * * This redirects the host application to the SAML IdP. The host application * will be redirected back to the ThoughtSpot app after authentication. * @example * ```js * init({ * // ... * authType: AuthType.SAMLRedirect, * }); * ``` * * This opens the SAML IdP in a popup window. The popup is triggered * when the user clicks the trigger button. The popup window will be * closed automatically after authentication. * @example * ```js * init({ * // ... * authType: AuthType.SAMLRedirect, * authTriggerText: 'Login with SAML', * authTriggerContainer: '#tsEmbed', * inPopup: true, * }); * ``` * * Can also use the event to trigger the popup flow. Works the same * as the above example. * @example * ```js * const authEE = init({ * // ... * authType: AuthType.SAMLRedirect, * inPopup: true, * }); * * someButtonOnYourPage.addEventListener('click', () => { * authEE.emit(AuthEvent.TRIGGER_SSO_POPUP); * }); * ``` */ SAMLRedirect = "SSO_SAML", /** * SSO using OIDC * SSO using OIDC, Use {@link OIDCRedirect} instead * @deprecated This option is deprecated. * @hidden */ OIDC = "SSO_OIDC", /** * SSO using OIDC * Will make the host application redirect to the OIDC IdP. * See code samples in {@link SAMLRedirect}. */ OIDCRedirect = "SSO_OIDC", /** * Trusted authentication server * Use {@link TrustedAuth} instead * @deprecated This option is deprecated. * @hidden */ AuthServer = "AuthServer", /** * Trusted authentication server. Use your own authentication server * which returns a bearer token, generated using the `secret_key` obtained * from ThoughtSpot. * @example * ```js * init({ * // ... * authType: AuthType.TrustedAuthToken, * getAuthToken: () => { * return fetch('https://my-backend.app/ts-token') * .then((response) => response.json()) * .then((data) => data.token); * } * }); * ``` */ TrustedAuthToken = "AuthServer", /** * Trusted authentication server Cookieless, Use your own authentication * server which returns a bearer token, generated using the `secret_key` * obtained from ThoughtSpot. This uses a cookieless authentication * approach, recommended to bypass the third-party cookie-blocking restriction * implemented by some browsers. * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw * @example * ```js * init({ * // ... * authType: AuthType.TrustedAuthTokenCookieless, * getAuthToken: () => { * return fetch('https://my-backend.app/ts-token') * .then((response) => response.json()) * .then((data) => data.token); * } * }); * ``` */ TrustedAuthTokenCookieless = "AuthServerCookieless", /** * Use the ThoughtSpot login API to authenticate to the cluster directly. * * Warning: This feature is primarily intended for developer testing. It is * strongly advised not to use this authentication method in production. */ Basic = "Basic" } /** * * **Note**: This attribute is not supported in the classic (V1) homepage experience. * */ export enum HomeLeftNavItem { /** * The *Search data* option in * the *Insights* left navigation panel. * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl */ SearchData = "search-data", /** * The *Home* menu option in * the *Insights* left navigation panel. * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl */ Home = "insights-home", /** * The *Liveboards* menu option in * the *Insights* left navigation panel. * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl */ Liveboards = "liveboards", /** * The *Answers* menu option in * the *Insights* left navigation panel. * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl */ Answers = "answers", /** * The *Monitor subscriptions* menu option in * the *Insights* left navigation panel. * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl */ MonitorSubscription = "monitor-alerts", /** * The *SpotIQ analysis* menu option in * the *Insights* left navigation panel. * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl */ SpotIQAnalysis = "spotiq-analysis", /** * The *Liveboard schedules* menu option in * the *Insights* left navigation panel. * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl */ LiveboardSchedules = "liveboard-schedules", /** * The create option in the *Insights* * left navigation panel. * Available in the V3 navigation experience. * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl */ Create = "create", /** * The *Spotter* menu option in the *Insights* * left navigation panel. * Available in the V3 navigation experience. * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl */ Spotter = "spotter", /** * The *Favorites* section in the *Insights* * left navigation panel. * Available in the V3 navigation experience. * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl */ Favorites = "favorites" } export type DOMSelector = string | HTMLElement; /** * inline customCSS within the {@link CustomisationsInterface}. * Use {@link CustomCssVariables} or css rules. */ export interface customCssInterface { /** * The custom css variables, which can be set. * The variables are available in the {@link CustomCssVariables} * interface. For more information, see * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference]. */ variables?: CustomCssVariables; /** * Can be used to define a custom font face * like: * @example * ```js * rules_UNSTABLE?: { * "@font-face": { * "font-family": "custom-font", * "src": url("/path/") * }; * }; * ``` * * Also, custom css rules outside of variables. * @example * ```js * rules_UNSTABLE?: { * ".thoughtspot_class_name": { * "border-radius": "10px", * margin: "20px" * }; * }; * ``` */ rules_UNSTABLE?: { [selector: string]: { [declaration: string]: string; }; }; } /** * Styles within the {@link CustomisationsInterface}. */ export interface CustomStyles { customCSSUrl?: string; customCSS?: customCssInterface; } /** * Configuration to define the customization on the Embedded * ThoughtSpot components. * You can customize styles, text strings, and icons. * For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework]. * @example * ```js * init({ * // ... * customizations: { * style: { * customCSS: { * variables: {}, * rules_UNSTABLE: {} * } * }, * content: { * strings: { * 'LIVEBOARDS': 'Dashboards', * 'ANSWERS': 'Visualizations', * 'Edit': 'Modify', * 'Show underlying data': 'Show source data', * 'SpotIQ': 'Insights', * 'Monitor': 'Alerts', * } * }, * iconSpriteUrl: 'https://my-custom-icon-sprite.svg' * } * }) * ``` */ export interface CustomisationsInterface { style?: CustomStyles; content?: { /** * @version SDK: 1.26.0 | 9.7.0.cl */ strings?: Record<string, any>; stringIDs?: Record<string, string>; stringIDsUrl?: string; [key: string]: any; }; iconSpriteUrl?: string; } /** * The configuration object for embedding ThoughtSpot content. * It includes the ThoughtSpot hostname or IP address, * the type of authentication, and the authentication endpoint * if a trusted authentication server is used. * @group Authentication / Init */ export interface EmbedConfig { /** * The ThoughtSpot cluster hostname or IP address. */ thoughtSpotHost: string; /** * The authentication mechanism to use. */ authType: AuthType; /** * [AuthServer] The trusted authentication endpoint to use to get the * authentication token. A `GET` request is made to the * authentication API endpoint, which returns the token * as a plaintext response. For trusted authentication, * the `authEndpoint` or `getAuthToken` attribute is required. */ authEndpoint?: string; /** * [AuthServer] A function that invokes the trusted authentication endpoint * and returns a Promise that resolves to the `auth token` string. * For trusted authentication, the `authEndpoint` or `getAuthToken` * attribute is required. * * It is advisable to fetch a new token inside this method and not * reuse the old issued token. When auth expires this method is * called again and if it is called with an older token, the authentication * will not succeed. */ getAuthToken?: () => Promise<string>; /** * [AuthServer / Basic] The user name of the ThoughtSpot user. This * attribute is required for trusted authentication. */ username?: string; /** * [Basic] The ThoughtSpot login password corresponding to the username * * Warning: This feature is primarily intended for developer testing. It is * strongly advised not to use this authentication method in production. */ password?: string; /** * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will * open the SAML auth flow in a popup, instead of redirecting the browser in * place. * @deprecated This option is deprecated. * @default false */ noRedirect?: boolean; /** * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open * the SAML auth flow in a popup, instead of redirecting the browser in place. * * Need to use this with `authTriggerContainer`. Or manually trigger * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction. * @version SDK: 1.18.0 * @default false */ inPopup?: boolean; /** * [SSO] For SSO Authentication, one can supply an optional path param; * This will be the path on the host origin where the SAML flow will be * terminated. * * Eg: "/dashboard", "#/foo" [Do not include the host] * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw */ redirectPath?: string; /** @internal */ basepath?: string; /** * Boolean to define if the query parameters in the ThoughtSpot URL * should be encoded in base64. This provides additional security to * ThoughtSpot clusters against cross-site scripting attacks. * @default false */ shouldEncodeUrlQueryParams?: boolean; /** * Suppress cookie access alert when third-party cookies are blocked by the * user's browser. Third-party cookie blocking is the default behaviour on * some web browsers like Safari. If you set this attribute to `true`, * you are encouraged to handle `noCookieAccess` event, to show your own treatment * in this case. * @default false */ suppressNoCookieAccessAlert?: boolean; /** * Ignore the cookie access alert when third-party cookies are blocked by the * user's browser. If you set this to `true`, the embedded iframe behaviour * persists even in the case of a non-logged-in user. * @default false */ ignoreNoCookieAccess?: boolean; /** * Re-login a us