IDashboardLayoutSectionHeaderChangedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IDashboardLayoutSectionHeaderChanged event.
export interface IDashboardLayoutSectionHeaderChangedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) The new header of the section. | ||
| number | (BETA) Index of the section which had the header updated. | |
| (BETA) Path of the section which had the header updated. |
Property details
IDashboardLayoutSectionHeaderChangedPayload.newHeaderpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The new header of the section.
readonly newHeader: IDashboardLayoutSectionHeader;
IDashboardLayoutSectionHeaderChangedPayload.sectionIndexpropertyBetaDeprecated
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Warning: This API is now obsolete.
The prop will be removed in the next major SDK version. Use IDashboardLayoutSectionHeaderChangedPayload.sectionPath instead.
TODO LX-648: Remove property in the next major version.
Index of the section which had the header updated.
readonly sectionIndex: number;
IDashboardLayoutSectionHeaderChangedPayload.sectionPathpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Path of the section which had the header updated.
readonly sectionPath: ILayoutSectionPath;