Embedded analytics SDK API
    Preparing search index...

    Function EditableDashboard

    • 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.

      Parameters

      • props: {
            autoRefreshInterval?: number;
            dashboardId: SdkDashboardId;
            drillThroughQuestionHeight?: Height<string | number>;
            drillThroughQuestionProps?: DrillThroughQuestionProps;
            initialParameters?: ParameterValues;
            onParametersChange?: (payload: ParameterChangePayload) => void;
            parameters?: ParameterValues;
            plugins?: MetabasePluginsConfig;
            renderDrillThroughQuestion?: () => ReactNode;
        } & { dashboardId?: SdkDashboardId
        | null; token?: string | null } & {
            enableEntityNavigation?: boolean;
            hiddenParameters?: string[];
            initialParameters?: ParameterValues;
            withCardTitle?: boolean;
            withDownloads?: boolean;
            withSubscriptions?: boolean;
            withTitle?: boolean;
        } & { className?: string; style?: CSSProperties } & {
            onLoad?: (dashboard: MetabaseDashboard | null) => void;
            onLoadWithoutCards?: (dashboard: MetabaseDashboard | null) => void;
            onVisualizationChange?: (
                visualization:
                    | "object"
                    | "table"
                    | "bar"
                    | "line"
                    | "pie"
                    | "scalar"
                    | "row"
                    | "area"
                    | "combo"
                    | "pivot"
                    | "smartscalar"
                    | "gauge"
                    | "progress"
                    | "funnel"
                    | "map"
                    | "scatter"
                    | "boxplot"
                    | "waterfall"
                    | "sankey"
                    | "treemap"
                    | "list",
            ) => void;
        } & { children?: ReactNode } & {
            dataPickerProps?: Pick<SdkQuestionProps, "entityTypes" | "dataPicker">;
        }
        • OptionaldashboardId?: SdkDashboardId | null
        • Optionaltoken?: string | null
        • OptionalenableEntityNavigation?: boolean
        • OptionalhiddenParameters?: string[]
        • OptionalinitialParameters?: ParameterValues
        • OptionalwithCardTitle?: boolean
        • OptionalwithDownloads?: boolean
        • OptionalwithSubscriptions?: boolean
        • OptionalwithTitle?: boolean
        • OptionalclassName?: string

          A custom class name to be added to the root element.

        • Optionalstyle?: CSSProperties

          A custom style object to be added to the root element.

        • OptionalonLoad?: (dashboard: MetabaseDashboard | null) => void

          Callback that is called when the dashboard is loaded.

        • OptionalonLoadWithoutCards?: (dashboard: MetabaseDashboard | null) => void

          Callback that is called when the dashboard is loaded without cards.

        • OptionalonVisualizationChange?: (
              visualization:
                  | "object"
                  | "table"
                  | "bar"
                  | "line"
                  | "pie"
                  | "scalar"
                  | "row"
                  | "area"
                  | "combo"
                  | "pivot"
                  | "smartscalar"
                  | "gauge"
                  | "progress"
                  | "funnel"
                  | "map"
                  | "scatter"
                  | "boxplot"
                  | "waterfall"
                  | "sankey"
                  | "treemap"
                  | "list",
          ) => void

          A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question.

        • OptionaldataPickerProps?: Pick<SdkQuestionProps, "entityTypes" | "dataPicker">

          Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

          Set dataPicker: "staged" to always get the staged data picker. By default, Metabase shows a simple dropdown menu with tables and models, and only switches to the staged picker when there are 100 or more data sources. entityTypes: ["question"] only takes effect in the staged picker.

      Returns Element