ReportViewJQuery class
Extends
Section titled “Extends”- chartWidget
- columnsBarWidget
- columnsPanelWidget
- context
- domRoots
- enableExport
- entitiesPanelWidget
- exportWidget
- filterBarWidget
- localeWidget
- processWidget
- queryNameWidget
- queryPanelWidget
- resultCountSlot
- resultFacetPanelWidget
- resultGridWidget
- resultOptions
- resultPanelSlot
- sortingBarWidget
- statementPanelWidget
- statementWidget
- detach
- executeQuery
- fetchData
- getContext
- init
- loadReport
- newReport
- removeCurrentReport
- renderReportList
- renderReportProps
- saveCurrentReportAs
- setActiveReport
- setDialogService
- syncReport
- clearErrors
- clearReportButtonClick
- createChartWidget
- createColumnsBarWidget
- createColumnsPanelWidget
- createEntitiesPanelWidget
- createExportWidget
- createFilterBarWidget
- createLocaleWidget
- createProcessWidget
- createQueryNameWidget
- createQueryPanelWidget
- createResultFacetsPanel
- createResultGridWidget
- createSortingBarWidget
- createStatementPanelWidget
- disableExportButtons
- displayRecordsCount
- enableExportButtons
- errorHandler
- getReportContentFromCache
- hideExportButtons
- hideResultSpinner
- initDone
- initOptions
- initWidgets
- insertIntoReportList
- loadReportButtonClick
- newReportButtonClick
- removeFromReportList
- removeReportButtonClick
- renderReportItemInList
- renderReportPanels
- resolveElement
- resolveElementsByClassName
- saveReportButtonClick
- saveReportContentInCache
- showExportButtons
- showResultSpinner
- toggleExportButtons
- updateReportButtonClick
Constructors
Section titled “Constructors”constructor
Section titled “constructor”⊕ new ReportViewJQuery(): ReportViewJQuery
Protected Properties
Section titled “Protected Properties”chartWidget
Section titled “chartWidget”● chartWidget?: Widget
columnsBarWidget
Section titled “columnsBarWidget”● columnsBarWidget?: Widget
columnsPanelWidget
Section titled “columnsPanelWidget”● columnsPanelWidget?: Widget
context
Section titled “context”● context: EqContext
domRoots
Section titled “domRoots”● domRoots: Array<Document | ShadowRoot> = [ document ]
enableExport
Section titled “enableExport”● enableExport: boolean = false
entitiesPanelWidget
Section titled “entitiesPanelWidget”● entitiesPanelWidget?: Widget
exportWidget
Section titled “exportWidget”● exportWidget?: Widget
filterBarWidget
Section titled “filterBarWidget”● filterBarWidget?: Widget
localeWidget
Section titled “localeWidget”● localeWidget?: Widget
processWidget
Section titled “processWidget”● processWidget?: Widget
queryNameWidget
Section titled “queryNameWidget”● queryNameWidget?: Widget
queryPanelWidget
Section titled “queryPanelWidget”● queryPanelWidget?: Widget
resultCountSlot
Section titled “resultCountSlot”● resultCountSlot?: HTMLElement
resultFacetPanelWidget
Section titled “resultFacetPanelWidget”● resultFacetPanelWidget?: Widget
resultGridWidget
Section titled “resultGridWidget”● resultGridWidget?: Widget
resultOptions
Section titled “resultOptions”● resultOptions: EqResultOptions
resultPanelSlot
Section titled “resultPanelSlot”● resultPanelSlot?: HTMLElement
sortingBarWidget
Section titled “sortingBarWidget”● sortingBarWidget?: Widget
statementPanelWidget
Section titled “statementPanelWidget”● statementPanelWidget?: Widget
statementWidget
Section titled “statementWidget”● statementWidget?: Widget
Public Methods
Section titled “Public Methods”detach
Section titled “detach”▸ detach(): void
Returns void
executeQuery
Section titled “executeQuery”▸ executeQuery(options?: any): void
Parameters:
Section titled “Parameters:”- options:
any, Optional
Returns void
fetchData
Section titled “fetchData”Fetches the data according to the query and other options defined in the context.
▸ fetchData(options?: any): void
Parameters:
Section titled “Parameters:”- options:
any, Optional - The options.
Returns void
getContext
Section titled “getContext”▸ getContext(): EqContext
Returns EqContext
▸ init(options?: EqViewOptions): void
Parameters:
Section titled “Parameters:”- options: EqViewOptions, Optional
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 a 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
setDialogService
Section titled “setDialogService”Sets dialog service for the view
▸ setDialogService(dialogService: DialogService): void
Parameters:
Section titled “Parameters:”- dialogService:
DialogService- The dialog service.
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”Creates the widget that represents Chart Widget.
▸ createChartWidget(slotElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slotElement:
HTMLElement
Returns Widget - the created Widget object.
createColumnsBarWidget
Section titled “createColumnsBarWidget”Creates the widget that represents Columns Bar.
▸ createColumnsBarWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createColumnsPanelWidget
Section titled “createColumnsPanelWidget”Creates the widget that represents Columns Panel.
▸ createColumnsPanelWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createEntitiesPanelWidget
Section titled “createEntitiesPanelWidget”Creates the widget that represents Entity Panel.
▸ createEntitiesPanelWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createExportWidget
Section titled “createExportWidget”Creates the widget that represents Export funcionality.
▸ createExportWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement-
Returns Widget
createFilterBarWidget
Section titled “createFilterBarWidget”Creates the widget that represents Filter Bar.
▸ createFilterBarWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createLocaleWidget
Section titled “createLocaleWidget”Creates the widget that represents Locale Widget.
▸ createLocaleWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createProcessWidget
Section titled “createProcessWidget”Creates the widget that represents Process Widget.
▸ createProcessWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createQueryNameWidget
Section titled “createQueryNameWidget”Creates the widget that represents Query Name Widget.
▸ createQueryNameWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
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(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createResultFacetsPanel
Section titled “createResultFacetsPanel”Creates the widget that represents Result Facets Panel Widget.
▸ createResultFacetsPanel(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement-
Returns Widget
createResultGridWidget
Section titled “createResultGridWidget”Creates the widget that represents Grid Widget.
▸ createResultGridWidget(slotElement: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slotElement:
HTMLElement
Returns Widget - the created Widget object.
createSortingBarWidget
Section titled “createSortingBarWidget”Creates the widget that represents Sorting Bar.
▸ createSortingBarWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The HTMLElement to place the created widget in.
Returns Widget - the created Widget object.
createStatementPanelWidget
Section titled “createStatementPanelWidget”Creates the widget that represents Statement Panel Widget.
▸ createStatementPanelWidget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
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
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
hideResultSpinner
Section titled “hideResultSpinner”▸ hideResultSpinner(): void
Returns void
initDone
Section titled “initDone”▸ initDone(): void
Returns void
initOptions
Section titled “initOptions”▸ initOptions(options?: ReportViewOptions): ReportViewOptions
Parameters:
Section titled “Parameters:”- options: ReportViewOptions, Optional
Returns ReportViewOptions
initWidgets
Section titled “initWidgets”▸ initWidgets(options?: ReportViewOptions): void
Parameters:
Section titled “Parameters:”- options: ReportViewOptions, Optional
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
resolveElement
Section titled “resolveElement”▸ resolveElement(elementOrId: string | HTMLElement): HTMLElement
Parameters:
Section titled “Parameters:”- elementOrId:
string|HTMLElement
Returns HTMLElement
resolveElementsByClassName
Section titled “resolveElementsByClassName”▸ resolveElementsByClassName(className: string): Element[]
Parameters:
Section titled “Parameters:”- className:
string
Returns Element[]
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
showResultSpinner
Section titled “showResultSpinner”▸ showResultSpinner(): void
Returns void
toggleExportButtons
Section titled “toggleExportButtons”▸ toggleExportButtons(): void
Returns void
updateReportButtonClick
Section titled “updateReportButtonClick”The handler of the “Update” button click.
▸ updateReportButtonClick(): void
Returns void