excelize-rs 0.1.0

Rust language library for reading and writing Microsoft Excel (XLAM / XLSM / XLSX / XLTM / XLTX) spreadsheets
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

//! Chartsheet part (`chartsheets/sheet*.xml`).
//!
//! Ported from Go `xmlChartSheet.go`.

use serde::{Deserialize, Serialize};

use super::common::{XlsxColor, XlsxExtLst, XlsxInnerXml};

/// Directly maps the chartsheet element of Chartsheet Parts in a
/// SpreadsheetML document.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "chartsheet")]
pub struct XlsxChartsheet {
    #[serde(rename = "@xmlns", default)]
    pub xmlns: Option<String>,
    #[serde(rename = "sheetPr", default)]
    pub sheet_pr: Option<XlsxChartsheetPr>,
    #[serde(rename = "sheetViews", default)]
    pub sheet_views: Option<XlsxChartsheetViews>,
    #[serde(rename = "sheetProtection", default)]
    pub sheet_protection: Option<XlsxChartsheetProtection>,
    #[serde(rename = "customSheetViews", default)]
    pub custom_sheet_views: Option<XlsxCustomChartsheetViews>,
    #[serde(rename = "pageMargins", default)]
    pub page_margins: Option<XlsxPageMargins>,
    #[serde(rename = "pageSetup", default)]
    pub page_setup: Option<XlsxPageSetUp>,
    #[serde(rename = "headerFooter", default)]
    pub header_footer: Option<XlsxHeaderFooter>,
    #[serde(rename = "drawing", default)]
    pub drawing: Option<XlsxDrawing>,
    #[serde(rename = "drawingHF", default)]
    pub drawing_hf: Option<XlsxDrawingHF>,
    #[serde(rename = "picture", default)]
    pub picture: Option<XlsxPicture>,
    #[serde(rename = "webPublishItems", default)]
    pub web_publish_items: Option<XlsxInnerXml>,
    #[serde(rename = "extLst", default)]
    pub ext_lst: Option<XlsxExtLst>,
}

/// Specifies chart sheet properties.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "sheetPr")]
pub struct XlsxChartsheetPr {
    #[serde(rename = "@published", default)]
    pub published: Option<bool>,
    #[serde(rename = "@codeName", default)]
    pub code_name: Option<String>,
    #[serde(rename = "tabColor", default)]
    pub tab_color: Option<XlsxColor>,
}

/// Specifies chart sheet views.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "sheetViews")]
pub struct XlsxChartsheetViews {
    #[serde(rename = "sheetView", default)]
    pub sheet_view: Vec<XlsxChartsheetView>,
    #[serde(rename = "extLst", default)]
    pub ext_lst: Vec<XlsxExtLst>,
}

/// Defines custom view properties for chart sheets.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "sheetView")]
pub struct XlsxChartsheetView {
    #[serde(rename = "@tabSelected", default)]
    pub tab_selected: Option<bool>,
    #[serde(rename = "@zoomScale", default)]
    pub zoom_scale: Option<u32>,
    #[serde(rename = "@workbookViewId")]
    pub workbook_view_id: u32,
    #[serde(rename = "@zoomToFit", default)]
    pub zoom_to_fit: Option<bool>,
    #[serde(rename = "extLst", default)]
    pub ext_lst: Vec<XlsxExtLst>,
}

/// Expresses the chart sheet protection options to enforce when the chart
/// sheet is protected.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "sheetProtection")]
pub struct XlsxChartsheetProtection {
    #[serde(rename = "@algorithmName", default)]
    pub algorithm_name: Option<String>,
    #[serde(rename = "@hashValue", default)]
    pub hash_value: Option<String>,
    #[serde(rename = "@saltValue", default)]
    pub salt_value: Option<String>,
    #[serde(rename = "@spinCount", default)]
    pub spin_count: Option<u32>,
    #[serde(rename = "@content", default)]
    pub content: Option<bool>,
    #[serde(rename = "@objects", default)]
    pub objects: Option<bool>,
}

/// Collection of custom Chart Sheet View information.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "customSheetViews")]
pub struct XlsxCustomChartsheetViews {
    #[serde(rename = "customSheetView", default)]
    pub custom_sheet_view: Vec<XlsxCustomChartsheetView>,
}

