@projektemacher/storymapjs 0.10.8 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (195) hide show
  1. package/CHANGELOG +81 -0
  2. package/README.md +129 -12
  3. package/dist/assets/{demo-DBpeF31K.js → demo-bWnOyfUw.js} +1 -1
  4. package/dist/assets/harness-C3JUv5Ii.js +1 -0
  5. package/dist/assets/{harness-multi-CYHgI0a9.js → harness-multi-XZNex3tb.js} +1 -1
  6. package/dist/assets/{harness-support-Do7sIp2j.js → harness-support-CjfZIVeb.js} +1 -1
  7. package/dist/assets/main-DQ32hWBM.js +17 -0
  8. package/dist/context.json +13 -2
  9. package/dist/css/storymap.css +1 -1
  10. package/dist/demo.html +3 -2
  11. package/dist/docs/api/assets/navigation.js +1 -1
  12. package/dist/docs/api/assets/search.js +1 -1
  13. package/dist/docs/api/classes/StoryMap.html +777 -269
  14. package/dist/docs/api/functions/MediaType.html +1 -1
  15. package/dist/docs/api/functions/isPresentation3Collection.html +1 -1
  16. package/dist/docs/api/functions/isPresentation3Manifest.html +1 -1
  17. package/dist/docs/api/functions/isSlideshowCollection.html +51 -0
  18. package/dist/docs/api/functions/loadCSS.html +1 -1
  19. package/dist/docs/api/functions/manifestToStorymapData.html +1 -1
  20. package/dist/docs/api/functions/setLanguage.html +1 -1
  21. package/dist/docs/api/functions/slideshowToStorymapData.html +51 -0
  22. package/dist/docs/api/functions/slideshowVersion.html +48 -0
  23. package/dist/docs/api/functions/storymapToManifest.html +1 -1
  24. package/dist/docs/api/functions/validateStorymap.html +1 -1
  25. package/dist/docs/api/functions/validateStorymapAndReport.html +1 -1
  26. package/dist/docs/api/index.html +115 -12
  27. package/dist/docs/api/interfaces/AnimationHandle.html +2 -2
  28. package/dist/docs/api/interfaces/ImagereadyPayload.html +4 -4
  29. package/dist/docs/api/interfaces/LanguageEntry.html +6 -6
  30. package/dist/docs/api/interfaces/LatLngLiteral.html +4 -4
  31. package/dist/docs/api/interfaces/LoadOptions.html +2 -2
  32. package/dist/docs/api/interfaces/MapEvents.html +116 -0
  33. package/dist/docs/api/interfaces/MapMarkerEvents.html +66 -0
  34. package/dist/docs/api/interfaces/MarkerEventPayload.html +57 -0
  35. package/dist/docs/api/interfaces/MediaEvents.html +78 -0
  36. package/dist/docs/api/interfaces/MenuBarEvents.html +114 -0
  37. package/dist/docs/api/interfaces/MessageEvents.html +72 -0
  38. package/dist/docs/api/interfaces/OlLayer.html +1 -1
  39. package/dist/docs/api/interfaces/OlMap.html +1 -1
  40. package/dist/docs/api/interfaces/OlSource.html +1 -1
  41. package/dist/docs/api/interfaces/OlTileLayer.html +1 -1
  42. package/dist/docs/api/interfaces/OlVectorLayer.html +1 -1
  43. package/dist/docs/api/interfaces/OlView.html +1 -1
  44. package/dist/docs/api/interfaces/SlideBackgroundState.html +66 -0
  45. package/dist/docs/api/interfaces/SlideEvents.html +78 -0
  46. package/dist/docs/api/interfaces/SlideNavEvents.html +72 -0
  47. package/dist/docs/api/interfaces/SlideshowPlayerSettings.html +182 -0
  48. package/dist/docs/api/interfaces/SlideshowToStorymapResult.html +60 -0
  49. package/dist/docs/api/interfaces/SlideshowTranslatorOptions.html +65 -0
  50. package/dist/docs/api/interfaces/SlideshowWarning.html +72 -0
  51. package/dist/docs/api/interfaces/StoryMapEvents.html +146 -0
  52. package/dist/docs/api/interfaces/StoryMapMarker.html +763 -0
  53. package/dist/docs/api/interfaces/StorySliderEvents.html +102 -0
  54. package/dist/docs/api/interfaces/StorymapBasemap.html +69 -0
  55. package/dist/docs/api/interfaces/StorymapData.html +12 -6
  56. package/dist/docs/api/interfaces/StorymapDataWrapper.html +2 -2
  57. package/dist/docs/api/interfaces/StorymapDocument.html +2 -2
  58. package/dist/docs/api/interfaces/StorymapError.html +3 -3
  59. package/dist/docs/api/interfaces/StorymapGeoreference.html +5 -5
  60. package/dist/docs/api/interfaces/StorymapGeoreferenceBody.html +4 -4
  61. package/dist/docs/api/interfaces/StorymapGroundControlPoint.html +4 -4
  62. package/dist/docs/api/interfaces/StorymapLanguageMap.html +2 -2
  63. package/dist/docs/api/interfaces/StorymapManifest.html +12 -12
  64. package/dist/docs/api/interfaces/StorymapManifestAnnotation.html +43 -11
  65. package/dist/docs/api/interfaces/StorymapManifestBackground.html +6 -6
  66. package/dist/docs/api/interfaces/StorymapManifestCanvas.html +65 -17
  67. package/dist/docs/api/interfaces/StorymapManifestContentResource.html +8 -8
  68. package/dist/docs/api/interfaces/StorymapManifestFeatureCollection.html +4 -4
  69. package/dist/docs/api/interfaces/StorymapManifestGeoreferencing.html +7 -7
  70. package/dist/docs/api/interfaces/StorymapManifestImageService.html +4 -4
  71. package/dist/docs/api/interfaces/StorymapManifestRange.html +5 -5
  72. package/dist/docs/api/interfaces/StorymapManifestService.html +4 -4
  73. package/dist/docs/api/interfaces/StorymapManifestSpecificResource.html +4 -4
  74. package/dist/docs/api/interfaces/StorymapManifestStatement.html +3 -3
  75. package/dist/docs/api/interfaces/StorymapMapOptions.html +5 -5
  76. package/dist/docs/api/interfaces/StorymapOptions.html +277 -75
  77. package/dist/docs/api/interfaces/StorymapOverlayLayer.html +42 -11
  78. package/dist/docs/api/interfaces/StorymapSlide.html +70 -16
  79. package/dist/docs/api/interfaces/StorymapSlideBackground.html +4 -4
  80. package/dist/docs/api/interfaces/StorymapSlideLocation.html +58 -14
  81. package/dist/docs/api/interfaces/StorymapSlideMarker.html +8 -9
  82. package/dist/docs/api/interfaces/StorymapSlideMedia.html +49 -10
  83. package/dist/docs/api/interfaces/StorymapSlideNarration.html +61 -9
  84. package/dist/docs/api/interfaces/StorymapSlideText.html +4 -4
  85. package/dist/docs/api/interfaces/StorymapTilejson.html +8 -8
  86. package/dist/docs/api/interfaces/SwipableEvents.html +102 -0
  87. package/dist/docs/api/interfaces/TextEvents.html +66 -0
  88. package/dist/docs/api/media/events.md +66 -0
  89. package/dist/docs/api/media/migration-from-knightlab.md +89 -49
  90. package/dist/docs/api/media/slideshow.md +109 -0
  91. package/dist/docs/api/media/storymap-as-iiif-manifest.md +1007 -0
  92. package/dist/docs/api/modules.html +6 -6
  93. package/dist/docs/api/types/ContentState.html +3 -3
  94. package/dist/docs/api/types/FiredEvent.html +43 -0
  95. package/dist/docs/api/types/ImagereadyKind.html +1 -1
  96. package/dist/docs/api/types/MediaTypeMatch.html +5 -5
  97. package/dist/docs/api/types/SwipeDirection.html +36 -0
  98. package/dist/docs/api/types/TileSourceFactory.html +1 -1
  99. package/dist/docs/authoring.html +20 -7
  100. package/dist/docs/events.html +263 -0
  101. package/dist/docs/iiif.html +136 -22
  102. package/dist/docs/migration.html +66 -19
  103. package/dist/docs/readme.html +113 -12
  104. package/dist/embed/index.html +7 -0
  105. package/dist/examples/font-css-false.json +33 -0
  106. package/dist/examples/issue-image-region.json +1 -1
  107. package/dist/examples/layers-control.json +60 -0
  108. package/dist/examples/map-template-provider.json +36 -0
  109. package/dist/examples/multi-media.json +71 -0
  110. package/dist/examples-iiif/annotated-image.json +16 -0
  111. package/dist/examples-iiif/font-css-false.json +114 -0
  112. package/dist/examples-iiif/issue-image-region.json +1 -1
  113. package/dist/examples-iiif/layers-control.json +226 -0
  114. package/dist/examples-iiif/map-template-provider.json +133 -0
  115. package/dist/examples-iiif/multi-media.json +237 -0
  116. package/dist/examples-slideshow/single.json +79 -0
  117. package/dist/examples-slideshow/static/pixel.png +0 -0
  118. package/dist/examples-slideshow/static.json +44 -0
  119. package/dist/harness-multi.html +3 -3
  120. package/dist/harness.html +4 -3
  121. package/dist/index.html +3 -2
  122. package/dist/js/storymap.d.ts +1326 -289
  123. package/dist/js/storymap.js +6690 -4784
  124. package/dist/js/storymap.js.map +1 -1
  125. package/dist/navplace-properties.json +14 -0
  126. package/dist/site.css +54 -36
  127. package/docs/migration-from-knightlab.md +89 -49
  128. package/docs/storymap-as-iiif-manifest.md +199 -126
  129. package/package.json +4 -2
  130. package/schema/storymap.schema.json +334 -34
  131. package/src/core/Util.ts +3 -1
  132. package/src/core/mixins.ts +42 -28
  133. package/src/language/Language.ts +7 -0
  134. package/src/language/locale/.expected-gaps.json +287 -27
  135. package/src/language/locale/de.json +11 -1
  136. package/src/language/locale/en.json +11 -1
  137. package/src/main.ts +51 -0
  138. package/src/map/Map.ts +44 -6
  139. package/src/map/MapMarker.ts +16 -3
  140. package/src/map/openlayers/Map.OpenLayers.ts +787 -62
  141. package/src/map/openlayers/MapMarker.OpenLayers.ts +113 -13
  142. package/src/map/slideView.ts +149 -0
  143. package/src/map/types.ts +2 -0
  144. package/src/media/EmbedUtil.ts +27 -2
  145. package/src/media/Media.ts +27 -4
  146. package/src/media/embedId.ts +6 -0
  147. package/src/media/types/Flickr.ts +14 -3
  148. package/src/media/types/HtmlMedia.ts +66 -0
  149. package/src/media/types/Image.ts +15 -3
  150. package/src/media/types/SoundCloud.ts +1 -1
  151. package/src/media/types/Text.ts +27 -8
  152. package/src/media/types/Twitter.ts +9 -7
  153. package/src/media/types/Vimeo.ts +1 -1
  154. package/src/media/types/YouTube.ts +2 -2
  155. package/src/scss/Typography.scss +15 -15
  156. package/src/scss/VCO.StoryMap.scss +173 -8
  157. package/src/scss/core/Reset.scss +5 -18
  158. package/src/scss/map/VCO.Map.scss +1 -1
  159. package/src/scss/map/VCO.MapMarker.scss +20 -9
  160. package/src/scss/map/openlayers/VCO.Map.OpenLayers.scss +7 -4
  161. package/src/scss/media/VCO.Media.scss +7 -7
  162. package/src/scss/media/types/VCO.Media.Blockquote.scss +1 -1
  163. package/src/scss/media/types/VCO.Media.Text.scss +5 -5
  164. package/src/scss/media/types/VCO.Media.Twitter.scss +4 -4
  165. package/src/scss/media/types/VCO.Media.Wikipedia.scss +2 -19
  166. package/src/scss/site/site.scss +55 -36
  167. package/src/scss/slider/VCO.Slide.scss +49 -11
  168. package/src/scss/slider/VCO.SlideNav.scss +23 -7
  169. package/src/scss/slider/VCO.StorySlider.scss +50 -0
  170. package/src/scss/snapmap/VCO.SnapMap.scss +3 -3
  171. package/src/scss/ui/VCO.Consent.scss +20 -14
  172. package/src/scss/ui/VCO.Layers.scss +119 -0
  173. package/src/scss/ui/VCO.MenuBar.Button.scss +140 -19
  174. package/src/scss/ui/VCO.MenuBar.scss +9 -2
  175. package/src/scss/ui/VCO.Message.scss +14 -0
  176. package/src/slider/Slide.ts +232 -74
  177. package/src/slider/SlideNav.ts +15 -4
  178. package/src/slider/StorySlider.ts +203 -22
  179. package/src/storymap/Consent.ts +22 -0
  180. package/src/storymap/StoryMap.ts +944 -131
  181. package/src/storymap/content-state.ts +3 -8
  182. package/src/storymap/font-css.ts +72 -0
  183. package/src/storymap/from-slideshow.ts +785 -0
  184. package/src/storymap/iiif-shared.ts +228 -0
  185. package/src/storymap/iiif.ts +289 -100
  186. package/src/storymap/to-iiif.ts +131 -44
  187. package/src/types.ts +382 -17
  188. package/src/ui/LayersControl.ts +302 -0
  189. package/src/ui/MenuBar.ts +232 -21
  190. package/src/ui/Message.ts +36 -3
  191. package/src/ui/Swipable.ts +25 -7
  192. package/dist/assets/harness-Cr0rYpvt.js +0 -1
  193. package/dist/assets/main-DXalctuR.js +0 -17
  194. package/src/scss/VCO.StoryMap.Dark.scss +0 -150
  195. package/src/scss/Variables.Dark.scss +0 -57
