@iiif/3d-manifesto-dev
Version:
IIIF Presentation API utility library for client and server with 3D extension
66 lines (64 loc) • 106 kB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Collection | manifesto</title><meta name="description" content="Documentation for manifesto"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">manifesto</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">Collection</a></li></ul><h1>Class Collection</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="962"><h4>Hierarchy (<a href="../hierarchy.html#Collection">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="IIIFResource.html" class="tsd-signature-type tsd-kind-class">IIIFResource</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Collection</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L15">src/Collection.ts:15</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#__jsonld" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>__<wbr/>jsonld</span></a>
<a href="#context" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a>
<a href="#defaulttree" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Tree</span></a>
<a href="#externalresource" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>external<wbr/>Resource</span></a>
<a href="#id" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
<a href="#index" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index</span></a>
<a href="#isloaded" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Loaded</span></a>
<a href="#items" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>items</span></a>
<a href="#options" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
<a href="#parentcollection" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Collection</span></a>
<a href="#parentlabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Label</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#getattribution" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Attribution</span></a>
<a href="#getbehavior" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Behavior</span></a>
<a href="#getcollectionbyindex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Collection<wbr/>By<wbr/>Index</span></a>
<a href="#getcollections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Collections</span></a>
<a href="#getdefaultlabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>Label</span></a>
<a href="#getdefaulttree" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>Tree</span></a>
<a href="#getdescription" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Description</span></a>
<a href="#gethomepage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Homepage</span></a>
<a href="#getiiifresourcetype" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>IIIF<wbr/>Resource<wbr/>Type</span></a>
<a href="#getlabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Label</span></a>
<a href="#getlicense" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>License</span></a>
<a href="#getlogo" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Logo</span></a>
<a href="#getmanifestbyindex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Manifest<wbr/>By<wbr/>Index</span></a>
<a href="#getmanifests" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Manifests</span></a>
<a href="#getmetadata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Metadata</span></a>
<a href="#getnavdate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Nav<wbr/>Date</span></a>
<a href="#getproperty" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Property</span></a>
<a href="#getpropertyasobject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Property<wbr/>As<wbr/>Object</span></a>
<a href="#getrelated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Related</span></a>
<a href="#getrendering" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Rendering</span></a>
<a href="#getrenderings" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Renderings</span></a>
<a href="#getrequiredstatement" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Required<wbr/>Statement</span></a>
<a href="#getrights" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Rights</span></a>
<a href="#getseealso" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>See<wbr/>Also</span></a>
<a href="#getservice" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Service</span></a>
<a href="#getservices" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Services</span></a>
<a href="#getsummary" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Summary</span></a>
<a href="#getthumbnail" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a>
<a href="#gettotalcollections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Collections</span></a>
<a href="#gettotalitems" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Items</span></a>
<a href="#gettotalmanifests" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Manifests</span></a>
<a href="#gettrackinglabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tracking<wbr/>Label</span></a>
<a href="#getviewingdirection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Viewing<wbr/>Direction</span></a>
<a href="#getviewinghint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Viewing<wbr/>Hint</span></a>
<a href="#isannotation" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Annotation</span></a>
<a href="#iscanvas" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Canvas</span></a>
<a href="#iscollection" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Collection</span></a>
<a href="#ismanifest" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Manifest</span></a>
<a href="#isrange" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Range</span></a>
<a href="#isscene" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Scene</span></a>
<a href="#issequence" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Sequence</span></a>
<a href="#load" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorcollection"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Collection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonld</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IManifestoOptions.html" class="tsd-signature-type tsd-kind-interface">IManifestoOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Collection</a><a href="#constructorcollection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonld</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/IManifestoOptions.html" class="tsd-signature-type tsd-kind-interface">IManifestoOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Collection</a></h4><aside class="tsd-sources"><p>Overrides <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L20">src/Collection.ts:20</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="__jsonld"><span>__<wbr/>jsonld</span><a href="#__jsonld" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">__jsonld</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#__jsonld">__jsonld</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/JSONLDResource.ts#L4">src/JSONLDResource.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="context"><span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#context">context</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/JSONLDResource.ts#L2">src/JSONLDResource.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="defaulttree"><span>default<wbr/>Tree</span><a href="#defaulttree" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">defaultTree</span><span class="tsd-signature-symbol">:</span> <a href="TreeNode.html" class="tsd-signature-type tsd-kind-class">TreeNode</a></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#defaulttree">defaultTree</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L18">src/IIIFResource.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="externalresource"><span>external<wbr/>Resource</span><a href="#externalresource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">externalResource</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IExternalResource.html" class="tsd-signature-type tsd-kind-interface">IExternalResource</a></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#externalresource">externalResource</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/ManifestResource.ts#L19">src/ManifestResource.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/JSONLDResource.ts#L3">src/JSONLDResource.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="index"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -1</span></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#index">index</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L19">src/IIIFResource.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isloaded"><span>is<wbr/>Loaded</span><a href="#isloaded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isLoaded</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#isloaded">isLoaded</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L20">src/IIIFResource.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="items"><span>items</span><a href="#items" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <a href="IIIFResource.html" class="tsd-signature-type tsd-kind-class">IIIFResource</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L16">src/Collection.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="options"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IManifestoOptions.html" class="tsd-signature-type tsd-kind-interface">IManifestoOptions</a></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#options">options</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/ManifestResource.ts#L20">src/ManifestResource.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="parentcollection"><span>parent<wbr/>Collection</span><a href="#parentcollection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parentCollection</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Collection</a></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#parentcollection">parentCollection</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L21">src/IIIFResource.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="parentlabel"><span>parent<wbr/>Label</span><a href="#parentlabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parentLabel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#parentlabel">parentLabel</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L22">src/IIIFResource.ts:22</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getattribution"><span class="deprecated">get<wbr/>Attribution</span><a href="#getattribution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getattribution-1"><span class="tsd-kind-call-signature">getAttribution</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="PropertyValue.html" class="tsd-signature-type tsd-kind-class">PropertyValue</a><a href="#getattribution-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="PropertyValue.html" class="tsd-signature-type tsd-kind-class">PropertyValue</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getattribution">getAttribution</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L40">src/IIIFResource.ts:40</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getbehavior"><span>get<wbr/>Behavior</span><a href="#getbehavior" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getbehavior-1"><span class="tsd-kind-call-signature">getBehavior</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Behavior</span><a href="#getbehavior-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Note: this only will return the first behavior as per the manifesto convention
IIIF v3 supports multiple behaviors</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Behavior</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L108">src/Collection.ts:108</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcollectionbyindex"><span>get<wbr/>Collection<wbr/>By<wbr/>Index</span><a href="#getcollectionbyindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getcollectionbyindex-1"><span class="tsd-kind-call-signature">getCollectionByIndex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">collectionIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">></span><a href="#getcollectionbyindex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L43">src/Collection.ts:43</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcollections"><span>get<wbr/>Collections</span><a href="#getcollections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getcollections-1"><span class="tsd-kind-call-signature">getCollections</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">[]</span><a href="#getcollections-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Collection</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L25">src/Collection.ts:25</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getdefaultlabel"><span>get<wbr/>Default<wbr/>Label</span><a href="#getdefaultlabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getdefaultlabel-1"><span class="tsd-kind-call-signature">getDefaultLabel</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><a href="#getdefaultlabel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getdefaultlabel">getDefaultLabel</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/ManifestResource.ts#L61">src/ManifestResource.ts:61</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdefaulttree"><span>get<wbr/>Default<wbr/>Tree</span><a href="#getdefaulttree" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getdefaulttree-1"><span class="tsd-kind-call-signature">getDefaultTree</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="TreeNode.html" class="tsd-signature-type tsd-kind-class">TreeNode</a><a href="#getdefaulttree-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a tree of sub collections and manifests, using each child manifest's first 'top' range.</p>
</div><h4 class="tsd-returns-title">Returns <a href="TreeNode.html" class="tsd-signature-type tsd-kind-class">TreeNode</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getdefaulttree">getDefaultTree</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L129">src/Collection.ts:129</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getdescription"><span>get<wbr/>Description</span><a href="#getdescription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getdescription-1"><span class="tsd-kind-call-signature">getDescription</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="PropertyValue.html" class="tsd-signature-type tsd-kind-class">PropertyValue</a><a href="#getdescription-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="PropertyValue.html" class="tsd-signature-type tsd-kind-class">PropertyValue</a></h4><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getdescription">getDescription</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L52">src/IIIFResource.ts:52</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gethomepage"><span>get<wbr/>Homepage</span><a href="#gethomepage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="gethomepage-1"><span class="tsd-kind-call-signature">getHomepage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><a href="#gethomepage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#gethomepage">getHomepage</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L62">src/IIIFResource.ts:62</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getiiifresourcetype"><span>get<wbr/>IIIF<wbr/>Resource<wbr/>Type</span><a href="#getiiifresourcetype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getiiifresourcetype-1"><span class="tsd-kind-call-signature">getIIIFResourceType</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IIIFResourceType</span><a href="#getiiifresourcetype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IIIFResourceType</span></h4><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getiiifresourcetype">getIIIFResourceType</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L72">src/IIIFResource.ts:72</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getlabel"><span>get<wbr/>Label</span><a href="#getlabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getlabel-1"><span class="tsd-kind-call-signature">getLabel</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="PropertyValue.html" class="tsd-signature-type tsd-kind-class">PropertyValue</a><a href="#getlabel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>returns the PropertyValue which in turn allows a language-specific string
encoded in the json as the "label" property</p>
</div><h4 class="tsd-returns-title">Returns <a href="PropertyValue.html" class="tsd-signature-type tsd-kind-class">PropertyValue</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">label</span><span class="hl-1"> = </span><span class="hl-2">manifest</span><span class="hl-1">.</span><span class="hl-3">getLabel</span><span class="hl-1">().</span><span class="hl-3">getValue</span><span class="hl-1">(); </span><span class="hl-4">// returns the string for default locale</span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">label</span><span class="hl-1"> = </span><span class="hl-2">manifest</span><span class="hl-1">.</span><span class="hl-3">getLabel</span><span class="hl-1">().</span><span class="hl-3">getValue</span><span class="hl-1">(</span><span class="hl-2">locale</span><span class="hl-1">); </span><span class="hl-4">// locale a string , examples</span><br/><span class="hl-1"> </span><span class="hl-4">// would be "fr", "en-US",</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getlabel">getLabel</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/ManifestResource.ts#L41">src/ManifestResource.ts:41</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getlicense"><span>get<wbr/>License</span><a href="#getlicense" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getlicense-1"><span class="tsd-kind-call-signature">getLicense</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><a href="#getlicense-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getlicense">getLicense</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L107">src/IIIFResource.ts:107</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getlogo"><span>get<wbr/>Logo</span><a href="#getlogo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getlogo-1"><span class="tsd-kind-call-signature">getLogo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><a href="#getlogo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="IIIFResource.html">IIIFResource</a>.<a href="IIIFResource.html#getlogo">getLogo</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/IIIFResource.ts#L76">src/IIIFResource.ts:76</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmanifestbyindex"><span>get<wbr/>Manifest<wbr/>By<wbr/>Index</span><a href="#getmanifestbyindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmanifestbyindex-1"><span class="tsd-kind-call-signature">getManifestByIndex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">manifestIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Manifest.html" class="tsd-signature-type tsd-kind-class">Manifest</a><span class="tsd-signature-symbol">></span><a href="#getmanifestbyindex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">manifestIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Manifest.html" class="tsd-signature-type tsd-kind-class">Manifest</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Collection.ts#L64">src/Collection.ts:64</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmanifests"><span>get<wbr/>Manifests</span><a href="#getmanifests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0