Inbound event reference

Sigma supports the following inbound events, which are triggered by user input in the host application or parent window.

• For a list of the events emitted by actions in your Sigma embed, see Outbound event reference.
• For examples and more details, see Implement inbound and outbound events in embeds.

workbook:bookmark:create

This event creates a bookmark without using the embed UI.

Event structure:

{
   type: 'workbook:bookmark:create';
   name: string;
   isDefault: boolean;
   isShared: boolean;
}

Event properties:

workbook:bookmark:delete

This event deletes a bookmark without using the embed UI.

Event structure:

{
   type: 'workbook:bookmark:delete';
   bookmarkId: string;
}

Event properties:

workbook:bookmark:select

This event selects or clears a bookmark in an embed.

Event structure:

{
   type: 'workbook:bookmark:select';
   bookmarkId?: string | null;
}

Event properties:

workbook:bookmark:update

This event is used to update a bookmark with the changes from a user's exploration (custom view). The event is equivalent to clicking Save updates to custom view in the document menu in the Sigma UI.

Event structure:

{
   type: 'workbook:bookmark:update';
}

A workbook:error iframe event is triggered in the following circumstances:

workbook:fullscreen:update

This event is used to update the fullscreen search parameter. If the targeted element is maximized, calling this function will minimize it and vice versa. Equivalent to Maximize element in the UI.

This event is useful for maximizing and minimizing elements without using the UI.

Event structure:

{
   type: 'workbook:fullscreen:update';
   nodeId: string | null;
}

Event properties:

workbook:modal:toggle

This event is used to open or close a modal in an embed. This event requires the user to have the necessary permissions to interact with the modal in the UI. For example, the Schedule exports modal requires the Schedule export permission.

Event structure:

{
   type: 'workbook:modal:toggle';
   modalType: 'schedule' | 'export' | undefined;
}

Event properties:

workbook:mode:update

This event is used to change between View mode and Explore mode in an embed. If the user does not have the necessary permissions to explore the content or if the embed does not support Explore mode, this event has no effect. For more information about workbook modes, see Workbook modes overview.

Event structure:

{  
   type: 'workbook:mode:update';
   mode: 'view' | 'explore';
}

Event properties:

workbook:selectednodeid:update

This event is used to select a node ID (element ID or page ID) without using the UI.

Event structure:

{
   type: 'workbook:selectednodeid:update';
   selectedNodeId: string | null;
   nodeType: 'element' | 'page';
}

Event properties:

workbook:sharinglink:update

This event is used to make a link available that embed users can share with other users though the embed menu, embed footer, and scheduled exports email notifications. See Configure a shareable link for an embed for instructions.

📘

Sigma loads the URL you supply using this event to anyone given this sharing link. Ensure that your application authenticates users before displaying the content.

Event structure:

{
  type: 'workbook:sharinglink:update';
  sharingLink: string | null;
  sharingExplorationLink?: string | null;
}

Event properties:

Sigma validates the strings passed in sharingLink and sharingExplorationLink using two regular expressions. Your URL must match one of these:

^https?:\/\/(www\.)?[-a-zA-Z0-9\.~%:_\-@\/\?=&\+\*!\$]{2,50}\.[a-z]{2,10}\b([-a-zA-Z0-9\.~%:_\-@\/\?=&\+\*!\$]*)$

Or:

^https?:\/\/[-a-zA-Z0-9\.~%:_\-@\/\?=&\+\*!\$]+(\\.[-a-zA-Z0-9\.~%:_\-@\/\?=&\+\*!\$]+)*(:[0-9]+)\/?(\/[.[-a-zA-Z0-9\.~%:_\-@\/\?=&\+\*!\$]+]*)*$

The links cannot be longer than 1000 characters. If the value does not pass validation, the sharing link is not set.

workbook:variables:list

This event is used to list the controls and their values.

Event structure:

{  
   type: 'workbook:variables:list' 
}

Will return:

{
   type: 'workbook:variables:current';
   variables: variablesObject;
}

Event properties (returned):

workbook:variables:update

This event is used to update the controls and control values of a workbook without using the UI.

For more details about the expected format of control values for specific control types, see Set control values in a URL using query string parameters

Example call: frame.contentWindow.postMessage({type: "workbook:variables:update", variables: {ua: 'south'}})

{  
   type: 'workbook:variables:update';
   variables: variablesObject 
}

Event properties: