Struct FootprintConfig 

pub struct FootprintConfig {

    pub modes: Vec<FootprintMode>,
    pub profile: bool,
    pub color_by: FootprintColor,
    pub ask_color: Color32,
    pub bid_color: Color32,
    pub text_color: Color32,
    pub neutral_color: Color32,
    pub auto_row_height: Option<f32>,
    pub min_text_height: f32,
    pub imbalance_ratio: f64,
    pub imbalance_min_volume: f64,
    pub diagonal: bool,
    pub show_poc: bool,
    pub value_area: Option<f64>,
    pub value_area_high: Option<Stroke>,
    pub value_area_low: Option<Stroke>,
    pub node_sensitivity: NodeSensitivity,
    pub abbreviate: bool,
    pub show_zero: bool,
    pub font_size: [f32; 2],
    pub extreme_ratio: bool,
    pub pullback: bool,
    pub statistics: bool,
    pub studies: Option<FootprintStudyConfig>,
}

Footprint appearance. Supply colours from the host’s theme. Serializable, so a host can keep it with its chart settings; fields missing from older documents take their defaults.

Fields

modes: Vec<FootprintMode>

One to four columns per bar; only the first four entries are drawn.

profile: bool

Draw proportional volume profiles behind the numbers.

color_by: FootprintColor

Cell colouring rule.

ask_color: Color32

Buy colour.

bid_color: Color32

Sell colour.

text_color: Color32

Text colour and POC outline.

neutral_color: Color32

Cell fill for balanced or unclassified executions.

auto_row_height: Option<f32>

Group adjacent rows automatically to at least this screen height. None keeps the aggregation’s manual grouping. Grouping is an integer multiple of the input step.

min_text_height: f32

Hide numbers when a row is shorter than this height. A column uses compact values and fonts down to 8 points before switching to a profile overview without numbers.

imbalance_ratio: f64

Dominance multiple, normally 3 (300%).

imbalance_min_volume: f64

Inclusive minimum dominant-side volume for cell imbalances and stacked zones, in instrument volume units after row grouping. Overrides the study config’s minimum when drawn by the chart. Zero preserves all ratio signals; negative or non-finite, none.

diagonal: bool

Compare to the opposite side one price away instead of at the same price.

show_poc: bool

Outline the highest-volume row when its cells are large enough for the stroke.

value_area: Option<f64>

Shade the contiguous value area containing this share of the bar volume.

value_area_high: Option<Stroke>

Trade profiles: the guide along the top edge of the value area (VAH); None hides it.

value_area_low: Option<Stroke>

Trade profiles: the guide along the bottom edge of the value area (VAL); None hides it.

node_sensitivity: NodeSensitivity

Trade profiles: how volume nodes are chosen.

abbreviate: bool

Prefer 1.2K for 1,200 and 3.4M for 3,400,000, even when every digit would fit. Otherwise compact units are only a width-fitting fallback.

show_zero: bool

Write zero volumes as 0. Otherwise they are left blank, so a one-sided row shows only the side that traded.

font_size: [f32; 2]

Preferred smallest and largest font size of the numbers, in points. A row’s size follows its volume relative to the bar’s largest row; equal values request one size. Both are held within 8 and 24 points. Fitting to the cell can reduce the size to 8 points; columns that cannot fit readable numbers use an overview without them.

extreme_ratio: bool

Write the ask/bid ratio of the highest and lowest row of each bar above and below it, or n/a when the bid is zero and the ratio is undefined.

pullback: bool

Outline the rows of the bar’s pullback range, see pullback_range.

statistics: bool

Reserve a per-bar statistics table below the chart’s price pane. Used by crate::widget::Chart::show_footprint.

studies: Option<FootprintStudyConfig>

Annotations calculated from the displayed rows after executions or grouping change. None hides them. Used by crate::widget::Chart::show_footprint.

Trait Implementations

impl Clone for FootprintConfig

fn clone(&self) -> FootprintConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FootprintConfig

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

Formats the value using the given formatter.

impl Default for FootprintConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FootprintConfig

where FootprintConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FootprintConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.