Skip to content

Commit

Permalink
Deploying to gh-pages from @ 29e0055 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@HLWeil
HLWeil committed Nov 29, 2024
1 parent 67f42cd commit 27c6808
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 101 deletions.
200 changes: 100 additions & 100 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
<meta content="Heinrich Lukas Weil, Oliver Maus, Kevin Schneider, Kevin Frey, Timo Mühlhaus" name="author">
<!-- Opengraph properties (https://ogp.me/) -->
<meta property="og:site_name" content="FsSpreadsheet">
<meta property="og:title" content="FsSpreadsheet Documentation
<meta property="og:title" content="FsSpreadsheet Documentation
" />
<meta property="og:url" content="/FsSpreadsheet/index.html">
<meta property="og:type" content="website" />
<!-- Twitter cards (https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary-card-with-large-image) -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="/FsSpreadsheet/">
<meta name="twitter:title" content="FsSpreadsheet Documentation
<meta name="twitter:title" content="FsSpreadsheet Documentation
">

<title>FsSpreadsheet Documentation
<title>FsSpreadsheet Documentation
| FsSpreadsheet</title>
<link href="https://fonts.googleapis.com" rel="preconnect">
<link crossorigin href="https://fonts.gstatic.com" rel="preconnect">
Expand Down Expand Up @@ -93,100 +93,100 @@
</aside>
<main>
<div id="content">
<h1><a name="FsSpreadsheet-Documentation" class="anchor" href="#FsSpreadsheet-Documentation">FsSpreadsheet Documentation</a></h1>
<p>FsSpreadsheet is a library for reading and writing spreadsheets in F#, Javascript and Python using Fable. It is a wrapper of the Python library openpyxl (<a href="https://openpyxl.readthedocs.io/en/stable/)">https://openpyxl.readthedocs.io/en/stable/)</a> and the Javascript library exceljs (<a href="https://www.npmjs.com/package/@nfdi4plants/exceljs).">https://www.npmjs.com/package/@nfdi4plants/exceljs).</a></p>
<h2><a name="Installation" class="anchor" href="#Installation">Installation</a></h2>
<h3><a name="F" class="anchor" href="#F">F#</a></h3>
<p>Project</p>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">dotnet add package FsSpreadsheet.Net
</code></pre></td></tr></table>
<p>Script</p>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="pp">#r</span> <span class="s">&quot;nuget: FsSpreadsheet.Net&quot;</span>

<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 1)" onmouseover="showTip(event, 'fs1', 1)" class="id">FsSpreadsheet</span>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 2)" onmouseover="showTip(event, 'fs1', 2)" class="id">FsSpreadsheet</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs2', 3)" onmouseover="showTip(event, 'fs2', 3)" class="id">Net</span>
</code></pre>
<h3><a name="Javascript" class="anchor" href="#Javascript">Javascript</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">npm install @fslab/fsspreadsheet
</code></pre></td></tr></table>
<h3><a name="Python" class="anchor" href="#Python">Python</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">pip install fsspreadsheet
</code></pre></td></tr></table>
<h2><a name="Usage_Xlsx_IO" class="anchor" href="#Usage_Xlsx_IO">Usage_Xlsx_IO</a></h2>
<h3><a name="F-1" class="anchor" href="#F-1">F#</a></h3>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 4)" onmouseover="showTip(event, 'fs1', 4)" class="id">FsSpreadsheet</span>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 5)" onmouseover="showTip(event, 'fs1', 5)" class="id">FsSpreadsheet</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs2', 6)" onmouseover="showTip(event, 'fs2', 6)" class="id">Net</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs3', 7)" onmouseover="showTip(event, 'fs3', 7)" class="id">path</span> <span class="o">=</span> <span class="s">&quot;path/to/spreadsheet.xlsx&quot;</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs4', 8)" onmouseover="showTip(event, 'fs4', 8)" class="d">wb</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs5', 9)" onmouseover="showTip(event, 'fs5', 9)" class="d">FsWorkbook</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs6', 10)" onmouseover="showTip(event, 'fs6', 10)" class="id">fromXlsxFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs3', 11)" onmouseover="showTip(event, 'fs3', 11)" class="id">path</span><span class="pn">)</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs7', 12)" onmouseover="showTip(event, 'fs7', 12)" class="id">newPath</span> <span class="o">=</span> <span class="s">&quot;path/to/new/spreadsheet.xlsx&quot;</span>

