Struct ColumnSetting 

pub struct ColumnSetting {
    pub column: usize,
    pub width: Option<f64>,
    pub hidden: bool,
    pub outline_level: u8,
    pub collapsed: bool,
    pub style: Option<CellFormat>,
}

A single column’s width/visibility/outline setting (<col>, CT_Col) — extended for collapsed.

Fields

column: usize

The 0-based column index this setting applies to (e.g. 0 for column A) — written as min == max == column + 1 (see Sheet.column_settings’s doc comment for why this crate doesn’t bother collapsing adjacent columns into a single ranged <col>).

width: Option<f64>

The column’s width, in Excel’s own character-width units. None leaves the column at Excel’s default width.

hidden: bool

Whether this column is hidden.

outline_level: u8

This column’s outline (grouping) level (0-7).

collapsed: bool

Whether this column’s outline group is shown collapsed (the “-” summary-only state of the little outline button). Distinct from outline_level itself (which columns belong to the group) — this is only the group’s current expanded/collapsed display state.

style: Option<CellFormat>

This column’s default cell format (<col style="n">, an index into xl/styles.xml’s cellXfs). Applied by real Excel to any cell in this column that doesn’t carry its own explicit <c s=".."> — e.g. a brand-new cell typed into an empty row of this column picks up this format automatically. Distinct from Cell::format: a cell’s own format always wins over its column’s default when both are set (same precedence as real Excel’s own column-formatting feature); this crate does not enforce or resolve that precedence itself, it only stores and writes each side’s format independently, same “storage, not resolution” posture as elsewhere in this crate. Deduplicated into shared cellXfs entries by the writer exactly like Cell::format — see writer.rs::collect_cell_formats.

Implementations

impl ColumnSetting

pub fn new(column: usize) -> ColumnSetting

Creates a column setting with no width/hidden/outline/style override yet (only useful as a starting point for the with_* builders).

Examples found in repository

examples/xlsx_structure_and_layout.rs (line 27)

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

    let merged_sheet = Sheet::new("Merged cells")
        .with_row(Row::new().with_text("This title spans three columns"))
        .with_merged_range("A1:C1");

    let columns_sheet = Sheet::new("Columns")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Wide"))
                .with_cell(Cell::text("Hidden"))
                .with_cell(Cell::text("Grouped")),
        )
        .with_column_setting(ColumnSetting::new(0).with_width(30.0))
        .with_column_setting(ColumnSetting::new(1).with_hidden(true))
        .with_column_setting(
            ColumnSetting::new(2)
                .with_outline_level(1)
                .with_collapsed(false),
        );

    let rows_sheet = Sheet::new("Rows")
        .with_row(Row::new().with_text("Normal row"))
        .with_row(Row::new().with_text("Taller row").with_height(30.0))
        .with_row(Row::new().with_text("Hidden row").with_hidden(true))
        .with_row(
            Row::new()
                .with_text("Grouped detail row")
                .with_outline_level(1),
        );

    let frozen_panes_sheet = Sheet::new("Frozen panes")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Frozen header"))
                .with_cell(Cell::text("Frozen header")),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::text("Scrolling data"))
                .with_cell(Cell::number(1.0)),
        )
        .with_freeze_panes(FreezePane::new(1, 1));

    let page_breaks_sheet = Sheet::new("Page breaks")
        .with_row(Row::new().with_text("Above this row: page break"))
        .with_row(Row::new().with_text("Below the break"))
        .with_row_break(1)
        .with_column_break(0)
        .with_outline_summary_below(false)
        .with_outline_summary_right(false);

    let workbook = Workbook::new()
        .with_sheet(merged_sheet)
        .with_sheet(columns_sheet)
        .with_sheet(rows_sheet)
        .with_sheet(frozen_panes_sheet)
        .with_sheet(page_breaks_sheet);

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

pub fn with_width(self, width: f64) -> ColumnSetting

Sets the column’s width and returns it for chaining.

Examples found in repository

