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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
use crate::{
try_to_vec, CStringHelper, StringOrFloat, Worksheet, WorksheetCol, WorksheetRow, XlsxError,
};
/// And/or operator conditions when using 2 filter rules with `filter_column2`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
pub enum FilterOperator {
#[default]
FilterAnd,
FilterOr,
}
impl FilterOperator {
pub(crate) fn into_internal(self) -> libxlsxwriter_sys::lxw_filter_operator {
match self {
FilterOperator::FilterAnd => libxlsxwriter_sys::lxw_filter_operator_LXW_FILTER_AND,
FilterOperator::FilterOr => libxlsxwriter_sys::lxw_filter_operator_LXW_FILTER_OR,
}
}
}
/// Criteria used to define an autofilter rule condition.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
pub enum FilterCriteria {
/// Filter cells equal to a value.
#[default]
EqualTo,
/// Filter cells not equal to a value.
NotEqualTo,
/// Filter cells greater than a value.
GreaterThan,
/// Filter cells less than a value.
LessThan,
/// Filter cells greater than or equal to a value.
GreaterThanOrEqualTo,
/// Filter cells less than or equal to a value.
LessThanOrEqualTo,
/// Filter cells that are blank.
Blanks,
/// Filter cells that are not blank.
NonBlanks,
}
impl FilterCriteria {
pub(crate) fn into_internal(self) -> libxlsxwriter_sys::lxw_filter_criteria {
match self {
FilterCriteria::EqualTo => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_EQUAL_TO
}
FilterCriteria::NotEqualTo => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_NOT_EQUAL_TO
}
FilterCriteria::GreaterThan => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_GREATER_THAN
}
FilterCriteria::LessThan => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_LESS_THAN
}
FilterCriteria::GreaterThanOrEqualTo => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_GREATER_THAN_OR_EQUAL_TO
}
FilterCriteria::LessThanOrEqualTo => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_LESS_THAN_OR_EQUAL_TO
}
FilterCriteria::Blanks => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_BLANKS
}
FilterCriteria::NonBlanks => {
libxlsxwriter_sys::lxw_filter_criteria_LXW_FILTER_CRITERIA_NON_BLANKS
}
}
}
}
/// Options for autofilter rules.
#[derive(Debug, Clone, PartialEq, PartialOrd, Default)]
pub struct FilterRule {
/// The FilterCriteria to define the rule.
pub criteria: FilterCriteria,
/// value to which the criteria applies.
pub value: StringOrFloat,
}
impl FilterRule {
pub fn new<T: Into<StringOrFloat>>(criteria: FilterCriteria, value: T) -> Self {
FilterRule {
criteria,
value: value.into(),
}
}
pub(crate) fn to_internal(
&self,
c_string_helper: &mut CStringHelper,
) -> Result<libxlsxwriter_sys::lxw_filter_rule, XlsxError> {
Ok(libxlsxwriter_sys::lxw_filter_rule {
criteria: self.criteria.into_internal() as u8,
value_string: c_string_helper.add_opt(self.value.to_str())?
as *mut std::os::raw::c_char,
value: self.value.to_f64().unwrap_or_default(),
})
}
}
impl<'a> Worksheet<'a> {
/// This function allows an autofilter to be added to a worksheet.
///
/// An autofilter is a way of adding drop down lists to the headers of a 2D range of worksheet data.
/// This allows users to filter the data based on simple criteria so that some data is shown and some is hidden.
///
pub fn autofilter(
&mut self,
first_row: WorksheetRow,
first_col: WorksheetCol,
last_row: WorksheetRow,
last_col: WorksheetCol,
) -> Result<(), XlsxError> {
unsafe {
let result = libxlsxwriter_sys::worksheet_autofilter(
self.worksheet,
first_row,
first_col,
last_row,
last_col,
);
if result == libxlsxwriter_sys::lxw_error_LXW_NO_ERROR {
Ok(())
} else {
Err(XlsxError::new(result))
}
}
}
/// This function can be used to filter columns in a autofilter range based on single rule conditions.
///
/// ```rust
/// use xlsxwriter::prelude::*;
/// # use xlsxwriter::worksheet::filter::*;
///
/// # fn main() -> Result<(), XlsxError> {
/// # let workbook = Workbook::new("test-worksheet_filter_column.xlsx")?;
/// # let mut worksheet = workbook.add_worksheet(None)?;
/// # worksheet.write_string(0, 0, "Column A", None)?;
/// # worksheet.write_string(0, 1, "Column B", None)?;
/// # for i in 1..=10 {
/// # let v: f64 = i.into();
/// # worksheet.write_number(i, 0, v, None)?;
/// # worksheet.write_number(i, 1, v + 0.5, None)?;
/// # }
/// worksheet.autofilter(0, 0, 10, 1)?;
/// worksheet.filter_column(0, &FilterRule::new(FilterCriteria::NotEqualTo, 9.0))?;
/// worksheet.set_row_opt(9, LXW_DEF_ROW_HEIGHT, None, &RowColOptions::new(true, 0, false))?;
/// # Ok(())
/// # }
///
/// ```
///
/// The `col` parameter is a zero indexed column number and must refer to a column in an existing autofilter created with [`Worksheet::autofilter`].
/// It isn't sufficient to just specify the filter condition. You must also hide any rows that don't match the filter condition.
pub fn filter_column(
&mut self,
col: crate::WorksheetCol,
rule: &FilterRule,
) -> Result<(), XlsxError> {
unsafe {
let mut c_string_helper = CStringHelper::new();
let mut rule_converted = rule.to_internal(&mut c_string_helper)?;
let e = libxlsxwriter_sys::worksheet_filter_column(
self.worksheet,
col,
&mut rule_converted,
);
if e != libxlsxwriter_sys::lxw_error_LXW_NO_ERROR {
return Err(XlsxError::new(e));
}
}
Ok(())
}
/// This function can be used to filter columns in a autofilter range based on two rule conditions.
///
/// ```rust
/// use xlsxwriter::prelude::*;
/// # use xlsxwriter::worksheet::filter::*;
///
/// # fn main() -> Result<(), XlsxError> {
/// # let workbook = Workbook::new("test-worksheet_filter_column2.xlsx")?;
/// # let mut worksheet = workbook.add_worksheet(None)?;
/// # worksheet.write_string(0, 0, "Column A", None)?;
/// # worksheet.write_string(0, 1, "Column B", None)?;
/// # for i in 1..=10 {
/// # let v: f64 = i.into();
/// # worksheet.write_number(i, 0, v, None)?;
/// # worksheet.write_number(i, 1, v + 0.5, None)?;
/// # }
/// worksheet.autofilter(0, 0, 10, 1)?;
/// worksheet.filter_column2(0, &FilterRule::new(FilterCriteria::LessThan, 8.5), &FilterRule::new(FilterCriteria::GreaterThan, 9.5), FilterOperator::FilterOr)?;
/// worksheet.set_row_opt(9, LXW_DEF_ROW_HEIGHT, None, &RowColOptions::new(true, 0, false))?;
/// # Ok(())
/// # }
///
/// ```
///
/// It isn't sufficient to just specify the filter condition. You must also hide any rows that don't match the filter condition.
pub fn filter_column2(
&mut self,
col: crate::WorksheetCol,
rule1: &FilterRule,
rule2: &FilterRule,
and_or: FilterOperator,
) -> Result<(), XlsxError> {
unsafe {
let mut c_string_helper = CStringHelper::new();
let mut rule_converted1 = rule1.to_internal(&mut c_string_helper)?;
let mut rule_converted2 = rule2.to_internal(&mut c_string_helper)?;
let e = libxlsxwriter_sys::worksheet_filter_column2(
self.worksheet,
col,
&mut rule_converted1,
&mut rule_converted2,
and_or.into_internal() as u8,
);
if e != libxlsxwriter_sys::lxw_error_LXW_NO_ERROR {
return Err(XlsxError::new(e));
}
}
Ok(())
}
/// This function can be used specify multiple string matching criteria. This is a newer type of filter introduced in Excel 2007.
/// Prior to that it was only possible to have either 1 or 2 filter conditions, such as the ones used by [`Worksheet::filter_column()`]
/// and [`Worksheet::filter_column2()`].
///
/// ```rust
/// use xlsxwriter::prelude::*;
///
/// # fn main() -> Result<(), XlsxError> {
/// # let workbook = Workbook::new("test-worksheet_filter_list.xlsx")?;
/// # let mut worksheet = workbook.add_worksheet(None)?;
/// # worksheet.write_string(0, 0, "Column A", None)?;
/// # worksheet.write_string(0, 1, "Column B", None)?;
/// # for i in 1..=10 {
/// # let v: f64 = i.into();
/// # worksheet.write_number(i, 0, v, None)?;
/// # worksheet.write_number(i, 1, v + 0.5, None)?;
/// # }
/// worksheet.autofilter(0, 0, 10, 1)?;
/// worksheet.filter_list(0, &["1", "2", "3", "4", "5", "6", "7", "8", "10"])?;
/// worksheet.set_row_opt(9, LXW_DEF_ROW_HEIGHT, None, &RowColOptions::new(true, 0, false))?;
/// # Ok(())
/// # }
///
/// ```
///
/// It isn't sufficient to just specify the filter condition. You must also hide any rows that don't match the filter condition.
pub fn filter_list(
&mut self,
col: crate::WorksheetCol,
list: &[&str],
) -> Result<(), XlsxError> {
let mut cstring_helper = crate::CStringHelper::new();
let mut cstr_list: Vec<_> = try_to_vec(
list.iter()
.map(|x| Ok(cstring_helper.add(x)? as *mut std::os::raw::c_char)),
)?;
cstr_list.push(std::ptr::null_mut());
unsafe {
let result = libxlsxwriter_sys::worksheet_filter_list(
self.worksheet,
col,
cstr_list.as_mut_ptr(),
);
if result != libxlsxwriter_sys::lxw_error_LXW_NO_ERROR {
return Err(XlsxError::new(result));
}
}
Ok(())
}
}
#[cfg(test)]
mod test {
use crate::{RowColOptions, Workbook};
use super::*;
fn create_sheet(worksheet: &mut Worksheet) -> Result<(), XlsxError> {
worksheet.write_string(0, 0, "Column A", None)?;
worksheet.write_string(0, 1, "Column B", None)?;
worksheet.write_string(0, 2, "Column C", None)?;
worksheet.write_string(0, 3, "Column D", None)?;
for i in 1..20 {
let value: f64 = i.into();
worksheet.write_number(i, 0, value, None)?;
worksheet.write_number(i, 1, value / 2., None)?;
worksheet.write_string(i, 2, &format!("TEXT{:02}", i), None)?;
worksheet.write_boolean(i, 3, i % 2 == 0, None)?;
}
worksheet.autofilter(0, 0, 19, 3)?;
Ok(())
}
#[test]
fn test_autofilter() -> Result<(), XlsxError> {
let workbook = Workbook::new("test-worksheet_autofilter.xlsx")?;
// ------------
let mut worksheet1 = workbook.add_worksheet(Some("Sheet 1"))?;
create_sheet(&mut worksheet1)?;
let worksheet1_criteria = FilterRule::new(FilterCriteria::GreaterThan, 10.0);
worksheet1.filter_column(0, &worksheet1_criteria)?;
let hidden_row = RowColOptions::new(true, 0, false);
for i in 1..=10 {
worksheet1.set_row_opt(i, 13.2, None, &hidden_row)?;
}
// ------------
let mut worksheet2 = workbook.add_worksheet(Some("Sheet 2"))?;
create_sheet(&mut worksheet2)?;
let worksheet2_criteria1 = FilterRule::new(FilterCriteria::GreaterThanOrEqualTo, 3.0);
let worksheet2_criteria2 = FilterRule::new(FilterCriteria::LessThan, 5.5);
worksheet2.filter_column2(
1,
&worksheet2_criteria1,
&worksheet2_criteria2,
FilterOperator::FilterAnd,
)?;
for i in 1..20 {
let value: f64 = i.into();
if (value / 2.0) < 3. || 5.5 <= (value / 2.0) {
worksheet2.set_row_opt(i, 13.2, None, &hidden_row)?;
}
}
// --------------
let mut worksheet3 = workbook.add_worksheet(Some("Sheet 3"))?;
create_sheet(&mut worksheet3)?;
worksheet3.filter_list(2, &["TEXT02", "TEXT03"])?;
for i in 1..20 {
if i != 2 && i != 3 {
worksheet3.set_row_opt(i, 13.2, None, &hidden_row)?;
}
}
workbook.close()?;
Ok(())
}
}