package/dist/docs/api/interfaces/StorymapSlideLocation.html CHANGED
@@ -16,14 +16,14 @@
16
16
  actually types its document and options with, and TypeDoc warns about a
17
17
  documented member whose type it cannot link.</p>
18
18
  </div></section>
19
- <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideLocation</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#icon">icon</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#iconsize">iconSize</a><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><br/>    <a class="tsd-kind-property" href="#image">image</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#lat">lat</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#line">line</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#lon">lon</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#region">region</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</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><br/>    <a class="tsd-kind-property" href="#use_custom_marker">use_custom_marker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#zoom">zoom</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
19
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideLocation</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#basemap">basemap</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#filter">filter</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapSlideFilter</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#icon">icon</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#iconsize">iconSize</a><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><br/>    <a class="tsd-kind-property" href="#image">image</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#lat">lat</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#line">line</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#lon">lon</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mask">mask</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapSlideMask</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#region">region</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</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><br/>    <a class="tsd-kind-property" href="#rotation">rotation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#use_custom_marker">use_custom_marker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#zoom">zoom</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
20
20
  <section class="tsd-panel">
21
21
  <h4 class="tsd-before-signature">Indexable</h4>
22
22
  <ul class="tsd-signatures">
23
23
  <li class="tsd-index-signature">
