resizeWidth()

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

resizeWidth() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the ResizeWidth command.

Signature:

export declare function resizeWidth(sectionIndex: number, itemIndex: number, width: number, correlationId?: string): IResizeWidth;

Parameters

Parameter	Type	Description
sectionIndex	number	index of the section
itemIndex	number	index of the item
width	number	width in Grid Rows (by default 1 Grid Row is 20px)
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 TODO LX-648: Consider removing this command variant and leave only a nested variant

Returns:

IResizeWidth

Remarks

This command operates only on the root layout. For nested layouts, use resizeNestedLayoutItemWidth().