DashboardConfig

Home > @gooddata/sdk-ui-dashboard > DashboardConfig

DashboardConfig type

Dashboard configuration can influence the available features, look and feel and behavior of the dashboard.

Signature:

export type DashboardConfig = {
    locale?: ILocale;
    separators?: ISeparators;
    settings?: ISettings;
    dateFilterConfig?: IDateFilterConfig;
    overrideDefaultFilters?: FilterContextItem[];
    overrideTitle?: string;
    colorPalette?: IColorPalette;
    objectAvailability?: ObjectAvailabilityConfig;
    mapboxToken?: string;
    agGridToken?: string;
    isReadOnly?: boolean;
    isEmbedded?: boolean;
    isExport?: boolean;
    isWhiteLabeled?: boolean;
    disableDefaultDrills?: boolean;
    enableFilterValuesResolutionInDrillEvents?: boolean;
    menuButtonItemsVisibility?: IMenuButtonItemsVisibility;
    allowUnfinishedFeatures?: boolean;
    allowCreateInsightRequest?: boolean;
    initialRenderMode?: RenderMode;
    hideSaveAsNewButton?: boolean;
    hideShareButton?: boolean;
    hideWidgetTitles?: boolean;
    widgetsOverlay?: Record<string, IDashboardWidgetOverlay>;
    exportId?: string;
    exportType?: "visual" | "slides";
    disableCrossFiltering?: boolean;
    disableUserFilterReset?: boolean;
    hideAddTabButton?: boolean;
    openAutomationOnLoad?: boolean;
    focusObject?: IDashboardFocusObject;
    slideConfig?: IDashboardExportSlideConfig;
    references?: IDashboardReferences;
    entitlements?: IEntitlementDescriptor[];
    initialContent?: DashboardItem[];
    executionTimestamp?: string;
    evaluationFrequency?: string;
    workspaceDescriptor?: {
        title: string;
    };
    externalRecipient?: string;
};

References: ILocale, ISeparators, ISettings, IDateFilterConfig, FilterContextItem, IColorPalette, ObjectAvailabilityConfig, IMenuButtonItemsVisibility, RenderMode, IDashboardWidgetOverlay, IDashboardFocusObject, IDashboardExportSlideConfig, IDashboardReferences, IEntitlementDescriptor, DashboardItem