changeNestedLayoutSectionHeader()

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

changeNestedLayoutSectionHeader() 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 ChangeLayoutSectionHeader command.

Signature:

export declare function changeNestedLayoutSectionHeader(index: ILayoutSectionPath, header: IDashboardLayoutSectionHeader, merge?: boolean, correlationId?: string): ChangeLayoutSectionHeader;

Parameters

Parameter	Type	Description
index	ILayoutSectionPath	index of section to change
header	IDashboardLayoutSectionHeader	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:

ChangeLayoutSectionHeader

Remarks

Dispatching this command will result in change of the section's title and/or description.