HtmlDataFilterView class

The EasyQuery client-side view that represents the UI for data filtering page

Extends

DataFilterView

Index

Constructors

Protected Properties

Public Methods

Protected Methods

Constructors


constructor

⊕ new HtmlDataFilterView(): HtmlDataFilterView


Protected Properties


chartWidget

● chartWidget?: Widget


columnsBarWidget

● columnsBarWidget?: Widget


columnsPanelWidget

● columnsPanelWidget?: Widget


context

● context: EqContext


domRoots

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


enableExport

● enableExport: boolean = false


entitiesPanelWidget

● entitiesPanelWidget?: Widget


exportWidget

● exportWidget?: Widget


filterBarWidget

● filterBarWidget?: Widget


localeWidget

● localeWidget?: Widget


processWidget

● processWidget?: Widget


queryNameWidget

● queryNameWidget?: Widget


queryPanelWidget

● queryPanelWidget?: Widget


resultCountSlot

● resultCountSlot?: HTMLElement


resultFacetPanelWidget

● resultFacetPanelWidget?: Widget


resultGridWidget

● resultGridWidget?: Widget


resultOptions

● resultOptions: EqResultOptions


resultPanelSlot

● resultPanelSlot?: HTMLElement


sortingBarWidget

● sortingBarWidget?: Widget


statementPanelWidget

● statementPanelWidget?: Widget


statementWidget

● statementWidget?: Widget


Public Methods


applyQueryFilter

Obsolete. Left for backward compatibility. Use fetchData() instead

▸ applyQueryFilter(): void

Returns void


detach

▸ detach(): void

Returns void


executeQuery

▸ executeQuery(options?: any): void

Parameters:

  • options: any, Optional

Returns void


fetchData

▸ fetchData(): void

Returns void


getContext

▸ getContext(): EqContext

Returns EqContext


init

▸ init(options?: EqViewOptions): void

Parameters:

Returns void


setDialogService

Sets dialog service for the view

▸ setDialogService(dialogService: DialogService): void

Parameters:

  • dialogService: DialogService - The dialog service.

Returns void


Protected Methods


createChartWidget

Creates the widget that represents Chart Widget.

▸ createChartWidget(slotElement: HTMLElement): Widget

Parameters:

  • slotElement: HTMLElement

Returns Widget - the created Widget object.


createColumnsBarWidget

Creates the widget that represents Columns Bar.

▸ createColumnsBarWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createColumnsPanelWidget

Creates the widget that represents Columns Panel.

▸ createColumnsPanelWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createEntitiesPanelWidget

Creates the widget that represents Entity Panel.

▸ createEntitiesPanelWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createExportWidget

Creates the widget that represents Export funcionality.

▸ createExportWidget(slot: HTMLElement): Widget

Parameters:

  • slot: HTMLElement -

Returns Widget


createFilterBarWidget

Creates the widget that represents Filter Bar.

▸ createFilterBarWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createLocaleWidget

Creates the widget that represents Locale Widget.

▸ createLocaleWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createProcessWidget

Creates the widget that represents Process Widget.

▸ createProcessWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createQueryNameWidget

Creates the widget that represents Query Name Widget.

▸ createQueryNameWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createQueryPanelWidget

Creates the widget that represents Query Panel.

▸ createQueryPanelWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createResultFacetsPanel

Creates the widget that represents Result Facets Panel Widget.

▸ createResultFacetsPanel(slot: HTMLElement): Widget

Parameters:

  • slot: HTMLElement -

Returns Widget


createResultGridWidget

Creates the widget that represents Grid Widget.

▸ createResultGridWidget(element: HTMLElement): Widget

Parameters:

  • element: HTMLElement

Returns Widget - the created Widget object.


createSortingBarWidget

Creates the widget that represents Sorting Bar.

▸ createSortingBarWidget(slot: HTMLElement): Widget

Parameters:

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

Returns Widget - the created Widget object.


createStatementPanelWidget

Creates the widget that represents Statement Panel Widget.

▸ createStatementPanelWidget(slot: HTMLElement): Widget

Parameters:

  • slot: HTMLElement -

Returns Widget


disableExportButtons

▸ disableExportButtons(): void

Returns void


displayRecordsCount

Shows records count.

▸ displayRecordsCount(count: number): void

Parameters:

  • count: number - The value to show.

Returns void


enableExportButtons

▸ enableExportButtons(): void

Returns void


hideResultSpinner

▸ hideResultSpinner(): void

Returns void


initDone

▸ initDone(): void

Returns void


initOptions

▸ initOptions(options?: EqViewOptions): EqViewOptions

Parameters:

Returns EqViewOptions


initWidgets

▸ initWidgets(options?: EqViewOptions): void

Parameters:

Returns void


resolveElement

▸ resolveElement(elementOrId: string | HTMLElement): HTMLElement

Parameters:

  • elementOrId: string | HTMLElement

Returns HTMLElement


resolveElementsByClassName

▸ resolveElementsByClassName(className: string): Element[]

Parameters:

  • className: string

Returns Element[]


showResultSpinner

▸ showResultSpinner(): void

Returns void


toggleExportButtons

▸ toggleExportButtons(): void

Returns void