pptx 0.1.0

A Rust library for creating and manipulating PowerPoint (.pptx) files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! XY (scatter) chart data types.

use crate::enums::chart::XlChartType;
use crate::error::PptxResult;

use super::super::xmlwriter::ChartXmlWriter;

// ---------------------------------------------------------------------------
// XyChartData
// ---------------------------------------------------------------------------

/// Accumulates data for XY (scatter) charts.
///
/// # Example
/// ```
/// use pptx::chart::data::XyChartData;
///
/// let mut chart_data = XyChartData::new();
/// let mut series = chart_data.add_series("Measurements");
/// series.add_data_point(1.0, 2.5);
/// series.add_data_point(3.0, 4.0);
/// ```
#[derive(Debug, Clone)]
pub struct XyChartData {
    series: Vec<XySeriesData>,
    number_format: String,
}

impl XyChartData {
    /// Create a new empty XY chart data object.
    #[must_use]
    pub fn new() -> Self {
        Self {
            series: Vec::new(),
            number_format: "General".to_string(),
        }
    }

    /// Add a series and return a mutable reference to populate its data points.
    ///
    /// # Panics
    /// This method will not panic; the internal `unwrap()` is safe because
    /// an element was just pushed.
    pub fn add_series(&mut self, name: &str) -> &mut XySeriesData {
        let index = self.series.len();
        self.series.push(XySeriesData {
            name: name.to_string(),
            data_points: Vec::new(),
            number_format: None,
            index,
        });
        let idx = self.series.len() - 1;
        &mut self.series[idx]
    }

    /// Get the series data.
    #[must_use]
    pub fn series(&self) -> &[XySeriesData] {
        &self.series
    }

    /// Get the number format.
    #[must_use]
    pub fn number_format(&self) -> &str {
        &self.number_format
    }

    /// Generate chart XML for the given chart type.
    ///
    /// # Errors
    /// Returns an error if the chart type is unsupported or XML generation fails.
    pub fn to_xml(&self, chart_type: XlChartType) -> PptxResult<String> {
        ChartXmlWriter::write_xy(self, chart_type)
    }
}

/// Creates an empty XY chart data set with no series.
impl Default for XyChartData {
    fn default() -> Self {
        Self::new()
    }
}

/// Data for a single series in an XY chart.
#[derive(Debug, Clone)]
pub struct XySeriesData {
    name: String,
    data_points: Vec<XyDataPoint>,
    number_format: Option<String>,
    index: usize,
}

impl XySeriesData {
    /// Add a data point with X and Y values.
    pub fn add_data_point(&mut self, x: f64, y: f64) {
        self.data_points.push(XyDataPoint { x, y });
    }

    /// The series name.
    #[must_use]
    pub fn name(&self) -> &str {
        &self.name
    }

    /// The data points.
    #[must_use]
    pub fn data_points(&self) -> &[XyDataPoint] {
        &self.data_points
    }

    /// The X values.
    #[must_use]
    pub fn x_values(&self) -> Vec<f64> {
        self.data_points.iter().map(|dp| dp.x).collect()
    }

    /// The Y values.
    #[must_use]
    pub fn y_values(&self) -> Vec<f64> {
        self.data_points.iter().map(|dp| dp.y).collect()
    }

    /// The zero-based index of this series.
    #[must_use]
    pub const fn index(&self) -> usize {
        self.index
    }

    /// The number format, or `None` to inherit from chart data.
    #[must_use]
    pub fn number_format(&self) -> Option<&str> {
        self.number_format.as_deref()
    }
}

/// A data point in an XY chart series.
#[derive(Debug, Clone, Copy)]
pub struct XyDataPoint {
    /// The X value.
    pub x: f64,
    /// The Y value.
    pub y: f64,
}