<span onmouseout="hideTip(event, 'fs4', 13)" onmouseover="showTip(event, 'fs4', 13)" class="d">wb</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs8', 14)" onmouseover="showTip(event, 'fs8', 14)" class="id">ToXlsxFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs7', 15)" onmouseover="showTip(event, 'fs7', 15)" class="id">newPath</span><span class="pn">)</span>
</code></pre>
<h3><a name="Javascript-1" class="anchor" href="#Javascript-1">Javascript</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip highlighted"><code lang="javascript">import { Xlsx } from <span class="s">'@fslab/fsspreadsheet/Xlsx.js'</span>;

<span class="k">const</span> path <span class="o">=</span> <span class="s">"path/to/spreadsheet.xlsx"</span>

<span class="k">const</span> wb <span class="o">=</span> Xlsx.fromXlsxFile(path)

<span class="k">const</span> newPath <span class="o">=</span> <span class="s">"path/to/new/spreadsheet.xlsx"</span>

Xlsx.toXlsxFile(newPath,wb)
</code></pre></td></tr></table>
<h3><a name="Python-1" class="anchor" href="#Python-1">Python</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="python">from fsspreadsheet.xlsx import Xlsx

path = "path/to/spreadsheet.xlsx"

wb = Xlsx.from_xlsx_file(path)

newPath = "path/to/new/spreadsheet.xlsx"

Xlsx.to_xlsx_file(newPath,wb)
</code></pre></td></tr></table>
<h2><a name="Usage_Json_IO" class="anchor" href="#Usage_Json_IO">Usage_Json_IO</a></h2>
<h3><a name="F-2" class="anchor" href="#F-2">F#</a></h3>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 16)" onmouseover="showTip(event, 'fs1', 16)" class="id">FsSpreadsheet</span>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 17)" onmouseover="showTip(event, 'fs1', 17)" class="id">FsSpreadsheet</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs2', 18)" onmouseover="showTip(event, 'fs2', 18)" class="id">Net</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs3', 19)" onmouseover="showTip(event, 'fs3', 19)" class="id">path</span> <span class="o">=</span> <span class="s">&quot;path/to/spreadsheet.json&quot;</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs4', 20)" onmouseover="showTip(event, 'fs4', 20)" class="id">wb</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs5', 21)" onmouseover="showTip(event, 'fs5', 21)" class="id">FsWorkbook</span><span class="pn">.</span><span class="id">fromJsonFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs3', 22)" onmouseover="showTip(event, 'fs3', 22)" class="id">path</span><span class="pn">)</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs7', 23)" onmouseover="showTip(event, 'fs7', 23)" class="id">newPath</span> <span class="o">=</span> <span class="s">&quot;path/to/new/spreadsheet.json&quot;</span>

<span onmouseout="hideTip(event, 'fs4', 24)" onmouseover="showTip(event, 'fs4', 24)" class="id">wb</span><span class="pn">.</span><span class="id">ToJsonFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs7', 25)" onmouseover="showTip(event, 'fs7', 25)" class="id">newPath</span><span class="pn">)</span>
</code></pre>
<h3><a name="Javascript-2" class="anchor" href="#Javascript-2">Javascript</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip highlighted"><code lang="javascript">import { Json } from <span class="s">'@fslab/fsspreadsheet/Json.js'</span>;

<span class="k">const</span> path <span class="o">=</span> <span class="s">"path/to/spreadsheet.json"</span>

<span class="k">const</span> wb <span class="o">=</span> Json.fromJsonFile(path)

<span class="k">const</span> newPath <span class="o">=</span> <span class="s">"path/to/new/spreadsheet.json"</span>

Json.toJsonFile(newPath,wb)
</code></pre></td></tr></table>
<h3><a name="Python-2" class="anchor" href="#Python-2">Python</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="python">from fsspreadsheet.json import Json

path = "path/to/spreadsheet.json"

wb = Json.from_json_file(path)

newPath = "path/to/new/spreadsheet.json"

Json.to_json_file(newPath,wb)
</code></pre></td></tr></table>
<h1><a name="FsSpreadsheet-Documentation" class="anchor" href="#FsSpreadsheet-Documentation">FsSpreadsheet Documentation</a></h1>
<p>FsSpreadsheet is a library for reading and writing spreadsheets in F#, Javascript and Python using Fable. It is a wrapper of the Python library openpyxl (<a href="https://openpyxl.readthedocs.io/en/stable/)">https://openpyxl.readthedocs.io/en/stable/)</a> and the Javascript library exceljs (<a href="https://www.npmjs.com/package/@nfdi4plants/exceljs).">https://www.npmjs.com/package/@nfdi4plants/exceljs).</a></p>
<h2><a name="Installation" class="anchor" href="#Installation">Installation</a></h2>
<h3><a name="F" class="anchor" href="#F">F#</a></h3>
<p>Project</p>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">dotnet add package FsSpreadsheet.Net
</code></pre></td></tr></table>
<p>Script</p>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="pp">#r</span> <span class="s">&quot;nuget: FsSpreadsheet.Net&quot;</span>

<div class="fsdocs-tip" id="fs1">namespace FsSpreadsheet</div>
<div class="fsdocs-tip" id="fs2">namespace FsSpreadsheet.Net</div>
<div class="fsdocs-tip" id="fs3">val path: string</div>
<div class="fsdocs-tip" id="fs4">val wb: FsWorkbook</div>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 1)" onmouseover="showTip(event, 'fs1', 1)" class="id">FsSpreadsheet</span>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 2)" onmouseover="showTip(event, 'fs1', 2)" class="id">FsSpreadsheet</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs2', 3)" onmouseover="showTip(event, 'fs2', 3)" class="id">Net</span>
</code></pre>
<h3><a name="Javascript" class="anchor" href="#Javascript">Javascript</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">npm install @fslab/fsspreadsheet
</code></pre></td></tr></table>
<h3><a name="Python" class="anchor" href="#Python">Python</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">pip install fsspreadsheet
</code></pre></td></tr></table>
<h2><a name="Usage_Xlsx_IO" class="anchor" href="#Usage_Xlsx_IO">Usage_Xlsx_IO</a></h2>
<h3><a name="F-1" class="anchor" href="#F-1">F#</a></h3>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 4)" onmouseover="showTip(event, 'fs1', 4)" class="id">FsSpreadsheet</span>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 5)" onmouseover="showTip(event, 'fs1', 5)" class="id">FsSpreadsheet</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs2', 6)" onmouseover="showTip(event, 'fs2', 6)" class="id">Net</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs3', 7)" onmouseover="showTip(event, 'fs3', 7)" class="id">path</span> <span class="o">=</span> <span class="s">&quot;path/to/spreadsheet.xlsx&quot;</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs4', 8)" onmouseover="showTip(event, 'fs4', 8)" class="d">wb</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs5', 9)" onmouseover="showTip(event, 'fs5', 9)" class="d">FsWorkbook</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs6', 10)" onmouseover="showTip(event, 'fs6', 10)" class="id">fromXlsxFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs3', 11)" onmouseover="showTip(event, 'fs3', 11)" class="id">path</span><span class="pn">)</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs7', 12)" onmouseover="showTip(event, 'fs7', 12)" class="id">newPath</span> <span class="o">=</span> <span class="s">&quot;path/to/new/spreadsheet.xlsx&quot;</span>

<span onmouseout="hideTip(event, 'fs4', 13)" onmouseover="showTip(event, 'fs4', 13)" class="d">wb</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs8', 14)" onmouseover="showTip(event, 'fs8', 14)" class="id">ToXlsxFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs7', 15)" onmouseover="showTip(event, 'fs7', 15)" class="id">newPath</span><span class="pn">)</span>
</code></pre>
<h3><a name="Javascript-1" class="anchor" href="#Javascript-1">Javascript</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip highlighted"><code lang="javascript">import { Xlsx } from <span class="s">'@fslab/fsspreadsheet/Xlsx.js'</span>;

<span class="k">const</span> path <span class="o">=</span> <span class="s">"path/to/spreadsheet.xlsx"</span>

<span class="k">const</span> wb <span class="o">=</span> Xlsx.fromXlsxFile(path)

<span class="k">const</span> newPath <span class="o">=</span> <span class="s">"path/to/new/spreadsheet.xlsx"</span>

Xlsx.toXlsxFile(newPath,wb)
</code></pre></td></tr></table>
<h3><a name="Python-1" class="anchor" href="#Python-1">Python</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="python">from fsspreadsheet.xlsx import Xlsx

path = "path/to/spreadsheet.xlsx"

wb = Xlsx.from_xlsx_file(path)

newPath = "path/to/new/spreadsheet.xlsx"

