接口 EditableDashboardProps

interface EditableDashboardProps {
    className?: string;
    dashboardId: SdkDashboardId;
    dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">;
    drillThroughQuestionHeight?: Height<string | number>;
    drillThroughQuestionProps?: DrillThroughQuestionProps;
    hiddenParameters?: string[];
    initialParameters?: ParameterValues;
    onLoad?: (dashboard: null | MetabaseDashboard) => void;
    onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void;
    plugins?: MetabasePluginsConfig;
    renderDrillThroughQuestion?: () => ReactNode;
    style?: CSSProperties;
    withCardTitle?: boolean;
    withDownloads?: boolean;
    withTitle?: boolean;
}

索引

属性

className? dashboardId dataPickerProps? drillThroughQuestionHeight? drillThroughQuestionProps? hiddenParameters? initialParameters? onLoad? onLoadWithoutCards? plugins? renderDrillThroughQuestion? style? withCardTitle? withDownloads? withTitle?

属性

`可选`className

className?: string

要添加到根元素的自定义类名。

dashboardId

dashboardId: SdkDashboardId

仪表板的 ID。
这可以是

访问仪表板链接时使用的数字 ID，例如 `https://:3000/dashboard/1-my-dashboard`，其中 ID 为 `1`
在使用 API 或 SDK 集合浏览器直接返回数据时，在仪表板对象的 `entity_id` 键中找到的字符串 ID

`可选`dataPickerProps

dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">

创建新的仪表板问题时，要传递给 `InteractiveQuestion` 渲染的查询构建器的其他属性。

`可选`drillThroughQuestionHeight

drillThroughQuestionHeight?: Height<string | number>

从仪表板钻取到问题级别时，问题组件的高度。

`可选`drillThroughQuestionProps

drillThroughQuestionProps?: DrillThroughQuestionProps

从仪表板钻取到问题级别时，问题组件的属性。

类型声明

钻取问题的属性

可选children?: ReactNode
MetabaseProvider 组件的子组件。
可选className?: string
要添加到根元素的自定义类名。
可选entityTypes?: EmbeddingEntityType[]
一个数组，指定数据选择器中可用的实体类型
可选height?: Height<string | number>
一个数字或字符串，指定CSS大小值，用于指定组件的高度
可选initialSqlParameters?: SqlParameterValues
SQL参数的初始值。
可选isSaveEnabled?: boolean
是否显示保存按钮。
可选onBeforeSave?: (
question: undefined | MetabaseQuestion,
context: { isNewQuestion: boolean },
) => Promise<void>
保存前触发的回调函数。仅在 `isSaveEnabled = true` 时相关。
可选onRun?: (question: undefined | MetabaseQuestion) => void
当问题更新时触发的回调函数，包括用户点击问题编辑器中的 `Visualize` 按钮时。
可选onSave?: (
question: MetabaseQuestion,
context: { dashboardTabId?: number; isNewQuestion: boolean },
) => void
当用户保存问题时触发的回调函数。仅在 `isSaveEnabled = true` 时相关。
可选plugins?: MetabasePluginsConfig
可选style?: CSSProperties
要添加到根元素的自定义样式对象。
可选targetCollection?: SdkCollectionId
保存问题的集合。这将隐藏保存模态框中的集合选择器。仅适用于交互式问题。
可选title?: SdkQuestionTitleProps
确定是否显示问题标题，并允许显示自定义标题而不是默认问题标题。默认显示。仅适用于使用默认布局的交互式问题。
可选width?: Width<string | number>
一个数字或字符串，指定CSS大小值，用于指定组件的宽度
可选withChartTypeSelector?: boolean
确定是否显示图表类型选择器和相应的设置按钮。仅在使用默认布局时相关。
可选withDownloads?: boolean
启用在交互式问题中下载结果的功能。
可选withResetButton?: boolean
确定是否显示重置按钮。仅在使用默认布局时相关。

`可选`hiddenParameters

hiddenParameters?: string[]

要隐藏的参数列表。

结合 initialParameters 和 hiddenParameters 在前端过滤数据存在安全风险。
结合 initialParameters 和 hiddenParameters 以简化用户界面是可行的。

`可选`initialParameters

initialParameters?: ParameterValues

仪表板的查询参数。对于单个选项，使用 `string` 值；对于多个选项，使用字符串列表。

结合 initialParameters 和 hiddenParameters 在前端过滤数据存在安全风险。
结合 initialParameters 和 hiddenParameters 以简化用户界面是可行的。

`可选`onLoad

onLoad?: (dashboard: null | MetabaseDashboard) => void

仪表板加载时调用的回调函数。

`可选`onLoadWithoutCards

onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void

仪表板在没有卡片的情况下加载时调用的回调函数。

`可选`plugins

plugins?: MetabasePluginsConfig

