Skip to content

charton API


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

Interface: SymbolSearchResult ​

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

Symbol fields the search dialog shows. A data source's symbol info fits as is.

Properties ​

description? ​

optional description?: string

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


exchange? ​

optional exchange?: string

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

Matched by the exchange filter.


optional logo?: string

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

Image URL shown before the symbol.


name ​

name: string

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


root? ​

optional root?: string

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

Root shared by the months of a futures contract; results with the same root are listed together.


symbol ​

symbol: string

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

Key handed back on selection, e.g. for loading the symbol.


type? ​

optional type?: string

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

Free-form kind such as 'crypto', 'stock' or 'futures'; matched by the type filter.