Namespace contract.search
The namespace for the contract interface (to be used by a page builder) for
the search contract. This contract interface allows the pagebuilder to get
the CHIP-specific search keywords. In addition, it can have the CHIP highlight words
in its UI based on the search terms used.
Defined in: search.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
contract.search.fireHighlight(aHighlightWords)
Fires the "highlight" event which takes a string array with the words to
be highlighted as parameters.
|
| <static> |
contract.search.getKeywords()
Returns the CHIP-specific search keywords.
|
Method Detail
<static>
contract.search.fireHighlight(aHighlightWords)
Fires the "highlight" event which takes a string array with the words to
be highlighted as parameters.
- Parameters:
- {string[]} aHighlightWords
- words to be highlighted
- Since:
- 1.11.0
<static>
{string[]}
contract.search.getKeywords()
Returns the CHIP-specific search keywords.
- Since:
- 1.11.0
- Returns:
- {string[]} CHIP-specific search keywords. Empty array if the CHIP has not set any keywords.