Struct SymbolDetailsPanel 

pub struct SymbolDetailsPanel { /* private fields */ }

Details of the chart’s symbol, fed by the host’s Datafeed and Storage.

Keep it on the chart’s symbol with set_instrument, its latest quote with set_quote, such as the one WatchlistPanel::quote holds, and its average volume with set_average_volume. The quote’s last price, change, update time, extended-hours trade and session volume are shown, the extended-hours change measured from the regular last price; update times are shown in the time zone set with set_timezone, UTC by default. The header’s layout button shows or hides sections, the edit button moves to the notes, and a feed that supplies SymbolDetails::url gets a link to the instrument beside its name, and one that supplies SymbolDetails::category gets the category under it. For each new symbol the panel asks the feed for Datafeed::symbol_details and shows the statistics, on a card, and the profile it answers; an empty section, or a feed that does not support the request, shows nothing. Notes are kept in memory per symbol, and with a storage service attached they are read from and written to one StoreKind::SymbolNotes document per symbol as they are edited, one write per document at a time. Call poll each frame, even while the panel is hidden, then show while it is open. The More menu’s Financials item is reported by take_financials_request, for the host to open a FinancialsPanel with the company’s figures.

The Performance and Seasonality sections show what the host supplies. Call take_market_requests each frame: the first call for a symbol returns its MarketDetailRequests and shows both sections as loading, and the host answers with set_period_returns and set_seasonality. A host that never calls it sees neither section. Each section says whether it is loading, empty, unavailable or failed.

Implementations

impl SymbolDetailsPanel

pub fn new() -> Self

A panel without a symbol, feed or storage.

pub fn set_feed(&mut self, feed: Arc<dyn Datafeed>)

Ask feed for the details of each symbol from now on, starting with the shown one.

pub fn set_storage(&mut self, storage: Arc<dyn Storage>)

Keep notes in storage, reading them again from it. Edits not yet written are dropped.

pub fn set_instrument(&mut self, instrument: &Instrument)

Show instrument, such as the chart’s. A new symbol clears the quote and the average volume and asks for its details and notes; the same symbol only takes the new name, exchange and currency.

pub fn set_quote(&mut self, quote: Quote)

Sets the latest quote of the shown symbol. Its extended-hours trade shows below the regular price while it is set.

pub fn set_average_volume(&mut self, average: f64)

Sets the average daily volume of the shown symbol over the last 30 days. With the quote’s session volume, both are drawn as a bar split in proportion to the two.

pub fn set_timezone(&mut self, timezone: TimezoneId)

Shows update times in timezone, such as the chart’s.

pub fn set_financials_visible(&mut self, visible: bool)

Show or hide Financials in the More menu, shown by default. Hide it when the host cannot supply company financials.

pub fn take_financials_request(&mut self) -> bool

Whether the user chose Financials in the More menu since the last call.

pub fn take_market_requests(&mut self) -> Vec<MarketDetailRequest>

The market detail the sections still lack for the shown symbol, each returned once; it marks them loading. Call it every frame and answer with set_period_returns and set_seasonality.

pub fn set_period_returns( &mut self, symbol: &str, returns: MarketDetail<Vec<PeriodReturn>>, )

Answers the MarketDetailRequest::PeriodReturns of symbol. An answer for a symbol the panel no longer shows is ignored.

pub fn set_seasonality( &mut self, symbol: &str, seasonality: MarketDetail<Seasonality>, )

Answers the MarketDetailRequest::Seasonality of symbol. An answer for a symbol the panel no longer shows is ignored.

pub fn symbol(&self) -> Option<&str>

The shown symbol, if any.

pub fn poll(&mut self, ctx: &Context)

Receive the feed’s and storage’s answers, write edited notes, and wake the UI when the next answer arrives.

pub fn show(&mut self, ui: &mut Ui)

Render the shown symbol after poll.

Trait Implementations

impl Default for SymbolDetailsPanel

fn default() -> SymbolDetailsPanel

Returns the “default value” for a type.