AdvancedSearchView class

The EasyQuery client-side view that represents the UI for advanced search page

Extends

View

Index

Constructors

• constructor

Protected Properties

• chartWidget
• clearQueryButton
• columnsBarWidget
• columnsPanelWidget
• context
• copyQueryButton
• disabledClass
• domRoots
• dropdownButtonClass
• dropdownContainerClass
• dropdownContentClass
• dropdownShowClass
• enableExport
• entitiesPanelWidget
• exportButtons
• exportWidget
• fetchDataButton
• filterBarWidget
• loadQueryButton
• loadQueryFromFileButton
• loadQueryFromFileInput
• localeWidget
• newQueryButton
• processWidget
• queryListPanel
• queryListSelector
• queryNameLabel
• queryNameWidget
• queryPanelWidget
• removeQueryButton
• resultCountSlot
• resultFacetPanelWidget
• resultGridWidget
• resultOptions
• resultPanelSlot
• saveQueryButton
• saveQueryToFileButton
• sortingBarWidget
• statementPanelWidget
• statementWidget
• storageDropButton

Public Methods

• checkIfQueryModified
• detach
• executeQuery
• fetchData
• getContext
• init
• loadQuery
• setDialogService
• showLoadQueryFromFileDialog
• syncQuery

Protected Methods

• clearQueryButtonClick
• copyQueryButtonClick
• createChartWidget
• createColumnsBarWidget
• createColumnsPanelWidget
• createEntitiesPanelWidget
• createExportWidget
• createFilterBarWidget
• createLocaleWidget
• createNewQuery
• createProcessWidget
• createQueryNameWidget
• createQueryPanelWidget
• createResultFacetsPanel
• createResultGridWidget
• createSortingBarWidget
• createStatementPanelWidget
• disableExportButtons
• displayRecordsCount
• enableExportButtons
• fetchDataButtonClick
• fillLoadQueryButtonMenu
• hideExportButtons
• hideResultSpinner
• initDone
• initOptions
• initWidgets
• loadQueryButtonClick
• loadQueryFromFileButtonClick
• loadQueryFromFileInputSelect
• newQueryButtonClick
• refreshQueryList
• removeCurrentQuery
• removeQueryButtonClick
• renderSaveToFileDialogBody
• resolveElement
• resolveElementsByClassName
• saveCurrentQuery
• saveQuery
• saveQueryButtonClick
• saveQueryToFileButtonClick
• showNewQueryDialog
• showQueryChangedDialog
• showRemoveQueryDialog
• showResultSpinner
• showSaveQueryDialog
• showSaveQueryToFileDialog
• storageDropButtonClick
• toggleExportButtons

Constructors

---

constructor

⊕ new AdvancedSearchView(): AdvancedSearchView

---

Protected Properties

---

chartWidget

● chartWidget?: Widget

---

clearQueryButton

● clearQueryButton: HTMLElement

---

columnsBarWidget

● columnsBarWidget?: Widget

---

columnsPanelWidget

● columnsPanelWidget?: Widget

---

context

● context: EqContext

---

copyQueryButton

● copyQueryButton: HTMLElement

---

disabledClass

● disabledClass: string = "eqjs-disabled"

---

domRoots

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

---

dropdownButtonClass

● dropdownButtonClass: string = "eqv-drop-button"

---

dropdownContainerClass

● dropdownContainerClass: string = "eqv-dropdown-container"

---

dropdownContentClass

● dropdownContentClass: string = "eqv-dropdown-content"

---

dropdownShowClass

● dropdownShowClass: string = "eqv-dropdown-show"

---

enableExport

● enableExport: boolean = false

---

entitiesPanelWidget

● entitiesPanelWidget?: Widget

---

exportButtons

● exportButtons: HTMLElement[] = []

---

exportWidget

● exportWidget?: Widget

---

fetchDataButton

● fetchDataButton: HTMLElement

---

filterBarWidget

● filterBarWidget?: Widget

---

loadQueryButton

● loadQueryButton: HTMLElement

---

loadQueryFromFileButton

● loadQueryFromFileButton: HTMLElement

---

loadQueryFromFileInput

● loadQueryFromFileInput: HTMLInputElement

---

localeWidget

● localeWidget?: Widget

---

newQueryButton

● newQueryButton: HTMLElement

---

processWidget

● processWidget?: Widget

---

queryListPanel

● queryListPanel: HTMLElement

---

queryListSelector

● queryListSelector: HTMLSelectElement

---

queryNameLabel

● queryNameLabel: HTMLElement

---

queryNameWidget

● queryNameWidget?: Widget

---

queryPanelWidget

● queryPanelWidget?: Widget

---

removeQueryButton

● removeQueryButton: HTMLElement

---

resultCountSlot

● resultCountSlot?: HTMLElement

---

resultFacetPanelWidget

● resultFacetPanelWidget?: Widget

---

resultGridWidget

● resultGridWidget?: Widget

---

resultOptions

● resultOptions: EqResultOptions

---

resultPanelSlot

● resultPanelSlot?: HTMLElement

---

saveQueryButton

● saveQueryButton: HTMLElement

---

saveQueryToFileButton

● saveQueryToFileButton: HTMLElement

---

sortingBarWidget

● sortingBarWidget?: Widget

---

statementPanelWidget

● statementPanelWidget?: Widget

---

statementWidget

● statementWidget?: Widget

---

storageDropButton

● storageDropButton: HTMLElement

---

Public Methods

---

checkIfQueryModified

▸ checkIfQueryModified(callback: any): void

