newAdHocReportDefinition()

Home > @gooddata/sdk-model > newAdHocReportDefinition

newAdHocReportDefinition() 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 an ad-hoc report definition not based on any template.

Signature:

export declare function newAdHocReportDefinition(options: {
    title: string;
    periodStart: ReportDateString;
    periodEnd: ReportDateString;
    pages?: IReportContentPage[];
}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;

Parameters

Parameter	Type	Description
options	{ title: string; periodStart: ReportDateString; periodEnd: ReportDateString; pages?: IReportContentPage[]; }
modifications	Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>	(Optional)

Returns:

IReportDefinition