Struct Chart

pub struct Chart { /* private fields */ }

Supported chart types

• AreaChart
• Area3DChart
• BarChart
• Bar3DChart
• BubbleChart
• DoughnutChart
• LineChart
• Line3DChart
• OfPieChart
• PieChart
• RadarChart
• ScatterChart

Other types will be supported sequentially.

Example

extern crate umya_spreadsheet;
let mut book = umya_spreadsheet::new_file();

// Add Chart
let mut from_marker = umya_spreadsheet::structs::drawing::spreadsheet::MarkerType::default();
let mut to_marker = umya_spreadsheet::structs::drawing::spreadsheet::MarkerType::default();
from_marker.set_coordinate("C1");
to_marker.set_coordinate("D11");
let area_chart_series_list = vec![
    "Sheet1!$A$1:$A$10",
    "Sheet1!$B$1:$B$10",
];
let mut chart = umya_spreadsheet::structs::Chart::default();
chart.new_chart(
    umya_spreadsheet::structs::ChartType::LineChart,
    from_marker,
    to_marker,
    area_chart_series_list,
);
book.get_sheet_by_name_mut("Sheet1").unwrap()
    .add_chart(chart);

// Get Chart by Worksheet.
let mut worksheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
let chart = worksheet.get_chart("C1");
let chart = worksheet.get_chart_by_column_and_row(&3, &1);
let chart = worksheet.get_chart_mut("C1");
let chart = worksheet.get_chart_by_column_and_row_mut(&3, &1);

// Use this if there are multiple Charts in a given cell.
let charts = worksheet.get_charts("C1");
let charts = worksheet.get_charts_by_column_and_row(&3, &1);
let charts = worksheet.get_charts_mut("C1");
let charts = worksheet.get_charts_by_column_and_row_mut(&3, &1);

// Set Chart Title, Series Title, Horizonal Title and Vertical Title.
let mut chart = book.get_sheet_by_name_mut("Sheet1").unwrap().get_chart_mut("C1").unwrap();
chart
    .set_series_title(vec!["Line1", "Line2"])
    .set_series_point_title(vec!["Point1", "Point2", "Point3", "Point4"])
    .set_title("Chart Title")
    .set_horizontal_title("Horizontal Title")
    .set_vertical_title("Vertical Title");

// line chart is a stack line chart by default.
// To change it to an actual line chart, configure as follows
chart
    .set_grouping(umya_spreadsheet::drawing::charts::GroupingValues::Standard);

Implementations

impl Chart

pub fn set_title<S: Into<String>>(&mut self, value: S) -> &mut Self

pub fn set_grouping(&mut self, value: GroupingValues) -> &mut Self

pub fn set_vertical_title<S: Into<String>>(&mut self, value: S) -> &mut Self

pub fn set_horizontal_title<S: Into<String>>(&mut self, value: S) -> &mut Self

pub fn set_series_title<S: Into<String>>(&mut self, value: Vec<S>) -> &mut Self

pub fn set_series_point_title<S: Into<String>>( &mut self, value: Vec<S>, ) -> &mut Self

pub fn get_plot_area_mut(&mut self) -> &mut PlotArea

pub fn get_area_chart_series_list_mut(&mut self) -> &mut AreaChartSeriesList

pub fn get_two_cell_anchor(&self) -> &TwoCellAnchor

pub fn get_two_cell_anchor_mut(&mut self) -> &mut TwoCellAnchor

pub fn set_two_cell_anchor(&mut self, value: TwoCellAnchor) -> &mut Self

pub fn set_default_language<S: Into<String>>(&mut self, value: S) -> &mut Self

pub fn get_chart_space(&self) -> &ChartSpace

pub fn get_chart_space_mut(&mut self) -> &mut ChartSpace

pub fn new_chart( &mut self, chart_type: ChartType, from_marker: MarkerType, to_marker: MarkerType, area_chart_series_list: Vec<&str>, ) -> &mut Self

pub fn get_coordinate(&self) -> String

Trait Implementations

impl Clone for Chart

fn clone(&self) -> Chart

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chart

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Chart

fn default() -> Self

Returns the “default value” for a type.