Function StaticDashboard

Parameters

• props: StaticDashboardProps

  • 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

  • OptionalhiddenParameters?: string[]

    A list of parameters to hide.
    
    

    Remarks

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

  • OptionalinitialParameters?: DefaultQuery<string>

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

    Remarks

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

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

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

  • OptionalwithFooter?: boolean

    Whether to display the footer.

  • OptionalwithTitle?: boolean

    Whether the dashboard should display a title.