changeNestedLayoutSectionHeader()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the ChangeLayoutSectionHeader command.
export declare function changeNestedLayoutSectionHeader(index: ILayoutSectionPath, header: IDashboardLayoutSectionHeader, merge?: boolean, correlationId?: string): ChangeLayoutSectionHeader;
Parameters
Parameter | Type | Description |
|---|---|---|
index | index of section to change | |
header | new header | |
merge | boolean | (Optional) indicates whether the old header and the new header should be merged; default is no merging |
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 result in change of the section’s title and/or description.