umya-spreadsheet

Description

umya-spreadsheet is a library written in pure Rust to read and write xlsx file.

Chatting

The chat will be closed.

(Maybe I didn't set it up right, but it's because I no longer get notifications when new messages come in and I don't notice them anymore.)

Please mention in issues if you have any questions.

Version 3.0.0 has been released

This update contains breaking changes. Please refer to this page when upgrading from version 2.x to 3.x. https://github.com/MathNya/umya-spreadsheet/blob/master/CHANGELOG.md

Usage

Installation

Add the following code to Cargo.toml

[dependencies]
umya-spreadsheet = "3.0.0"

# WebAssembly support
umya-spreadsheet = { version = "3.0.0", features = ["js"] }

# Use only png for image processing
umya-spreadsheet = { version = "3.0.0", features = ["image/png"] }

Add the following code to main.rs

extern crate umya_spreadsheet;

Read file

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

Read file (Lazy)

Delays the loading of the worksheet until it is needed.
When loading a file with a large amount of data, response improvement can be expected.

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

New file

let mut book = umya_spreadsheet::new_file();

Write file

let path = std::path::Path::new("./tests/result_files/bbb.xlsx");
let _unused =  umya_spreadsheet::writer::xlsx::write(&book, path);

Write file with password

let path = std::path::Path::new("./tests/result_files/bbb.xlsx");
let _unused =  umya_spreadsheet::writer::xlsx::write_with_password(&book, path, "password");

let from_path = std::path::Path::new("./tests/test_files/aaa.xlsx");
let to_path = std::path::Path::new("./tests/result_files/bbb.xlsx");
let _unused =  umya_spreadsheet::writer::xlsx::set_password(&from_path, &to_path, "password");

Read Value

let mut book = umya_spreadsheet::new_file();
book.sheet_by_name("Sheet1").unwrap().cell("A1").value();
book.sheet_by_name("Sheet1").unwrap().cell((1, 1)).value();
book.sheet_by_name("Sheet1").unwrap().cell((1, 1)).value();
book.sheet_mut(&0).unwrap().cell((1, 1)).value();

Change Value

let mut book = umya_spreadsheet::new_file();
book.sheet_by_name_mut("Sheet1").unwrap().cell_mut("A1").set_value("TEST1");
book.sheet_mut(&0).unwrap().cell_mut("A1").set_value("TEST2");

Move Values

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

Change Style

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);

New Chart

let mut book = umya_spreadsheet::new_file();
// Add Chart
let mut from_marker = umya_spreadsheet::structs::drawing::spreadsheet::MarkerType::default();
from_marker.set_coordinate("C1");
let mut to_marker = umya_spreadsheet::structs::drawing::spreadsheet::MarkerType::default();
to_marker.set_coordinate("D11");
let area_chart_series_list = vec![
    "Sheet1!$A$1:$A$10",
    "Sheet1!$B$1:$B$10",
];
let mut chart = umya_spreadsheet::structs::Chart::default();
chart.new_chart(
    umya_spreadsheet::structs::ChartType::LineChart,
    from_marker,
    to_marker,
    area_chart_series_list,
);
book.sheet_by_name_mut("Sheet1").unwrap()
    .add_chart(chart);

Struct

Pass the book as a Workbook to modify it in other functions.

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"); 
}

See the next chapter for implementation status and more detailed usage.

Support Status

Function	detail	example
file reader	xlsx, xlsm	here.
file lazy_reader	xlsx, xlsm	here.
file writer	xlsx, xlsm	here.
	csv	here.
file writer with password	xlsx, xlsm	here.
worksheet	read, new, copy	here.
cell value	read, edit, formated value.	here.
cell style	read, edit	here.
columns	read, edit, auto width	here.
rows	read, edit
charts	read, edit	here.
drawings	read, edit(Still might be inconvenient.)
images	read, edit	here.
ole objects	read, edit(Still might be inconvenient.)

License

MIT

Contributing

Contributions by way of pull requests are welcome! Please make sure your code uses:

• cargo fmt for formatting
• clippy

cargo +nightly fmt --all
cargo clippy -- -D warnings

Acknowledgements

These are the people who have supported the umya-spreadsheet project. We would like to express our heartfelt gratitude to them.

8191, agentjill, attila-lin, boseongkim32, c-git, cstkingkey, DaimoniX, developer0hye, fabianboesiger, ggodlewski, gitter-badger, hackers267, iancormac84, jimchan3301, jmbrunskill, john-dc252, kazuk, kjh618, KyGost, lanej, matt-duch, mxsrm, nikvoid, oxabz, patrickomatic, piaoger, popen2, PSU3D0, RoloEdits, SamuelMarks, schungx, sjfhsjfh, tomgroenwoldt, tzfun, ubamrein, usagi, vonkruel, WilliamTCarroll, wolfiesch, xamgore, yerlibilgin, zjhsd2007

Projects using umya-spreadsheet

Community projects built with umya-spreadsheet (not endorsements). - spreadsheet-mcp - MCP server for spreadsheet analysis/editing (xlsx/xlsm via umya-spreadsheet) - formualizer - Arrow-backed spreadsheet engine and formula parser with excel parity (xlsx/xlsm via umya-spreadsheet)