IResizeWidthPayload

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Payload of the IResizeWidth command.

export interface IResizeWidthPayload

Properties

Property	Modifiers	Type	Description
itemIndex	`readonly`	number	*(BETA)* Indexes of the item to resize. Index is zero-based.
itemPath?	`readonly`	ILayoutItemPath	*(BETA)* (Optional) Index of the item to resize. Index is zero-based. TODO LX-648: make the prop required
sectionIndex	`readonly`	number	*(BETA)* Index of the section to resize. Index is zero-based.
width	`readonly`	number	*(BETA)* width to resize.

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Indexes of the item to resize.

Index is zero-based.

readonly itemIndex: number;

IResizeWidthPayload.itemIndex support will be removed in the next major SDK version. Use IResizeWidthPayload.itemPath instead.

TODO LX-648: Remove itemIndex in the next major version.

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Index of the item to resize.

Index is zero-based.

TODO LX-648: make the prop required

readonly itemPath?: ILayoutItemPath;

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

Index of the section to resize.

Index is zero-based.

readonly sectionIndex: number;

IResizeWidthPayload.sectionIndex support will be removed in the next major SDK version. Use IResizeWidthPayload.itemPath instead.

TODO LX-648: Remove sectionIndex in the next major version.

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

width to resize.

readonly width: number;