replaceNestedLayoutSectionItem()
Home > @gooddata/sdk-ui-dashboard > replaceNestedLayoutSectionItem
replaceNestedLayoutSectionItem() function
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the ReplaceSectionItem command. Dispatching this command will result in replacement of particular dashboard item with a new item. By default, the old item will be discarded, however you may specify to stash it for later use.
Signature:
export declare function replaceNestedLayoutSectionItem(itemPath: ILayoutItemPath, item: DashboardItemDefinition, stashIdentifier?: StashedDashboardItemsId, autoResolveDateFilterDataset?: boolean, correlationId?: string): ReplaceSectionItem;
Parameters
| Parameter | Type | Description |
|---|---|---|
| itemPath | ILayoutItemPath | path where the item to replace resides |
| item | DashboardItemDefinition | new item definition |
| stashIdentifier | StashedDashboardItemsId | (Optional) specify identifier of stash where the old item should be stored |
| autoResolveDateFilterDataset | boolean | (Optional) specify whether dashboard should auto-resolve date dataset to use for date filtering of KPI or insight widget that is replacing the existing item; default is disabled meaning date filtering will be enabled only for those KPI or Insight widgets that already specify dateDataset. |
| 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 |
Returns: