Constructor
new Search(options)
To create an instance, use method App.searchV2.createSearch
Parameters:
| Name | Type | Description |
|---|---|---|
options |
options |
Methods
(static) createSearch()
Factory method
(static) getSearch(config) → {*}
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Returns:
- Type
- *
(static) startSearch(input)
Parameters:
| Name | Type | Description |
|---|---|---|
input |
addToolbarExportItem()
Adds command to export search to search panel toolbar
applyCustomization()
Applies customization associated with search on search options. Keeps search panel open or close.
close()
destroy()
getCriteriaAsQueryString() → {string}
Returns criteria in form of query string
Returns:
- Type
- string
getHomePage() → {Object}
Return homepage for this search config, this will used to launch direct search with homepage in the background
Returns:
- Type
- Object
getQuery() → {Object}
Returns:
- Type
- Object
getSearchAsUrl()
Returns current search criteria as search url
getSearchLimit(searchForm) → {*|number}
Returns the search limit, if its empty then returns the default search limit
Parameters:
| Name | Type | Description |
|---|---|---|
searchForm |
Returns:
- Type
- * | number
getTerm() → {Object}
Returns:
- Type
- Object
initializeSearchBaseUrl()
Initialize base url for this search config, this will be used to prepare search url used for export.
isExternalSearch() → {boolean}
Returns:
- Type
- boolean
isOpen() → {boolean}
Returns:
- Type
- boolean
off(event, handler)
Parameters:
| Name | Type | Description |
|---|---|---|
event |
||
handler |
on()
Events
open()
search(force)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
force |
false
|
setCriteria(criteria)
Parameters:
| Name | Type | Description |
|---|---|---|
criteria |
Array | Array of search criterion objects |
setCriteriaAsQueryParams(queryParams)
Parameters:
| Name | Type | Description |
|---|---|---|
queryParams |
Array | Array of search criterion objects |
setTerm(term)
Parameters:
| Name | Type | Description |
|---|---|---|
term |