24
24
  <div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span></div></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L14">src/types.ts:14</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L14">src/types.ts:14</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <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>
@@ -31,13 +31,17 @@ documented member whose type it cannot link.</p>
31
31
  <div class="tsd-accordion-details">
32
32
  <section class="tsd-index-section">
33
33
  <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" 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>
34
- <div class="tsd-index-list"><a href="#icon" 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>icon?</span></a>
34
+ <div class="tsd-index-list"><a href="#basemap" 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>basemap?</span></a>
35
+ <a href="#filter" 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>filter?</span></a>
36
+ <a href="#icon" 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>icon?</span></a>
35
37
  <a href="#iconsize" 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>icon<wbr/>Size?</span></a>
36
38
  <a href="#image" 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>image?</span></a>
37
39
  <a href="#lat" 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>lat?</span></a>
38
40
  <a href="#line" 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>line?</span></a>
39
41
  <a href="#lon" 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>lon?</span></a>
42
+ <a href="#mask" 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>mask?</span></a>
40
43
  <a href="#region" 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>region?</span></a>
44
+ <a href="#rotation" 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>rotation?</span></a>
41
45
  <a href="#use_custom_marker" 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>use_<wbr/>custom_<wbr/>marker?</span></a>
42
46
  <a href="#zoom" 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>zoom?</span></a>