examples/xlsx_structure_and_layout.rs (line 27)

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

    let merged_sheet = Sheet::new("Merged cells")
        .with_row(Row::new().with_text("This title spans three columns"))
        .with_merged_range("A1:C1");

    let columns_sheet = Sheet::new("Columns")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Wide"))
                .with_cell(Cell::text("Hidden"))
                .with_cell(Cell::text("Grouped")),
        )
        .with_column_setting(ColumnSetting::new(0).with_width(30.0))
        .with_column_setting(ColumnSetting::new(1).with_hidden(true))
        .with_column_setting(
            ColumnSetting::new(2)
                .with_outline_level(1)
                .with_collapsed(false),
        );

    let rows_sheet = Sheet::new("Rows")
        .with_row(Row::new().with_text("Normal row"))
        .with_row(Row::new().with_text("Taller row").with_height(30.0))
        .with_row(Row::new().with_text("Hidden row").with_hidden(true))
        .with_row(
            Row::new()
                .with_text("Grouped detail row")
                .with_outline_level(1),
        );

    let frozen_panes_sheet = Sheet::new("Frozen panes")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Frozen header"))
                .with_cell(Cell::text("Frozen header")),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::text("Scrolling data"))
                .with_cell(Cell::number(1.0)),
        )
        .with_freeze_panes(FreezePane::new(1, 1));

    let page_breaks_sheet = Sheet::new("Page breaks")
        .with_row(Row::new().with_text("Above this row: page break"))
        .with_row(Row::new().with_text("Below the break"))
        .with_row_break(1)
        .with_column_break(0)
        .with_outline_summary_below(false)
        .with_outline_summary_right(false);

    let workbook = Workbook::new()
        .with_sheet(merged_sheet)
        .with_sheet(columns_sheet)
        .with_sheet(rows_sheet)
        .with_sheet(frozen_panes_sheet)
        .with_sheet(page_breaks_sheet);

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

pub fn with_style(self, style: CellFormat) -> ColumnSetting

Sets the column’s default cell format and returns it for chaining.

pub fn with_hidden(self, hidden: bool) -> ColumnSetting

Sets whether the column is hidden and returns it for chaining.

Examples found in repository

examples/xlsx_structure_and_layout.rs (line 28)

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

    let merged_sheet = Sheet::new("Merged cells")
        .with_row(Row::new().with_text("This title spans three columns"))
        .with_merged_range("A1:C1");

    let columns_sheet = Sheet::new("Columns")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Wide"))
                .with_cell(Cell::text("Hidden"))
                .with_cell(Cell::text("Grouped")),
        )
        .with_column_setting(ColumnSetting::new(0).with_width(30.0))
        .with_column_setting(ColumnSetting::new(1).with_hidden(true))
        .with_column_setting(
            ColumnSetting::new(2)
                .with_outline_level(1)
                .with_collapsed(false),
        );

    let rows_sheet = Sheet::new("Rows")
        .with_row(Row::new().with_text("Normal row"))
        .with_row(Row::new().with_text("Taller row").with_height(30.0))
        .with_row(Row::new().with_text("Hidden row").with_hidden(true))
        .with_row(
            Row::new()
                .with_text("Grouped detail row")
                .with_outline_level(1),
        );

    let frozen_panes_sheet = Sheet::new("Frozen panes")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Frozen header"))
                .with_cell(Cell::text("Frozen header")),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::text("Scrolling data"))
                .with_cell(Cell::number(1.0)),
        )
        .with_freeze_panes(FreezePane::new(1, 1));

    let page_breaks_sheet = Sheet::new("Page breaks")
        .with_row(Row::new().with_text("Above this row: page break"))
        .with_row(Row::new().with_text("Below the break"))
        .with_row_break(1)
        .with_column_break(0)
        .with_outline_summary_below(false)
        .with_outline_summary_right(false);

    let workbook = Workbook::new()
        .with_sheet(merged_sheet)
        .with_sheet(columns_sheet)
        .with_sheet(rows_sheet)
        .with_sheet(frozen_panes_sheet)
        .with_sheet(page_breaks_sheet);

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

pub fn with_collapsed(self, collapsed: bool) -> ColumnSetting

Sets whether this column’s outline group is shown collapsed and returns it for chaining.

Examples found in repository

