Struct VolumeProfileConfig 

pub struct VolumeProfileConfig {
    pub display: ProfileDisplay,
    pub up_color: [u8; 4],
    pub down_color: [u8; 4],
    pub value_area_colors: Option<[[u8; 4]; 2]>,
    pub show_value_area_lines: bool,
    /* private fields */
}

Row layout and display settings shared by volume profile studies and drawings.

Fields

display: ProfileDisplay

Volume displayed in each row. Totals still determine POC and value area.

up_color: [u8; 4]

Colour of rising bars, including an unchanged close, in split and delta modes.

down_color: [u8; 4]

Colour of falling bars in split and delta modes.

value_area_colors: Option<[[u8; 4]; 2]>

Optional colours inside the value area; absent uses the ordinary side colours.

show_value_area_lines: bool

Draw the high and low boundaries of the value area.

Implementations

impl VolumeProfileConfig

pub const ROWS: RangeInclusive<usize>

Price rows a profile may have.

pub fn new(rows: usize, value_area: f64) -> Option<Self>

A profile of rows equal price rows whose value area holds the value_area share of its volume (above 0, at most 1); None when either is out of bounds.

pub fn with_row_size(self, height: Option<f64>) -> Option<Self>

Fix each row to a price height, aligned to multiples of that height. None restores equal rows over the span. Rejects nonpositive or nonfinite heights. Profiles spanning more than 10,000 fixed rows are not drawn.

pub fn row_size(&self) -> Option<f64>

Fixed price height per row, or equal rows over the span when absent.

pub fn rows(&self) -> usize

Number of price rows.

pub fn value_area(&self) -> f64

Share of the volume inside the value area.

pub fn drawing_default() -> Self

Settings a new volume profile drawing starts with: up and down volume side by side in cyan and pink, drawn at half opacity outside the value area. Studies keep Self::default.

Trait Implementations

impl Clone for VolumeProfileConfig

fn clone(&self) -> VolumeProfileConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VolumeProfileConfig

impl Debug for VolumeProfileConfig

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

Formats the value using the given formatter.

impl Default for VolumeProfileConfig

fn default() -> Self

24 rows and a value area of 70% of the volume.

impl<'de> Deserialize<'de> for VolumeProfileConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VolumeProfileConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VolumeProfileConfig

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 VolumeProfileConfig