Repository navigation
@sapui5/types: sap/gantt/simple/DeltaLine is missing the settings constructor overload #625
Description
Summary
The TypeScript definition for sap/gantt/simple/DeltaLine in @sapui5/types appears to be incomplete.
At runtime, DeltaLine supports being created with a settings object, but the current type definition only exposes constructor(sId?: string).
This breaks TSX / JSX scenarios and also plain TypeScript code that instantiates DeltaLine with settings.
Affected Package
@sapui5/types:~1.142.13
Affected UI5 Class
sap/gantt/simple/DeltaLine
Current Typing
declare module "sap/gantt/simple/DeltaLine" {
export default class DeltaLine extends UI5Element {
constructor(sId?: string);
}
}Expected Typing
declare module "sap/gantt/simple/DeltaLine" {
export default class DeltaLine extends UI5Element {
constructor(settings?: $DeltaLineSettings);
constructor(id?: string, settings?: $DeltaLineSettings);
}
}Actual Behaviour
TypeScript rejects valid code like this:
import DeltaLine from "sap/gantt/simple/DeltaLine";
const deltaLine = new DeltaLine({
stroke: "red",
timeStamp: "2026-01-01T00:00:00",
endTimeStamp: "2026-01-01T12:00:00",
visibleDeltaStartEndLines: false,
});Expected Behaviour
The code above should type-check, because DeltaLine accepts a settings object at runtime.
Why This Matters
- It forces local type workarounds or wrapper classes.
- It breaks UI5 JSX/TSX runtimes that derive prop types from UI5 constructor signatures.
- It is inconsistent with the exported
$DeltaLineSettingsinterface, which already exists.
Reproduction
- Install
@sapui5/types@~1.142.13 - Create a TypeScript file with the example above
- Run TypeScript type-checking
- Observe that the constructor signature does not accept the settings object
Environment
- TypeScript: project using strict mode
- UI5 typings:
@sapui5/types@~1.142.13 - UI5 runtime used in app:
1.142.13
Suggested Fix
Please add the missing settings-based constructor overloads for sap/gantt/simple/DeltaLine.
The class already exports $DeltaLineSettings, so the constructor typing likely only needs to be aligned with the actual runtime API.
Additional Context
In our project we had to introduce a local wrapper around sap/gantt/simple/DeltaLine only to bridge the missing constructor typing. The runtime API itself works correctly; the issue is limited to the TypeScript declaration.
Activity
codeworrior commentedon Sep 14, 2026
That's due to an incomplete JSDoc in DeltaLine:
Only the ID parameter is documented, not the settings. I'll let the colleagues know so that they can fix it.
codeworrior commentedon Sep 14, 2026
A fix has been submitted for
which all suffered from the same issue.
Documentation fixes usually only go into the next monthly release (1.153), I hope that's okay.
edemuck commentedon Sep 14, 2026
The same issue exists on
sap.gantt.simple.GanttChartWithTable. The constructormSettingis from typeobject, instead of$GanttChartWithTableSettings. And the second constructor with only parametermSettingisn't available. There are more jsDoc gaps of other controls/elements (e.g.sap/gantt/simple/GanttRowSettings).codeworrior commentedon Sep 14, 2026
That looks same, but in fact is slightly different. The dts-generator expects the parameter to be named
/settings/, butGanttChartWithTabledocumented it asmSetting(singular).I didn't know about this special problem, but when searching for the missing
mSettingsdocumentation, I found severalmSettingand changed them tomSettings(just to be more precise, it's not a single setting). Luckily, this should fix theGanttChartWithTableissue already.Affected APIs:
I also found at least one that named the parameter
mAttributes(BaseDeltaRectangle). As I wasn't aware of the special check in the dts-generator (or didn't remember), I did not fix this one. Will do so.