ReportViewJQuery class
Extends
Section titled “Extends”- buildAndExecute
- getContext
- init
- loadReport
- newReport
- removeCurrentReport
- renderCurrentReport
- renderReportList
- saveCurrentReportAs
- setActiveReport
- syncReport
- clearErrors
- clearReportButtonClick
- createColumnsBarWidget
- createDefaultBroker
- createDefaultChartProvider
- createQueryPanelWidget
- disableExportButtons
- displayRecordsCount
- enableExportButtons
- errorHandler
- hideExportButtons
- insertIntoReportList
- loadReportButtonClick
- newReportButtonClick
- removeFromReportList
- removeReportButtonClick
- renderReportItemInList
- renderReportPanels
- saveReportButtonClick
- showExportButtons
- updateReportButtonClick
Constructors
Section titled “Constructors”constructor
Section titled “constructor”⊕ new ReportViewJQuery(): ReportViewJQuery
Public Methods
Section titled “Public Methods”buildAndExecute
Section titled “buildAndExecute”Builds and executes current report’s query.
▸ buildAndExecute(options?: any): void
Parameters:
Section titled “Parameters:”- options:
any, Optional - The options. In particular,options.pagedefines what page of data to query.
Returns void
getContext
Section titled “getContext”Returns the context.
▸ getContext(): EqContext
Returns EqContext - [[EqContext]] object.
Initializes the view.
▸ init(options?: ReportViewOptions): void
Parameters:
Section titled “Parameters:”- options: ReportViewOptions, Optional - The [[ReportViewOptions]] object.
Returns void
loadReport
Section titled “loadReport”Loads report by ID.
▸ loadReport(reportId: string): void
Parameters:
Section titled “Parameters:”- reportId:
string- The ID of the report to load.
Returns void
newReport
Section titled “newReport”Creates the new report.
▸ newReport(): void
Returns void
removeCurrentReport
Section titled “removeCurrentReport”Removes current report.
▸ removeCurrentReport(): void
Returns void
renderCurrentReport
Section titled “renderCurrentReport”Renders current report.
▸ renderCurrentReport(): void
Returns void
renderReportList
Section titled “renderReportList”Renders the list of reports.
▸ renderReportList(options?: any): void
Parameters:
Section titled “Parameters:”- options:
any, Optional - The options. In particular,options.reportIndexdefines which report should be active.
Returns void
saveCurrentReportAs
Section titled “saveCurrentReportAs”Shows the dialog to save the report with new name.
▸ saveCurrentReportAs(): void
Returns void
setActiveReport
Section titled “setActiveReport”Sets active report.
▸ setActiveReport(reportId: string): void
Parameters:
Section titled “Parameters:”- reportId:
string- The ID of the report to make active.
Returns void
syncReport
Section titled “syncReport”Sends current report’s query to back-end.
▸ syncReport(): void
Returns void
Protected Methods
Section titled “Protected Methods”clearErrors
Section titled “clearErrors”Clears the errors.
▸ clearErrors(): void
Returns void
clearReportButtonClick
Section titled “clearReportButtonClick”The handler of the “Clear” button click.
▸ clearReportButtonClick(): void
Returns void
createColumnsBarWidget
Section titled “createColumnsBarWidget”▸ createColumnsBarWidget(placeholderElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
HTMLElement
Returns Widget
createDefaultBroker
Section titled “createDefaultBroker”▸ createDefaultBroker(context: EqContext): EqBroker
Parameters:
Section titled “Parameters:”- context: EqContext
Returns EqBroker
createDefaultChartProvider
Section titled “createDefaultChartProvider”Creates the default chart provider for the view.
▸ createDefaultChartProvider(): ChartProvider
Returns ChartProvider - the created [[ChartProvider]] object.
createQueryPanelWidget
Section titled “createQueryPanelWidget”▸ createQueryPanelWidget(placeholderElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
HTMLElement
Returns Widget
disableExportButtons
Section titled “disableExportButtons”Disables export buttons.
▸ disableExportButtons(): void
Returns void
displayRecordsCount
Section titled “displayRecordsCount”Shows records count.
▸ displayRecordsCount(count: number): void
Parameters:
Section titled “Parameters:”- count:
number- The value to show.
Returns void
enableExportButtons
Section titled “enableExportButtons”Enables export buttons.
▸ enableExportButtons(): void
Returns void
errorHandler
Section titled “errorHandler”The handler of errors.
▸ errorHandler(error: any): void
Parameters:
Section titled “Parameters:”- error:
any- The error object.
Returns void
hideExportButtons
Section titled “hideExportButtons”Hides export buttons.
▸ hideExportButtons(): void
Returns void
insertIntoReportList
Section titled “insertIntoReportList”Inserts the report to the list of reports.
▸ insertIntoReportList(report: Report): void
Parameters:
Section titled “Parameters:”- report: Report - The [[Report]] object to be inserted.
Returns void
loadReportButtonClick
Section titled “loadReportButtonClick”The handler of the “Load” button click.
▸ loadReportButtonClick(): void
Returns void
newReportButtonClick
Section titled “newReportButtonClick”The handler of the “New” button click.
▸ newReportButtonClick(): void
Returns void
removeFromReportList
Section titled “removeFromReportList”Removes the report from the list of reports.
▸ removeFromReportList(reportId: string): number
Parameters:
Section titled “Parameters:”- reportId:
string- The ID of the report to be removed.
Returns number - the index of removed report.
removeReportButtonClick
Section titled “removeReportButtonClick”The handler of the “Remove” button click.
▸ removeReportButtonClick(): void
Returns void
renderReportItemInList
Section titled “renderReportItemInList”Renders a single item in the list of reports.
▸ renderReportItemInList(report: Report,ul: HTMLUListElement): void
Parameters:
Section titled “Parameters:”- report: Report - The [[Report]] object to render.
- ul:
HTMLUListElement- The [[HTMLUListElement]] to add the item to.
Returns void
renderReportPanels
Section titled “renderReportPanels”Renders report panels.
▸ renderReportPanels(): void
Returns void
saveReportButtonClick
Section titled “saveReportButtonClick”The handler of the “Save” button click.
▸ saveReportButtonClick(): void
Returns void
showExportButtons
Section titled “showExportButtons”Shows export buttons.
▸ showExportButtons(): void
Returns void
updateReportButtonClick
Section titled “updateReportButtonClick”The handler of the “Update” button click.
▸ updateReportButtonClick(): void
Returns void