IReplaceSectionItemPayload

IReplaceSectionItemPayload.autoResolveDateFilterDatasetpropertyBeta

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

Specify whether dashboard should auto-resolve date dataset to use for date filtering of the KPI or insight widget that will be used to replace item on a dashboard.

readonly autoResolveDateFilterDataset?: boolean;

Remarks

This is by default disabled. Meaning date filtering will be enabled only if the KPI or Insight widget already specifies dateDataset. If the dateDataset is undefined the widget will not be filtered by dashboard’s date filter.

When you turn on this option, then the dashboard will automatically resolve date dataset for those KPI and Insight widgets that have it undefined.

IReplaceSectionItemPayload.itempropertyBeta

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

New item definition.

readonly item: DashboardItemDefinition;

IReplaceSectionItemPayload.itemIndexpropertyBeta

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

Index of item within section that should be modified.

readonly itemIndex: number;

Remarks

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

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

IReplaceSectionItemPayload.itemPathpropertyBeta

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

Index where the item to modify resides.

TODO LX-648: make the prop required

readonly itemPath?: ILayoutItemPath;

IReplaceSectionItemPayload.sectionIndexpropertyBeta

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

Index of section where the item to modify resides.

readonly sectionIndex: number;

Remarks

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

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

IReplaceSectionItemPayload.stashIdentifierpropertyBeta

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

Specify identifier for stash where the old item should be stored.

readonly stashIdentifier?: StashedDashboardItemsId;

Remarks

If no stashIdentifier provided, then the old item will be thrown away.