Struct AutoFilterColumn 

pub struct AutoFilterColumn {
    pub column_offset: u32,
    pub visible_values: Vec<String>,
}

One column’s filter criteria within a Sheet::auto_filter_range (<filterColumn>/<filters>/<filter>, CT_FilterColumn/ CT_Filters/CT_Filter). Only the simplest, most common filter form is modeled: a fixed list of checked/visible values — CT_Filters’s CT_CustomFilters (e.g. “greater than”), CT_Top10, CT_DynamicFilter (e.g. “this month”), and CT_ColorFilter/CT_IconFilter forms are not.

Fields

column_offset: u32

This column’s 0-based offset from Sheet::auto_filter_range’s first column (colId) — e.g. 0 for the filter range’s own first column, regardless of that column’s real sheet position.

visible_values: Vec<String>

The values that remain visible when this filter is applied (<filter val=".."> per entry), written verbatim as text.

Implementations

impl AutoFilterColumn

pub fn new(column_offset: u32, visible_values: Vec<String>) -> AutoFilterColumn

Creates a filter column with the given visible values.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 47)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_workbook_metadata.xlsx");

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for AutoFilterColumn

fn clone(&self) -> AutoFilterColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutoFilterColumn

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

Formats the value using the given formatter.

impl PartialEq for AutoFilterColumn

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AutoFilterColumn