47 lines
6.5 KiB
HTML
47 lines
6.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This crate reads an xlsx file and transforms it into an internal representation (`Model`). An `xlsx` is a zip file containing a set of folders and `xml` files. The IronCalc json structure mimics the relevant parts of the Excel zip. Although the xlsx structure is quite complicated, it’s essentials regarding the spreadsheet technology are easier to grasp."><title>ironcalc - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ironcalc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ironcalc/index.html">ironcalc</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block">
|
||
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">ironcalc</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/ironcalc/lib.rs.html#1-61">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate reads an xlsx file and transforms it into an internal representation (<a href="../ironcalc/struct.Model.html"><code>Model</code></a>).
|
||
An <code>xlsx</code> is a zip file containing a set of folders and <code>xml</code> files. The IronCalc json structure mimics the relevant parts of the Excel zip.
|
||
Although the xlsx structure is quite complicated, it’s essentials regarding the spreadsheet technology are easier to grasp.</p>
|
||
<p>The simplest workbook folder structure might look like this:</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>docProps
|
||
app.xml
|
||
core.xml
|
||
|
||
_rels
|
||
.rels
|
||
|
||
xl
|
||
_rels
|
||
workbook.xml.rels
|
||
theme
|
||
theme1.xml
|
||
worksheets
|
||
sheet1.xml
|
||
calcChain.xml
|
||
styles.xml
|
||
workbook.xml
|
||
sharedStrings.xml
|
||
|
||
[Content_Types].xml
|
||
</code></pre></div>
|
||
<p>Note that more complicated workbooks will have many more files and folders.
|
||
For instance charts, pivot tables, comments, tables,…</p>
|
||
<p>The relevant json structure in IronCalc will be:</p>
|
||
<div class="example-wrap"><pre class="language-json"><code>{
|
||
"name": "Workbook1",
|
||
"defined_names": [],
|
||
"shared_strings": [],
|
||
"worksheets": [],
|
||
"styles": {
|
||
"num_fmts": [],
|
||
"fonts": [],
|
||
"fills": [],
|
||
"borders": [],
|
||
"cell_style_xfs": [],
|
||
"cell_styles" : [],
|
||
"cell_xfs": []
|
||
}
|
||
}
|
||
</code></pre></div>
|
||
<p>Note that there is not a 1-1 correspondence but there is a close resemblance.</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.base"><code>pub use <a class="mod" href="../ironcalc_base/index.html" title="mod ironcalc_base">ironcalc_base</a> as base;</code></div></li></ul><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="compare/index.html" title="mod ironcalc::compare">compare</a></div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod ironcalc::error">error</a></div></li><li><div class="item-name"><a class="mod" href="export/index.html" title="mod ironcalc::export">export</a></div></li><li><div class="item-name"><a class="mod" href="import/index.html" title="mod ironcalc::import">import</a></div></li></ul></section></div></main></body></html> |