const embed = new LiveboardEmbed('#tsEmbed', {
... //other embed view config
visibleActions: [Action.Save, Action.Edit, Action.Present, Action.Explore],
disabledActions: [Action.Download],
//hiddenActions: [], // Set either this or visibleActions
})
Action
- Index
- Enumeration members
- AIHighlights
- AddColumnSet
- AddDataPanelObjects
- AddFilter
- AddFormula
- AddParameter
- AddQuerySet
- AddTab
- AddToFavorites
- AddToWatchlist
- AllLiveboardFilters
- AnswerChartSwitcher
- AnswerDelete
- AskAi
- AxisMenuAggregate
- AxisMenuCompare
- AxisMenuConditionalFormat
- AxisMenuEdit
- AxisMenuFilter
- AxisMenuGroup
- AxisMenuMerge
- AxisMenuNumberFormat
- AxisMenuPosition
- AxisMenuRemove
- AxisMenuRename
- AxisMenuSort
- AxisMenuTextWrapping
- AxisMenuTimeBucket
- ChangeFilterVisibilityInTab
- ChooseDataSources
- CollapseDataPanel
- CollapseDataSources
- ColumnRename
- ConfigureFilter
- CopyAndEdit
- CopyLink
- CopyToClipboard
- CoverAndFilterOptionInPDF
- CreateGroup
- CreateLiveboard
- CreateMonitor
- CrossFilter
- DataLiteracyPill
- DataModelInstructions
- DeepAnalysisPill
- DeletePreviousPrompt
- DeleteScheduleHomepage
- DisableChipReorder
- Download
- DownloadAsCsv
- DownloadAsPdf
- DownloadAsPng
- DownloadAsXlsx
- DownloadLiveboard
- DownloadLiveboardAsA4Pdf
- DownloadLiveboardAsContinuousPDF
- DownloadLiveboardAsCsv
- DownloadLiveboardAsXlsx
- DrillDown
- DrillExclude
- DrillInclude
- Edit
- EditACopy
- EditDetails
- EditInputTable
- EditMeasure
- EditPreviousPrompt
- EditSageAnswer
- EditScheduleHomepage
- EditTML
- EditTitle
- EditTokens
- EnableContextualChangeAnalysis
- EnableIterativeChangeAnalysis
- Explore
- ExportTML
- ImportTML
- InConversationTraining
- IncludeCurrentPeriod
- KPIAnalysisCTA
- LiveboardInfo
- LiveboardStylePanel
- LiveboardUsers
- MakeACopy
- ManageMonitor
- ManagePipelines
- ManagePublishing
- ManageTags
- MarkAsVerified
- ModifySageAnswer
- MoveOutOfGroup
- MoveToGroup
- MoveToTab
- OrganiseFavourites
- OrganizeFavorites
- Parameterize
- PauseScheduleHomepage
- PersonalisedViewsDropdown
- PersonalizedViewsDropdown
- Pin
- PngScreenshotInEmail
- Present
- PreviewDataSpotter
- Publish
- QueryDetailsButtons
- QuickSearchPill
- RefreshLiveboardBrowserCache
- Remove
- RemoveAttachment
- RemoveCrossFilter
- RemoveFromFavorites
- RemoveFromWatchlist
- RenameModalTitleDescription
- ReportError
- RequestAccess
- RequestVerification
- ResetSpotterChat
- SageAnswerFeedback
- Save
- SaveAsView
- Schedule
- SchedulesList
- SendTestScheduleEmail
- Separator
- Share
- ShareViz
- ShowSageQuery
- ShowUnderlyingData
- SpotIQAnalyze
- SpotterAnalystCreate
- SpotterAnalystDelete
- SpotterAnalystEdit
- SpotterAnalystList
- SpotterAnalystMakeACopy
- SpotterAnalystShare
- SpotterAnalystSidebar
- SpotterChatConnectorResources
- SpotterChatConnectors
- SpotterChatDelete
- SpotterChatMenu
- SpotterChatModeSwitcher
- SpotterChatPin
- SpotterChatRename
- SpotterDefaultAnalyst
- SpotterDocs
- SpotterFeedback
- SpotterNewChat
- SpotterPastChatBanner
- SpotterShareConversationButtonHeader
- SpotterShareConversationMenuItemSidebar
- SpotterShareIncludeNewMessagesCheckbox
- SpotterShareStaleInfoBannerDismissButton
- SpotterShareUpToCurrentInfo
- SpotterSharedConversationBanner
- SpotterSharedConversationBannerDismissButton
- SpotterSharedConversationExitButton
- SpotterSidebarFooter
- SpotterSidebarHeader
- SpotterSidebarToggle
- SpotterTokenQuickEdit
- SpotterViz
- SpotterVizCheckpointRestore
- SpotterVizFeedback
- SpotterVizReferenceMode
- SpotterWarningsBanner
- SpotterWarningsOnTokens
- Subscription
- SyncToOtherApps
- SyncToSheets
- SyncToSlack
- SyncToTeams
- TML
- ToggleSize
- UngroupLiveboardGroup
- Unpublish
- UnsubscribeScheduleHomepage
- UpdateTML
- VerifiedLiveboard
- ViewScheduleRunHomepage
ThoughtSpot application pages include actions and menu commands for various user-initiated operations. These actions are represented as enumeration members in the SDK. To control actions in the embedded view: - disabledActions — the action is grayed out and still visible, but non-interactive (user can see but not click). - hiddenActions — the action is completely removed from the UI (user cannot see it at all). - visibleActions — allowlist, only these actions are shown; all others are hidden.
Use disabledActions to disable (gray out) an action. Use hiddenActions to hide (fully remove) an action. Use visibleActions to show only specific actions.
const embed = new LiveboardEmbed('#tsEmbed', {
... //other embed view config
//visibleActions: [],
disabledActions: [Action.Download],
hiddenActions: [Action.Edit, Action.Explore],
})
See also Developer Documentation.
Index🔗
Enumeration members🔗
AIHighlights🔗
AIHighlights:= "AIHighlights"
The AI Highlights action on a Liveboard.
Defined in : types.ts
Version : SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
hiddenAction: [Action.AIHighlights]
AddColumnSet🔗
AddColumnSet:= "addSimpleCohort"
The Add Column Set action on a Answer. Allows adding column sets to a Answer.
Defined in : types.ts
Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
disabledActions: [Action.AddColumnSet]
AddDataPanelObjects🔗
AddDataPanelObjects:= "addDataPanelObjects"
The Add Data Panel Objects action on the data panel v2. Allows to show action menu to add different objects (such as formulas, Parameters) in data panel new experience.
Defined in : types.ts
Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
disabledActions: [Action.AddDataPanelObjects]
AddFilter🔗
AddFilter:= "addFilter"
The Add filter action on a Liveboard page. Allows adding filters to visualizations on a Liveboard.
Defined in : types.ts
disabledActions: [Action.AddFilter]
AddFormula🔗
AddFormula:= "addFormula"
The Create formula action on a Search or Answer page. Allows adding formulas to an Answer.
Defined in : types.ts
disabledActions: [Action.AddFormula]
AddParameter🔗
AddParameter:= "addParameter"
The Add parameter action on a Liveboard or Answer. Allows adding Parameters to a Liveboard or Answer.
Defined in : types.ts
disabledActions: [Action.AddParameter]
AddQuerySet🔗
AddQuerySet:= "addAdvancedCohort"
The Add Query Set action on a Answer. Allows adding query sets to a Answer.
Defined in : types.ts
Version : SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
disabledActions: [Action.AddQuerySet]
AddTab🔗
AddTab:= "addTab"
The Add Tab action on a Liveboard. Allows adding a new tab to a Liveboard view.
Defined in : types.ts
Version : SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
disabledActions: [Action.AddTab]
AddToFavorites🔗
AddToFavorites:= "addToFavorites"
The Favorites icon (*) for Answers, Liveboard, and data objects like Model, Tables and Views. Allows adding an object to the user’s favorites list.
Defined in : types.ts
Version : SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
disabledActions: [Action.AddToFavorites]
AddToWatchlist🔗
AddToWatchlist:= "addToWatchlist"
The Add KPI to Watchlist action on Home page watchlist. Adds a KPI chart to the watchlist on the Home page.
Defined in : types.ts
Version : SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
disabledActions: [Action.AddToWatchlist]
AllLiveboardFilters🔗
AllLiveboardFilters:= "allLiveboardFilters"
Action ID to show, hide, or disable all filter surfaces on a Liveboard, including filter, parameter, and cross-filter chips at the liveboard, tab, and group levels. Parameter and cross-filter chips are hide-only.
Defined in : types.ts
Version : SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
hiddenActions: [Action.AllLiveboardFilters]
disabledActions: [Action.AllLiveboardFilters]
AnswerChartSwitcher🔗
AnswerChartSwitcher:= "answerChartSwitcher"
The chart switcher icon on Answer page and visualizations in edit mode. Allows switching to the table or chart mode when editing a visualization.
Defined in : types.ts
Version : SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
disabledActions: [Action.AnswerChartSwitcher]
AnswerDelete🔗
AnswerDelete:= "onDeleteAnswer"
The Delete action for Answers in the full application embedding mode.
Defined in : types.ts
Version : SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
disabledActions: [Action.AnswerDelete]
AskAi🔗
AskAi:= "AskAi"
Action ID for the Ask Sage In Natural Language Search embed, Spotter in Liveboard, full app, and Spotter embed.
Allows initiating a conversation with ThoughtSpot AI analyst.
Defined in : types.ts
Version : SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
hiddenAction: [Action.AskAi]
AxisMenuAggregate🔗
AxisMenuAggregate:= "axisMenuAggregate"
The Aggregate option in the chart axis or the table column customization menu. Provides aggregation options to analyze the data on a chart or table.
Defined in : types.ts
Version : SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
disabledActions: [Action.AxisMenuAggregate]