Struct spreadsheet_ods::Sheet

pub struct Sheet { /* private fields */ }

One sheet of the spreadsheet.

Contains the data and the style-references. The can also be styles on the whole sheet, columns and rows. The more complicated grouping tags are not covered.

Implementations

impl Sheet

pub fn new_with_name<S: Into<String>>(name: S) -> Self

👎Deprecated

Create an empty sheet.

pub fn new<S: Into<String>>(name: S) -> Self

Create an empty sheet.

The name is shown as the tab-title, but also as a reference for this sheet in formulas and sheet-metadata. Giving an empty string here is allowed and a name will be generated, when the document is opened. But any metadata will not be applied.

Renaming the sheet works for metadata, but formulas will not be fixed.

Examples found in repository

examples/negative_number_red.rs (line 46)

pub fn main() -> Result<(), OdsError> {
    let mut wb = WorkBook::new(locale!("de_AT"));

    // positive format
    let mut f_number = ValueFormatNumber::new_localized("num0", locale!("de_AT"));
    f_number
        .part_number()
        .decimal_places(2)
        .min_integer_digits(1)
        .grouping()
        .build();
    let f_number = wb.add_number_format(f_number);

    // negative format
    let mut f_number_red = ValueFormatNumber::new_localized("num0red", locale!("de_AT"));
    f_number_red.part_text("-").build();
    f_number_red
        .part_number()
        .decimal_places(2)
        .min_integer_digits(1)
        .grouping()
        .build();
    f_number_red.set_color(Rgb::new(255, 0, 0));
    f_number_red.push_stylemap(ValueStyleMap::new(ValueCondition::value_ge(0), f_number));
    let f_number_red = wb.add_number_format(f_number_red);

    // cellstyle for this number format
    let s_number = CellStyle::new("num_red", &f_number_red);
    let s_number = wb.add_cellstyle(s_number);

    // ...

    let mut sheet = Sheet::new("sample");

    sheet.set_styled_value(0, 0, 723, &s_number);
    sheet.set_styled_value(1, 0, -723, &s_number);

    wb.push_sheet(sheet);

    write_ods(&mut wb, "examples/neg.ods")?;

    Ok(())
}

pub fn clone_no_data(&self) -> Self

Copy all the attributes but not the actual data.

pub fn iter(&self) -> CellIter<'_>

Iterate all cells.

pub fn cell_count(&self) -> usize

Count all cells with any data.

pub fn range<R>(&self, range: R) -> Range<'_>

where R: RangeBounds<(u32, u32)>,

Iterate a range of cells.

pub fn set_name<V: Into<String>>(&mut self, name: V)

Sheet name.

pub fn name(&self) -> &String

Sheet name.

pub fn config(&self) -> &SheetConfig

Configuration for the sheet.

pub fn config_mut(&mut self) -> &mut SheetConfig

Configuration for the sheet.

pub fn set_style(&mut self, style: &TableStyleRef)

Sets the table-style

pub fn style(&self) -> Option<&String>

Returns the table-style.

pub fn set_colstyle(&mut self, col: u32, style: &ColStyleRef)

Column style.

pub fn clear_colstyle(&mut self, col: u32)

Remove the style.

pub fn colstyle(&self, col: u32) -> Option<&String>

Returns the column style.

pub fn set_col_cellstyle(&mut self, col: u32, style: &CellStyleRef)

Default cell style for this column.

pub fn clear_col_cellstyle(&mut self, col: u32)

Remove the style.

pub fn col_cellstyle(&self, col: u32) -> Option<&String>

Returns the default cell style for this column.

pub fn set_col_visible(&mut self, col: u32, visible: Visibility)

Visibility of the column

pub fn col_visible(&self, col: u32) -> Visibility

Returns the default cell style for this column.

pub fn set_col_width(&mut self, col: u32, width: Length)

Sets the column width for this column.

pub fn col_width(&self, col: u32) -> Length

Returns the column-width.

pub fn set_rowstyle(&mut self, row: u32, style: &RowStyleRef)

Row style.

pub fn clear_rowstyle(&mut self, row: u32)

Remove the style.

pub fn rowstyle(&self, row: u32) -> Option<&String>

Returns the row style.

pub fn set_row_cellstyle(&mut self, row: u32, style: &CellStyleRef)

Default cell style for this row.

pub fn clear_row_cellstyle(&mut self, row: u32)

Remove the style.

pub fn row_cellstyle(&self, row: u32) -> Option<&String>

Returns the default cell style for this row.

pub fn set_row_visible(&mut self, row: u32, visible: Visibility)

Visibility of the row

pub fn row_visible(&self, row: u32) -> Visibility

Returns the default cell style for this row.

pub fn set_row_repeat(&mut self, row: u32, repeat: u32)

Sets the repeat count for this row. Usually this is the last row with data in a sheet. Setting the repeat count will not change the row number of following rows. But they will be changed after writing to an ODS file and reading it again.

