umya-spreadsheet

When writing functions that modify a spreadsheet, pass the Workbook as a mutable reference (&mut Workbook).

let mut book = umya_spreadsheet::new_file();
let _unused =  book.new_sheet("Sheet2");
update_excel(&mut book);

fn update_excel(book: &mut Workbook) {
   book.sheet_by_name_mut("Sheet2").unwrap().cell_mut("A1").set_value("Test"); 
}

Add umya-spreadsheet to your Cargo.toml. You can enable specific features for WebAssembly support or restricted image processing.

Standard Installation

[dependencies]
umya-spreadsheet = "3.0.1"

WebAssembly Support

To use the library in a WebAssembly environment, enable the js feature:

[dependencies]
umya-spreadsheet = { version = "3.0.1", features = ["js"] }

Restricted Image Processing

To use only png for image processing, enable the image/png feature:

[dependencies]
umya-spreadsheet = { version = "3.0.1", features = ["image/png"] }

In your main.rs, ensure you include:

extern crate umya_spreadsheet;

Worksheets can be created, cloned, or accessed by index or name.

• Create New: Use book.new_sheet("Name") to add a worksheet.
• Access by Index: Use book.sheet(index) (0-indexed).
• Access by Name: Use book.sheet_by_name("Name") or book.sheet_by_name_mut("Name") for mutable access.
• Clone/Copy: You can clone a worksheet using .clone() and then add it back to the workbook using book.add_sheet(cloned_sheet).

use umya_spreadsheet::*;

let mut book = new_file();

// New worksheet
let _ = book.new_sheet("Sheet2");

// Copy Worksheet
let mut clone_sheet = book.sheet(0).unwrap().clone();
clone_sheet.set_name("New Sheet");
let _ = book.add_sheet(clone_sheet);

You can create a new workbook, read an existing .xlsx file, or use a lazy reader for better performance with large files.

• New File: Use new_file() to create a workbook with a default theme, stylesheet, and one worksheet named "Sheet1".
• Standard Reader: Use reader::xlsx::read(path) to load an existing file.
• Lazy Reader: Use reader::xlsx::lazy_read(path) to delay loading worksheets until they are needed, which improves performance for large files.

use umya_spreadsheet::*;
use std::path::Path;

// New file
let mut book = new_file();

// Reader
let path = Path::new("./test.xlsx");
let mut book = reader::xlsx::read(path).unwrap();

// Lazy Reader (better for large files)
let mut book = reader::xlsx::lazy_read(path).unwrap();

Use umya_spreadsheet::reader::xlsx::read to load an existing .xlsx file into a Workbook.

let path = std::path::Path::new("./path/to/file.xlsx");
let mut book = umya_spreadsheet::reader::xlsx::read(path).unwrap();

let path = std::path::Path::new("./tests/test_files/aaa.xlsx");
let mut book = umya_spreadsheet::reader::xlsx::read(path).unwrap();

For large files, use umya_spreadsheet::reader::xlsx::lazy_read. This delays the loading of worksheets until they are actually needed, which can significantly improve response times and memory usage when dealing with massive datasets.

let path = std::path::Path::new("./tests/test_files/aaa.xlsx");
let mut book = umya_spreadsheet::reader::xlsx::lazy_read(path).unwrap();

You can modify the style of a cell, such as its background color, by accessing its mutable style object.

let mut book = umya_spreadsheet::new_file();
let mut style = book.sheet_by_name_mut("Sheet1").unwrap().style_mut("A1");

// Set background color to red
style.set_background_color(umya_spreadsheet::Color::COLOR_RED);

let mut book = umya_spreadsheet::new_file();
let mut style = book.sheet_by_name_mut("Sheet1").unwrap().style_mut("A1");
// fill color on red.
style.set_background_color(umya_spreadsheet::Color::COLOR_RED);

Use move_range on a mutable worksheet to move a range of cells to a new row and column location.

let range = "A1:A3";
let row = 10;
let column = 2;
book.sheet_by_name_mut("Sheet1").unwrap().move_range(range, &row, &column);

To save your changes to an .xlsx file, use the writer::xlsx::write function, passing the workbook reference and the target file path.

use umya_spreadsheet::*;
use std::path::Path;

let mut book = new_file();
let path = Path::new("output.xlsx");
let _unused = writer::xlsx::write(&book, path);