Function EditableDashboard

Parameters

• props: EditableDashboardProps

  • OptionalclassName?: string

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

  • dashboardId: SdkDashboardId

    The ID of the dashboard.
    This is either:
    

    • the numerical ID when accessing a dashboard link, i.e. http://localhost:3000/dashboard/1-my-dashboard where the ID is 1
      
    • the string ID found in the entity_id key of the dashboard object when using the API directly or using the SDK Collection Browser to return data

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

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

  • OptionaldrillThroughQuestionHeight?: Height<string | number>

    Height of a question component when drilled from the dashboard to a question level.

  • OptionaldrillThroughQuestionProps?: DrillThroughQuestionProps

    Props of a question component when drilled from the dashboard to a question level.

  • OptionalhiddenParameters?: string[]

    A list of parameters to hide.
    

    • Combining initialParameters and hiddenParameters to filter data on the frontend is a security risk.
      
    • Combining initialParameters and hiddenParameters to declutter the user interface is fine.

  • OptionalinitialParameters?: ParameterValues

    Query parameters for the dashboard. For a single option, use a string value, and use a list of strings for multiple options.
    

    • Combining initialParameters and hiddenParameters to filter data on the frontend is a security risk.
      
    • Combining initialParameters and hiddenParameters to declutter the user interface is fine.

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

    Callback that is called when the dashboard is loaded.

  • OptionalonLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => 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"
            | "waterfall"
            | "sankey",
    ) => 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.

  • Optionalplugins?: MetabasePluginsConfig

    Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details.

  • OptionalrenderDrillThroughQuestion?: () => ReactNode

    A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout.

  • Optionalstyle?: CSSProperties

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

  • OptionalwithCardTitle?: boolean

    Whether the dashboard cards should display a title.

  • OptionalwithDownloads?: boolean

    Whether to hide the download button.

  • OptionalwithTitle?: boolean

    Whether the dashboard should display a title.