> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# uiSettings

> Controls general settings of the application in embed.

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

## Syntax

```markdown theme={null}
uiSettings=<encoded_settings_object>
```

## Properties

<ParamField path="uiSettings" type="object">
  An object containing UI configuration settings.

  <Expandable title="uiSettings properties" defaultOpen="true">
    <ParamField body="dashboardChartContextMenu" type="boolean" default="true">
      When `true`, context menus (the <Icon icon="ellipsis-vertical" /> 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.
    </ParamField>

    <ParamField body="dashboardGeneratedAt" type="boolean" default="true">
      When `true`, the "Generated \<timestamp>" stamp is displayed in the dashboard footer. Omitted and unset keys will also resolve to `true`.

      When `false`, the timestamp is hidden.
    </ParamField>

    <ParamField body="documentBreadcrumb" type="string" default="link">
      Controls the display of folder path breadcrumbs in document title headers. This setting applies to [Create mode embeds](/embed/customization/create-mode) 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")
    </ParamField>

    <ParamField body="showNavigation" type="boolean">
      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.
    </ParamField>

    <ParamField body="tileRanTimestamp" type="boolean" default="true">
      When `true`, the "Query ran \<timestamp>" entry is displayed in a tile's context menu (both classic menu and advanced-layout context menu). Omitted and unset keys will also resolve to `true`.

      When `false`, this entry is hidden in the tile's context menu.

      <Warning>
        On non-classic dashboards, setting this property to `false` can hide the entire context menu button (<Icon icon="ellipsis-vertical" />) if no other menu actions are available to the viewer. The button may appear and disappear as viewers apply filters that change the available actions.
      </Warning>
    </ParamField>
  </Expandable>
</ParamField>

## Examples

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

```markdown title="Example uiSettings with showNavigation" theme={null}
uiSettings=%7B%22showNavigation%22%3A%20false%7D
```

The following example demonstrates hiding the dashboard tile context menu:

<CodeGroup>
  ```markdown Plain text theme={null}
  uiSettings={"dashboardChartContextMenu": false}
  ```

  ```markdown URL-encoded theme={null}
  uiSettings=%7B%22dashboardChartContextMenu%22%3A%20false%7D
  ```
</CodeGroup>

The following example demonstrates hiding both timestamp displays:

<CodeGroup>
  ```markdown Plain text theme={null}
  uiSettings={"dashboardGeneratedAt": false, "tileRanTimestamp": false}
  ```

  ```markdown URL-encoded theme={null}
  uiSettings=%7B%22dashboardGeneratedAt%22%3A%20false%2C%20%22tileRanTimestamp%22%3A%20false%7D
  ```
</CodeGroup>