用于覆盖或添加钻取菜单的附加映射函数。详情请参见实现自定义操作部分。

`可选`renderDrillThroughQuestion

renderDrillThroughQuestion?: () => ReactNode

用于渲染问题布局的自定义 React 组件。使用命名空间 InteractiveQuestion 组件来构建布局。

`可选`style

style?: CSSProperties

要添加到根元素的自定义样式对象。

`可选`withCardTitle

withCardTitle?: boolean

仪表板卡片是否显示标题。

`可选`withDownloads

withDownloads?: boolean

是否隐藏下载按钮。

`可选`withTitle

withTitle?: boolean

仪表板是否显示标题。

接口 EditableDashboardProps

索引

属性

属性

`可选`className

dashboardId

`可选`dataPickerProps

`可选`drillThroughQuestionHeight

`可选`drillThroughQuestionProps

类型声明

`可选`children?: ReactNode

`可选`className?: string

`可选`entityTypes?: EmbeddingEntityType[]

`可选`height?: Height<string | number>

`可选`initialSqlParameters?: SqlParameterValues

`可选`isSaveEnabled?: boolean

`可选`onBeforeSave?: (
question: undefined | MetabaseQuestion,
context: { isNewQuestion: boolean },
) => Promise<void>

`可选`onRun?: (question: undefined | MetabaseQuestion) => void

`可选`onSave?: (
question: MetabaseQuestion,
context: { dashboardTabId?: number; isNewQuestion: boolean },
) => void

`可选`plugins?: MetabasePluginsConfig

`可选`style?: CSSProperties

`可选`targetCollection?: SdkCollectionId

`可选`title?: SdkQuestionTitleProps

`可选`width?: Width<string | number>

`可选`withChartTypeSelector?: boolean

`可选`withDownloads?: boolean

`可选`withResetButton?: boolean

`可选`hiddenParameters

`可选`initialParameters

`可选`onLoad

`可选`onLoadWithoutCards

`可选`plugins

`可选`renderDrillThroughQuestion

`可选`style

`可选`withCardTitle

`可选`withDownloads

`可选`withTitle

设置

本页内容

接口 EditableDashboardProps

索引

属性

属性

可选className

dashboardId

可选dataPickerProps

可选drillThroughQuestionHeight

可选drillThroughQuestionProps

类型声明

可选children?: ReactNode

可选className?: string

可选entityTypes?: EmbeddingEntityType[]

可选height?: Height<string | number>

可选initialSqlParameters?: SqlParameterValues

可选isSaveEnabled?: boolean

可选onBeforeSave?: ( question: undefined | MetabaseQuestion, context: { isNewQuestion: boolean },) => Promise<void>

可选onRun?: (question: undefined | MetabaseQuestion) => void

可选onSave?: ( question: MetabaseQuestion, context: { dashboardTabId?: number; isNewQuestion: boolean },) => void

可选plugins?: MetabasePluginsConfig

可选style?: CSSProperties

可选targetCollection?: SdkCollectionId

可选title?: SdkQuestionTitleProps

可选width?: Width<string | number>

可选withChartTypeSelector?: boolean

可选withDownloads?: boolean

可选withResetButton?: boolean

可选hiddenParameters

可选initialParameters

可选onLoad

可选onLoadWithoutCards

可选plugins

可选renderDrillThroughQuestion

可选style

可选withCardTitle

可选withDownloads

可选withTitle

设置

本页内容

`可选`className

`可选`dataPickerProps

`可选`drillThroughQuestionHeight

`可选`drillThroughQuestionProps

`可选`children?: ReactNode

`可选`className?: string

`可选`entityTypes?: EmbeddingEntityType[]

`可选`height?: Height<string | number>

`可选`initialSqlParameters?: SqlParameterValues

`可选`isSaveEnabled?: boolean

`可选`onBeforeSave?: (
question: undefined | MetabaseQuestion,
context: { isNewQuestion: boolean },
) => Promise<void>

`可选`onRun?: (question: undefined | MetabaseQuestion) => void

`可选`onSave?: (
question: MetabaseQuestion,
context: { dashboardTabId?: number; isNewQuestion: boolean },
) => void

`可选`plugins?: MetabasePluginsConfig

`可选`style?: CSSProperties

`可选`targetCollection?: SdkCollectionId

`可选`title?: SdkQuestionTitleProps

`可选`width?: Width<string | number>

`可选`withChartTypeSelector?: boolean

`可选`withDownloads?: boolean

`可选`withResetButton?: boolean

`可选`hiddenParameters

`可选`initialParameters

`可选`onLoad

`可选`onLoadWithoutCards

`可选`plugins

`可选`renderDrillThroughQuestion

`可选`style

`可选`withCardTitle

`可选`withDownloads

`可选`withTitle