Panics

Panics if the repeat is 0.

pub fn row_repeat(&self, row: u32) -> u32

Returns the repeat count for this row.

pub fn set_row_height(&mut self, row: u32, height: Length)

Sets the row-height.

pub fn row_height(&self, row: u32) -> Length

Returns the row-height

pub fn used_cols(&self) -> u32

Returns the maximum used column +1 in the column header

pub fn used_rows(&self) -> u32

Returns the maximum used row +1 in the row header

pub fn used_grid_size(&self) -> (u32, u32)

Returns a tuple of (max(row)+1, max(col)+1)

pub fn set_display(&mut self, display: bool)

Is the sheet displayed?

pub fn display(&self) -> bool

Is the sheet displayed?

pub fn set_print(&mut self, print: bool)

Is the sheet printed?

pub fn print(&self) -> bool

Is the sheet printed?

pub fn is_empty(&self, row: u32, col: u32) -> bool

Returns true if there is no SCell at the given position.

pub fn cell(&self, row: u32, col: u32) -> Option<CellContent>

Basic range operator. Returns a copy of the cell content.

pub fn cell_ref(&self, row: u32, col: u32) -> Option<CellContentRef<'_>>

Returns a copy of the cell content.

pub fn add_cell(&mut self, row: u32, col: u32, cell: CellContent)

Consumes the CellContent and sets the values.

pub fn remove_cell(&mut self, row: u32, col: u32) -> Option<CellContent>

Removes the cell and returns the values as CellContent.

pub fn set_styled_value<V: Into<Value>>( &mut self, row: u32, col: u32, value: V, style: &CellStyleRef )

Sets a value for the specified cell. Creates a new cell if necessary.

Examples found in repository

examples/negative_number_red.rs (line 48)

pub fn main() -> Result<(), OdsError> {
    let mut wb = WorkBook::new(locale!("de_AT"));

    // positive format
    let mut f_number = ValueFormatNumber::new_localized("num0", locale!("de_AT"));
    f_number
        .part_number()
        .decimal_places(2)
        .min_integer_digits(1)
        .grouping()
        .build();
    let f_number = wb.add_number_format(f_number);

    // negative format
    let mut f_number_red = ValueFormatNumber::new_localized("num0red", locale!("de_AT"));
    f_number_red.part_text("-").build();
    f_number_red
        .part_number()
        .decimal_places(2)
        .min_integer_digits(1)
        .grouping()
        .build();
    f_number_red.set_color(Rgb::new(255, 0, 0));
    f_number_red.push_stylemap(ValueStyleMap::new(ValueCondition::value_ge(0), f_number));
    let f_number_red = wb.add_number_format(f_number_red);

    // cellstyle for this number format
    let s_number = CellStyle::new("num_red", &f_number_red);
    let s_number = wb.add_cellstyle(s_number);

    // ...

    let mut sheet = Sheet::new("sample");

    sheet.set_styled_value(0, 0, 723, &s_number);
    sheet.set_styled_value(1, 0, -723, &s_number);

    wb.push_sheet(sheet);

    write_ods(&mut wb, "examples/neg.ods")?;

    Ok(())
}

pub fn set_value<V: Into<Value>>(&mut self, row: u32, col: u32, value: V)

Sets a value for the specified cell. Creates a new cell if necessary.

pub fn value(&self, row: u32, col: u32) -> &Value

Returns a value

pub fn set_formula<V: Into<String>>(&mut self, row: u32, col: u32, formula: V)

Sets a formula for the specified cell. Creates a new cell if necessary.

pub fn clear_formula(&mut self, row: u32, col: u32)

Removes the formula.

pub fn formula(&self, row: u32, col: u32) -> Option<&String>

Returns a value

pub fn set_col_repeat(&mut self, row: u32, col: u32, repeat: u32)

Sets a repeat counter for the cell.

pub fn col_repeat(&self, row: u32, col: u32) -> u32

Returns the repeat counter for the cell.

pub fn set_cellstyle(&mut self, row: u32, col: u32, style: &CellStyleRef)

Sets the cell-style for the specified cell. Creates a new cell if necessary.

pub fn clear_cellstyle(&mut self, row: u32, col: u32)

Removes the cell-style.

pub fn cellstyle(&self, row: u32, col: u32) -> Option<&String>

Returns a value

pub fn set_validation(&mut self, row: u32, col: u32, validation: &ValidationRef)

Sets a content-validation for this cell.

pub fn clear_validation(&mut self, row: u32, col: u32)

Removes the cell-style.

pub fn validation(&self, row: u32, col: u32) -> Option<&String>

Returns a content-validation name for this cell.

pub fn set_row_span(&mut self, row: u32, col: u32, span: u32)

Sets the rowspan of the cell. Must be greater than 0.

pub fn row_span(&self, row: u32, col: u32) -> u32