/// Defines custom view properties for chart sheets.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "customSheetView")]
pub struct XlsxCustomChartsheetView {
    #[serde(rename = "@guid")]
    pub guid: String,
    #[serde(rename = "@scale", default)]
    pub scale: Option<u32>,
    #[serde(rename = "@state", default)]
    pub state: Option<String>,
    #[serde(rename = "@zoomToFit", default)]
    pub zoom_to_fit: Option<bool>,
    #[serde(rename = "pageMargins", default)]
    pub page_margins: Vec<XlsxPageMargins>,
    #[serde(rename = "pageSetup", default)]
    pub page_setup: Vec<XlsxPageSetUp>,
    #[serde(rename = "headerFooter", default)]
    pub header_footer: Vec<XlsxHeaderFooter>,
}

/// Page margins for a sheet or a custom sheet view.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "pageMargins")]
pub struct XlsxPageMargins {
    #[serde(rename = "@left")]
    pub left: f64,
    #[serde(rename = "@right")]
    pub right: f64,
    #[serde(rename = "@top")]
    pub top: f64,
    #[serde(rename = "@bottom")]
    pub bottom: f64,
    #[serde(rename = "@header")]
    pub header: f64,
    #[serde(rename = "@footer")]
    pub footer: f64,
}

/// Page setup settings for the worksheet.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "pageSetup")]
pub struct XlsxPageSetUp {
    #[serde(rename = "@blackAndWhite", default)]
    pub black_and_white: Option<bool>,
    #[serde(rename = "@cellComments", default)]
    pub cell_comments: Option<String>,
    #[serde(rename = "@copies", default)]
    pub copies: Option<i64>,
    #[serde(rename = "@draft", default)]
    pub draft: Option<bool>,
    #[serde(rename = "@errors", default)]
    pub errors: Option<String>,
    #[serde(rename = "@firstPageNumber", default)]
    pub first_page_number: Option<String>,
    #[serde(rename = "@fitToHeight", default)]
    pub fit_to_height: Option<i64>,
    #[serde(rename = "@fitToWidth", default)]
    pub fit_to_width: Option<i64>,
    #[serde(rename = "@horizontalDpi", default)]
    pub horizontal_dpi: Option<String>,
    #[serde(rename = "@r:id", default)]
    pub r_id: Option<String>,
    #[serde(rename = "@orientation", default)]
    pub orientation: Option<String>,
    #[serde(rename = "@pageOrder", default)]
    pub page_order: Option<String>,
    #[serde(rename = "@paperHeight", default)]
    pub paper_height: Option<String>,
    #[serde(rename = "@paperSize", default)]
    pub paper_size: Option<i64>,
    #[serde(rename = "@paperWidth", default)]
    pub paper_width: Option<String>,
    #[serde(rename = "@scale", default)]
    pub scale: Option<i64>,
    #[serde(rename = "@useFirstPageNumber", default)]
    pub use_first_page_number: Option<bool>,
    #[serde(rename = "@usePrinterDefaults", default)]
    pub use_printer_defaults: Option<bool>,
    #[serde(rename = "@verticalDpi", default)]
    pub vertical_dpi: Option<String>,
}

/// When printed or viewed in page layout view, each page of a worksheet can
/// have a page header, a page footer, or both.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "headerFooter")]
pub struct XlsxHeaderFooter {
    #[serde(rename = "@differentOddEven", default)]
    pub different_odd_even: Option<bool>,
    #[serde(rename = "@differentFirst", default)]
    pub different_first: Option<bool>,
    #[serde(rename = "@scaleWithDoc", default)]
    pub scale_with_doc: Option<bool>,
    #[serde(rename = "@alignWithMargins", default)]
    pub align_with_margins: Option<bool>,
    #[serde(rename = "oddHeader", default)]
    pub odd_header: Option<String>,
    #[serde(rename = "oddFooter", default)]
    pub odd_footer: Option<String>,
    #[serde(rename = "evenHeader", default)]
    pub even_header: Option<String>,
    #[serde(rename = "evenFooter", default)]
    pub even_footer: Option<String>,
    #[serde(rename = "firstHeader", default)]
    pub first_header: Option<String>,
    #[serde(rename = "firstFooter", default)]
    pub first_footer: Option<String>,
}

/// Drawing reference for a chartsheet.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "drawing")]
pub struct XlsxDrawing {
    #[serde(rename = "@r:id", default)]
    pub r_id: Option<String>,
}

/// Drawing reference in header/footer.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "drawingHF")]
pub struct XlsxDrawingHF {
    #[serde(flatten, default)]
    pub inner: XlsxInnerXml,
}

/// Picture reference for a chartsheet.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "picture")]
pub struct XlsxPicture {
    #[serde(rename = "@r:id", default)]
    pub r_id: Option<String>,
}