IAddSectionItemsPayload

IAddSectionItemsPayload.autoResolveDateFilterDatasetpropertyBeta

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

Specify whether dashboard should auto-resolve date dataset to use for date filtering of KPI and insight widgets.

readonly autoResolveDateFilterDataset?: boolean;

Remarks

This is by default disabled. Meaning date filtering will be enabled only for those KPI or Insight widgets that already specify dateDataset. Those that have dateDataset undefined 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.

IAddSectionItemsPayload.itemIndexpropertyBeta

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

Index within section items where the item should be inserted.

readonly itemIndex: RelativeIndex;

Remarks

Index is zero-based. For convenience, you may specify -1 to append the new item.

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

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

IAddSectionItemsPayload.itemPathpropertyBeta

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

Path to which the item should be added.

readonly itemPath?: ILayoutItemPath;

Remarks

Index is zero-based.

TODO LX-648: make the prop required

IAddSectionItemsPayload.itemspropertyBeta

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

Items to add. This item may be a placeholder for KPI or insight, an actual dashboard widget or a previously stashed dashboard item.

readonly items: DashboardItemDefinition[];

Remarks

Note: if you use the stashed items identifier, the items will be moved from the stash - you cannot use the stash identifier again.

IAddSectionItemsPayload.sectionIndexpropertyBeta

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

Section to which the item should be added.

readonly sectionIndex: number;

Remarks

Index is zero-based.

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

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