> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IMoveSectionItemPayload

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/commands/layout.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Payload of the [IMoveSectionItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitem/index.md) command.

**Signature:**

```typescript
export interface IMoveSectionItemPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [fromPath?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadfrompath) | `readonly` | [ILayoutItemPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ilayoutitempath/index.md) | **_(BETA)_** _(Optional)_ Path where the item to move is located. Index is zero-based. TODO LX-648: make the prop required |
| [itemIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloaditemindex) | `readonly` | number | **_(BETA)_** Index of section item that should be moved. Index is zero-based. |
| [removeOriginalSectionIfEmpty](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadremoveoriginalsectionifempty) | `readonly` | boolean | **_(BETA)_** If true and original section stays empty after move, then it will be removed. |
| [sectionIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadsectionindex) | `readonly` | number | **_(BETA)_** Index of the section where the item to move is located. Index is zero-based. |
| [toItemIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtoitemindex) | `readonly` | [RelativeIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.relativeindex/index.md) | **_(BETA)_** Index within the target section. Index is zero-based. For convenience you may specify -1 to append the item at the end of the target section's items. |
| [toPath?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtopath) | `readonly` | [ILayoutItemPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ilayoutitempath/index.md) | **_(BETA)_** _(Optional)_ Path to which the item should be moved. Index is zero-based. For convenience, you may specify -1 to move to last section. TODO LX-648: make the prop required |
| [toSectionIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtosectionindex) | `readonly` | [RelativeIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.relativeindex/index.md) | **_(BETA)_** Index of section to which the item should be moved. Index is zero-based. For convenience you may specify -1 to move to last section. |

## Property details

### IMoveSectionItemPayload.fromPath

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Path where the item to move is located.

Index is zero-based.

TODO LX-648: make the prop required

**Signature:**

```typescript
readonly fromPath?: ILayoutItemPath;
```

### IMoveSectionItemPayload.itemIndex

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Index of section item that should be moved.

Index is zero-based.

**Signature:**

```typescript
readonly itemIndex: number;
```

#### Remarks

[IMoveSectionItemPayload.itemIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloaditemindex) support will be removed in the next major SDK version. Use [IMoveSectionItemPayload.fromPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadfrompath) instead.

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

### IMoveSectionItemPayload.removeOriginalSectionIfEmpty

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

If true and original section stays empty after move, then it will be removed.

**Signature:**

```typescript
readonly removeOriginalSectionIfEmpty: boolean;
```

### IMoveSectionItemPayload.sectionIndex

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Index of the section where the item to move is located.

Index is zero-based.

**Signature:**

```typescript
readonly sectionIndex: number;
```

#### Remarks

[IMoveSectionItemPayload.sectionIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadsectionindex) support will be removed in the next major SDK version. Use [IMoveSectionItemPayload.fromPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadfrompath) instead.

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

### IMoveSectionItemPayload.toItemIndex

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Index within the target section.

Index is zero-based. For convenience you may specify -1 to append the item at the end of the target section's items.

**Signature:**

```typescript
readonly toItemIndex: RelativeIndex;
```

#### Remarks

[IMoveSectionItemPayload.toItemIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtoitemindex) support will be removed in the next major SDK version. Use [IMoveSectionItemPayload.toPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtopath) instead.

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

### IMoveSectionItemPayload.toPath

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Path to which the item should be moved.

Index is zero-based. For convenience, you may specify -1 to move to last section.

TODO LX-648: make the prop required

**Signature:**

```typescript
readonly toPath?: ILayoutItemPath;
```

### IMoveSectionItemPayload.toSectionIndex

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Index of section to which the item should be moved.

Index is zero-based. For convenience you may specify -1 to move to last section.

**Signature:**

```typescript
readonly toSectionIndex: RelativeIndex;
```

#### Remarks

[IMoveSectionItemPayload.toSectionIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtosectionindex) support will be removed in the next major SDK version. Use [IMoveSectionItemPayload.toPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.imovesectionitempayload/index.md#imovesectionitempayloadtopath) instead.

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