toggleLayoutSectionHeaders()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the ToggleLayoutSectionHeaders command.
export declare function toggleLayoutSectionHeaders(layoutPath: ILayoutItemPath | undefined, enableSectionHeaders: boolean, correlationId?: string): IToggleLayoutSectionHeaders;
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
IToggleLayoutSectionHeaders
Remarks
This command toggles headers of the sections for the dashboard layout.