Embedded analytics SDK API
    Preparing search index...

    Interface StaticDashboardProps

    interface StaticDashboardProps {
        className?: string;
        dashboardId: SdkDashboardId;
        hiddenParameters?: string[];
        initialParameters?: DefaultQuery<string>;
        onLoad?: (dashboard: null | MetabaseDashboard) => void;
        onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void;
        style?: CSSProperties;
        withCardTitle?: boolean;
        withDownloads?: boolean;
        withFooter?: boolean;
        withTitle?: boolean;
    }
    Index

    Properties

    className? dashboardId hiddenParameters? initialParameters? onLoad? onLoadWithoutCards? style? withCardTitle? withDownloads? withFooter? withTitle?

    Properties

    className?: 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
    hiddenParameters?: string[]

    A list of parameters to hide.


    - Combining initialParameters and hiddenParameters to filter data on the frontend is a [security risk](/docs/master/embedding/sdk/authentication#security-warning-each-end-user-must-have-their-own-metabase-account).
    - Combining initialParameters and hiddenParameters to declutter the user interface is fine.
    initialParameters?: DefaultQuery<string>

    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](/docs/master/embedding/sdk/authentication#security-warning-each-end-user-must-have-their-own-metabase-account).
    - Combining initialParameters and hiddenParameters to declutter the user interface is fine.
    onLoad?: (dashboard: null | MetabaseDashboard) => void

    Callback that is called when the dashboard is loaded.

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

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

    style?: CSSProperties

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

    withCardTitle?: boolean

    Whether the dashboard cards should display a title.

    withDownloads?: boolean

    Whether to hide the download button.

    withFooter?: boolean

    Whether to display the footer.

    withTitle?: boolean

    Whether the dashboard should display a title.

    Settings

    On This Page

    Properties