DataFilterView class
The view that represents a data-filtering scenario (a text search for one entity/table)
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
- createChartWidget
- createColumnsBarWidget
- createColumnsPanelWidget
- createEntitiesPanelWidget
- createExportWidget
- createFilterBarWidget
- createLocaleWidget
- createProcessWidget
- createQueryNameWidget
- createQueryPanelWidget
- createResultFacetsPanel
- createResultGridWidget
- createSortingBarWidget
- createStatementPanelWidget
- disableExportButtons
- displayRecordsCount
- enableExportButtons
- hideResultSpinner
- initDone
- initOptions
- initWidgets
- resolveElement
- resolveElementsByClassName
- showResultSpinner
- toggleExportButtons
Constructors
Section titled “Constructors”constructor
Section titled “constructor”⊕ new DataFilterView(): DataFilterView
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”applyQueryFilter
Section titled “applyQueryFilter”Obsolete. Left for backward compatibility. Use fetchData() instead
▸ applyQueryFilter(): void
Returns void
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”▸ fetchData(): void
Returns void
getContext
Section titled “getContext”▸ getContext(): EqContext
Returns EqContext
▸ init(options?: EqViewOptions): void
Parameters:
Section titled “Parameters:”- options: EqViewOptions, Optional
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
Protected Methods
Section titled “Protected Methods”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”▸ 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”▸ enableExportButtons(): 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?: EqViewOptions): EqViewOptions
Parameters:
Section titled “Parameters:”- options: EqViewOptions, Optional
Returns EqViewOptions
initWidgets
Section titled “initWidgets”▸ initWidgets(options?: EqViewOptions): void
Parameters:
Section titled “Parameters:”- options: EqViewOptions, Optional
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[]
showResultSpinner
Section titled “showResultSpinner”▸ showResultSpinner(): void
Returns void
toggleExportButtons
Section titled “toggleExportButtons”▸ toggleExportButtons(): void
Returns void