The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Settings for defineMetabaseConfig().
Page-level configuration shared by every web component on the page.
Properties
| Property | Type | Description |
|---|---|---|
allowedCustomVisualizations |
`custom:${string}`[] |
The custom visualizations that components on the page can load, each prefixed with custom:, like ["custom:Calendar Heatmap"]. Not available in guest embeds. See Custom visualizations in embeds.--- Optional |
apiKey |
string |
Development only. An API key from your Metabase, which embeds use to render on localhost. See Preview embeds during development. --- Optional |
fetchRequestToken |
() => Promise<{ jwt: string; }> |
SSO embeds with JWT only. A function that fetches the JWT for embeds. See Customizing JWT authentication. --- Optional |
guestEmbedProviderUri |
string |
Guest embeds only. Your app's endpoint that signs guest tokens. The embed calls this endpoint for a token on load, and again when the current token expires. The endpoint should return { jwt: string }. See Configure a guest embed.--- Optional |
instanceUrl |
string |
The URL of your Metabase, like https://youlooknicetoday.metabaseapp.com. |
isGuest |
boolean |
Whether the components authenticate as guest embeds, with a signed JWT instead of a Metabase session. See Configure a guest embed. --- Optional Default: false |
jwtProviderUri |
string |
SSO embeds with JWT only. The URL of your JWT provider. When set, embeds use JWT and skip the request that discovers the SSO method. --- Optional |
locale |
string |
The display language for every embed, as an ISO language code like en or de. Defaults to your Metabase instance's locale. See Set the language.--- Optional |
pluginsConfig |
{ handleLink: (url: string) => { handled: boolean; }; } |
Plugins that customize component behavior. Web components support handleLink, for customizing what happens when people click a link. See Web component plugins.--- Optional |
pluginsConfig.handleLink |
(url: string) => { handled: boolean; } |
Called when people click a link in an embed. Return { handled: true } to handle the link yourself, or { handled: false } to open the link in a new tab.--- Optional |
preferredAuthMethod |
string |
SSO embeds only. Which SSO method to use. If you've set up both SAML and JWT, embeds default to SAML. See Authentication. --- Optional Possible values: "jwt", "saml" |
theme |
object |
Colors, fonts, and per-component appearance overrides. See Appearance. --- Optional |
useExistingUserSession |
boolean |
Development only. Whether to render embeds with your own Metabase session. Only supported in Google Chrome. See Preview embeds during development. --- Optional Default: false |