43
47
  </div></section></div></details></section></section>
@@ -45,54 +49,94 @@ documented member whose type it cannot link.</p>
45
49
  <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-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></h2></summary>
46
50
  <section>
47
51
  <section class="tsd-panel tsd-member">
52
+ <h3 class="tsd-anchor-link" id="basemap"><code class="tsd-tag">Optional</code><span>basemap</span><a href="#basemap" 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>
53
+ <div class="tsd-signature"><span class="tsd-kind-property">basemap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
54
+ <div class="tsd-comment tsd-typography"><p>Per-slide basemap override (multi-manifest slideshow tours): any
55
+ <code>map_type</code> value or IIIF <code>info.json</code> URL. Absent keeps the story
56
+ basemap. The layer is cached, so returning to a slide is free.
57
+ Honored only with <code>slideshow_source</code>.</p>
58
+ </div><aside class="tsd-sources">
59
+ <ul>
60
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L51">src/types.ts:51</a></li></ul></aside></section>
61
+ <section class="tsd-panel tsd-member">
62
+ <h3 class="tsd-anchor-link" id="filter"><code class="tsd-tag">Optional</code><span>filter</span><a href="#filter" 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>
63
+ <div class="tsd-signature"><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapSlideFilter</span></div>
64
+ <div class="tsd-comment tsd-typography"><p>Per-slide image grading (slideshow <code>filters</code>): applied as a CSS
65
+ <code>filter()</code> on the map viewport. All fields optional; absent means
66
+ unfiltered. <code>hueRotate</code> is degrees (-180..180), <code>blur</code> is CSS pixels.
67
+ Honored only with <code>slideshow_source</code>.</p>
68
+ </div><aside class="tsd-sources">
69
+ <ul>
70
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L37">src/types.ts:37</a></li></ul></aside></section>
71
+ <section class="tsd-panel tsd-member">
48
72
  <h3 class="tsd-anchor-link" id="icon"><code class="tsd-tag">Optional</code><span>icon</span><a href="#icon" 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>
49
73
  <div class="tsd-signature"><span class="tsd-kind-property">icon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
50
74
  <ul>
51
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L25">src/types.ts:25</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L53">src/types.ts:53</a></li></ul></aside></section>
52
76
  <section class="tsd-panel tsd-member">
53
77
  <h3 class="tsd-anchor-link" id="iconsize"><code class="tsd-tag">Optional</code><span>icon<wbr/>Size</span><a href="#iconsize" 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>
54
78
  <div class="tsd-signature"><span class="tsd-kind-property">iconSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
55
79
  <ul>
56
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L26">src/types.ts:26</a></li></ul></aside></section>
80
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L54">src/types.ts:54</a></li></ul></aside></section>
57
81
  <section class="tsd-panel tsd-member">
58
82
  <h3 class="tsd-anchor-link" id="image"><code class="tsd-tag">Optional</code><span>image</span><a href="#image" 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>
59
83
  <div class="tsd-signature"><span class="tsd-kind-property">image</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
60
84
  <ul>
61
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L27">src/types.ts:27</a></li></ul></aside></section>
85
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L55">src/types.ts:55</a></li></ul></aside></section>
62
86
  <section class="tsd-panel tsd-member">
63
87
  <h3 class="tsd-anchor-link" id="lat"><code class="tsd-tag">Optional</code><span>lat</span><a href="#lat" 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>
64
88
  <div class="tsd-signature"><span class="tsd-kind-property">lat</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
65
89
  <ul>
66
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L15">src/types.ts:15</a></li></ul></aside></section>
90
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L15">src/types.ts:15</a></li></ul></aside></section>
67
91
  <section class="tsd-panel tsd-member">
