Dashboard

Home > @gooddata/sdk-code-schemas > v1 > Dashboard

v1.Dashboard interface

Signature:

export interface Dashboard 

Properties

Property	Modifiers	Type	Description
cross_filtering?		boolean	(Optional) Whether cross filtering is enabled for this dashboard. Defaults to true.
description?		string	(Optional) An optional description of the dashboard.
enable_section_headers?		boolean	(Optional) Applies to the root layout. Whether all sections headers are enabled. Defaults to true.
filter_views?		boolean	(Optional) Whether user can save and apply filter views for this dashboard. Defaults to true.
filters?		DashboardFilters	(Optional)
id		Id8
permissions?		{ VIEW?: Permission; EDIT?: Permission; SHARE?: Permission; }	(Optional) Permissions for the dashboard
persistent_filters_across_tabs?		boolean	(Optional) Whether persistent filters across tabs are enabled for this dashboard. Defaults to true.
plugins?		({ id: Id14; parameters?: { [k: string]: unknown; }; } | Id15)[]	(Optional) A list of plugins in this dashboard.
sections?		Section[]	(Optional) A list of sections in this dashboard.
tabs?		Tab[]	(Optional) A list of tabs in this dashboard. Each tab has its own layout, filters, and filter configurations. Mutually exclusive with sections and filters at dashboard level.
tags?		Tags9	(Optional)
timezone_config?		TimezoneConfig	(Optional)
title?		string	(Optional) An optional human readable title for the dashboard. Will be derived from id if not provided explicitly.
type		"dashboard"
user_filters_reset?		boolean	(Optional) Whether user can reset custom updated filters. Defaults to true.
user_filters_save?		boolean	(Optional) Whether user filter setting will be stored in local storage. Defaults to true.
version?		"2" | "3"	(Optional) Dashboard model version. "2" (default if omitted) — legacy shape: root-level sections/filters are also mirrored into a default tab, producing a declarative model with duplicated content for backward compatibility with older SDK readers. "3" — clean shape: tabs are the sole source of layout and filters; root sections/filters in YAML are still allowed as an authoring shortcut but are wrapped into a single synthetic tab without duplication. Use "3" for new dashboards; "2" exists to keep existing files round-trippable.