Skip to main content

plotlars_core/components/
exponent.rs

1/// An enumeration representing the format for value exponents on the axis.
2///
3/// # Example
4///
5/// ```rust
6/// use polars::prelude::*;
7/// use plotlars::{Axis, Plot, TimeSeriesPlot, ValueExponent};
8///
9/// let dataset = LazyCsvReader::new(PlRefPath::new("data/revenue_and_cost.csv"))
10///     .finish()
11///     .unwrap()
12///     .select([
13///         col("Date").cast(DataType::String),
14///         col("Revenue").cast(DataType::Int32),
15///         col("Cost").cast(DataType::Int32),
16///     ])
17///     .collect()
18///     .unwrap();
19///
20/// TimeSeriesPlot::builder()
21///     .data(&dataset)
22///     .x("Date")
23///     .y("Revenue")
24///     .y_axis(
25///         &Axis::new()
26///             .value_exponent(ValueExponent::SmallE)
27///     )
28///     .build()
29///     .plot();
30/// ```
31///
32/// ![Example](https://imgur.com/I6gYYkb.png)
33#[derive(Clone)]
34pub enum ValueExponent {
35    None,
36    SmallE,
37    CapitalE,
38    Power,
39    SI,
40    B,
41}