Struct plotters_iced::ChartBuilder [−][src]
pub struct ChartBuilder<'a, 'b, DB> where
DB: DrawingBackend, { /* fields omitted */ }
Expand description
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.
Implementations
Create a chart builder on the given drawing area
root
: The root drawing area- Returns: The chart builder object
Set the margin size of the chart (applied for top, bottom, left and right at the same time)
size
: The size of the chart margin.
Set the top margin of current chart
size
: The size of the top margin.
pub fn margin_bottom<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn margin_bottom<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the bottom margin of current chart
size
: The size of the bottom margin.
Set the left margin of current chart
size
: The size of the left margin.
pub fn margin_right<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn margin_right<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the right margin of current chart
size
: The size of the right margin.
pub fn set_all_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn set_all_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set all the label area size with the same value
pub fn set_left_and_bottom_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn set_left_and_bottom_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the most commonly used label area size to the same value
pub fn x_label_area_size<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn x_label_area_size<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the size of X label area
size
: The height of the x label area, if x is 0, the chart doesn’t have the X label area
pub fn y_label_area_size<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn y_label_area_size<S>(&mut self, size: S) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the size of the Y label area
size
: The width of the Y label area. If size is 0, the chart doesn’t have Y label area
pub fn top_x_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn top_x_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the size of X label area on the top of the chart
size
: The height of the x label area, if x is 0, the chart doesn’t have the X label area
pub fn right_y_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn right_y_label_area_size<S>(
&mut self,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set the size of the Y label area on the right side
size
: The width of the Y label area. If size is 0, the chart doesn’t have Y label area
pub fn set_label_area_size<S>(
&mut self,
pos: LabelAreaPosition,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]
pub fn set_label_area_size<S>(
&mut self,
pos: LabelAreaPosition,
size: S
) -> &mut ChartBuilder<'a, 'b, DB> where
S: SizeDesc,
[src]Set a label area size
pos
: THe position where the label area locatedsize
: The size of the label area size
Set the caption of the chart
caption
: The caption of the chartstyle
: The text style- Note: If the caption is set, the margin option will be ignored
pub fn build_ranged<X, Y>(
&mut self,
x_spec: X,
y_spec: Y
) -> Result<ChartContext<'a, DB, Cartesian2d<<X as AsRangedCoord>::CoordDescType, <Y as AsRangedCoord>::CoordDescType>>, DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>> where
X: AsRangedCoord,
Y: AsRangedCoord,
[src]build_ranged
has been renamed to build_cartesian_2d
and is to be removed in the future.
pub fn build_cartesian_2d<X, Y>(
&mut self,
x_spec: X,
y_spec: Y
) -> Result<ChartContext<'a, DB, Cartesian2d<<X as AsRangedCoord>::CoordDescType, <Y as AsRangedCoord>::CoordDescType>>, DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>> where
X: AsRangedCoord,
Y: AsRangedCoord,
[src]
pub fn build_cartesian_2d<X, Y>(
&mut self,
x_spec: X,
y_spec: Y
) -> Result<ChartContext<'a, DB, Cartesian2d<<X as AsRangedCoord>::CoordDescType, <Y as AsRangedCoord>::CoordDescType>>, DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>> where
X: AsRangedCoord,
Y: AsRangedCoord,
[src]Build the chart with a 2D Cartesian coordinate system. The function will returns a chart context, where data series can be rendered on.
x_spec
: The specification of X axisy_spec
: The specification of Y axis- Returns: A chart context
pub fn build_cartesian_3d<X, Y, Z>(
&mut self,
x_spec: X,
y_spec: Y,
z_spec: Z
) -> Result<ChartContext<'a, DB, Cartesian3d<<X as AsRangedCoord>::CoordDescType, <Y as AsRangedCoord>::CoordDescType, <Z as AsRangedCoord>::CoordDescType>>, DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>> where
X: AsRangedCoord,
Y: AsRangedCoord,
Z: AsRangedCoord,
[src]
pub fn build_cartesian_3d<X, Y, Z>(
&mut self,
x_spec: X,
y_spec: Y,
z_spec: Z
) -> Result<ChartContext<'a, DB, Cartesian3d<<X as AsRangedCoord>::CoordDescType, <Y as AsRangedCoord>::CoordDescType, <Z as AsRangedCoord>::CoordDescType>>, DrawingAreaErrorKind<<DB as DrawingBackend>::ErrorType>> where
X: AsRangedCoord,
Y: AsRangedCoord,
Z: AsRangedCoord,
[src]Build a 3 dimensional cartesian chart. The function will returns a chart context, where data series can be rendered on.
x_spec
: The specification of X axisy_spec
: The specification of Y axisz_sepc
: The specification of Z axis- Returns: A chart context
Auto Trait Implementations
impl<'a, 'b, DB> !RefUnwindSafe for ChartBuilder<'a, 'b, DB>
impl<'a, 'b, DB> !Send for ChartBuilder<'a, 'b, DB>
impl<'a, 'b, DB> !Sync for ChartBuilder<'a, 'b, DB>
impl<'a, 'b, DB> Unpin for ChartBuilder<'a, 'b, DB>
impl<'a, 'b, DB> !UnwindSafe for ChartBuilder<'a, 'b, DB>