changeDashboardDensity()

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

changeDashboardDensity() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the ChangeDashboardDensity command.

Signature:

export declare function changeDashboardDensity(density: DashboardDensity, correlationId?: string): IChangeDashboardDensity;

Parameters

Parameter

Type

Description

density

DashboardDensity

density value to set

correlationId

string

(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing

Returns:

IChangeDashboardDensity

Remarks

Dispatching this command will change the dashboard density setting for the current user. The value is persisted in localStorage and will be used on the next dashboard load, taking priority over the theme's default density setting.

← ChangeAttributeFilterSelectionPayloadChangeDateFilterSelection →