ReportPageCollectionBuilder

Properties

Methods

constructor

Definition:

constructor(parent: VBIReportBuilder<TQueryDSL, TSeedDSL>, doc: Y.Doc, dsl: Y.Map<any>, options: VBIReportBuilderOptions<TQueryDSL, TSeedDSL>)

Parameters:

ParameterTypeDescription
parentVBIReportBuilder<TQueryDSL, TSeedDSL>-
docY.Doc-
dslY.Map-
optionsVBIReportBuilderOptions<TQueryDSL, TSeedDSL>-

add

Definition:

add(title: string, callback: (page: ReportPageBuilder<TQueryDSL, TSeedDSL>) => void): VBIReportBuilder<TQueryDSL, TSeedDSL>

Returns: VBIReportBuilder<TQueryDSL, TSeedDSL>

Parameters:

ParameterTypeDescription
titlestring-
callback(page: ReportPageBuilder<TQueryDSL, TSeedDSL>) => void-

remove

Definition:

remove(pageId: string): VBIReportBuilder<TQueryDSL, TSeedDSL>

Returns: VBIReportBuilder<TQueryDSL, TSeedDSL>

Parameters:

ParameterTypeDescription
pageIdstring-

update

Definition:

update(pageId: string, callback: (page: ReportPageBuilder<TQueryDSL, TSeedDSL>) => void): VBIReportBuilder<TQueryDSL, TSeedDSL>

Returns: VBIReportBuilder<TQueryDSL, TSeedDSL>

Parameters:

ParameterTypeDescription
pageIdstring-
callback(page: ReportPageBuilder<TQueryDSL, TSeedDSL>) => void-

get

Definition:

get(pageId: string): ReportPageBuilder<TQueryDSL, TSeedDSL> | undefined

Returns: ReportPageBuilder<TQueryDSL, TSeedDSL> \| undefined

Parameters:

ParameterTypeDescription
pageIdstring-