68
92
  <h3 class="tsd-anchor-link" id="line"><code class="tsd-tag">Optional</code><span>line</span><a href="#line" 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>
69
93
  <div class="tsd-signature"><span class="tsd-kind-property">line</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
70
94
  <ul>
71
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L24">src/types.ts:24</a></li></ul></aside></section>
95
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L52">src/types.ts:52</a></li></ul></aside></section>
72
96
  <section class="tsd-panel tsd-member">
73
97
  <h3 class="tsd-anchor-link" id="lon"><code class="tsd-tag">Optional</code><span>lon</span><a href="#lon" 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>
74
98
  <div class="tsd-signature"><span class="tsd-kind-property">lon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
75
99
  <ul>
76
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L16">src/types.ts:16</a></li></ul></aside></section>
100
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L16">src/types.ts:16</a></li></ul></aside></section>
101
+ <section class="tsd-panel tsd-member">
102
+ <h3 class="tsd-anchor-link" id="mask"><code class="tsd-tag">Optional</code><span>mask</span><a href="#mask" 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>
103
+ <div class="tsd-signature"><span class="tsd-kind-property">mask</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapSlideMask</span></div>
104
+ <div class="tsd-comment tsd-typography"><p>Spotlight mask (slideshow <code>passepartout</code>): normalized viewport
105
+ fractions <code>{x, y, w, h}</code> (0..1) left visible while the rest is dimmed
106
+ with <code>color</code>. <code>invert</code> dims the inside instead of the outside.
107
+ Absent means no mask. Honored only with <code>slideshow_source</code>.</p>
108
+ </div><aside class="tsd-sources">
109
+ <ul>
110
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L44">src/types.ts:44</a></li></ul></aside></section>
77
111
  <section class="tsd-panel tsd-member">
78
112
  <h3 class="tsd-anchor-link" id="region"><code class="tsd-tag">Optional</code><span>region</span><a href="#region" 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>
79
113
  <div class="tsd-signature"><span class="tsd-kind-property">region</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></div>
80
114
  <div class="tsd-comment tsd-typography"><p>Image region <code>[x, y, w, h]</code> in image pixels (IIIF xywh convention,
81
- StrollView-style image stops): the view fits the region on
115
+ slideshow-style image stops): the view fits the region on
82
116
  navigation; image maps (<code>map_type: &quot;iiif&quot;</code> + <code>map_as_image</code>) only.</p>
83
117
  </div><aside class="tsd-sources">
84
118
  <ul>
85
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L23">src/types.ts:23</a></li></ul></aside></section>
119
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L23">src/types.ts:23</a></li></ul></aside></section>
120
+ <section class="tsd-panel tsd-member">
121
+ <h3 class="tsd-anchor-link" id="rotation"><code class="tsd-tag">Optional</code><span>rotation</span><a href="#rotation" 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>
122
+ <div class="tsd-signature"><span class="tsd-kind-property">rotation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
123
+ <div class="tsd-comment tsd-typography"><p>View rotation in degrees clockwise (slideshow <code>rotation</code>). Applied to
124
+ the map view on navigation; absent means north-up (0). Image and geo
125
+ maps alike; purely presentational. Honored only with
126
+ <code>slideshow_source</code>.</p>
127
+ </div><aside class="tsd-sources">
128
+ <ul>
129
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L30">src/types.ts:30</a></li></ul></aside></section>
86
130
  <section class="tsd-panel tsd-member">
87
131
  <h3 class="tsd-anchor-link" id="use_custom_marker"><code class="tsd-tag">Optional</code><span>use_<wbr/>custom_<wbr/>marker</span><a href="#use_custom_marker" 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>
88
132
  <div class="tsd-signature"><span class="tsd-kind-property">use_custom_marker</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
89
133
  <ul>
90
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L28">src/types.ts:28</a></li></ul></aside></section>
134
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L56">src/types.ts:56</a></li></ul></aside></section>
91
135
  <section class="tsd-panel tsd-member">
92
136
  <h3 class="tsd-anchor-link" id="zoom"><code class="tsd-tag">Optional</code><span>zoom</span><a href="#zoom" 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>
93
137
  <div class="tsd-signature"><span class="tsd-kind-property">zoom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
94
138
  <ul>
95
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L17">src/types.ts:17</a></li></ul></aside></section></section></details></div>
139
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L17">src/types.ts:17</a></li></ul></aside></section></section></details></div>
96
140
  <div class="col-sidebar">
97
141
  <div class="page-menu">
98
142
  <div class="tsd-navigation settings">
