嵌入式分析 SDK API
    正在准备搜索索引...

    接口 InteractiveDashboardProps

    interface InteractiveDashboardProps {
        className?: string;
        dashboardId: SdkDashboardId;
        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 drillThroughQuestionHeight? drillThroughQuestionProps? hiddenParameters? initialParameters? onLoad? onLoadWithoutCards? plugins? renderDrillThroughQuestion? style? withCardTitle? withDownloads? withTitle?

    属性

    className?: string

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

    dashboardId: SdkDashboardId

    仪表盘的ID。
    这可以是：

    • 访问仪表盘链接时的数字ID，例如：http://localhost:3000/dashboard/1-my-dashboard，其中ID为1
    • 在使用API直接访问或使用SDK Collection Browser返回数据时，仪表盘对象中entity_id键中找到的字符串ID。
    drillThroughQuestionHeight?: Height<string | number>

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

    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

      确定是否显示重置按钮。仅在使用默认布局时相关。

    hiddenParameters?: string[]

    要隐藏的参数列表。

    initialParameters?: ParameterValues

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

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

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

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

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

    plugins?: MetabasePluginsConfig

    用于覆盖或添加钻取菜单的附加映射函数。有关更多详细信息，请参阅“实现自定义操作”部分。

    renderDrillThroughQuestion?: () => ReactNode

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

    style?: CSSProperties

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

    withCardTitle?: boolean

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

    withDownloads?: boolean

    是否隐藏下载按钮。

    withTitle?: boolean

    仪表盘是否应显示标题。

    设置

    本页内容

    属性
    © . All rights reserved.