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

# IRemoveSectionItemPayload

- 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 [IRemoveSectionItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitem/index.md) command.

**Signature:**

```typescript
export interface IRemoveSectionItemPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [eager?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloadeager) | `readonly` | boolean | **_(BETA)_** _(Optional)_ Specify whether to eagerly remove the entire section if the item being removed was the only item in the section. |
| [itemIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloaditemindex) | `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 item that should be moved. |
| [itemPath?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloaditempath) | `readonly` | [ILayoutItemPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ilayoutitempath/index.md) | **_(BETA)_** _(Optional)_ Index where the item to remove is located. |
| [sectionIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloadsectionindex) | `readonly` | number | **_(BETA)_** Index of the section where the item to move is located. |
| [stashIdentifier?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloadstashidentifier) | `readonly` | [StashedDashboardItemsId](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.stasheddashboarditemsid/index.md) | **_(BETA)_** _(Optional)_ Specify stash identifier. |

## Property details

### IRemoveSectionItemPayload.eager

> **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).
> 

Specify whether to eagerly remove the entire section if the item being removed was the only item in the section.

**Signature:**

```typescript
readonly eager?: boolean;
```

#### Remarks

Default is false. Meaning an empty section will be left.

### IRemoveSectionItemPayload.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.

**Signature:**

```typescript
readonly itemIndex: RelativeIndex;
```

#### Remarks

Index is zero-based. For convenience you may use index of -1 to remove last item from section.

[IRemoveSectionItemPayload.itemIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloaditemindex) support will be removed in the next major SDK version. Use [IRemoveSectionItemPayload.itemPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloaditempath) instead.

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

### IRemoveSectionItemPayload.itemPath

> **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 where the item to remove is located.

**Signature:**

```typescript
readonly itemPath?: ILayoutItemPath;
```

#### Remarks

Index is zero-based.

TODO LX-648: make the prop required

### IRemoveSectionItemPayload.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.

**Signature:**

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

#### Remarks

Index is zero-based.

[IRemoveSectionItemPayload.sectionIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloadsectionindex) support will be removed in the next major SDK version. Use [IRemoveSectionItemPayload.itemPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iremovesectionitempayload/index.md#iremovesectionitempayloaditempath) instead.

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

### IRemoveSectionItemPayload.stashIdentifier

> **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).
> 

Specify stash identifier.

**Signature:**

```typescript
readonly stashIdentifier?: StashedDashboardItemsId;
```

#### Remarks

If provided, the item will not be permanently removed but will be stored in the stash under this identifier. You can then use the stash identifier to 'resurrect' the item in different section.

Default behavior with no stashIdentifier is to permanently remove the item as well.