Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

10.1 KB
Raw Blame
function EditableDashboard(
  props: {
    autoRefreshInterval?: number;
    dashboardId: SdkDashboardId;
    drillThroughQuestionHeight?: Height<string | number>;
    drillThroughQuestionProps?: DrillThroughQuestionProps;
    initialParameters?: ParameterValues;
    navigatedEntityParameters?: NavigatedEntityParameters;
    onNavigatedEntityParametersChange?: (
      payload: NavigatedEntityParameterChangePayload,
    ) => void;
    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">;
  },
): Element;

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

Parameter Type Description
props { autoRefreshInterval?: number; dashboardId: SdkDashboardId; drillThroughQuestionHeight?: Height<string | number>; drillThroughQuestionProps?: DrillThroughQuestionProps; initialParameters?: ParameterValues; navigatedEntityParameters?: NavigatedEntityParameters; onNavigatedEntityParametersChange?: (payload: NavigatedEntityParameterChangePayload) => void; 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">; }

Returns

Element