manifesto.js
Version:
IIIF Presentation API utility library for client and server
275 lines • 13.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>manifesto</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">manifesto</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> manifesto</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="manifesto">manifesto</h1>
<p><a href="https://travis-ci.org/IIIF-Commons/manifesto"><img src="https://travis-ci.org/IIIF-Commons/manifesto.svg?branch=master" alt="Build Status"></a></p>
<p>IIIF Presentation API client and server utility library.</p>
<pre><code>npm <span class="hljs-keyword">install </span>manifesto.<span class="hljs-keyword">js </span>--save</code></pre><h2 id="getting-started">Getting Started</h2>
<h3 id="documentation">Documentation</h3>
<p><a href="https://iiif-commons.github.io/manifesto/">https://iiif-commons.github.io/manifesto/</a></p>
<h3 id="tutorial">Tutorial</h3>
<p><a href="http://blog.edsilv.com/manifesto/">http://blog.edsilv.com/manifesto/</a></p>
<h3 id="developer-setup">Developer Setup</h3>
<pre><code>git clone https:<span class="hljs-regexp">//gi</span>thub.com/iiif-commons/manifesto.git
<span class="hljs-built_in">npm</span> install
<span class="hljs-built_in">npm</span> build
<span class="hljs-built_in">npm</span> test</code></pre><h3 id="publishing-package">Publishing Package</h3>
<ol>
<li>Bump the version locally using <code>npm version</code> on a branch other than <code>master</code>. Example: <code>npm version patch -m 'bump to v3.0.42'</code></li>
<li>Push the bump version branch to GitHub and create a pull request to <code>master</code>.</li>
<li>After the pull request is merged, checkout <code>master</code> and pull the latest changes. <code>git checkout master && git pull</code></li>
<li>Run <code>npm publish</code></li>
<li>Push the git tags created <code>git push --tags</code></li>
</ol>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_annotation_.html">"<wbr>Annotation"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_annotationbody_.html">"<wbr>Annotation<wbr>Body"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_annotationlist_.html">"<wbr>Annotation<wbr>List"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_annotationpage_.html">"<wbr>Annotation<wbr>Page"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_canvas_.html">"<wbr>Canvas"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_collection_.html">"<wbr>Collection"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_duration_.html">"<wbr>Duration"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_iaccesstoken_.html">"IAccess<wbr>Token"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_iexternalimageresourcedata_.html">"IExternal<wbr>Image<wbr>Resource<wbr>Data"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_iexternalresource_.html">"IExternal<wbr>Resource"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_iexternalresourcedata_.html">"IExternal<wbr>Resource<wbr>Data"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_iexternalresourceoptions_.html">"IExternal<wbr>Resource<wbr>Options"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_iiifresource_.html">"IIIFResource"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_imanifestooptions_.html">"IManifesto<wbr>Options"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_jsonldresource_.html">"JSONLDResource"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_labelvaluepair_.html">"<wbr>Label<wbr>Value<wbr>Pair"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_language_.html">"<wbr>Language"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_languagemap_.html">"<wbr>Language<wbr>Map"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_manifest_.html">"<wbr>Manifest"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_manifestresource_.html">"<wbr>Manifest<wbr>Resource"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_manifesttype_.html">"<wbr>Manifest<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_range_.html">"<wbr>Range"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_rendering_.html">"<wbr>Rendering"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_resource_.html">"<wbr>Resource"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_sequence_.html">"<wbr>Sequence"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_serialisation_.html">"<wbr>Serialisation"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_service_.html">"<wbr>Service"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_size_.html">"<wbr>Size"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_statuscode_.html">"<wbr>Status<wbr>Code"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_thumb_.html">"<wbr>Thumb"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_thumbnail_.html">"<wbr>Thumbnail"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_treenode_.html">"<wbr>Tree<wbr>Node"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_treenodetype_.html">"<wbr>Tree<wbr>Node<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_utils_.html">"<wbr>Utils"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>