plotlars 0.12.0

Plotlars is a Rust library designed to facilitate the integration between the Polars data analysis library and visualization libraries.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

//! Plotlars bridges [Polars](https://pola.rs/) DataFrames with visualization backends.
//!
//! Two mutually exclusive backends are supported via Cargo features:
//! - `plotly` — interactive HTML charts (all 22 plot types)
//! - `plotters` — static PNG/SVG output (8 plot types)
//!
//! See the [README](https://github.com/alceal/plotlars) for full documentation and examples.
#![allow(clippy::needless_doctest_main)]

// ── Section 1: Compile-time guards ──────────────────────────────────────

#[cfg(all(feature = "plotly", feature = "plotters"))]
compile_error!(
    "Only one plotlars backend can be enabled at a time. \
     Choose either features = [\"plotly\"] or features = [\"plotters\"]."
);

#[cfg(not(any(feature = "plotly", feature = "plotters")))]
compile_error!(
    "A plotlars backend must be enabled. \
     Add features = [\"plotly\"] or features = [\"plotters\"] to your Cargo.toml."
);

// ── Section 2: Unconditional core re-exports ────────────────────────────

pub use plotlars_core::policy::{set_unsupported_option_policy, UnsupportedOptionPolicy};
pub use plotlars_core::Plot as PlotData;

// I/O re-exports
pub use plotlars_core::io::{CsvReader, ParquetReader, PlotlarsError};

#[cfg(feature = "format-json")]
pub use plotlars_core::io::JsonReader;

#[cfg(feature = "format-excel")]
pub use plotlars_core::io::ExcelReader;

/// Re-exported Polars prelude for advanced data manipulation.
///
/// Users who need to filter, cast, join, or otherwise transform DataFrames
/// can import from here instead of adding `polars` to their `Cargo.toml`:
///
/// ```rust
/// use plotlars::polars::prelude::*;
/// ```
pub mod polars {
    pub use polars::prelude;
}

// Component re-exports
pub use plotlars_core::components::arrangement::Arrangement;
pub use plotlars_core::components::axis::{Axis, AxisSide, AxisType};
pub use plotlars_core::components::bar_mode::BarMode;
pub use plotlars_core::components::cell::Cell;
pub use plotlars_core::components::color::Rgb;
pub use plotlars_core::components::colorbar::ColorBar;
pub use plotlars_core::components::coloring::Coloring;
pub use plotlars_core::components::dimensions::Dimensions;
pub use plotlars_core::components::direction::Direction;
pub use plotlars_core::components::exponent::ValueExponent;
pub use plotlars_core::components::facet::{FacetConfig, FacetScales};
pub use plotlars_core::components::fill::Fill;
pub use plotlars_core::components::header::Header;
pub use plotlars_core::components::intensity::IntensityMode;
pub use plotlars_core::components::legend::Legend;
pub use plotlars_core::components::lighting::Lighting;
pub use plotlars_core::components::line::Line;
pub use plotlars_core::components::mode::Mode;
pub use plotlars_core::components::orientation::Orientation;
pub use plotlars_core::components::palette::Palette;
pub use plotlars_core::components::shape::Shape;
pub use plotlars_core::components::text::Text;
pub use plotlars_core::components::tick::TickDirection;

// ── Section 3a: Plotly backend ──────────────────────────────────────────

#[cfg(feature = "plotly")]
pub use plotlars_plotly::PlotlyExt as Plot;

#[cfg(feature = "plotly")]
pub use plotlars_plotly::SubplotGrid;

#[cfg(feature = "plotly")]
pub use plotlars_core::plots::array2dplot::Array2dPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::barplot::BarPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::boxplot::BoxPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::candlestick::CandlestickPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::contourplot::ContourPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::density_mapbox::DensityMapbox;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::heatmap::HeatMap;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::histogram::Histogram;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::image::Image;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::lineplot::LinePlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::mesh3d::Mesh3D;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::ohlc::OhlcPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::piechart::PieChart;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::sankeydiagram::SankeyDiagram;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::scatter3dplot::Scatter3dPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::scattergeo::ScatterGeo;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::scattermap::ScatterMap;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::scatterplot::ScatterPlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::scatterpolar::ScatterPolar;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::surfaceplot::SurfacePlot;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::table::Table;
#[cfg(feature = "plotly")]
pub use plotlars_core::plots::timeseriesplot::TimeSeriesPlot;

// ── Section 3b: Plotters backend ────────────────────────────────────────

#[cfg(feature = "plotters")]
pub use plotlars_plotters::PlottersExt as Plot;

#[cfg(feature = "plotters")]
pub use plotlars_core::plots::barplot::BarPlot;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::boxplot::BoxPlot;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::candlestick::CandlestickPlot;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::heatmap::HeatMap;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::histogram::Histogram;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::lineplot::LinePlot;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::scatterplot::ScatterPlot;
#[cfg(feature = "plotters")]
pub use plotlars_core::plots::timeseriesplot::TimeSeriesPlot;