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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
/*! # Plotters - Another Plotting Library in Rust <a href="https://crates.io/crates/plotters"> <img style="display: inline!important" src="https://img.shields.io/crates/v/plotters.svg"></img> </a> <a href="https://docs.rs/plotters"> <img style="display: inline!important" src="https://docs.rs/plotters/badge.svg"></img> </a> Plotters is a flexible drawing library for data visualization written in pure Rust for both native and WebAssembly. - Why plotting in Rust? Although rendering a figure doesn't requires too many computation power in most of the case, and programming language such as Python and Javascript is used for visualization purpose. Sometimes we need to make a figure based on huge amount of data, for example, rendering some human gene data may requires to downsampling trillions data points, which isn't even doable with many high-level programming language. In this case, Rust is a perfect candidate for rendering figures, since it runs very fast while having high-level abstraction abilities. - What type of figure is supported? Currently, we support line series, point series and candlestick series. And the library is designed to be able to render multiple figure into a single image. But Plotter is aimed to be a platform that is fully extendable to supporting any other types of figure. - Plotting on HTML5 canvas Plotters currently supports backend that uses the HTML5 canvas. To use the WASM support, you can simply create `CanvasBackend` instead of other backend and all other API remains the same! Check the demo that uses Plotters with WASM at [here](http://home.chpc.utah.edu/~u0875014/wasm-test/) ## Gallery <div class="galleryItem"> <a href="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/sample.png"> <img src="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/sample.png" class="galleryItem"></img> </a> <div class="galleryText"> Multiple Plot <a href="https://github.com/38/plotters/blob/master/examples/chart.rs">[code]</a> </div> </div> <div class="galleryItem"> <a href="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/stock.png"> <img src="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/stock.png" class="galleryItem"></img> </a> <div class="galleryText"> Candlestick Plot <a href="https://github.com/38/plotters/blob/master/examples/stock.rs">[code]</a> </div> </div> <div class="galleryItem"> <a href="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/histogram.png"> <img src="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/histogram.png" class="galleryItem"></img> </a> <div class="galleryText"> Histogram <a href="https://github.com/38/plotters/blob/master/examples/histogram.rs">[code]</a> </div> </div> <div class="galleryItem"> <a href="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/0.png"> <img src="https://raw.githubusercontent.com/38/plotters/master/examples/outputs/0.png" class="galleryItem"></img> </a> <div class="galleryText"> Simple Chart </div> </div> ## Quick Start ```rust use plotters::prelude::*; fn main() -> Result<(), Box<dyn std::error::Error>> { let mut backend = BitMapBackend::new("examples/outputs/0.png", (640, 480)); backend.open()?; let root: DrawingArea<_, _> = backend.into(); let font = Into::<FontDesc>::into("Arial").resize(50.0); root.fill(&White)?; let mut chart = ChartBuilder::on(&root) .caption("y=x^2", &font) .x_label_area_size(30) .y_label_area_size(30) .build_ranged(-1f32..1f32, -0.1f32..1f32); chart.configure_mesh().draw()?; chart.draw_series(LineSeries::new( (-50..=50).map(|x| x as f32 / 50.0).map(|x| (x, x * x)), &RGBColor(255, 0, 0), ))?; root.close()?; return Ok(()); } ``` ![](https://raw.githubusercontent.com/38/plotters/master/examples/outputs/0.png) ## Concepts by examples ### Drawing Backends Plotters can use different drawing backends, such as SVG, BitMap, etc. And even real-time rendering, such as library. For example a bitmap drawing backend. ```rust use plotters::prelude::*; fn main() -> Result<(), Box<dyn std::error::Error>> { // Create a 800*600 bitmap and start drawing let mut backend = BitMapBackend::new("examples/outputs/1.png", (300,200)); // And if we want SVG backend // let backend = SVGBackend::new("output.svg", (800, 600)); backend.open()?; backend.draw_rect((50,50), (200, 150), &Red, true)?; backend.close()?; return Ok(()); } ``` And this will produce ![](https://raw.githubusercontent.com/38/plotters/master/examples/outputs/1.png) ### Drawing Area Plotters use a concept called drawing area for layout purpose. Plotters support multiple plot integrate in a single image. This is done by craeting sub drawing areas. Besides that, drawing area also allows customized cooridnate system, by doing so, the coordinate mapping is done by the drawing area automatically. ```rust use plotters::prelude::*; fn main() -> Result<(), Box<dyn std::error::Error>> { let backend = BitMapBackend::new("examples/outputs/2.png", (300, 200)); // A backend object can be converted into a drawing area let root_drawing_area:DrawingArea<_,_> = backend.into(); // And we can split the drawing area into 3x3 grid let child_drawing_areas = root_drawing_area.split_evenly((3,3)); // Then we fill the drawing area with different color for (area,color) in child_drawing_areas.into_iter().zip(0..) { area.fill(&Palette99::pick(color))?; } root_drawing_area.close()?; return Ok(()); } ``` And this will produce ![](https://raw.githubusercontent.com/38/plotters/master/examples/outputs/2.png) ### Elements In Plotters, elements are build blocks of a image. All elements are able to draw on a drawing area. There are different types of elements, such as, lines, texts, circles, etc. You may also combining existing elements to build a complex element. ```rust use plotters::prelude::*; fn main() -> Result<(), Box<dyn std::error::Error>> { let backend = BitMapBackend::new("examples/outputs/3.png", (300, 200)); // A backend object can be converted into a drawing area let root:DrawingArea<_,_> = backend.into(); root.fill(&White); // Draw an circle on the drawing area root.draw(&Circle::new((100,100), 50, Into::<ShapeStyle>::into(&Green).filled()))?; root.close()?; return Ok(()); } ``` And this will produce ![](https://raw.githubusercontent.com/38/plotters/master/examples/outputs/3.png) ### Composable Elements Besides the basic elements, elements can be composed into a logic group we called composed elements. When composing new elements, the upper-left conner is given in the target coordinate, and a new pixel based coordinate which has the upper-left conner defined as `(0,0)` is used for further element composition purpose. For example, we can have an element which includes a dot and its coordinate. ```rust use plotters::prelude::*; fn main() -> Result<(), Box<dyn std::error::Error>> { let backend = BitMapBackend::new("examples/outputs/4.png", (640, 480)); // A backend object can be converted into a drawing area let root:DrawingArea<_,_> = backend.into(); root.fill(&RGBColor(240,200,200))?; let root = root.apply_coord_spec(RangedCoord::<RangedCoordf32, RangedCoordf32>::new(0f32..1f32, 0f32..1f32, (0..640, 0..480))); let font = Into::<FontDesc>::into("Arial").resize(15.0); let dot_and_label = |x:f32,y:f32| { return EmptyElement::at((x,y)) + Circle::new((0,0), 3, ShapeStyle::from(&Black).filled()) + OwnedText::new(format!("({:.2},{:.2})", x, y), (10, 0), &font); }; root.draw(&dot_and_label(0.5, 0.6))?; root.draw(&dot_and_label(0.25, 0.33))?; root.draw(&dot_and_label(0.8, 0.8))?; root.close()?; return Ok(()); } ``` ![](https://raw.githubusercontent.com/38/plotters/master/examples/outputs/4.png) ### Chart Context In order to draw a chart, Plotters need an data object build on top of drawing area called `ChartContext`. The chart context defines even higher level constructs compare to the drawing area. For example, you can define the label areas, meshs, and put a data series onto the drawing area with the help of the chart context object. ```rust use plotters::prelude::*; fn main() -> Result<(), Box<dyn std::error::Error>> { let backend = BitMapBackend::new("examples/outputs/5.png", (640, 480)); let root:DrawingArea<_,_> = backend.into(); root.fill(&White); let root = root.margin(10,10,10,10); // After this point, we should be able to draw construct a chart context let font:FontDesc = Into::<FontDesc>::into("Arial").resize(40.0); // Create the chart object let mut chart = ChartBuilder::on(&root) // Set the caption of the chart .caption("This is our first plot", &font) // Set the size of the label region .x_label_area_size(20) .y_label_area_size(40) // Finally attach a coordinate on the drawing area and make a chart context .build_ranged(0f32..10f32, 0f32..10f32); // Then we can draw a mesh chart.configure_mesh() // We can customize the maxium number of labels allowed for each axis .x_labels(30) .y_labels(10) // We can also change the format of the label text .y_label_formatter(&|x| format!("{:.3}", x)) .draw()?; // And we can draw something in the drawing area let smaller_font = font.resize(10.0); chart.draw_series(LineSeries::new(vec![(0.0,0.0), (5.0, 5.0), (8.0, 7.0)], &Red))?; // Similarly, we can draw point series chart.draw_series(PointSeries::of_element(vec![(0.0,0.0), (5.0, 5.0), (8.0, 7.0)], 5, &Red, &|c,s,st| { return EmptyElement::at(c) // We want to construct a composed element on-the-fly + Circle::new((0,0),s,st.filled()) // At this point, the new pixel coordinate is established + OwnedText::new(format!("{:?}", c), (10, 0), &smaller_font); }))?; root.close()?; return Ok(()); } ``` ![](https://raw.githubusercontent.com/38/plotters/master/examples/outputs/5.png) <style> img { display: block; margin: 0 auto; max-width: 500px; } .galleryItem { width: 250px; display: inline-block; } .galleryImg { max-width: 100%; } .galleryText { text-align: center; } </style> */ pub mod chart; pub mod coord; pub mod data; pub mod drawing; pub mod element; pub mod series; pub mod style; pub mod prelude { pub use crate::chart::{ChartBuilder, ChartContext}; pub use crate::coord::{ CoordTranslate, Ranged, RangedCoord, RangedCoordf32, RangedCoordf64, RangedCoordi32, RangedCoordi64, RangedCoordu32, RangedCoordu64, RangedDate, RangedDateTime, }; pub use crate::drawing::*; pub use crate::series::{Histogram, LineSeries, PointSeries}; pub use crate::style::{ Black, Blue, Color, Cyan, FontDesc, Green, Magenta, Mixable, Palette, Palette100, Palette99, Palette9999, PaletteColor, RGBColor, Red, ShapeStyle, SimpleColor, TextStyle, Transparent, White, Yellow, }; pub use crate::element::{ CandleStick, Circle, Cross, EmptyElement, OwnedText, Path, Rectangle, Text, }; #[allow(type_alias_bounds)] /// The type used to returns a drawing operation that can be failed /// - `T`: The return type /// - `D`: The drawing backend type pub type DrawResult<T, D: DrawingBackend> = Result<T, crate::drawing::DrawingAreaErrorKind<D::ErrorType>>; }