Struct spreadsheet_ods::Sheet

pub struct Sheet { /* fields omitted */ }

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() -> Self

New, empty

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

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

Sheet name.

pub fn name(&self) -> &String

Sheet name.

pub fn set_style<V: Into<String>>(&mut self, style: V)

Sets the table-style

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

Returns the table-style.

pub fn set_column_style<V: Into<String>>(&mut self, col: ucell, style: V)

Column style.

pub fn clear_column_style(&mut self, col: ucell)

Remove the style.

pub fn column_style(&self, col: ucell) -> Option<&String>

Returns the column style.

pub fn set_column_cell_style<V: Into<String>>(&mut self, col: ucell, style: V)

Default cell style for this column.

pub fn clear_column_cell_style(&mut self, col: ucell)

Remove the style.

pub fn column_cell_style(&self, col: ucell) -> Option<&String>

Returns the default cell style for this column.

pub fn set_column_visible(&mut self, col: ucell, visible: Visibility)

Visibility of the column

pub fn column_visible(&self, col: ucell) -> Visibility

Returns the default cell style for this column.

pub fn set_col_width(
    &mut self,
    workbook: &mut WorkBook,
    col: ucell,
    width: Length
)

Creates a col style and sets the col width.

pub fn set_row_style<V: Into<String>>(&mut self, col: ucell, style: V)

Row style.

pub fn clear_row_style(&mut self, col: ucell)

Remove the style.

pub fn row_style(&self, col: ucell) -> Option<&String>

Returns the row style.

pub fn set_row_cell_style<V: Into<String>>(&mut self, col: ucell, style: V)

Default cell style for this row.

pub fn clear_row_cell_style(&mut self, col: ucell)

Remove the style.

pub fn row_cell_style(&self, col: ucell) -> Option<&String>

Returns the default cell style for this row.

pub fn set_row_visible(&mut self, col: ucell, visible: Visibility)

Visibility of the row

pub fn row_visible(&self, col: ucell) -> Visibility

Returns the default cell style for this row.

pub fn set_row_height(
    &mut self,
    workbook: &mut WorkBook,
    row: ucell,
    height: Length
)

Creates a row-style and sets the row height.

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

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: ucell, col: ucell) -> bool

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

pub fn cell(&self, row: ucell, col: ucell) -> Option<&SCell>

Returns the cell if available.

pub fn cell_mut(&mut self, row: ucell, col: ucell) -> &mut SCell

Ensures that there is a SCell at the given position and returns a reference to it.

pub fn add_cell(&mut self, row: ucell, col: ucell, cell: SCell) -> Option<SCell>

Adds a cell. Replaces an existing one.

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

Removes a cell.

pub fn set_styled_value<V: Into<Value>, W: Into<String>>(
    &mut self,
    row: ucell,
    col: ucell,
    value: V,
    style: W
)

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

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

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

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

Returns a value

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

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

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

Returns a value

pub fn set_cell_style<V: Into<String>>(
    &mut self,
    row: ucell,
    col: ucell,
    style: V
)

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

pub fn cell_style(&self, row: ucell, col: ucell) -> Option<&String>

Returns a value

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

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

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

Rowspan of the cell.

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

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

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

Colspan of the cell.

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

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: ucell, col_end: ucell)

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.

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.