Rowspan of the cell.

pub fn set_col_span(&mut self, row: u32, col: u32, span: u32)

Sets the colspan of the cell. Must be greater than 0.

pub fn col_span(&self, row: u32, col: u32) -> u32

Colspan of the cell.

pub fn set_matrix_row_span(&mut self, row: u32, col: u32, span: u32)

Sets the rowspan of the cell. Must be greater than 0.

pub fn matrix_row_span(&self, row: u32, col: u32) -> u32

Rowspan of the cell.

pub fn set_matrix_col_span(&mut self, row: u32, col: u32, span: u32)

Sets the colspan of the cell. Must be greater than 0.

pub fn matrix_col_span(&self, row: u32, col: u32) -> u32

Colspan of the cell.

pub fn set_annotation(&mut self, row: u32, col: u32, annotation: Annotation)

Sets a annotation for this cell.

pub fn clear_annotation(&mut self, row: u32, col: u32)

Removes the annotation.

pub fn annotation(&self, row: u32, col: u32) -> Option<&Annotation>

Returns a content-validation name for this cell.

pub fn annotation_mut(&mut self, row: u32, col: u32) -> Option<&mut Annotation>

Returns a content-validation name for this cell.

pub fn add_draw_frame(&mut self, row: u32, col: u32, draw_frame: DrawFrame)

Add a drawframe to a specific cell.

pub fn clear_draw_frames(&mut self, row: u32, col: u32)

Removes all drawframes.

pub fn draw_frames(&self, row: u32, col: u32) -> Option<&Vec<DrawFrame>>

Returns the draw-frames.

pub fn draw_frames_mut( &mut self, row: u32, col: u32 ) -> Option<&mut Vec<DrawFrame>>

Returns a content-validation name for this cell.

pub fn set_header_rows(&mut self, row_start: u32, row_end: u32)

Defines a range of rows as header rows.

pub fn clear_header_rows(&mut self)

Clears the header-rows definition.

pub fn header_rows(&self) -> &Option<RowRange>

Returns the header rows.

pub fn set_header_cols(&mut self, col_start: u32, col_end: u32)

Defines a range of columns as header columns.

pub fn clear_header_cols(&mut self)

Clears the header-columns definition.

pub fn header_cols(&self) -> &Option<ColRange>

Returns the header columns.

pub fn add_print_range(&mut self, range: CellRange)

Print ranges.

pub fn clear_print_ranges(&mut self)

Remove print ranges.

pub fn print_ranges(&self) -> Option<&Vec<CellRange>>

Return the print ranges.

pub fn split_col_header(&mut self, col: u32)

Split horizontally on a cell boundary. The splitting is fixed in position.

pub fn split_row_header(&mut self, row: u32)

Split vertically on a cell boundary. The splitting is fixed in position.

pub fn split_horizontal(&mut self, col: u32)

Split horizontally with a pixel width. The split can be moved around. For more control look at SheetConfig.

pub fn split_vertical(&mut self, col: u32)

Split vertically with a pixel width. The split can be moved around. For more control look at SheetConfig.

pub fn add_col_group(&mut self, from: u32, to: u32)

Add a column group.

Panic

Column groups can be contained within another, but they can’t overlap. From must be less than or equal to.

pub fn remove_col_group(&mut self, from: u32, to: u32)

Remove a column group.

pub fn set_col_group_displayed(&mut self, from: u32, to: u32, display: bool)

Change the expansion/collapse of a col group.

Does nothing if no such group exists.

pub fn col_group_count(&self) -> usize

Count of column groups.

pub fn col_group(&self, idx: usize) -> Option<&Grouped>

Returns the nth column group.

pub fn col_group_mut(&mut self, idx: usize) -> Option<&mut Grouped>

Returns the nth column group.

pub fn col_group_iter(&self) -> impl Iterator<Item = &Grouped>

Iterate the column groups.

pub fn add_row_group(&mut self, from: u32, to: u32)

Add a row group.

Panic

Row groups can be contained within another, but they can’t overlap. From must be less than or equal to.

pub fn remove_row_group(&mut self, from: u32, to: u32)

Remove a row group.

pub fn set_row_group_displayed(&mut self, from: u32, to: u32, display: bool)

Change the expansion/collapse of a row group.

Does nothing if no such group exists.

pub fn row_group_count(&self) -> usize

Count of row groups.

pub fn row_group(&self, idx: usize) -> Option<&Grouped>

Returns the nth row group.

pub fn row_group_iter(&self) -> impl Iterator<Item = &Grouped>

Iterate row groups.

Trait Implementations

impl Clone for Sheet

fn clone(&self) -> Sheet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sheet

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

Formats the value using the given formatter.

impl Default for Sheet

fn default() -> Sheet

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a Sheet

type Item = ((u32, u32), CellContentRef<'a>)

The type of the elements being iterated over.

type IntoIter = CellIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.