IAddLayoutSectionPayload

IAddLayoutSectionPayload.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 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.

IAddLayoutSectionPayload.indexpropertyBeta

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

Index where to place the new section

readonly index: RelativeIndex | ILayoutSectionPath;

Remarks

Index is zero-based and for convenience index -1 means place new section at the end. 0 means place new section at the beginning. Both 0 and -1 and can be used when inserting the first section into and empty layout.

RelativeIndex support will be removed in the next major SDK version. Use ILayoutSectionPath instead.

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

IAddLayoutSectionPayload.initialHeaderpropertyBeta

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

Specify the section header.

readonly initialHeader?: IDashboardLayoutSectionHeader;

IAddLayoutSectionPayload.initialItemspropertyBeta

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

Specify one or more items to include in the newly created section.

readonly initialItems?: DashboardItemDefinition[];