@@ -109,7 +153,7 @@ navigation; image maps (<code>map_type: &quot;iiif&quot;</code> + <code>map_as_i
109
153
  <h3>On This Page</h3></summary>
110
154
  <div class="tsd-accordion-details">
111
155
  <details open class="tsd-accordion tsd-page-navigation-section"><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>Properties</summary>
112
- <div><a href="#icon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon</span></a><a href="#iconsize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon<wbr/>Size</span></a><a href="#image"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>image</span></a><a href="#lat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lat</span></a><a href="#line"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>line</span></a><a href="#lon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lon</span></a><a href="#region"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>region</span></a><a href="#use_custom_marker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use_<wbr/>custom_<wbr/>marker</span></a><a href="#zoom"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>zoom</span></a></div></details></div></details></div>
156
+ <div><a href="#basemap"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>basemap</span></a><a href="#filter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a><a href="#icon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon</span></a><a href="#iconsize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon<wbr/>Size</span></a><a href="#image"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>image</span></a><a href="#lat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lat</span></a><a href="#line"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>line</span></a><a href="#lon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lon</span></a><a href="#mask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mask</span></a><a href="#region"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>region</span></a><a href="#rotation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rotation</span></a><a href="#use_custom_marker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use_<wbr/>custom_<wbr/>marker</span></a><a href="#zoom"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>zoom</span></a></div></details></div></details></div>
113
157
  <div class="site-menu">
114
158
  <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
115
159
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
package/dist/docs/api/interfaces/StorymapSlideMarker.html CHANGED
@@ -12,8 +12,7 @@
12
12
  <h1>Interface StorymapSlideMarker</h1></div>
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>Per-slide marker presentation, consolidated. <code>location.*</code> keeps working as
15
- the legacy spelling and <code>marker.*</code> wins when present — see
16
- docs/plans/iiif-media-tours.md §2.</p>
15
+ the legacy spelling and <code>marker.*</code> wins when present.</p>
17
16
  <p>In a IIIF manifest none of this is a <code>storymap:</code> term: it all arrives in the
18
17
  <code>navPlace</code> Feature's <code>properties</code> bag (<code>icon</code>, <code>iconSize</code>, <code>image</code>, <code>name</code>,
19
18
  <code>popup</code>, <code>audioBadge</code>), which is a GeoJSON foreign-member bag and so needs
@@ -26,7 +25,7 @@ no vocabulary registration.</p>
26
25
  <li class="tsd-index-signature">
27
26
  <div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span></div></li></ul></section><aside class="tsd-sources">
28
27
  <ul>
29
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L79">src/types.ts:79</a></li></ul></aside>
28
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L151">src/types.ts:151</a></li></ul></aside>
30
29
  <section class="tsd-panel-group tsd-index-group">
31
30
  <section class="tsd-panel tsd-index-panel">
32
31
  <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>
@@ -50,36 +49,36 @@ no vocabulary registration.</p>
50
49
  <div class="tsd-comment tsd-typography"><p>Mark slides that carry narration or audio media with a small badge.</p>
51
50
  </div><aside class="tsd-sources">
52
51
  <ul>
53
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L88">src/types.ts:88</a></li></ul></aside></section>
52
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L160">src/types.ts:160</a></li></ul></aside></section>
54
53
  <section class="tsd-panel tsd-member">
55
54
  <h3 class="tsd-anchor-link" id="icon"><code class="tsd-tag">Optional</code><span>icon</span><a href="#icon" 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>
56
55
  <div class="tsd-signature"><span class="tsd-kind-property">icon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
57
56
  <ul>
58
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L80">src/types.ts:80</a></li></ul></aside></section>
57
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L152">src/types.ts:152</a></li></ul></aside></section>
59
58
  <section class="tsd-panel tsd-member">
60
59
  <h3 class="tsd-anchor-link" id="iconsize"><code class="tsd-tag">Optional</code><span>icon<wbr/>Size</span><a href="#iconsize" 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>
61
60
  <div class="tsd-signature"><span class="tsd-kind-property">iconSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
62
61
  <ul>
63
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L81">src/types.ts:81</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L153">src/types.ts:153</a></li></ul></aside></section>
64
63
  <section class="tsd-panel tsd-member">
65
64
  <h3 class="tsd-anchor-link" id="image"><code class="tsd-tag">Optional</code><span>image</span><a href="#image" 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>
66
65
  <div class="tsd-signature"><span class="tsd-kind-property">image</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
67
66
  <ul>
68
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L82">src/types.ts:82</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L154">src/types.ts:154</a></li></ul></aside></section>
69
68
  <section class="tsd-panel tsd-member">
70
69
  <h3 class="tsd-anchor-link" id="label"><code class="tsd-tag">Optional</code><span>label</span><a href="#label" 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>
71
70
  <div class="tsd-signature"><span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
72
71
  <div class="tsd-comment tsd-typography"><p>The marker label; in a manifest this is <code>properties.name</code>.</p>
73
72
  </div><aside class="tsd-sources">
74
73
  <ul>
75
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L84">src/types.ts:84</a></li></ul></aside></section>
74
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L156">src/types.ts:156</a></li></ul></aside></section>
76
75
  <section class="tsd-panel tsd-member">
77
76
  <h3 class="tsd-anchor-link" id="popup"><code class="tsd-tag">Optional</code><span>popup</span><a href="#popup" 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>
78
77
  <div class="tsd-signature"><span class="tsd-kind-property">popup</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
79
78
  <div class="tsd-comment tsd-typography"><p>Show the popup card when this (active) marker is clicked.</p>
80
79
  </div><aside class="tsd-sources">
