AdvancedSearchView class
The EasyQuery client-side view that represents the UI for advanced search page
Extends
Section titled “Extends”- 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
- checkIfQueryModified
- detach
- executeQuery
- fetchData
- getContext
- init
- loadQuery
- setDialogService
- showLoadQueryFromFileDialog
- syncQuery
- 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
Section titled “Constructors”constructor
Section titled “constructor”⊕ new AdvancedSearchView(): AdvancedSearchView
Protected Properties
Section titled “Protected Properties”chartWidget
Section titled “chartWidget”● chartWidget?: Widget
clearQueryButton
Section titled “clearQueryButton”● clearQueryButton: HTMLElement
columnsBarWidget
Section titled “columnsBarWidget”● columnsBarWidget?: Widget
columnsPanelWidget
Section titled “columnsPanelWidget”● columnsPanelWidget?: Widget
context
Section titled “context”● context: EqContext
copyQueryButton
Section titled “copyQueryButton”● copyQueryButton: HTMLElement
disabledClass
Section titled “disabledClass”● disabledClass: string = "eqjs-disabled"
domRoots
Section titled “domRoots”● domRoots: Array<Document | ShadowRoot> = [ document ]
dropdownButtonClass
Section titled “dropdownButtonClass”● dropdownButtonClass: string = "eqv-drop-button"
dropdownContainerClass
Section titled “dropdownContainerClass”● dropdownContainerClass: string = "eqv-dropdown-container"
dropdownContentClass
Section titled “dropdownContentClass”● dropdownContentClass: string = "eqv-dropdown-content"
dropdownShowClass
Section titled “dropdownShowClass”● dropdownShowClass: string = "eqv-dropdown-show"
enableExport
Section titled “enableExport”● enableExport: boolean = false
entitiesPanelWidget
Section titled “entitiesPanelWidget”● entitiesPanelWidget?: Widget
exportButtons
Section titled “exportButtons”● exportButtons: HTMLElement[] = []
exportWidget
Section titled “exportWidget”● exportWidget?: Widget
fetchDataButton
Section titled “fetchDataButton”● fetchDataButton: HTMLElement
filterBarWidget
Section titled “filterBarWidget”● filterBarWidget?: Widget
loadQueryButton
Section titled “loadQueryButton”● loadQueryButton: HTMLElement
loadQueryFromFileButton
Section titled “loadQueryFromFileButton”● loadQueryFromFileButton: HTMLElement
loadQueryFromFileInput
Section titled “loadQueryFromFileInput”● loadQueryFromFileInput: HTMLInputElement
localeWidget
Section titled “localeWidget”● localeWidget?: Widget
newQueryButton
Section titled “newQueryButton”● newQueryButton: HTMLElement
processWidget
Section titled “processWidget”● processWidget?: Widget
queryListPanel
Section titled “queryListPanel”● queryListPanel: HTMLElement
queryListSelector
Section titled “queryListSelector”● queryListSelector: HTMLSelectElement
queryNameLabel
Section titled “queryNameLabel”● queryNameLabel: HTMLElement
queryNameWidget
Section titled “queryNameWidget”● queryNameWidget?: Widget
queryPanelWidget
Section titled “queryPanelWidget”● queryPanelWidget?: Widget
removeQueryButton
Section titled “removeQueryButton”● removeQueryButton: HTMLElement
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
saveQueryButton
Section titled “saveQueryButton”● saveQueryButton: HTMLElement
saveQueryToFileButton
Section titled “saveQueryToFileButton”● saveQueryToFileButton: HTMLElement
sortingBarWidget
Section titled “sortingBarWidget”● sortingBarWidget?: Widget
statementPanelWidget
Section titled “statementPanelWidget”● statementPanelWidget?: Widget
statementWidget
Section titled “statementWidget”● statementWidget?: Widget
storageDropButton
Section titled “storageDropButton”● storageDropButton: HTMLElement
Public Methods
Section titled “Public Methods”checkIfQueryModified
Section titled “checkIfQueryModified”▸ checkIfQueryModified(callback: any): void
Parameters:
Section titled “Parameters:”- callback:
any
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”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
loadQuery
Section titled “loadQuery”▸ loadQuery(queryId: string): void
Parameters:
Section titled “Parameters:”- queryId:
string
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
showLoadQueryFromFileDialog
Section titled “showLoadQueryFromFileDialog”▸ showLoadQueryFromFileDialog(): void
Returns void
syncQuery
Section titled “syncQuery”Sends current query to the backend.
▸ syncQuery(): void
Returns void
Protected Methods
Section titled “Protected Methods”clearQueryButtonClick
Section titled “clearQueryButtonClick”▸ clearQueryButtonClick(): void
Returns void
copyQueryButtonClick
Section titled “copyQueryButtonClick”▸ copyQueryButtonClick(): 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.
createNewQuery
Section titled “createNewQuery”▸ createNewQuery(options?: ContextNewQueryOptions): Query
Parameters:
Section titled “Parameters:”- options: ContextNewQueryOptions, Optional
Returns Query
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
fetchDataButtonClick
Section titled “fetchDataButtonClick”▸ fetchDataButtonClick(): void
Returns void
fillLoadQueryButtonMenu
Section titled “fillLoadQueryButtonMenu”▸ fillLoadQueryButtonMenu(queryList: any): void
Parameters:
Section titled “Parameters:”- queryList:
any
Returns void
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?: 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
loadQueryButtonClick
Section titled “loadQueryButtonClick”▸ loadQueryButtonClick(): void
Returns void
loadQueryFromFileButtonClick
Section titled “loadQueryFromFileButtonClick”▸ loadQueryFromFileButtonClick(): void
Returns void
loadQueryFromFileInputSelect
Section titled “loadQueryFromFileInputSelect”▸ loadQueryFromFileInputSelect(): void
Returns void
newQueryButtonClick
Section titled “newQueryButtonClick”▸ newQueryButtonClick(): void
Returns void
refreshQueryList
Section titled “refreshQueryList”▸ refreshQueryList(): void
Returns void
removeCurrentQuery
Section titled “removeCurrentQuery”▸ removeCurrentQuery(): void
Returns void
removeQueryButtonClick
Section titled “removeQueryButtonClick”▸ removeQueryButtonClick(): void
Returns void
renderSaveToFileDialogBody
Section titled “renderSaveToFileDialogBody”▸ renderSaveToFileDialogBody(name: string,format?: string): HTMLElement
Parameters:
Section titled “Parameters:”- name:
string - format:
string, Default value ="json"
Returns HTMLElement
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[]
saveCurrentQuery
Section titled “saveCurrentQuery”▸ saveCurrentQuery(copyQuery?: boolean,callback?: any): void
Parameters:
Section titled “Parameters:”- copyQuery:
boolean, Default value =false - callback:
any, Optional
Returns void
saveQuery
Section titled “saveQuery”▸ saveQuery(success: any,error?: any): void
Parameters:
Section titled “Parameters:”- success:
any - error:
any, Optional
Returns void
saveQueryButtonClick
Section titled “saveQueryButtonClick”▸ saveQueryButtonClick(): void
Returns void
saveQueryToFileButtonClick
Section titled “saveQueryToFileButtonClick”▸ saveQueryToFileButtonClick(): void
Returns void
showNewQueryDialog
Section titled “showNewQueryDialog”▸ showNewQueryDialog(callback: (result: string) => Promise<DlgCallbackResult>): void
Parameters:
Section titled “Parameters:”- callback: (result:
string) =>Promise<DlgCallbackResult>
Returns void
showQueryChangedDialog
Section titled “showQueryChangedDialog”▸ showQueryChangedDialog(callback: (result: boolean) => void): void
Parameters:
Section titled “Parameters:”- callback: (result:
boolean) =>void
Returns void
showRemoveQueryDialog
Section titled “showRemoveQueryDialog”▸ showRemoveQueryDialog(callback: (result: boolean) => void): void
Parameters:
Section titled “Parameters:”- callback: (result:
boolean) =>void
Returns void
showResultSpinner
Section titled “showResultSpinner”▸ showResultSpinner(): void
Returns void
showSaveQueryDialog
Section titled “showSaveQueryDialog”▸ showSaveQueryDialog(callback: (result: string) => Promise<DlgCallbackResult>): void
Parameters:
Section titled “Parameters:”- callback: (result:
string) =>Promise<DlgCallbackResult>
Returns void
showSaveQueryToFileDialog
Section titled “showSaveQueryToFileDialog”▸ showSaveQueryToFileDialog(callback: (fileName: string, format: string) => Promise<DlgCallbackResult>): void
Parameters:
Section titled “Parameters:”- callback: (fileName:
string, format:string) =>Promise<DlgCallbackResult>
Returns void
storageDropButtonClick
Section titled “storageDropButtonClick”▸ storageDropButtonClick(): void
Returns void
toggleExportButtons
Section titled “toggleExportButtons”▸ toggleExportButtons(): void
Returns void