VBI.report

The report namespace on a VBI instance, responsible for creating Report Builders, empty reports, and empty pages.

Methods

create

Creates a VBIReportBuilder from a report DSL.

Definition:

create(report: VBIReportDSLInput, builderOptions?: VBIReportBuilderOptions<TQueryDSL, TSeedDSL>): VBIReportBuilder<TQueryDSL, TSeedDSL>

Returns: VBIReportBuilder<TQueryDSL, TSeedDSL>

Parameters:

ParameterTypeDescription
reportVBIReportDSLInput-
builderOptions?VBIReportBuilderOptions<TQueryDSL, TSeedDSL>-

createEmpty

Creates an empty report DSL.

Definition:

createEmpty(uuid?: string): VBIReportDSL

Returns: VBIReportDSL

Parameters:

ParameterTypeDescription
uuid?string-

createEmptyPage

Creates an empty report page DSL.

Definition:

createEmptyPage(pageId?: string): VBIReportPageDSL

Returns: VBIReportPageDSL

Parameters:

ParameterTypeDescription
pageId?string-