Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _docs/v0.63/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ Metabase's reference documentation.
- [Managing people and groups](./people-and-groups/managing)
- [Password complexity](./people-and-groups/changing-password-complexity)
- [Session expiration](./people-and-groups/changing-session-expiration)
- [Two-factor authentication](./people-and-groups/two-factor-authentication)
- [Google Sign-In](./people-and-groups/google-sign-in)
- [LDAP](./people-and-groups/ldap)
- [API keys](./people-and-groups/api-keys)
Expand Down
64 changes: 15 additions & 49 deletions _docs/v0.63/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -4906,7 +4906,13 @@
}
},
"required" : [ "channel_type", "details" ]
}, { } ]
}, {
"type" : "object",
"properties" : {
"channel_type" : { }
},
"required" : [ "channel_type" ]
} ]
},
"metabase.channel.models.channel.ChannelTemplateEmailDetails" : {
"oneOf" : [ {
Expand Down Expand Up @@ -4975,7 +4981,13 @@
}
},
"required" : [ "channel_type", "details" ]
}, { } ]
}, {
"type" : "object",
"properties" : {
"channel_type" : { }
},
"required" : [ "channel_type" ]
} ]
},
"metabase.collections-rest.api.DashboardQuestionCandidate" : {
"type" : "object",
Expand Down Expand Up @@ -43390,7 +43402,7 @@
"get" : {
"operationId" : "get-api-search",
"summary" : "GET /api/search",
"description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine: `hnsw` (approximate index search, default),\n `brute-force` (exact filter-first search), or `hnsw-iterative-relaxed` / `hnsw-iterative-strict`\n (index-backed iterative scans with inline filters); ignored by other engines\n - `vector_search_ef_search`: override pgvector's `hnsw.ef_search` (1-1000) for the iterative strategies; (admin only)\n - `vector_search_max_scan_tuples`: override pgvector's `hnsw.max_scan_tuples` for the iterative strategies; (admin only)\n - `vector_search_explain`: set to true to record vector-scan instrumentation for this search (expensive); (admin only)\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
"description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine: `hnsw` (approximate index search, default),\n `brute-force` (exact filter-first search), or `hnsw-iterative-relaxed` / `hnsw-iterative-strict`\n (index-backed iterative scans with inline filters); ignored by other engines\n - `vector_search_ef_search`: override pgvector's `hnsw.ef_search` (1-1000) for the iterative strategies; (admin only)\n - `vector_search_max_scan_tuples`: override pgvector's `hnsw.max_scan_tuples` for the iterative strategies; (admin only)\n - `vector_search_explain`: set to true to record vector-scan instrumentation for this search (expensive); (admin only)\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
"parameters" : [ {
"in" : "query",
"name" : "q",
Expand Down Expand Up @@ -43692,29 +43704,6 @@
"type" : "null"
} ]
}
}, {
"in" : "query",
"name" : "non_temporal_dim_ids",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
"name" : "has_temporal_dim",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
} ],
"responses" : {
"2XX" : {
Expand Down Expand Up @@ -44036,29 +44025,6 @@
"type" : "null"
} ]
}
}, {
"in" : "query",
"name" : "non_temporal_dim_ids",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
"name" : "has_temporal_dim",
"required" : false,
"schema" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
"name" : "expected_result_type",
Expand Down
10 changes: 6 additions & 4 deletions _docs/v0.63/developers-guide/custom-visualizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ settings: {
| `group` | Sub-heading within a section for grouping related settings. |
| `index` | Display order within a group. |
| `inline` | When `true`, renders the widget on the same line as `title` (handy for `"toggle"`). |
| `widget` | A [built-in widget](#built-in-widgets) name, or a [custom React component](#custom-widgets). |
| `widget` | A [built-in widget](#built-in-widgets) name, or a [custom React component](#custom-widgets). |
| `getDefault(series, settings)` | Computes the default value when none is stored. |
| `getValue(series, settings)` | Always-computed value — overrides the stored value on every render. |
| `getProps(series, settings)` | Returns widget-specific props. |
Expand Down Expand Up @@ -424,13 +424,15 @@ Metabase runs plugin code in an isolated sandbox, so a visualization works only
- **Navigation and the rest of the app**: history changes, the host page's URL and referrer, and any DOM outside the plugin's own container.
- **Unsafe DOM and timing APIs**: `document.write`, `execCommand`, constructable stylesheets, raw HTML parsers (`DOMParser`, `setHTMLUnsafe`, `XSLTProcessor`), and resource-timing APIs that expose other requests the page has made.

### Custom visualizations don't render in embeds or public links
### When embedding, custom visualizations are only available in the SDK

[Embeds](../embedding/introduction) and [public links](../embedding/public-links) (to questions, dashboards, and documents) don't render custom visualizations. Any card that uses one falls back to the default visualization (a table).
The [Modular embedding SDK](../embedding/sdk/introduction) renders custom visualizations when you allowlist them with the [`allowedCustomVisualizations` prop](../embedding/sdk/config#custom-visualizations) on `MetabaseProvider`.

Other embedding types don't render custom visualizations. In [modular embedding](../embedding/modular-embedding) with web components and [public links](../embedding/public-links), any card that uses a custom visualization falls back to the default visualization for the query's results.

### Custom visualizations don't render in exports and subscriptions

Static renders—like charts in alerts or dashboard subscriptions—fall back to a table for any card that uses a custom visualization.
Static renders—like charts in alerts or dashboard subscriptions—fall back to a default visualization for the card's data shape.

## Example plugins

Expand Down
Loading