CustomAction
Table of Contents
A code-based custom action to inject into the embedded ThoughtSpot UI.
Pass an array of these as customActions in the embed view config. When a
user invokes the action, the host emits EmbedEvent.CustomAction with
a CustomActionPayload carrying the same id.
Index🔗
Properties🔗
dataModelIds🔗
dataModelIds: {modelColumnNames?: string[] , modelIds?: string[] }
Optional
Scope the action by data model, using model GUIDs or column names.
Allowed for VIZ, ANSWER, and SPOTTER targets.
Parameters
- modelColumnNames
-
Optional
-
modelColumnNames: string[]
-
- modelIds
-
Optional
-
modelIds: string[]
-
groupIds🔗
groupIds: string[]
Optional
Restrict the action to specific user groups by ID.
id🔗
id: string
Unique identifier for the action. Echoed back as id on the
CustomActionPayload when the action is invoked.
metadataIds🔗
metadataIds: {answerIds?: string[] , liveboardIds?: string[] , vizIds?: string[] }
Optional
Scope the action to specific objects by GUID. Which keys are allowed
depends on target (for example, a VIZ action may use answerIds,
liveboardIds, and vizIds).
Parameters
- answerIds
-
Optional
-
answerIds: string[]
-
- liveboardIds
-
Optional
-
liveboardIds: string[]
-
- vizIds
-
Optional
-
vizIds: string[]
-
name🔗
name: string
Display label shown on the action’s button or menu item.
orgIds🔗
orgIds: string[]
Optional
Restrict the action to specific organizations by ID.
position🔗
position: CustomActionsPosition
Where the action appears: a primary button, the "More" menu, or the right-click context menu. See CustomActionsPosition.
target🔗
target: CustomActionTarget
The surface the action applies to (Liveboard, visualization, Answer, or
Spotter). See CustomActionTarget. The allowed position values
and scoping keys depend on the target.