Xlsx.to_xlsx_file(newPath,wb)
</code></pre></td></tr></table>
<h2><a name="Usage_Json_IO" class="anchor" href="#Usage_Json_IO">Usage_Json_IO</a></h2>
<h3><a name="F-2" class="anchor" href="#F-2">F#</a></h3>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 16)" onmouseover="showTip(event, 'fs1', 16)" class="id">FsSpreadsheet</span>
<span class="k">open</span> <span onmouseout="hideTip(event, 'fs1', 17)" onmouseover="showTip(event, 'fs1', 17)" class="id">FsSpreadsheet</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs2', 18)" onmouseover="showTip(event, 'fs2', 18)" class="id">Net</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs3', 19)" onmouseover="showTip(event, 'fs3', 19)" class="id">path</span> <span class="o">=</span> <span class="s">&quot;path/to/spreadsheet.json&quot;</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs4', 20)" onmouseover="showTip(event, 'fs4', 20)" class="id">wb</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs5', 21)" onmouseover="showTip(event, 'fs5', 21)" class="id">FsWorkbook</span><span class="pn">.</span><span class="id">fromJsonFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs3', 22)" onmouseover="showTip(event, 'fs3', 22)" class="id">path</span><span class="pn">)</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs7', 23)" onmouseover="showTip(event, 'fs7', 23)" class="id">newPath</span> <span class="o">=</span> <span class="s">&quot;path/to/new/spreadsheet.json&quot;</span>

<span onmouseout="hideTip(event, 'fs4', 24)" onmouseover="showTip(event, 'fs4', 24)" class="id">wb</span><span class="pn">.</span><span class="id">ToJsonFile</span><span class="pn">(</span><span onmouseout="hideTip(event, 'fs7', 25)" onmouseover="showTip(event, 'fs7', 25)" class="id">newPath</span><span class="pn">)</span>
</code></pre>
<h3><a name="Javascript-2" class="anchor" href="#Javascript-2">Javascript</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip highlighted"><code lang="javascript">import { Json } from <span class="s">'@fslab/fsspreadsheet/Json.js'</span>;

<span class="k">const</span> path <span class="o">=</span> <span class="s">"path/to/spreadsheet.json"</span>

<span class="k">const</span> wb <span class="o">=</span> Json.fromJsonFile(path)

<span class="k">const</span> newPath <span class="o">=</span> <span class="s">"path/to/new/spreadsheet.json"</span>

Json.toJsonFile(newPath,wb)
</code></pre></td></tr></table>
<h3><a name="Python-2" class="anchor" href="#Python-2">Python</a></h3>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="python">from fsspreadsheet.json import Json

path = "path/to/spreadsheet.json"

wb = Json.from_json_file(path)

newPath = "path/to/new/spreadsheet.json"

Json.to_json_file(newPath,wb)
</code></pre></td></tr></table>

<div class="fsdocs-tip" id="fs1">namespace FsSpreadsheet</div>
<div class="fsdocs-tip" id="fs2">namespace FsSpreadsheet.Net</div>
<div class="fsdocs-tip" id="fs3">val path: string</div>
<div class="fsdocs-tip" id="fs4">val wb: FsWorkbook</div>
<div class="fsdocs-tip" id="fs5">Multiple items<br />type FsWorkbook =
interface IDisposable
new: unit -&gt; FsWorkbook
Expand All @@ -200,10 +200,10 @@ <h3><a name="Python-2" class="anchor" href="#Python-2">Python</a></h3>
member InitWorksheet: name: string -&gt; FsWorksheet
...<br /><em>&lt;summary&gt;
Creates an empty FsWorkbook.
&lt;/summary&gt;</em><br /><br />--------------------<br />new: unit -&gt; FsWorkbook</div>
<div class="fsdocs-tip" id="fs6">static member FsWorkbook.fromXlsxFile: filePath: string -&gt; FsWorkbook</div>
<div class="fsdocs-tip" id="fs7">val newPath: string</div>
<div class="fsdocs-tip" id="fs8">member FsWorkbook.ToXlsxFile: path: string -&gt; unit</div>
&lt;/summary&gt;</em><br /><br />--------------------<br />new: unit -&gt; FsWorkbook</div>
<div class="fsdocs-tip" id="fs6">static member FsWorkbook.fromXlsxFile: filePath: string -&gt; FsWorkbook</div>
<div class="fsdocs-tip" id="fs7">val newPath: string</div>
<div class="fsdocs-tip" id="fs8">member FsWorkbook.ToXlsxFile: path: string -&gt; unit</div>

</div>
</main>
Expand Down
2 changes: 1 addition & 1 deletion index.json
View file

Large diffs are not rendered by default.

0 comments on commit 27c6808

Please # to comment.