Interface WatchlistPanelOptions

interface WatchlistPanelOptions {
    pollMs?: number;
    quotes?: QuoteFeed;
    staleAfterMs?: number;
    store: WatchlistStore;
    formatPrice(value: number, instrument: InstrumentKey): string;
    normalize(instrument: InstrumentKey): InstrumentKey;
    onSelect(instrument: InstrumentKey): void;
}

Properties

pollMs? quotes? staleAfterMs? store

Methods

formatPrice? normalize? onSelect?

Properties

OptionalpollMs

pollMs?: number

Refresh interval for a snapshot-only source. 0 disables. Default 15000 ms.

Optionalquotes

quotes?: QuoteFeed

Quotes for the rows on screen. Without one, rows show symbols only.

OptionalstaleAfterMs

staleAfterMs?: number

A snapshot older than this is shown as stale. Default 60000 ms.

store

store: WatchlistStore

Named lists: a WatchlistRepository from openalgo-charts/workspace, or any implementation of its store contract.

Methods

OptionalformatPrice

Optionalnormalize

  • normalize(instrument: InstrumentKey): InstrumentKey

  • The instrument the host charts for an entry. The panel saves what it adds in this form, and compares entries with the chart through it, so a row is marked as, and refused as a repeat of, what choosing it would chart. Default: unchanged. The widget upper-cases the symbol, as its symbol box does.

    Parameters

    Returns InstrumentKey

OptionalonSelect

Settings

Member Visibility

On This Page

Properties
Methods