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