Struct OrderBookView 

pub struct OrderBookView {
    pub filter: OrderFilter,
    pub profile: BookProfile,
    pub quantity_unit: Option<String>,
    pub tiers: Option<OrderSizeTiers>,
    pub tier_colors: Option<[Color32; 2]>,
}

How the live book is shown by the heatmap’s profile and by a depth ladder: which individual orders count, what a bar measures, and which orders are highlighted. Its tiers also mark the heatmap’s cells. The defaults show the aggregate book as the feed sends it. Serializable, so a host can keep it with its chart settings; fields missing from older documents take their defaults.

Fields

filter: OrderFilter

The orders that count. Anything but the default needs a feed that sends order events, see Sink::push_order_event.

profile: BookProfile

What a bar of the profile measures.

quantity_unit: Option<String>

Quantity unit supplied by the host, such as “lots”, “shares” or “BTC”. Labels use “feed units” when absent or blank. This describes the supplied sizes, without conversion; it is independent of the instrument’s price unit.

tiers: Option<OrderSizeTiers>

Highlights a price whose largest known individual order reaches a tier. A price without order data, as with an aggregate feed, is not highlighted and not reported as small. The liquidity heatmap marks its cells by the largest order its history recorded in the row, see DepthColumn::largest_bid_orders.

tier_colors: Option<[Color32; 2]>

Colours of the notable and the large tier, or None, the default, for the ChartColors::order_notable and order_large of the theme the view is drawn with, so the marks follow a change of theme.

Implementations

impl OrderBookView

pub fn tier_color(&self, tier: OrderSizeTier, colors: &ChartColors) -> Color32

The colour of a tier: from tier_colors when set, otherwise from colors, the chart colours of the theme the view is drawn with.

Trait Implementations

impl Clone for OrderBookView

fn clone(&self) -> OrderBookView

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OrderBookView

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OrderBookView

fn default() -> OrderBookView

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderBookView

where OrderBookView: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderBookView

fn eq(&self, other: &OrderBookView) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OrderBookView

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OrderBookView