81
80
  <ul>
82
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L86">src/types.ts:86</a></li></ul></aside></section></section></details></div>
81
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L158">src/types.ts:158</a></li></ul></aside></section></section></details></div>
83
82
  <div class="col-sidebar">
84
83
  <div class="page-menu">
85
84
  <div class="tsd-navigation settings">
package/dist/docs/api/interfaces/StorymapSlideMedia.html CHANGED
@@ -16,14 +16,14 @@
16
16
  actually types its document and options with, and TypeDoc warns about a
17
17
  documented member whose type it cannot link.</p>
18
18
  </div></section>
19
- <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideMedia</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#alt">alt</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#caption">caption</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#credit">credit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mediatype">mediatype</a><span class="tsd-signature-symbol">?:</span> <a href="../types/MediaTypeMatch.html" class="tsd-signature-type tsd-kind-type-alias">MediaTypeMatch</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#subtitles">subtitles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#thumb">thumb</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#url">url</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
19
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideMedia</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#alt">alt</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#caption">caption</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#credit">credit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#loop">loop</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#mediatype">mediatype</a><span class="tsd-signature-symbol">?:</span> <a href="../types/MediaTypeMatch.html" class="tsd-signature-type tsd-kind-type-alias">MediaTypeMatch</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#offset">offset</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#play">play</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;auto&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;click&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#stoponexit">stopOnExit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#subtitles">subtitles</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#thumb">thumb</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#url">url</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
20
20
  <section class="tsd-panel">
21
21
  <h4 class="tsd-before-signature">Indexable</h4>
22
22
  <ul class="tsd-signatures">
23
23
  <li class="tsd-index-signature">
24
24
  <div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span></div></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L40">src/types.ts:40</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L97">src/types.ts:97</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <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>
@@ -34,7 +34,11 @@ documented member whose type it cannot link.</p>
34
34
  <div class="tsd-index-list"><a href="#alt" 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>alt?</span></a>
35
35
  <a href="#caption" 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>caption?</span></a>
36
36
  <a href="#credit" 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>credit?</span></a>
37
+ <a href="#loop" 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>loop?</span></a>
37
38
  <a href="#mediatype" 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>mediatype?</span></a>
39
+ <a href="#offset" 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>offset?</span></a>
40
+ <a href="#play" 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>play?</span></a>
41
+ <a href="#stoponexit" 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>stop<wbr/>On<wbr/>Exit?</span></a>
38
42
  <a href="#subtitles" 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>subtitles?</span></a>
39
43
  <a href="#thumb" 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>thumb?</span></a>
40
44
  <a href="#url" 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>url?</span></a>
@@ -50,22 +54,57 @@ media is an image. In IIIF this is the painting annotation's
50
54
  <code>accessibilitySummary</code>.</p>
51
55
  </div><aside class="tsd-sources">
52
56
  <ul>
53
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L49">src/types.ts:49</a></li></ul></aside></section>
57
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L106">src/types.ts:106</a></li></ul></aside></section>
54
58
  <section class="tsd-panel tsd-member">
55
59
  <h3 class="tsd-anchor-link" id="caption"><code class="tsd-tag">Optional</code><span>caption</span><a href="#caption" 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>
56
60
  <div class="tsd-signature"><span class="tsd-kind-property">caption</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
57
61
  <ul>
58
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L42">src/types.ts:42</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L99">src/types.ts:99</a></li></ul></aside></section>
59
63
  <section class="tsd-panel tsd-member">
60
64
  <h3 class="tsd-anchor-link" id="credit"><code class="tsd-tag">Optional</code><span>credit</span><a href="#credit" 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>
61
65
  <div class="tsd-signature"><span class="tsd-kind-property">credit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
62
66
  <ul>
63
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L43">src/types.ts:43</a></li></ul></aside></section>
67
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L100">src/types.ts:100</a></li></ul></aside></section>
68
+ <section class="tsd-panel tsd-member">
69
+ <h3 class="tsd-anchor-link" id="loop"><code class="tsd-tag">Optional</code><span>loop</span><a href="#loop" 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>
70
+ <div class="tsd-signature"><span class="tsd-kind-property">loop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
71
+ <div class="tsd-comment tsd-typography"><p>Loop audio/video media (slideshow <code>audio.loop</code>). Absent means no loop.
72
+ Honored only with <code>slideshow_source</code>.</p>
73
+ </div><aside class="tsd-sources">
74
+ <ul>
75
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L126">src/types.ts:126</a></li></ul></aside></section>
64
76
  <section class="tsd-panel tsd-member">
65
77
  <h3 class="tsd-anchor-link" id="mediatype"><code class="tsd-tag">Optional</code><span>mediatype</span><a href="#mediatype" 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>
66
78
  <div class="tsd-signature"><span class="tsd-kind-property">mediatype</span><span class="tsd-signature-symbol">?:</span> <a href="../types/MediaTypeMatch.html" class="tsd-signature-type tsd-kind-type-alias">MediaTypeMatch</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
67
79
  <ul>
