customTheme

Defines custom theme properties for styling embedded dashboards. In the Embed URL Builder, this is the Custom theme field.

Syntax

customTheme={"<theme_property_1>":"<value>", "<theme_property_2>":"<value>"...}

object

An object containing theme properties and their values. Values must be a valid theme property.

In the v1 signed payload format, send the value as JSON:

v1 payload

customTheme={"dashboard-background":"blue"}

In the legacy v0 format, stringify and URL encode the value before sending:

v0 (legacy) payload

customTheme=%7B%22dashboard-background%22%3A%22blue%22%7D