@iiif/3d-manifesto-dev
Version:
IIIF Presentation API utility library for client and server with 3D extension
98 lines (96 loc) • 103 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>Light | 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">Light</a></li></ul><h1>Class Light</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>With the 3D extensions to the IIIF Presentation API the name of this
class is misleading, but for now is being retained for the sake backward
compatibility with earlier manifesto code and tests.</p>
<p>The 3D extensions allow that the body property of an annotation can be
a light, camera, or model, or a SpecificResource object wrapping a light, camera,
or model.
*</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="395"><h4>Hierarchy (<a href="../hierarchy.html#Light">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="AnnotationBody.html" class="tsd-signature-type tsd-kind-class">AnnotationBody</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Light</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/Light.ts#L9">src/Light.ts:9</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="#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="#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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#angle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Angle</span></a>
<a href="#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Color</span></a>
<a href="#intensity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Intensity</span></a>
<a href="#lookat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Look<wbr/>At</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#getangle" 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/>Angle</span></a>
<a href="#getcolor" 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/>Color</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="#getformat" 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/>Format</span></a>
<a href="#getheight" 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/>Height</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="#getintensity" 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/>Intensity</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="#getlookat" 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/>Look<wbr/>At</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="#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="#getpropertyfromselforsource" 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/>From<wbr/>Self<wbr/>Or<wbr/>Source</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="#getresourceid" 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/>Resource<wbr/>ID</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="#getsource" 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/>Source</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="#gettransform" 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/>Transform</span></a>
<a href="#gettransformmatrix" 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/>Transform<wbr/>Matrix</span></a>
<a href="#gettransformset" 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/>Transform<wbr/>Set</span></a>
<a href="#gettype" 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/>Type</span></a>
<a href="#getwidth" 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/>Width</span></a>
<a href="#isambientlight" 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>is<wbr/>Ambient<wbr/>Light</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="#isdirectionallight" 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>is<wbr/>Directional<wbr/>Light</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="#ismodel" 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/>Model</span></a>
<a href="#ispointlight" 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>is<wbr/>Point<wbr/>Light</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="#isspecificresource" 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/>Specific<wbr/>Resource</span></a>
<a href="#isspotlight" 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>is<wbr/>Spot<wbr/>Light</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="constructorlight"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Light</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">Light</a><a href="#constructorlight" 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><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">jsonld</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag">Optional</code><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">Light</a></h4><aside class="tsd-sources"><p>Overrides <a href="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Light.ts#L10">src/Light.ts:10</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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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="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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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="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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><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>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="angle"><span>Angle</span><a href="#angle" 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><div class="tsd-signature" id="angleangle"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">Angle</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Light.ts#L81">src/Light.ts:81</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="color"><span>Color</span><a href="#color" 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><div class="tsd-signature" id="colorcolor"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">Color</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="Color.html" class="tsd-signature-type tsd-kind-class">Color</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Color.html" class="tsd-signature-type tsd-kind-class">Color</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Light.ts#L20">src/Light.ts:20</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="intensity"><span>Intensity</span><a href="#intensity" 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><div class="tsd-signature" id="intensityintensity"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">Intensity</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Light.ts#L53">src/Light.ts:53</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lookat"><span>Look<wbr/>At</span><a href="#lookat" 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><div class="tsd-signature" id="lookatlookat"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">LookAt</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">object</span></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">object</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Light.ts#L104">src/Light.ts:104</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-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"><h3 class="tsd-anchor-link" id="getangle"><span>get<wbr/>Angle</span><a href="#getangle" 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="getangle-1"><span class="tsd-kind-call-signature">getAngle</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><a href="#getangle-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>As defined in the <a href="http://temp-draft-4.md">temp-draft-4.md</a> (
<a href="https://github.com/IIIF/3d/blob/main/temp-draft-4.md#lights">https://github.com/IIIF/3d/blob/main/temp-draft-4.md#lights</a> ; 12 May 2024)
this quantity is the half-angle of the cone of the spotlight.</p>
<p>The inconsistency between this definition of the angle and the definition of
fieldOfView for PerspectiveCamera (where the property value defines the full angle) has
already been noted: <a href="https://github.com/IIIF/api/issues/2284">https://github.com/IIIF/api/issues/2284</a></p>
<p>provisional decision is to return undefined in case that this property
is accessed in a light that is not a spotlight</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></h4><p>number</p>
<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/Light.ts#L73">src/Light.ts:73</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcolor"><span>get<wbr/>Color</span><a href="#getcolor" 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="getcolor-1"><span class="tsd-kind-call-signature">getColor</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="Color.html" class="tsd-signature-type tsd-kind-class">Color</a><a href="#getcolor-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="Color.html" class="tsd-signature-type tsd-kind-class">Color</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/Light.ts#L14">src/Light.ts:14</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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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 tsd-is-inherited"><h3 class="tsd-anchor-link" id="getformat"><span>get<wbr/>Format</span><a href="#getformat" 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="getformat-1"><span class="tsd-kind-call-signature">getFormat</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">MediaType</span><a href="#getformat-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">MediaType</span></h4><aside class="tsd-sources"><p>Inherited from <a href="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#getformat">getFormat</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/AnnotationBody.ts#L48">src/AnnotationBody.ts:48</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getheight"><span>get<wbr/>Height</span><a href="#getheight" 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="getheight-1"><span class="tsd-kind-call-signature">getHeight</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getheight-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">number</span></h4><aside class="tsd-sources"><p>Inherited from <a href="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#getheight">getHeight</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/AnnotationBody.ts#L72">src/AnnotationBody.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="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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#getiiifresourcetype">getIIIFResourceType</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/ManifestResource.ts#L27">src/ManifestResource.ts:27</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getintensity"><span>get<wbr/>Intensity</span><a href="#getintensity" 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="getintensity-1"><span class="tsd-kind-call-signature">getIntensity</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getintensity-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>The implementation of the intensity is based on
<a href="https://github.com/IIIF/3d/blob/main/temp-draft-4.md">temp-draft-4.md</a>
and the example 3D manifests
<a href="https://github.com/IIIF/3d/tree/main/manifests/3_lights">lights</a>
on 24 Mar 2024. The intensity property in the manifest is an object
with declared type 'Value', a numeric property named 'value' and a
property named unit . This implementation will only work with a unit == 'relative'
and it will be assumed that a relative unit value of 1.0 corresponds to the
brightest light source a rendering engine supports.</p>
<p>This code will implement a default intensity of 1.0</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</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/Light.ts#L37">src/Light.ts:37</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="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.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"><h3 class="tsd-anchor-link" id="getlookat"><span>get<wbr/>Look<wbr/>At</span><a href="#getlookat" 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="getlookat-1"><span class="tsd-kind-call-signature">getLookAt</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">object</span> <span class="tsd-signature-symbol">|</span> <a href="PointSelector.html" class="tsd-signature-type tsd-kind-class">PointSelector</a><a href="#getlookat-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">object</span> <span class="tsd-signature-symbol">|</span> <a href="PointSelector.html" class="tsd-signature-type tsd-kind-class">PointSelector</a></h4><p>: if not null, is either a PointSelector, or an object
with an id matching the id of an Annotation instance.</p>
<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/Light.ts#L89">src/Light.ts:89</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmetadata"><span>get<wbr/>Metadata</span><a href="#getmetadata" 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="getmetadata-1"><span class="tsd-kind-call-signature">getMetadata</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LabelValuePair.html" class="tsd-signature-type tsd-kind-class">LabelValuePair</a><span class="tsd-signature-symbol">[]</span><a href="#getmetadata-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="LabelValuePair.html" class="tsd-signature-type tsd-kind-class">LabelValuePair</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#getmetadata">getMetadata</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/ManifestResource.ts#L65">src/ManifestResource.ts:65</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getproperty"><span>get<wbr/>Property</span><a href="#getproperty" 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="getproperty-1"><span class="tsd-kind-call-signature">getProperty</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getproperty-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">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><p>Inherited from <a href="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#getproperty">getProperty</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/JSONLDResource.ts#L12">src/JSONLDResource.ts:12</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getpropertyasobject"><span>get<wbr/>Property<wbr/>As<wbr/>Object</span><a href="#getpropertyasobject" 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="getpropertyasobject-1"><span class="tsd-kind-call-signature">getPropertyAsObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getpropertyasobject-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>A function that wraps the getProperty function, which client
code can use if it is needed to identify when the json value of
a property is an IRI -- Internationalized Resource Identifier</p>
<p>If the value of the json value is a bare string, then it will be
wrapped in a json object with the string in the property 'id',
additionally that property will have a property 'isIRI' which will
be true for the literal string case, otherwise false meaning the
returned getProperty should be parsed as before.</p>
<ul>
<li></li>
</ul>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="AnnotationBody.html">AnnotationBody</a>.<a href="AnnotationBody.html#getpropertyasobject">getPropertyAsObject</a></p><ul><li>Defined in <a href="https://github.com/IIIF-Commons/manifesto-3d/blob/e1a15f018c20be0d71fde610bcfd928a6974e482/src/JSONLDResource.ts#L39">src/JSONLDResource.ts:39</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getpropertyfromselforsource"><span>get<wbr/>Property<wbr/>From<wbr/>Self<wbr/>Or<wbr/>Source</span><a href="#getpropertyfromselforsource" 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="getpropertyfromselforsource-1"><span class="tsd-kind-call-signature">getPropertyFromSelfOrSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prop</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getpropertyfromselforsource-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">prop</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><p>Inherited from <a href="AnnotationBody.html">AnnotationBody</a>.<a href="Annota