Parameters:

• callback: any

Returns void

---

detach

▸ detach(): void

Returns void

---

executeQuery

▸ executeQuery(options?: any): void

Parameters:

• options: any, Optional

Returns void

---

fetchData

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

▸ fetchData(options?: any): void

Parameters:

• options: any, Optional - The options.

Returns void

---

getContext

▸ getContext(): EqContext

Returns EqContext

---

init

▸ init(options?: EqViewOptions): void

Parameters:

• options: EqViewOptions, Optional

Returns void

---

loadQuery

▸ loadQuery(queryId: string): void

Parameters:

• queryId: string

Returns void

---

setDialogService

Sets dialog service for the view

▸ setDialogService(dialogService: DialogService): void

Parameters:

• dialogService: DialogService - The dialog service.

Returns void

---

showLoadQueryFromFileDialog

▸ showLoadQueryFromFileDialog(): void

Returns void

---

syncQuery

Sends current query to the backend.

▸ syncQuery(): void

Returns void

---

Protected Methods

---

clearQueryButtonClick

▸ clearQueryButtonClick(): void

Returns void

---

copyQueryButtonClick

▸ copyQueryButtonClick(): void

Returns void

---

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.

---

createNewQuery

▸ createNewQuery(options?: ContextNewQueryOptions): Query

Parameters:

• options: ContextNewQueryOptions, Optional

Returns Query

---

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(slotElement: HTMLElement): Widget

Parameters:

• slotElement: 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

Disables export buttons.

▸ disableExportButtons(): void

Returns void

---

displayRecordsCount

Shows records count.

▸ displayRecordsCount(count: number): void

Parameters:

• count: number - The value to show.

Returns void

---

enableExportButtons

Enables export buttons.

▸ enableExportButtons(): void

Returns void

---

fetchDataButtonClick

▸ fetchDataButtonClick(): void

Returns void

---

fillLoadQueryButtonMenu

▸ fillLoadQueryButtonMenu(queryList: any): void

Parameters:

• queryList: any

Returns void

---

hideExportButtons

Hides export buttons.

▸ hideExportButtons(): void

Returns void

---

hideResultSpinner

▸ hideResultSpinner(): void

Returns void

---

initDone

▸ initDone(): void

Returns void

---

initOptions

▸ initOptions(options?: EqViewOptions): EqViewOptions

Parameters:

• options: EqViewOptions, Optional

Returns EqViewOptions

---

initWidgets

▸ initWidgets(options?: EqViewOptions): void

Parameters:

• options: EqViewOptions, Optional

Returns void

---

loadQueryButtonClick

▸ loadQueryButtonClick(): void

Returns void

---

loadQueryFromFileButtonClick

▸ loadQueryFromFileButtonClick(): void

Returns void

---

loadQueryFromFileInputSelect

▸ loadQueryFromFileInputSelect(): void

Returns void

---

newQueryButtonClick

▸ newQueryButtonClick(): void

Returns void

---

refreshQueryList

▸ refreshQueryList(): void

Returns void

---

removeCurrentQuery

▸ removeCurrentQuery(): void

Returns void

---

removeQueryButtonClick

▸ removeQueryButtonClick(): void

Returns void

---

renderSaveToFileDialogBody

▸ renderSaveToFileDialogBody(name: string,format?: string): HTMLElement

Parameters:

• name: string
• format: string, Default value = "json"

Returns HTMLElement

---

resolveElement

▸ resolveElement(elementOrId: string | HTMLElement): HTMLElement

Parameters:

• elementOrId: string | HTMLElement

Returns HTMLElement

---

resolveElementsByClassName

▸ resolveElementsByClassName(className: string): Element[]

Parameters:

• className: string

Returns Element[]

---

saveCurrentQuery

▸ saveCurrentQuery(copyQuery?: boolean,callback?: any): void

Parameters:

• copyQuery: boolean, Default value = false
• callback: any, Optional

Returns void

---

saveQuery

▸ saveQuery(success: any,error?: any): void

Parameters:

• success: any
• error: any, Optional

Returns void

---

saveQueryButtonClick

▸ saveQueryButtonClick(): void

Returns void

---

saveQueryToFileButtonClick

▸ saveQueryToFileButtonClick(): void

Returns void

---

showNewQueryDialog

▸ showNewQueryDialog(callback: (result: string) => Promise<DlgCallbackResult>): void

Parameters:

• callback: (result: string) => Promise<DlgCallbackResult>

Returns void

---

showQueryChangedDialog

▸ showQueryChangedDialog(callback: (result: boolean) => void): void

Parameters:

• callback: (result: boolean) => void

Returns void

---

showRemoveQueryDialog

▸ showRemoveQueryDialog(callback: (result: boolean) => void): void

Parameters:

• callback: (result: boolean) => void

Returns void

---

showResultSpinner

▸ showResultSpinner(): void

Returns void

---

showSaveQueryDialog

▸ showSaveQueryDialog(callback: (result: string) => Promise<DlgCallbackResult>): void

Parameters:

• callback: (result: string) => Promise<DlgCallbackResult>

Returns void

---

showSaveQueryToFileDialog

▸ showSaveQueryToFileDialog(callback: (fileName: string, format: string) => Promise<DlgCallbackResult>): void

Parameters:

• callback: (fileName: string, format: string) => Promise<DlgCallbackResult>

Returns void

---

storageDropButtonClick

▸ storageDropButtonClick(): void

Returns void

---

toggleExportButtons

▸ toggleExportButtons(): void

Returns void

---