examples/xlsx_structure_and_layout.rs (line 32)

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

    let merged_sheet = Sheet::new("Merged cells")
        .with_row(Row::new().with_text("This title spans three columns"))
        .with_merged_range("A1:C1");

    let columns_sheet = Sheet::new("Columns")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Wide"))
                .with_cell(Cell::text("Hidden"))
                .with_cell(Cell::text("Grouped")),
        )
        .with_column_setting(ColumnSetting::new(0).with_width(30.0))
        .with_column_setting(ColumnSetting::new(1).with_hidden(true))
        .with_column_setting(
            ColumnSetting::new(2)
                .with_outline_level(1)
                .with_collapsed(false),
        );

    let rows_sheet = Sheet::new("Rows")
        .with_row(Row::new().with_text("Normal row"))
        .with_row(Row::new().with_text("Taller row").with_height(30.0))
        .with_row(Row::new().with_text("Hidden row").with_hidden(true))
        .with_row(
            Row::new()
                .with_text("Grouped detail row")
                .with_outline_level(1),
        );

    let frozen_panes_sheet = Sheet::new("Frozen panes")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Frozen header"))
                .with_cell(Cell::text("Frozen header")),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::text("Scrolling data"))
                .with_cell(Cell::number(1.0)),
        )
        .with_freeze_panes(FreezePane::new(1, 1));

    let page_breaks_sheet = Sheet::new("Page breaks")
        .with_row(Row::new().with_text("Above this row: page break"))
        .with_row(Row::new().with_text("Below the break"))
        .with_row_break(1)
        .with_column_break(0)
        .with_outline_summary_below(false)
        .with_outline_summary_right(false);

    let workbook = Workbook::new()
        .with_sheet(merged_sheet)
        .with_sheet(columns_sheet)
        .with_sheet(rows_sheet)
        .with_sheet(frozen_panes_sheet)
        .with_sheet(page_breaks_sheet);

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

pub fn with_outline_level(self, level: u8) -> ColumnSetting

Sets the column’s outline (grouping) level and returns it for chaining.

Examples found in repository

examples/xlsx_structure_and_layout.rs (line 31)

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

    let merged_sheet = Sheet::new("Merged cells")
        .with_row(Row::new().with_text("This title spans three columns"))
        .with_merged_range("A1:C1");

    let columns_sheet = Sheet::new("Columns")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Wide"))
                .with_cell(Cell::text("Hidden"))
                .with_cell(Cell::text("Grouped")),
        )
        .with_column_setting(ColumnSetting::new(0).with_width(30.0))
        .with_column_setting(ColumnSetting::new(1).with_hidden(true))
        .with_column_setting(
            ColumnSetting::new(2)
                .with_outline_level(1)
                .with_collapsed(false),
        );

    let rows_sheet = Sheet::new("Rows")
        .with_row(Row::new().with_text("Normal row"))
        .with_row(Row::new().with_text("Taller row").with_height(30.0))
        .with_row(Row::new().with_text("Hidden row").with_hidden(true))
        .with_row(
            Row::new()
                .with_text("Grouped detail row")
                .with_outline_level(1),
        );

    let frozen_panes_sheet = Sheet::new("Frozen panes")
        .with_row(
            Row::new()
                .with_cell(Cell::text("Frozen header"))
                .with_cell(Cell::text("Frozen header")),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::text("Scrolling data"))
                .with_cell(Cell::number(1.0)),
        )
        .with_freeze_panes(FreezePane::new(1, 1));

    let page_breaks_sheet = Sheet::new("Page breaks")
        .with_row(Row::new().with_text("Above this row: page break"))
        .with_row(Row::new().with_text("Below the break"))
        .with_row_break(1)
        .with_column_break(0)
        .with_outline_summary_below(false)
        .with_outline_summary_right(false);

    let workbook = Workbook::new()
        .with_sheet(merged_sheet)
        .with_sheet(columns_sheet)
        .with_sheet(rows_sheet)
        .with_sheet(frozen_panes_sheet)
        .with_sheet(page_breaks_sheet);

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

Trait Implementations

impl Clone for ColumnSetting

fn clone(&self) -> ColumnSetting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnSetting

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

Formats the value using the given formatter.

impl PartialEq for ColumnSetting

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColumnSetting