toggleLayoutSectionHeaders()
Home > @gooddata/sdk-ui-dashboard > toggleLayoutSectionHeaders
toggleLayoutSectionHeaders() 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 ToggleLayoutSectionHeaders command.
Signature:
export declare function toggleLayoutSectionHeaders(layoutPath: ILayoutItemPath | undefined, enableSectionHeaders: boolean, correlationId?: string): ToggleLayoutSectionHeaders;
Parameters
| Parameter | Type | Description |
|---|---|---|
| layoutPath | ILayoutItemPath | undefined | layout for which the sections will have the headers toggled. |
| enableSectionHeaders | boolean | value of that determines state of the headers of the layout sections. True to enable headers, false to disable them. |
| 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:
ToggleLayoutSectionHeaders
Remarks
This command toggles headers of the sections for the dashboard layout.