[][src]Module plotters_unstable::prelude

The module imports the most commonly used types and modules in Plotters

Re-exports

pub use crate::coord::ranged1d::Ranged;
pub use crate::drawing::*;
pub use crate::style::BLACK;
pub use crate::style::BLUE;
pub use crate::style::CYAN;
pub use crate::style::GREEN;
pub use crate::style::MAGENTA;
pub use crate::style::RED;
pub use crate::style::TRANSPARENT;
pub use crate::style::WHITE;
pub use crate::style::YELLOW;

Structs

AreaSeries

An area series is similar to a line series but use a filled polygon

BitMapBackend

The backend that drawing a bitmap

BitMapElement

The element that contains a bitmap on it

Boxplot

The boxplot element

CandleStick

The candlestick data point element

Cartesian2d

A 2D Cartesian coordinate system described by two 1D ranged coordinate specs.

ChartBuilder

The helper object to create a chart context, which is used for the high-level figure drawing. With the help of this object, we can convert a basic drawing area into a chart context, which allows the high-level charting API being used on the drawing area.

ChartContext

The context of the chart. This is the core object of Plotters. Any plot/chart is abstracted as this type, and any data series can be placed to the chart context.

Circle

A circle element

Cross

Describe a cross

DynElement

The container for a dynamically dispatched element

EmptyElement

An empty composable element, which is the start point of an ad-hoc composable element

ErrorBar
FontDesc

Describes a font

GroupBy

Grouping the value in the coordinate specification.

HSLColor

The color described by HSL color space

Histogram

The series that aggregate data into a histogram

LineSeries

The line series object, which takes an iterator of points in guest coordinate system and creates the element rendering the line plot

Linspace

The coordinate combinator that transform a continous coordinate to a discrete coordinate to a discrete coordinate by a giving step.

LogCoord

A log scaled coordinate axis

LogRange

The logarithmic coodinate decorator. This decorator is used to make the axis rendered as logarithmically.

MultiLineText

An multi-line text element. The Text element allows only single line text and the MultiLineText supports drawing multiple lines

NestedRange

A nested coordinate spec which is a discrete coordinate on the top level and for each value in discrete value, there is a secondary coordinate system. And the value is defined as a tuple of primary coordinate value and secondary coordinate value

Palette99

The palette of 99% accessibility

Palette100

The palette of 100% accessibility

Palette9999

The palette of 99.99% accessibility

PaletteColor

A color in the given palette

PathElement

An element of a series of connected lines

Pixel

An element of a single pixel

PointSeries

The point plot object, which takes an iterator of points in guest coordinate system and create an element for each point

Polygon

An element of a filled polygon

Quartiles

The quartiles

RGBColor

The color described by its RGB value

RangedDate

The ranged coordinate for date

RangedDateTime

The ranged coordinate for the date and time

RangedDuration

The coordinate that for duration of time

Rectangle

A rectangle element

SVGBackend

The SVG image drawing backend

ShapeStyle

Style for any of shape

Text

A single line text element. This can be owned or borrowed string, dependents on String or str moved into.

TextStyle

Style of a text

TriangleMarker

Describe a triangle marker

Enums

FontFamily

Describes font family. This can be either a specific font family name, such as "arial", or a general font family class, such as "serif" and "sans-serif"

FontStyle

Describes the font style. Such as Italic, Oblique, etc.

FontTransform

Specifying text transformations

LabelAreaPosition

The enum used to specify the position of label area. This is used when we configure the label area size with the API ChartBuilder::set_label_area_size(struct ChartBuilder.html#method.set_label_area_size)

NestedValue

Describe a value for a nested coordinate

SegmentValue

The value that used by the segmented coordinate.

SeriesLabelPosition

Describes where we want to put the series label

Traits

AsRelative

Allows a value turns into a relative size

BindKeyPointMethod
BindKeyPoints
BuildNestedCoord
Color

Any color representation

CoordTranslate

The trait that translates some customized object to the backend coordinate

DiscreteRanged

The trait indicates the coordinate is discrete This means we can bidirectionally map the range value to 0 to N in which N is the number of distinct values of the range.

DrawingBackend

The drawing backend trait, which implements the low-level drawing APIs. This trait has a set of default implementation. And the minimal requirement of implementing a drawing backend is implementing the draw_pixel function.

IntoDynElement

The trait that makes the conversion from the statically dispatched element to the dynamically dispatched element

IntoFont

The trait that allows some type turns into a font description

IntoLinspace
IntoLogRange
IntoMonthly

The trait that converts a normal date coord into a yearly one

IntoPartialAxis

The trait for the types that can be converted into a partial axis

IntoSegmentedCoord

The trait for types that can decorated by SegmentedCoord decorator.

IntoYearly

The trait that converts a normal date coord into a yearly one

LogScalable

The trait for the type that is able to be presented in the log scale. This trait is primarily used by LogRange.

Palette
ToGroupByRange

The trait that provides method Self::group_by function which creates a GroupBy decorated ranged value.

Functions

make_partial_axis

Make a partial axis based on the percentage of visible portion. We can use into_partial_axis to create a partial axis range specification. But sometimes, we want to directly specify the percentage visible to the user.

Type Definitions

DrawResult

The type used to returns a drawing operation that can be failed

PathDeprecated