changeDashboardDensity()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the ChangeDashboardDensity command.
export declare function changeDashboardDensity(density: DashboardDensity, correlationId?: string): IChangeDashboardDensity;
Parameters
Parameter | Type | Description |
|---|---|---|
density | 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
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.