mirror of
https://github.com/cheminfo/netcdfjs.git
synced 2026-01-18 15:56:16 +00:00
438 lines
9.7 KiB
HTML
438 lines
9.7 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta charset='utf-8' />
|
|
<title>netcdfjs 0.0.1 | Documentation</title>
|
|
<meta name='viewport' content='width=device-width,initial-scale=1'>
|
|
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
|
|
<link href='assets/style.css' type='text/css' rel='stylesheet' />
|
|
<link href='assets/github.css' type='text/css' rel='stylesheet' />
|
|
</head>
|
|
<body class='documentation'>
|
|
<div class='max-width-4 mx-auto'>
|
|
<div class='clearfix md-mxn2'>
|
|
<div class='fixed xs-hide fix-3 overflow-auto max-height-100'>
|
|
<div class='py1 px2'>
|
|
<h3 class='mb0 no-anchor'>netcdfjs</h3>
|
|
<div class='mb1'><code>0.0.1</code></div>
|
|
<input
|
|
placeholder='Filter'
|
|
id='filter-input'
|
|
class='col12 block input'
|
|
type='text' />
|
|
<div id='toc'>
|
|
<ul class='list-reset h5 py1-ul'>
|
|
|
|
|
|
<li><a
|
|
href='#netcdfreader'
|
|
class=" toggle-sibling">
|
|
NetCDFReader
|
|
<span class='icon'>▸</span>
|
|
</a>
|
|
|
|
<div class='toggle-target display-none'>
|
|
|
|
|
|
<ul class='list-reset py1-ul pl1'>
|
|
<li class='h5'><span>Instance members</span></li>
|
|
|
|
<li><a
|
|
href='#NetCDFReader#version'
|
|
class='regular pre-open'>
|
|
#version
|
|
</a></li>
|
|
|
|
<li><a
|
|
href='#NetCDFReader#recordDimension'
|
|
class='regular pre-open'>
|
|
#recordDimension
|
|
</a></li>
|
|
|
|
<li><a
|
|
href='#NetCDFReader#dimensions'
|
|
class='regular pre-open'>
|
|
#dimensions
|
|
</a></li>
|
|
|
|
<li><a
|
|
href='#NetCDFReader#globalAttributes'
|
|
class='regular pre-open'>
|
|
#globalAttributes
|
|
</a></li>
|
|
|
|
<li><a
|
|
href='#NetCDFReader#variables'
|
|
class='regular pre-open'>
|
|
#variables
|
|
</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class='mt1 h6 quiet'>
|
|
<a href='http://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class='fix-margin-3'>
|
|
|
|
|
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
|
|
|
|
|
<div class='clearfix'>
|
|
<h3 class='fl m0' id='netcdfreader'>
|
|
NetCDFReader
|
|
</h3>
|
|
|
|
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/cheminfo-js/netcdfjs/blob/a4d5bbae083b84c1a7a150dd183868a3737dc265/src/index.js#L13-L80'>
|
|
<span>src/index.js</span>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
|
|
<p>Reads a NetCDF v3.x file
|
|
<a href="https://www.unidata.ucar.edu/software/netcdf/docs/file_format_specifications.html">https://www.unidata.ucar.edu/software/netcdf/docs/file_format_specifications.html</a></p>
|
|
|
|
|
|
<div class='pre p1 fill-light mt0'>new NetCDFReader(data: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer">ArrayBuffer</a>)</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Parameters</div>
|
|
<div class='prose'>
|
|
|
|
<div class='space-bottom0'>
|
|
<div>
|
|
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer">ArrayBuffer</a>)</code> ArrayBuffer or any Typed Array (including Node.js' Buffer from v4) with the data
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
|
|
<div class="clearfix">
|
|
|
|
<div class='border-bottom' id='NetCDFReader#version'>
|
|
<div class="clearfix small pointer toggle-sibling">
|
|
<div class="py1 contain">
|
|
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
|
<span class='code strong strong truncate'>version</span>
|
|
</div>
|
|
</div>
|
|
<div class="clearfix display-none toggle-target">
|
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
|
|
|
|
|
|
|
|
|
|
|
<div class='pre p1 fill-light mt0'>version</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
|
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
|
|
Version for the NetCDF format
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class='border-bottom' id='NetCDFReader#recordDimension'>
|
|
<div class="clearfix small pointer toggle-sibling">
|
|
<div class="py1 contain">
|
|
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
|
<span class='code strong strong truncate'>recordDimension</span>
|
|
</div>
|
|
</div>
|
|
<div class="clearfix display-none toggle-target">
|
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
|
|
|
|
|
|
|
|
|
|
|
<div class='pre p1 fill-light mt0'>recordDimension</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
|
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code>:
|
|
Length of record dimension
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class='border-bottom' id='NetCDFReader#dimensions'>
|
|
<div class="clearfix small pointer toggle-sibling">
|
|
<div class="py1 contain">
|
|
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
|
<span class='code strong strong truncate'>dimensions</span>
|
|
</div>
|
|
</div>
|
|
<div class="clearfix display-none toggle-target">
|
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
|
|
|
|
|
|
|
|
|
|
|
<div class='pre p1 fill-light mt0'>dimensions</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
|
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>></code>:
|
|
List of dimensions with:
|
|
<ul>
|
|
<li><code>name</code>: String with the name of the dimension</li>
|
|
<li><code>size</code>: Number with the size of the dimension</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class='border-bottom' id='NetCDFReader#globalAttributes'>
|
|
<div class="clearfix small pointer toggle-sibling">
|
|
<div class="py1 contain">
|
|
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
|
<span class='code strong strong truncate'>globalAttributes</span>
|
|
</div>
|
|
</div>
|
|
<div class="clearfix display-none toggle-target">
|
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
|
|
|
|
|
|
|
|
|
|
|
<div class='pre p1 fill-light mt0'>globalAttributes</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
|
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>></code>:
|
|
List of global attributes with:
|
|
<ul>
|
|
<li><code>name</code>: String with the name of the attribute</li>
|
|
<li><code>type</code>: String with the type of the attribute</li>
|
|
<li><code>value</code>: A number or string with the value of the attribute</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class='border-bottom' id='NetCDFReader#variables'>
|
|
<div class="clearfix small pointer toggle-sibling">
|
|
<div class="py1 contain">
|
|
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
|
<span class='code strong strong truncate'>variables</span>
|
|
</div>
|
|
</div>
|
|
<div class="clearfix display-none toggle-target">
|
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
|
|
|
|
|
|
|
|
|
|
|
<div class='pre p1 fill-light mt0'>variables</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
|
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>></code>:
|
|
List of variables with:
|
|
<ul>
|
|
<li><code>name</code>: String with the name of the variable</li>
|
|
<li><code>dimensions</code>: Array with the dimension IDs of the variable</li>
|
|
<li><code>attributes</code>: Array with the attributes of the variable</li>
|
|
<li><code>type</code>: String with the type of the variable</li>
|
|
<li><code>size</code>: Number with the size of the variable</li>
|
|
<li><code>offset</code>: Number with the offset where of the variable begins</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src='assets/anchor.js'></script>
|
|
<script src='assets/site.js'></script>
|
|
</body>
|
|
</html>
|