68
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L51">src/types.ts:51</a></li></ul></aside></section>
80
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L108">src/types.ts:108</a></li></ul></aside></section>
81
+ <section class="tsd-panel tsd-member">
82
+ <h3 class="tsd-anchor-link" id="offset"><code class="tsd-tag">Optional</code><span>offset</span><a href="#offset" 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>
83
+ <div class="tsd-signature"><span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
84
+ <div class="tsd-comment tsd-typography"><p>Start offset in seconds for audio/video media (slideshow <code>audio.offset</code>).
85
+ Applied once the media metadata is available; absent or negative means 0.
86
+ Honored only with <code>slideshow_source</code>.</p>
87
+ </div><aside class="tsd-sources">
88
+ <ul>
89
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L121">src/types.ts:121</a></li></ul></aside></section>
90
+ <section class="tsd-panel tsd-member">
91
+ <h3 class="tsd-anchor-link" id="play"><code class="tsd-tag">Optional</code><span>play</span><a href="#play" 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>
92
+ <div class="tsd-signature"><span class="tsd-kind-property">play</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;auto&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;click&quot;</span></div>
93
+ <div class="tsd-comment tsd-typography"><p><code>auto</code> (default) plays on activation; <code>click</code> arms the media paused and
94
+ lets the visitor start it (slideshow <code>audio.play</code>). Absent means <code>auto</code>.
95
+ Honored only with <code>slideshow_source</code>.</p>
96
+ </div><aside class="tsd-sources">
97
+ <ul>
98
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L132">src/types.ts:132</a></li></ul></aside></section>
99
+ <section class="tsd-panel tsd-member">
100
+ <h3 class="tsd-anchor-link" id="stoponexit"><code class="tsd-tag">Optional</code><span>stop<wbr/>On<wbr/>Exit</span><a href="#stoponexit" 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>
101
+ <div class="tsd-signature"><span class="tsd-kind-property">stopOnExit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
102
+ <div class="tsd-comment tsd-typography"><p>Stop this media when leaving the slide (default true). <code>false</code> lets an
103
+ audio bed continue across slides (slideshow ambient audio). Honored
104
+ only with <code>slideshow_source</code>.</p>
105
+ </div><aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L138">src/types.ts:138</a></li></ul></aside></section>
69
108
  <section class="tsd-panel tsd-member">
70
109
  <h3 class="tsd-anchor-link" id="subtitles"><code class="tsd-tag">Optional</code><span>subtitles</span><a href="#subtitles" 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>
71
110
  <div class="tsd-signature"><span class="tsd-kind-property">subtitles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div>
@@ -75,17 +114,17 @@ storymap-JSON field; the authoring guide notes the
75
114
  <code>TextualBody</code> + <code>format: text/vtt</code> shape we also accept.</p>
76
115
  </div><aside class="tsd-sources">
77
116
  <ul>
78
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L58">src/types.ts:58</a></li></ul></aside></section>
117
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L115">src/types.ts:115</a></li></ul></aside></section>
79
118
  <section class="tsd-panel tsd-member">
80
119
  <h3 class="tsd-anchor-link" id="thumb"><code class="tsd-tag">Optional</code><span>thumb</span><a href="#thumb" 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>
81
120
  <div class="tsd-signature"><span class="tsd-kind-property">thumb</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
82
121
  <ul>
83
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L50">src/types.ts:50</a></li></ul></aside></section>
122
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L107">src/types.ts:107</a></li></ul></aside></section>
84
123
  <section class="tsd-panel tsd-member">
85
124
  <h3 class="tsd-anchor-link" id="url"><code class="tsd-tag">Optional</code><span>url</span><a href="#url" 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>
86
125
  <div class="tsd-signature"><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
87
126
  <ul>
88
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L41">src/types.ts:41</a></li></ul></aside></section></section></details></div>
127
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L98">src/types.ts:98</a></li></ul></aside></section></section></details></div>
89
128
  <div class="col-sidebar">
90
129
  <div class="page-menu">
91
130
  <div class="tsd-navigation settings">
@@ -102,7 +141,7 @@ storymap-JSON field; the authoring guide notes the
102
141
  <h3>On This Page</h3></summary>
103
142
  <div class="tsd-accordion-details">
104
143
  <details open class="tsd-accordion tsd-page-navigation-section"><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>Properties</summary>
105
- <div><a href="#alt"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alt</span></a><a href="#caption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption</span></a><a href="#credit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>credit</span></a><a href="#mediatype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mediatype</span></a><a href="#subtitles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subtitles</span></a><a href="#thumb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thumb</span></a><a href="#url"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</span></a></div></details></div></details></div>
144
+ <div><a href="#alt"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alt</span></a><a href="#caption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption</span></a><a href="#credit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>credit</span></a><a href="#loop"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>loop</span></a><a href="#mediatype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mediatype</span></a><a href="#offset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>offset</span></a><a href="#play"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>play</span></a><a href="#stoponexit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop<wbr/>On<wbr/>Exit</span></a><a href="#subtitles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subtitles</span></a><a href="#thumb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>thumb</span></a><a href="#url"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</span></a></div></details></div></details></div>
106
145
  <div class="site-menu">
107
146
  <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
108
147
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">