接口 EditableDashboardProps

interface EditableDashboardProps {
    className?: string;
    dashboardId: SdkDashboardId;
    drillThroughQuestionHeight?: number;
    drillThroughQuestionProps?: DrillThroughQuestionProps;
    initialParameters?: ParameterValues;
    onLoad?: (dashboard: null | MetabaseDashboard) => void;
    onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void;
    plugins?: MetabasePluginsConfig;
    style?: CSSProperties;
    withCardTitle?: boolean;
    withDownloads?: boolean;
}

索引

属性

className? dashboardId drillThroughQuestionHeight? drillThroughQuestionProps? initialParameters? onLoad? onLoadWithoutCards? plugins? style? withCardTitle? withDownloads?

属性

`可选`className

className?: string

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

dashboardId

dashboardId: SdkDashboardId

仪表板的 ID。
这可以是

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

`可选`drillThroughQuestionHeight

drillThroughQuestionHeight?: 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: undefined | MetabaseQuestion,
context: { isNewQuestion: boolean },
) => void
当用户保存问题时触发的回调函数。仅当 isSaveEnabled = true 时才相关
可选plugins?: MetabasePluginsConfig
可选style?: CSSProperties
要添加到根元素的自定义样式对象。
可选targetCollection?: SdkCollectionId
保存问题的集合。这将从保存模态框中隐藏集合选择器。仅适用于交互式问题。
可选title?: SdkQuestionTitleProps
确定是否显示问题标题，并允许显示自定义标题而非默认问题标题。默认显示。仅在使用默认布局时适用于交互式问题。
可选width?: Width<string | number>
一个数字或字符串，指定组件宽度的 CSS 大小值
可选withChartTypeSelector?: boolean
确定是否显示图表类型选择器和相应的设置按钮。仅在使用默认布局时相关。
可选withDownloads?: boolean
启用在交互式问题中下载结果的功能。
可选withResetButton?: boolean
确定是否显示重置按钮。仅在使用默认布局时相关。

`可选`initialParameters

initialParameters?: ParameterValues

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

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

`可选`onLoad

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

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

`可选`onLoadWithoutCards

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

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

`可选`plugins

plugins?: MetabasePluginsConfig

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

`可选`style

style?: CSSProperties

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

`可选`withCardTitle

withCardTitle?: boolean

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

`可选`withDownloads

withDownloads?: boolean

是否隐藏下载按钮。

© . All rights reserved.