uiSettings - Omni Docs

In the Embed URL Builder, this is the UI Settings field.

Syntax

uiSettings=<encoded_settings_object>

Properties

uiSettings

object

An object containing UI configuration settings.

Hide uiSettings properties

When true, context menus (the icon and right-click menu) will be available on dashboard tiles. When false, context menus will be hidden.This setting is not applicable to classic dashboards.

Controls the display of folder path breadcrumbs in document title headers. This setting applies to Create mode embeds and affects workbooks and dashboards.Supported values:

link - Displays the folder path breadcrumb in the document title header as clickable links
display - Displays the folder path breadcrumb as visible text without hyperlinks, preventing navigation out of the embed
none - Hides the folder path breadcrumb entirely, including the personal-scope prefix (e.g., “X’s Documents”)

When true, the left navigation panel and icon will display in the top-left corner of the app. When false, the panel and icon are hidden.

Examples

The following example demonstrates what the URL encoded version of uiSettings={"showNavigation": false} would be:

Example uiSettings with showNavigation

uiSettings=%7B%22showNavigation%22%3A%20false%7D

The following example demonstrates hiding the dashboard tile context menu:

uiSettings={"dashboardChartContextMenu": false}

uiSettings=%7B%22dashboardChartContextMenu%22%3A%20false%7D

timezone

userAttributes

⌘I

​Syntax

​Properties

​Examples

Syntax

Properties

Examples