EntitySearchEngineComponent<T>
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends any | any |
Constructors
Constructor
new EntitySearchEngineComponent<T>(options): EntitySearchEngineComponent<T>;
Parameters
| Parameter | Type |
|---|---|
options | EntitySearchEngineComponentOptions |
Returns
EntitySearchEngineComponent<T>
Overrides
EntityDefinitionComponent.constructor
Properties
| Property | Modifier | Type | Default value | Inherited from |
|---|---|---|---|---|
definition | public | EntityDefinition | undefined | EntityDefinitionComponent.definition |
type | public | string | undefined | EntityDefinitionComponent.type |
TYPE | static | string | 'search-engine' | - |
Accessors
system
Get Signature
get system(): System;
Returns
Inherited from
EntityDefinitionComponent.system
Methods
getCmdPaletteSearchEngine()
getCmdPaletteSearchEngine(options?): CMDPalletSearchEngine;
Parameters
| Parameter | Type |
|---|---|
options | Omit<CommandPalletSearchEngineOptions, "displayName"> |
Returns
getComboBoxDirective()
getComboBoxDirective(event): SearchEngineComboBoxDirective<EntitySearchResultEntry<T>, EntityComboBoxItem<T>>;
Parameters
| Parameter | Type |
|---|---|
event | GetComboBoxDirectiveOptions<T> |
Returns
SearchEngineComboBoxDirective<EntitySearchResultEntry<T>, EntityComboBoxItem<T>>
getLabel()
getLabel(): string;
Returns
string
getSearchEngine()
abstract getSearchEngine(): SearchEngine<SearchResult<EntitySearchResultEntry<T>>>;
Returns
SearchEngine<SearchResult<EntitySearchResultEntry<T>>>
hideSearchOnMobile()
hideSearchOnMobile(): boolean;
Returns
boolean
setDefinition()
setDefinition(definition): void;
Parameters
| Parameter | Type |
|---|---|
definition | EntityDefinition |
Returns
void