Symbol Search - kroim/charting-library-wiki GitHub Wiki

The Symbol Search is used to search and display instruments that match a full or partial instrument name entered in the search field.

Setting data

If you have a short list of symbols, the easiest way to display them in the symbol search is to implement the symbols group request API.

Otherwise, you can use a single symbol search requests.

In case of JS API, you need to implement searchSymbols.

Filters

The search window has predefined UI to filter symbols based on symbol types and exchanges. Both filters are optional. You can use any string as a symbol type.

Grouping of futures

The search window displays futures grouped by a root. To enable grouping you need to provide a regular expression to parse instrument names and set futures as a type.

Hiding the Symbol Search

If your use of the library doesn't involve changing the displayed instrument by users, then you can hide the search box using header_symbol_search featureset.