charton

Appearance

charton API

charton API / @chart-on/ui / index / SymbolSearchSource

Interface: SymbolSearchSource<T> ​

Defined in: ui/src/symbol-search-model.ts:51

Where results come from. A data source with search(query) fits as is.

Type Parameters ​

T ​

T extends SymbolSearchResult = SymbolSearchResult

Properties ​

searchFilters? ​

optional searchFilters?: SymbolSearchFilters

Defined in: ui/src/symbol-search-model.ts:58

Exchange and type filters the dialog offers; none when omitted.

Methods ​

search(query, request): Promise<SymbolSearchPage<T> | T[]>

Defined in: ui/src/symbol-search-model.ts:56

Results for query: an array for the whole result, or a page to load the rest on demand from request.offset.

Parameters ​

query ​

string

request ​

SymbolSearchRequest

Returns ​

Promise<SymbolSearchPage<T> | T[]>