diff --git a/_docs/latest/embedding/sdk/api/snippets/EditableDashboard.md b/_docs/latest/embedding/sdk/api/snippets/EditableDashboard.md index ac861fe186..4bfd4acb74 100644 --- a/_docs/latest/embedding/sdk/api/snippets/EditableDashboard.md +++ b/_docs/latest/embedding/sdk/api/snippets/EditableDashboard.md @@ -12,7 +12,27 @@ latest: true --- ```ts -function EditableDashboard(props: EditableDashboardProps): Element; +function EditableDashboard( + props: { + drillThroughQuestionHeight: Height; + drillThroughQuestionProps: DrillThroughQuestionProps; + plugins: MetabasePluginsConfig; + renderDrillThroughQuestion: () => ReactNode; + } & { + dashboardId: SdkDashboardId; + hiddenParameters: string[]; + initialParameters: ParameterValues; + withCardTitle: boolean; + withDownloads: boolean; + withTitle: boolean; + } & { + className: string; + style: CSSProperties; + } & { + onLoad: (dashboard: null | MetabaseDashboard) => void; + onLoadWithoutCards: (dashboard: null | MetabaseDashboard) => void; + } & {}, +): Element; ``` 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` -| Parameter | Type | Description | -| :-------- | :---------------------------------------------------------- | :---------- | -| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps) | | +| Parameter | Type | Description | +| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | +| `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`; \} & \{ \} | | diff --git a/_docs/v0.55/embedding/sdk/api/snippets/EditableDashboard.md b/_docs/v0.55/embedding/sdk/api/snippets/EditableDashboard.md index a61aaf9d9f..b54bf26c04 100644 --- a/_docs/v0.55/embedding/sdk/api/snippets/EditableDashboard.md +++ b/_docs/v0.55/embedding/sdk/api/snippets/EditableDashboard.md @@ -10,7 +10,27 @@ layout: new-docs --- ```ts -function EditableDashboard(props: EditableDashboardProps): Element; +function EditableDashboard( + props: { + drillThroughQuestionHeight: Height; + drillThroughQuestionProps: DrillThroughQuestionProps; + plugins: MetabasePluginsConfig; + renderDrillThroughQuestion: () => ReactNode; + } & { + dashboardId: SdkDashboardId; + hiddenParameters: string[]; + initialParameters: ParameterValues; + withCardTitle: boolean; + withDownloads: boolean; + withTitle: boolean; + } & { + className: string; + style: CSSProperties; + } & { + onLoad: (dashboard: null | MetabaseDashboard) => void; + onLoadWithoutCards: (dashboard: null | MetabaseDashboard) => void; + } & {}, +): Element; ``` 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` -| Parameter | Type | Description | -| :-------- | :---------------------------------------------------------- | :---------- | -| `props` | [`EditableDashboardProps`](./api/EditableDashboardProps) | | +| Parameter | Type | Description | +| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | +| `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`; \} & \{ \} | |