IWorkspaceReportsService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Service for managing report page layouts, report templates and reports.
export interface IWorkspaceReportsService
Remarks
Report page layouts returned by this service include the built-in layouts shipped with the product (BuiltInReportPageLayouts). Built-ins carryisBuiltIn: true, are never persisted on the backend, and reject update and delete.
Methods
Method | Description |
|---|---|
(ALPHA) Create a new report. | |
(ALPHA) Create a new report page layout. | |
(ALPHA) Create a new report template. | |
(ALPHA) Delete an existing report. | |
(ALPHA) Delete an existing report page layout. Rejects built-in and locked layouts. | |
(ALPHA) Delete an existing report template. | |
(ALPHA) Export a report to PDF. | |
(ALPHA) Get a single report by its reference. | |
(ALPHA) Get a single report page layout by its reference. | |
(ALPHA) Get the list of report page layouts available in the workspace, built-in layouts first. | |
(ALPHA) Get the list of reports available in the workspace. | |
(ALPHA) Get a single report template by its reference. | |
(ALPHA) Get the list of report templates available in the workspace. | |
(ALPHA) Update an existing report. Rejects locked reports. | |
(ALPHA) Update an existing report page layout. Rejects built-in and locked layouts. | |
(ALPHA) Update an existing report template. Rejects locked templates. |
Method details
IWorkspaceReportsService.createReport()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Create a new report.
createReport(report: IReportDefinition): Promise<IReport>;
Parameters
Parameter | Type | Description |
|---|---|---|
report |
Returns
Promise<IReport>
IWorkspaceReportsService.createReportPageLayout()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Create a new report page layout.
createReportPageLayout(page: IReportPageLayoutDefinition): Promise<IReportPageLayout>;
Parameters
Parameter | Type | Description |
|---|---|---|
page |
Returns
Promise<IReportPageLayout>
IWorkspaceReportsService.createReportTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Create a new report template.
createReportTemplate(template: IReportTemplateDefinition): Promise<IReportTemplate>;
Parameters
Parameter | Type | Description |
|---|---|---|
template |
Returns
Promise<IReportTemplate>
IWorkspaceReportsService.deleteReport()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Delete an existing report.
deleteReport(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IWorkspaceReportsService.deleteReportPageLayout()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Delete an existing report page layout. Rejects built-in and locked layouts.
deleteReportPageLayout(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IWorkspaceReportsService.deleteReportTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Delete an existing report template.
deleteReportTemplate(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IWorkspaceReportsService.exportReportToPdf()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Export a report to PDF.
exportReportToPdf(ref: ObjRef, options?: IReportExportPdfOptions): Promise<IExportResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ||
options | (Optional) |
Returns
Promise<IExportResult>
Remarks
The backend renders the report as it is saved, so unsaved changes are not part of the export.
IWorkspaceReportsService.getReport()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get a single report by its reference.
getReport(ref: ObjRef): Promise<IReport>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<IReport>
IWorkspaceReportsService.getReportPageLayout()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get a single report page layout by its reference.
getReportPageLayout(ref: ObjRef): Promise<IReportPageLayout>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<IReportPageLayout>
IWorkspaceReportsService.getReportPageLayouts()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get the list of report page layouts available in the workspace, built-in layouts first.
getReportPageLayouts(): Promise<IReportPageLayout[]>;
Returns
Promise<IReportPageLayout[]>
IWorkspaceReportsService.getReports()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get the list of reports available in the workspace.
getReports(): Promise<IReport[]>;
Returns
Promise<IReport[]>
IWorkspaceReportsService.getReportTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get a single report template by its reference.
getReportTemplate(ref: ObjRef): Promise<IReportTemplate>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<IReportTemplate>
IWorkspaceReportsService.getReportTemplates()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get the list of report templates available in the workspace.
getReportTemplates(): Promise<IReportTemplate[]>;
Returns
Promise<IReportTemplate[]>
IWorkspaceReportsService.updateReport()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Update an existing report. Rejects locked reports.
updateReport(report: IReport): Promise<IReport>;
Parameters
Parameter | Type | Description |
|---|---|---|
report |
Returns
Promise<IReport>
IWorkspaceReportsService.updateReportPageLayout()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Update an existing report page layout. Rejects built-in and locked layouts.
updateReportPageLayout(page: IReportPageLayout): Promise<IReportPageLayout>;
Parameters
Parameter | Type | Description |
|---|---|---|
page |
Returns
Promise<IReportPageLayout>
IWorkspaceReportsService.updateReportTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Update an existing report template. Rejects locked templates.
updateReportTemplate(template: IReportTemplate): Promise<IReportTemplate>;
Parameters
Parameter | Type | Description |
|---|---|---|
template |
Returns
Promise<IReportTemplate>