Skip to content

ReportViewJQuery class

ReportView


⊕ new ReportViewJQuery(): ReportViewJQuery



● chartWidget?: Widget


● columnsBarWidget?: Widget


● columnsPanelWidget?: Widget


● context: EqContext


● domRoots: Array<Document | ShadowRoot> = [ document ]


● enableExport: boolean = false


● entitiesPanelWidget?: Widget


● exportWidget?: Widget


● filterBarWidget?: Widget


● localeWidget?: Widget


● processWidget?: Widget


● queryNameWidget?: Widget


● queryPanelWidget?: Widget


● resultCountSlot?: HTMLElement


● resultFacetPanelWidget?: Widget


● resultGridWidget?: Widget


● resultOptions: EqResultOptions


● resultPanelSlot?: HTMLElement


● sortingBarWidget?: Widget


● statementPanelWidget?: Widget


● statementWidget?: Widget



▸ detach(): void

Returns void


▸ executeQuery(options?: any): void

  • options: any, Optional

Returns void


Fetches the data according to the query and other options defined in the context.

▸ fetchData(options?: any): void

  • options: any, Optional - The options.

Returns void


▸ getContext(): EqContext

Returns EqContext


▸ init(options?: EqViewOptions): void

Returns void


Loads report by ID.

▸ loadReport(reportId: string): void

  • reportId: string - The ID of the report to load.

Returns void


Creates a new report.

▸ newReport(): void

Returns void


Removes current report.

▸ removeCurrentReport(): void

Returns void


Renders the list of reports.

▸ renderReportList(options?: any): void

  • options: any, Optional - The options. In particular, options.reportIndex defines which report should be active.

Returns void


Renders current report.

▸ renderReportProps(): void

Returns void


Shows the dialog to save the report with new name.

▸ saveCurrentReportAs(): void

Returns void


Sets active report.

▸ setActiveReport(reportId: string): void

  • reportId: string - The ID of the report to make active.

Returns void


Sets dialog service for the view

▸ setDialogService(dialogService: DialogService): void

  • dialogService: DialogService - The dialog service.

Returns void


Sends current report’s query to back-end.

▸ syncReport(): void

Returns void



Clears the errors.

▸ clearErrors(): void

Returns void


The handler of the “Clear” button click.

▸ clearReportButtonClick(): void

Returns void


Creates the widget that represents Chart Widget.

▸ createChartWidget(slotElement: HTMLElement): Widget

  • slotElement: HTMLElement

Returns Widget - the created Widget object.


Creates the widget that represents Columns Bar.

▸ createColumnsBarWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Columns Panel.

▸ createColumnsPanelWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Entity Panel.

▸ createEntitiesPanelWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Export funcionality.

▸ createExportWidget(slot: HTMLElement): Widget

  • slot: HTMLElement -

Returns Widget


Creates the widget that represents Filter Bar.

▸ createFilterBarWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Locale Widget.

▸ createLocaleWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Process Widget.

▸ createProcessWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Query Name Widget.

▸ createQueryNameWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Query Panel.

▸ createQueryPanelWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Result Facets Panel Widget.

▸ createResultFacetsPanel(slot: HTMLElement): Widget

  • slot: HTMLElement -

Returns Widget


Creates the widget that represents Grid Widget.

▸ createResultGridWidget(slotElement: HTMLElement): Widget

  • slotElement: HTMLElement

Returns Widget - the created Widget object.


Creates the widget that represents Sorting Bar.

▸ createSortingBarWidget(slot: HTMLElement): Widget

  • slot: HTMLElement - The HTMLElement to place the created widget in.

Returns Widget - the created Widget object.


Creates the widget that represents Statement Panel Widget.

▸ createStatementPanelWidget(slot: HTMLElement): Widget

  • slot: HTMLElement -

Returns Widget


Disables export buttons.

▸ disableExportButtons(): void

Returns void


Shows records count.

▸ displayRecordsCount(count: number): void

  • count: number - The value to show.

Returns void


Enables export buttons.

▸ enableExportButtons(): void

Returns void


The handler of errors.

▸ errorHandler(error: any): void

  • error: any - The error object.

Returns void


Gets the report content from cache.

▸ getReportContentFromCache(report: Report): string | null

  • report: Report - The report.

Returns string | null - Content of the report (Query in JSOn string)


Hides export buttons.

▸ hideExportButtons(): void

Returns void


▸ hideResultSpinner(): void

Returns void


▸ initDone(): void

Returns void


▸ initOptions(options?: ReportViewOptions): ReportViewOptions

Returns ReportViewOptions


▸ initWidgets(options?: ReportViewOptions): void

Returns void


Inserts the report to the list of reports.

▸ insertIntoReportList(report: Report): void

  • report: Report - The [[Report]] object to be inserted.

Returns void


The handler of the “Load” button click.

▸ loadReportButtonClick(): void

Returns void


The handler of the “New” button click.

▸ newReportButtonClick(): void

Returns void


Removes the report from the list of reports.

▸ removeFromReportList(reportId: string): number

  • reportId: string - The ID of the report to be removed.

Returns number - the index of removed report.


The handler of the “Remove” button click.

▸ removeReportButtonClick(): void

Returns void


Renders a single item in the list of reports.

▸ renderReportItemInList(report: Report,ul: HTMLUListElement): void

  • report: Report - The [[Report]] object to render.
  • ul: HTMLUListElement - The [[HTMLUListElement]] to add the item to.

Returns void


Renders report panels.

▸ renderReportPanels(): void

Returns void


▸ resolveElement(elementOrId: string | HTMLElement): HTMLElement

  • elementOrId: string | HTMLElement

Returns HTMLElement


▸ resolveElementsByClassName(className: string): Element[]

  • className: string

Returns Element[]


The handler of the “Save” button click.

▸ saveReportButtonClick(): void

Returns void


Saves reports content to the cache.

▸ saveReportContentInCache(report: Report,content: string): void

  • report: Report - The report.
  • content: string - The content (Query serialized into JSON).

Returns void


Shows export buttons.

▸ showExportButtons(): void

Returns void


▸ showResultSpinner(): void

Returns void


▸ toggleExportButtons(): void

Returns void


The handler of the “Update” button click.

▸ updateReportButtonClick(): void

Returns void