newReportDefinitionFromTemplate()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates a report definition from a template.
export declare function newReportDefinitionFromTemplate(template: IReportTemplate | IReportTemplateDefinition, options: {
title: string;
periodStart: ReportDateString;
periodEnd: ReportDateString;
}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
Parameters
Parameter | Type | Description |
|---|---|---|
template | ||
options | { title: string; periodStart: ReportDateString; periodEnd: ReportDateString; } | |
modifications | Partial<Omit<IReportDefinition, “type” | “title” | “periodStart” | “periodEnd” | “content”>> | (Optional) |
Returns
Remarks
The template content is deep-copied; no reference to the template is kept, so the report stays frozen while the template evolves.