AdvancedSearchView class
The EasyQuery client-side view that represents the UI for advanced search page
- createColumnsPanelWidget
- createDefaultBroker
- createDefaultChartProvider
- createEntitiesPanelWidget
- createQueryPanelWidget
- disableExportButtons
- displayRecordsCount
- enableExportButtons
- hideExportButtons
Public Properties
Section titled “Public Properties”context
Section titled “context”● context: EqContext = new EqContext()
Protected Properties
Section titled “Protected Properties”disabledClass
Section titled “disabledClass”Name of the class to add to disabled elements.
● disabledClass: string
= "eqjs-disabled"
Public Methods
Section titled “Public Methods”buildAndExecute
Section titled “buildAndExecute”Builds and executes current query.
▸ buildAndExecute(options?: any
): void
Parameters:
Section titled “Parameters:”- options:
any
, Optional - The options. In particular,options.page
defines what page of data to query.
Returns void
getContext
Section titled “getContext”Returns the context.
▸ getContext(): EqContext
Returns EqContext - [[EqContext]] object.
Initializes the view.
▸ init(options?: EqViewOptions): void
Parameters:
Section titled “Parameters:”- options: EqViewOptions, Optional - The [[EqViewOptions]] object.
Returns void
syncQuery
Section titled “syncQuery”Sends current query to back-end.
▸ syncQuery(): void
Returns void
Protected Methods
Section titled “Protected Methods”createColumnsPanelWidget
Section titled “createColumnsPanelWidget”Creates the widget that represents Columns Panel.
▸ createColumnsPanelWidget(placeholderElement: HTMLElement
): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
HTMLElement
- The [[HTMLElement]] to place the created widget in.
Returns Widget - the created [[Widget]] object.
createDefaultBroker
Section titled “createDefaultBroker”Creates the default broker for the view.
▸ createDefaultBroker(context: EqContext): EqBroker
Parameters:
Section titled “Parameters:”- context: EqContext - The [[EqContext]] object.
Returns EqBroker - the created [[EqBroker]] object.
createDefaultChartProvider
Section titled “createDefaultChartProvider”Creates the default chart provider for the view.
▸ createDefaultChartProvider(): ChartProvider
Returns ChartProvider - the created [[ChartProvider]] object.
createEntitiesPanelWidget
Section titled “createEntitiesPanelWidget”Creates the widget that represents Entity Panel.
▸ createEntitiesPanelWidget(placeholderElement: HTMLElement
): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
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(placeholderElement: HTMLElement
): Widget
Parameters:
Section titled “Parameters:”- placeholderElement:
HTMLElement
- The [[HTMLElement]] to place the created widget in.
Returns Widget - the created [[Widget]] object.
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
hideExportButtons
Section titled “hideExportButtons”Hides export buttons.
▸ hideExportButtons(): void
Returns void