pub struct ChartBuilder<'a, 'b, DB: DrawingBackend> { /* private fields */ }
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§
Source§impl<'a, 'b, DB: DrawingBackend> ChartBuilder<'a, 'b, DB>
impl<'a, 'b, DB: DrawingBackend> ChartBuilder<'a, 'b, DB>
Sourcepub fn on(root: &'a DrawingArea<DB, Shift>) -> Self
pub fn on(root: &'a DrawingArea<DB, Shift>) -> Self
Create a chart builder on the given drawing area
root
: The root drawing area- Returns: The chart builder object
Sourcepub fn margin<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn margin<S: SizeDesc>(&mut self, size: S) -> &mut Self
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.
Sourcepub fn margin_top<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn margin_top<S: SizeDesc>(&mut self, size: S) -> &mut Self
Set the top margin of current chart
size
: The size of the top margin.
Sourcepub fn margin_bottom<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn margin_bottom<S: SizeDesc>(&mut self, size: S) -> &mut Self
Set the bottom margin of current chart
size
: The size of the bottom margin.
Sourcepub fn margin_left<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn margin_left<S: SizeDesc>(&mut self, size: S) -> &mut Self
Set the left margin of current chart
size
: The size of the left margin.
Sourcepub fn margin_right<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn margin_right<S: SizeDesc>(&mut self, size: S) -> &mut Self
Set the right margin of current chart
size
: The size of the right margin.
Sourcepub fn set_all_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn set_all_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
Set all the label area size with the same value
Sourcepub fn set_left_and_bottom_label_area_size<S: SizeDesc>(
&mut self,
size: S,
) -> &mut Self
pub fn set_left_and_bottom_label_area_size<S: SizeDesc>( &mut self, size: S, ) -> &mut Self
Set the most commonly used label area size to the same value
Sourcepub fn x_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn x_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
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
Sourcepub fn y_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn y_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
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
Sourcepub fn top_x_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn top_x_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
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
Sourcepub fn right_y_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
pub fn right_y_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self
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
Sourcepub fn set_label_area_size<S: SizeDesc>(
&mut self,
pos: LabelAreaPosition,
size: S,
) -> &mut Self
pub fn set_label_area_size<S: SizeDesc>( &mut self, pos: LabelAreaPosition, size: S, ) -> &mut Self
Set a label area size
pos
: THe position where the label area locatedsize
: The size of the label area size
Sourcepub fn caption<S: AsRef<str>, Style: IntoTextStyle<'b>>(
&mut self,
caption: S,
style: Style,
) -> &mut Self
pub fn caption<S: AsRef<str>, Style: IntoTextStyle<'b>>( &mut self, caption: S, style: Style, ) -> &mut Self
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
Sourcepub fn build_ranged<X: AsRangedCoord, Y: AsRangedCoord>(
&mut self,
x_spec: X,
y_spec: Y,
) -> Result<ChartContext<'a, DB, RangedCoord<X::CoordDescType, Y::CoordDescType>>, DrawingAreaErrorKind<DB::ErrorType>>
pub fn build_ranged<X: AsRangedCoord, Y: AsRangedCoord>( &mut self, x_spec: X, y_spec: Y, ) -> Result<ChartContext<'a, DB, RangedCoord<X::CoordDescType, Y::CoordDescType>>, DrawingAreaErrorKind<DB::ErrorType>>
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
Auto Trait Implementations§
impl<'a, 'b, DB> Freeze for ChartBuilder<'a, 'b, DB>
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>
Blanket Implementations§
Source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
Source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<Swp, Dwp, T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<Swp, Dwp, T>,
Source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T, U> ConvertInto<U> for Twhere
U: ConvertFrom<T>,
impl<T, U> ConvertInto<U> for Twhere
U: ConvertFrom<T>,
Source§fn convert_into(self) -> U
fn convert_into(self) -> U
Source§fn convert_unclamped_into(self) -> U
fn convert_unclamped_into(self) -> U
Source§fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains the unclamped color. Read more