index

Home > @gooddata/sdk-ui-dashboard > AddLayoutSectionPayload > index

AddLayoutSectionPayload.index property

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.

Index where to place the new section

Signature:

readonly index: RelativeIndex | ILayoutSectionPath;

Remarks

Index is zero-based and for convenience index -1 means place new section at the end. 0 means place new section at the beginning. Both 0 and -1 and can be used when inserting the first section into and empty layout.

RelativeIndex support will be removed in the next major SDK version. Use ILayoutSectionPath instead.

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