Skip to content

Commit d856847

Browse files
github-automation-metabaseMetabase Docs botescherize
authored
[auto] adding content to backport-55-b1cc2fb7ec7eef14e85e6052c67cdd97592244d0->release-x.55.x (#301)
Co-authored-by: Metabase Docs bot <[email protected]> Co-authored-by: Bryan Maass <[email protected]>
1 parent c327334 commit d856847

File tree

2 files changed

+48
-8
lines changed

2 files changed

+48
-8
lines changed

‎_docs/latest/embedding/sdk/api/snippets/EditableDashboard.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,27 @@ latest: true
1212
---
1313

1414
```ts
15-
function EditableDashboard(props: EditableDashboardProps): Element;
15+
function EditableDashboard(
16+
props: {
17+
drillThroughQuestionHeight: Height<string | number>;
18+
drillThroughQuestionProps: DrillThroughQuestionProps;
19+
plugins: MetabasePluginsConfig;
20+
renderDrillThroughQuestion: () => ReactNode;
21+
} & {
22+
dashboardId: SdkDashboardId;
23+
hiddenParameters: string[];
24+
initialParameters: ParameterValues;
25+
withCardTitle: boolean;
26+
withDownloads: boolean;
27+
withTitle: boolean;
28+
} & {
29+
className: string;
30+
style: CSSProperties;
31+
} & {
32+
onLoad: (dashboard: null | MetabaseDashboard) => void;
33+
onLoadWithoutCards: (dashboard: null | MetabaseDashboard) => void;
34+
} & {},
35+
): Element;
1636
```
1737

1838
A dashboard component with the features available in the `InteractiveDashboard` component, as well as the ability to add and update questions, layout, and content within your dashboard.
@@ -21,9 +41,9 @@ A dashboard component with the features available in the `InteractiveDashboard`
2141

2242
<!-- [<snippet parameters>] -->
2343

24-
| Parameter | Type | Description |
25-
| :-------- | :---------------------------------------------------------- | :---------- |
26-
| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps) | |
44+
| Parameter | Type | Description |
45+
| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |
46+
| `props` | \{ `drillThroughQuestionHeight`: `Height`\<`string` \| `number`\>; `drillThroughQuestionProps`: [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps); `plugins`: [`MetabasePluginsConfig`](./api/MetabasePluginsConfig); `renderDrillThroughQuestion`: () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478); \} & \{ `dashboardId`: [`SdkDashboardId`](./api/SdkDashboardId); `hiddenParameters`: `string`[]; `initialParameters`: [`ParameterValues`](./api/ParameterValues); `withCardTitle`: `boolean`; `withDownloads`: `boolean`; `withTitle`: `boolean`; \} & \{ `className`: `string`; `style`: [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579); \} & \{ `onLoad`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; `onLoadWithoutCards`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; \} & \{ \} | |
2747

2848
<!-- [<endsnippet parameters>] -->
2949

‎_docs/v0.55/embedding/sdk/api/snippets/EditableDashboard.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,27 @@ layout: new-docs
1010
---
1111

1212
```ts
13-
function EditableDashboard(props: EditableDashboardProps): Element;
13+
function EditableDashboard(
14+
props: {
15+
drillThroughQuestionHeight: Height<string | number>;
16+
drillThroughQuestionProps: DrillThroughQuestionProps;
17+
plugins: MetabasePluginsConfig;
18+
renderDrillThroughQuestion: () => ReactNode;
19+
} & {
20+
dashboardId: SdkDashboardId;
21+
hiddenParameters: string[];
22+
initialParameters: ParameterValues;
23+
withCardTitle: boolean;
24+
withDownloads: boolean;
25+
withTitle: boolean;
26+
} & {
27+
className: string;
28+
style: CSSProperties;
29+
} & {
30+
onLoad: (dashboard: null | MetabaseDashboard) => void;
31+
onLoadWithoutCards: (dashboard: null | MetabaseDashboard) => void;
32+
} & {},
33+
): Element;
1434
```
1535

1636
A dashboard component with the features available in the `InteractiveDashboard` component, as well as the ability to add and update questions, layout, and content within your dashboard.
@@ -19,9 +39,9 @@ A dashboard component with the features available in the `InteractiveDashboard`
1939

2040
<!-- [<snippet parameters>] -->
2141

22-
| Parameter | Type | Description |
23-
| :-------- | :---------------------------------------------------------- | :---------- |
24-
| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps) | |
42+
| Parameter | Type | Description |
43+
| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |
44+
| `props` | \{ `drillThroughQuestionHeight`: `Height`\<`string` \| `number`\>; `drillThroughQuestionProps`: [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps); `plugins`: [`MetabasePluginsConfig`](./api/MetabasePluginsConfig); `renderDrillThroughQuestion`: () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478); \} & \{ `dashboardId`: [`SdkDashboardId`](./api/SdkDashboardId); `hiddenParameters`: `string`[]; `initialParameters`: [`ParameterValues`](./api/ParameterValues); `withCardTitle`: `boolean`; `withDownloads`: `boolean`; `withTitle`: `boolean`; \} & \{ `className`: `string`; `style`: [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579); \} & \{ `onLoad`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; `onLoadWithoutCards`: (`dashboard`: `null` \| [`MetabaseDashboard`](./api/MetabaseDashboard)) => `void`; \} & \{ \} | |
2545

2646
<!-- [<endsnippet parameters>] -->
2747

0 commit comments

Comments
 (0)