newReportDefinitionFromTemplate()

Home > @gooddata/sdk-model > newReportDefinitionFromTemplate

newReportDefinitionFromTemplate() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates a report definition from a template.

Signature:

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	IReportTemplate | IReportTemplateDefinition
options	{ title: string; periodStart: ReportDateString; periodEnd: ReportDateString; }
modifications	Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>	(Optional)

Returns:

IReportDefinition

Remarks

The template content is deep-copied; no reference to the template is kept, so the report stays frozen while the template evolves.