ReportView class
The EasyQuery client-side view that represents the UI for ad-hoc reporting page
- executeQuery
- getContext
- init
- loadReport
- newReport
- removeCurrentReport
- renderReportList
- renderReportProps
- saveCurrentReportAs
- setActiveReport
- syncReport
- clearErrors
- clearReportButtonClick
- createChartWidget
- createColumnsBarWidget
- createQueryPanelWidget
- createResultGridWidget
- disableExportButtons
- displayRecordsCount
- enableExportButtons
- errorHandler
- getReportContentFromCache
- hideExportButtons
- insertIntoReportList
- loadReportButtonClick
- newReportButtonClick
- removeFromReportList
- removeReportButtonClick
- renderReportItemInList
- renderReportPanels
- saveReportButtonClick
- saveReportContentInCache
- showExportButtons
- updateReportButtonClick
Public Methods
Section titled “Public Methods”executeQuery
Section titled “executeQuery”Builds and executes current report’s query.
▸ executeQuery(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
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
renderReportProps
Section titled “renderReportProps”Renders current report.
▸ renderReportProps(): void
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
createChartWidget
Section titled “createChartWidget”▸ createChartWidget(slotElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slotElement:
HTMLElement
Returns Widget
createColumnsBarWidget
Section titled “createColumnsBarWidget”Creates the widget that represents Columns Bar.
▸ createColumnsBarWidget(placeholderElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
HTMLElement- The [[HTMLElement]] to place the created widget in.
Returns Widget - the created [[Widget]] object.
createQueryPanelWidget
Section titled “createQueryPanelWidget”Creates the widget that represents Query Panel.
▸ createQueryPanelWidget(placeholderElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
HTMLElement- The [[HTMLElement]] to place the created widget in.
Returns Widget - the created [[Widget]] object.
createResultGridWidget
Section titled “createResultGridWidget”Creates the widget that represents the result grid.
▸ createResultGridWidget(slotElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slotElement:
HTMLElement- The [[HTMLElement]] to place the created widget in.
Returns Widget - the created [[Widget]] object.
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
getReportContentFromCache
Section titled “getReportContentFromCache”Gets the report content from cache.
▸ getReportContentFromCache(report: Report): string | null
Parameters:
Section titled “Parameters:”- report: Report - The report.
Returns string | null - Content of the report (Query in JSOn string)
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
saveReportContentInCache
Section titled “saveReportContentInCache”Saves reports content to the cache.
▸ saveReportContentInCache(report: Report,content: string): void
Parameters:
Section titled “Parameters:”- report: Report - The report.
- content:
string- The content (Query serialized into JSON).
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