Available on Premium and Enterprise plans.
This page covers embedded surfaces. To set the language of the main Cube
interface for your own account, see Preferences.
Supported languages
English (
en-US) is the default and the fallback when no language is configured.
A locale value can be a full code (es-ES), a short language code (es), or a regional
variant that isn’t shipped (es-AR). An exact match wins; otherwise the language’s own
default is used — es and es-AR both resolve to es-MX, and pt/pt-AO to pt-PT.
A value that doesn’t match any supported language is ignored.
How the language is resolved
The language of an embedded surface is resolved from the following sources, highest priority first:- Runtime override — a
cube:action:set-localemessage sent from the host page (see At runtime). - URL parameter — the
?locale=query parameter on the embed URL (see Per embed via URL). - Session setting —
settings.localeon the Generate Session API, for a language that belongs to the viewer rather than to one placement. Set it once when you mint the session and every iframe that session opens renders in it. - Account default — the language configured in Embed → Settings (see Account-wide default).
- Fallback —
en-US.
Account-wide default
Set a default language for all embedded surfaces from the Cube interface:- Go to Embed → Settings.
- In the Language card, pick a language from the dropdown.
settings.locale, a
?locale= URL parameter, or a runtime cube:action:set-locale message.
Clearing the setting removes the stored default, and embeds fall back to en-US — unless
a session or a per-embed override names a language.
The Creator Mode workspace title has its own, separate per-language overrides — set
under Embed → Settings, in the same Creator Mode section. It resolves against
the same UI language resolved above (session setting,
?locale=, runtime override,
or account default) — not an independent value. See Workspace appearance and SQL
visibility.Per embed via URL
Override the account default for an individual embed by adding the?locale= query
parameter to the embed URL:
At runtime
Switch the language after the embed has loaded by sending acube:action:set-locale message from
the host page. This takes precedence over every other source — the URL parameter, the
session setting, and the account default: