GoodData.UI API reference
  • All Products
  • All Products
  • GoodData.UI
  • API Reference
  • University
  • Community
  • Documentation
  • Support
  • 11.28.0
  • Code samples
  • GitHub

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

Id6

permissions?

{ VIEW?: Permission; EDIT?: Permission; SHARE?: Permission; }

(Optional) Permissions for the dashboard

plugins?

({ id: Id12; parameters?: { [k: string]: unknown; }; } | Id13)[]

(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?

Tags8

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

  • v1.Dashboard interface
  • Properties
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2026 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use