Struct ChartArea 

pub struct ChartArea { /* private fields */ }

The ChartArea struct is a representation of the background area object of an Excel chart.

The ChartArea struct can be used to configure properties of the chart area such as the formatting and is usually obtained via the Chart::chart_area() method.

It is used in conjunction with the Chart struct.

Examples

An example of formatting the chart area of a chart.

        chart.chart_area()
            .set_format(
                ChartFormat::new().set_solid_fill(
                    ChartSolidFill::new().set_color("#FFFFB3")
                ),
        );

Output file:

Implementations

impl ChartArea

pub fn new() -> ChartArea

Create a new ChartArea object to represent the background area object of an Excel chart.

pub fn set_format<T>(&mut self, format: T) -> &mut ChartArea

where T: IntoChartFormat,

Set the formatting properties for the chart area.

Set the formatting properties for a chart area via a ChartFormat object or a sub struct that implements IntoChartFormat. In Excel the chart area is the background area behind the chart.

The formatting that can be applied via a ChartFormat object are:

• ChartFormat::set_solid_fill(): Set the ChartSolidFill properties.
• ChartFormat::set_pattern_fill(): Set the ChartPatternFill properties.
• ChartFormat::set_gradient_fill(): Set the ChartGradientFill properties.
• ChartFormat::set_no_fill(): Turn off the fill for the chart object.
• ChartFormat::set_line(): Set the ChartLine properties.
• ChartFormat::set_border(): Set the ChartBorder properties. A synonym for ChartLine depending on context.
• ChartFormat::set_no_line(): Turn off the line for the chart object.
• ChartFormat::set_no_border(): Turn off the border for the chart object.

Parameters

format: A ChartFormat struct reference or a sub struct that will convert into a ChartFormat instance. See the docs for IntoChartFormat for details.

Examples

An example of formatting the chart “area” of a chart. In Excel the chart area is the background area behind the chart.

    let mut chart = Chart::new(ChartType::Column);

    // Add a data series with formatting.
    chart.add_series().set_values("Sheet1!$A$1:$A$6");

        chart.chart_area()
            .set_format(
                ChartFormat::new().set_solid_fill(
                    ChartSolidFill::new().set_color("#FFFFB3")
                ),
        );

    // Add the chart to the worksheet.
    worksheet.insert_chart(0, 2, &chart)?;

Output file:

Trait Implementations

impl Clone for ChartArea

fn clone(&self) -> ChartArea

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ChartArea

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ChartArea

fn eq(&self, other: &ChartArea) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChartArea