@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
@@ -11,19 +11,20 @@
11
11
  <li><a href="" aria-current="page">StorymapSlideNarration</a></li></ul>
12
12
  <h1>Interface StorymapSlideNarration</h1></div>
13
13
  <section class="tsd-panel tsd-comment">
14
- <div class="tsd-comment tsd-typography"><p>Public data and options types for constructing a StoryMap.</p>
15
- <p>The data types are exported rather than only referenced: they are what a host
16
- actually types its document and options with, and TypeDoc warns about a
17
- documented member whose type it cannot link.</p>
14
+ <div class="tsd-comment tsd-typography"><p>Optional spoken narration for one slide, played through a dedicated audio
15
+ element rather than the slide's media frame — a tour stop usually has a
16
+ picture and a recording, not one media item. In a IIIF manifest this is a
17
+ <code>motivation: &quot;supplementing&quot;</code> Sound/Video body, read and written alongside
18
+ the painting annotation.</p>
18
19
  </div></section>
19
- <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideNarration</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><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
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideNarration</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="#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="#stopallprevious">stopAllPrevious</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="#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="#url">url</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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
21
  <section class="tsd-panel">
21
22
  <h4 class="tsd-before-signature">Indexable</h4>
22
23
  <ul class="tsd-signatures">
23
24
  <li class="tsd-index-signature">
24
25
  <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
26
  <ul>
26
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L92">src/types.ts:92</a></li></ul></aside>
27
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L171">src/types.ts:171</a></li></ul></aside>
27
28
  <section class="tsd-panel-group tsd-index-group">
28
29
  <section class="tsd-panel tsd-index-panel">
29
30
  <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,16 +32,67 @@ documented member whose type it cannot link.</p>
31
32
  <div class="tsd-accordion-details">
32
33
  <section class="tsd-index-section">
33
34
  <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="#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>
35
+ <div class="tsd-index-list"><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>
36
+ <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>
37
+ <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>
38
+ <a href="#stopallprevious" 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/>All<wbr/>Previous?</span></a>
39
+ <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>
40
+ <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>
35
41
  </div></section></div></details></section></section>
36
42
  <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>
37
43
  <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>
38
44
  <section>
39
45
  <section class="tsd-panel tsd-member">
46
+ <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>
47
+ <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>
48
+ <div class="tsd-comment tsd-typography"><p>Loop the narration (slideshow <code>audio.loop</code>). Absent means no loop.
49
+ Note: a looping narration never fires <code>ended</code>, so <code>autoplay_media</code>
50
+ falls back to its millisecond timer for that slide. Honored only with
51
+ <code>slideshow_source</code>.</p>
52
+ </div><aside class="tsd-sources">
53
+ <ul>
54
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L179">src/types.ts:179</a></li></ul></aside></section>
55
+ <section class="tsd-panel tsd-member">
56
+ <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>
57
+ <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>
58
+ <div class="tsd-comment tsd-typography"><p>Start offset in seconds (slideshow <code>audio.offset</code>), applied once the
59
+ audio metadata is available. Absent or negative means 0. Honored only
60
+ with <code>slideshow_source</code>.</p>
61
+ </div><aside class="tsd-sources">
62
+ <ul>
63
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L185">src/types.ts:185</a></li></ul></aside></section>
64
+ <section class="tsd-panel tsd-member">
65
+ <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>
66
+ <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>
67
+ <div class="tsd-comment tsd-typography"><p><code>auto</code> (default) plays on navigation; <code>click</code> arms the narration
68
+ paused and lets the visitor start it (slideshow <code>audio.play</code>).
69
+ Honored only with <code>slideshow_source</code>.</p>
70
+ </div><aside class="tsd-sources">
71
+ <ul>
72
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L191">src/types.ts:191</a></li></ul></aside></section>
73
+ <section class="tsd-panel tsd-member">
74
+ <h3 class="tsd-anchor-link" id="stopallprevious"><code class="tsd-tag">Optional</code><span>stop<wbr/>All<wbr/>Previous</span><a href="#stopallprevious" 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>
75
+ <div class="tsd-signature"><span class="tsd-kind-property">stopAllPrevious</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
76
+ <div class="tsd-comment tsd-typography"><p>Stop any other playing narration/ambient track before starting this
77
+ one (default true). <code>false</code> allows the ambient overlap of two tracks.
78
+ Honored only with <code>slideshow_source</code>.</p>
79
+ </div><aside class="tsd-sources">
80
+ <ul>
81
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L203">src/types.ts:203</a></li></ul></aside></section>
82
+ <section class="tsd-panel tsd-member">
83
+ <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>
84
+ <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>
85
+ <div class="tsd-comment tsd-typography"><p>Stop the narration when leaving the slide (default true). <code>false</code>
86
+ keeps an audio bed playing across slides while the URL is unchanged
87
+ (slideshow ambient audio). Honored only with <code>slideshow_source</code>.</p>
88
+ </div><aside class="tsd-sources">
89
+ <ul>
90
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L197">src/types.ts:197</a></li></ul></aside></section>
91
+ <section class="tsd-panel tsd-member">
40
92
  <h3 class="tsd-anchor-link" id="url"><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>
41
93
  <div class="tsd-signature"><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
42
94
  <ul>
43
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L93">src/types.ts:93</a></li></ul></aside></section></section></details></div>
95
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L172">src/types.ts:172</a></li></ul></aside></section></section></details></div>
44
96
  <div class="col-sidebar">
45
97
  <div class="page-menu">
46
98
  <div class="tsd-navigation settings">
@@ -57,7 +109,7 @@ documented member whose type it cannot link.</p>
57
109
  <h3>On This Page</h3></summary>
58
110
  <div class="tsd-accordion-details">
59
111
  <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>
60
- <div><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>
112
+ <div><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="#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="#stopallprevious"><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/>All<wbr/>Previous</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="#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>
61
113
  <div class="site-menu">
62
114
  <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
63
115
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
@@ -18,7 +18,7 @@ documented member whose type it cannot link.</p>
18
18
  </div></section>
19
19
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlideText</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#headline">headline</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="#text">text</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="#text_align">text_align</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
20
20
  <ul>
21
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L8">src/types.ts:8</a></li></ul></aside>
21
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L8">src/types.ts:8</a></li></ul></aside>
22
22
  <section class="tsd-panel-group tsd-index-group">
23
23
  <section class="tsd-panel tsd-index-panel">
24
24
  <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>
@@ -37,17 +37,17 @@ documented member whose type it cannot link.</p>
37
37
  <h3 class="tsd-anchor-link" id="headline"><code class="tsd-tag">Optional</code><span>headline</span><a href="#headline" 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>
38
38
  <div class="tsd-signature"><span class="tsd-kind-property">headline</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
39
39
  <ul>
40
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L9">src/types.ts:9</a></li></ul></aside></section>
40
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L9">src/types.ts:9</a></li></ul></aside></section>
41
41
  <section class="tsd-panel tsd-member">
42
42
  <h3 class="tsd-anchor-link" id="text"><code class="tsd-tag">Optional</code><span>text</span><a href="#text" 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>
43
43
  <div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
44
44
  <ul>
45
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L10">src/types.ts:10</a></li></ul></aside></section>
45
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L10">src/types.ts:10</a></li></ul></aside></section>
46
46
  <section class="tsd-panel tsd-member">
47
47
  <h3 class="tsd-anchor-link" id="text_align"><code class="tsd-tag">Optional</code><span>text_<wbr/>align</span><a href="#text_align" 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>
48
48
  <div class="tsd-signature"><span class="tsd-kind-property">text_align</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
49
49
  <ul>
50
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L11">src/types.ts:11</a></li></ul></aside></section></section></details></div>
50
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L11">src/types.ts:11</a></li></ul></aside></section></section></details></div>
51
51
  <div class="col-sidebar">
52
52
  <div class="page-menu">
53
53
  <div class="tsd-navigation settings">
@@ -12,7 +12,7 @@
12
12
  <h1>Interface StorymapTilejson</h1></div>
13
13
  <section class="tsd-panel tsd-comment">
14
14
  <div class="tsd-comment tsd-typography"><p>TileJSON 2.1 tile source metadata, from a manifest's map configuration
15
- service (§2.9 of docs/plans/iiif-interop.md).</p>
15
+ service.</p>
16
16
  <p>This is how a manifest states a tile source: <code>tiles</code> is the URL template and
17
17
  the rest is the standard metadata around it, where a keyword basemap
18
18
  (<code>osm</code>, <code>stadia</code>, <code>iiif</code>, …) has no such thing to say. <code>minzoom</code>,
@@ -21,7 +21,7 @@ set the initial view.</p>
21
21
  </div></section>
22
22
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapTilejson</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#bounds">bounds</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="#center">center</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-symbol">;</span><br/>    <a class="tsd-kind-property" href="#maxzoom">maxzoom</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="#minzoom">minzoom</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="#scheme">scheme</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;xyz&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;tms&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#tiles">tiles</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">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
23
23
  <ul>
24
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L341">src/types.ts:341</a></li></ul></aside>
24
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L675">src/types.ts:675</a></li></ul></aside>
25
25
  <section class="tsd-panel-group tsd-index-group">
26
26
  <section class="tsd-panel tsd-index-panel">
27
27
  <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>
@@ -45,42 +45,42 @@ set the initial view.</p>
45
45
  <div class="tsd-comment tsd-typography"><p><code>[west, south, east, north]</code>, WGS84 lon/lat, of the covered area</p>
46
46
  </div><aside class="tsd-sources">
47
47
  <ul>
48
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L349">src/types.ts:349</a></li></ul></aside></section>
48
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L683">src/types.ts:683</a></li></ul></aside></section>
49
49
  <section class="tsd-panel tsd-member">
50
50
  <h3 class="tsd-anchor-link" id="center"><code class="tsd-tag">Optional</code><span>center</span><a href="#center" 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>
51
51
  <div class="tsd-signature"><span class="tsd-kind-property">center</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></div>
52
52
  <div class="tsd-comment tsd-typography"><p><code>[lon, lat, zoom]</code> of the map's default view</p>
53
53
  </div><aside class="tsd-sources">
54
54
  <ul>
55
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L353">src/types.ts:353</a></li></ul></aside></section>
55
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L687">src/types.ts:687</a></li></ul></aside></section>
56
56
  <section class="tsd-panel tsd-member">
57
57
  <h3 class="tsd-anchor-link" id="maxzoom"><code class="tsd-tag">Optional</code><span>maxzoom</span><a href="#maxzoom" 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>
58
58
  <div class="tsd-signature"><span class="tsd-kind-property">maxzoom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
59
59
  <div class="tsd-comment tsd-typography"><p>Highest zoom level the source has tiles for</p>
60
60
  </div><aside class="tsd-sources">
61
61
  <ul>
62
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L347">src/types.ts:347</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L681">src/types.ts:681</a></li></ul></aside></section>
63
63
  <section class="tsd-panel tsd-member">
64
64
  <h3 class="tsd-anchor-link" id="minzoom"><code class="tsd-tag">Optional</code><span>minzoom</span><a href="#minzoom" 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>
65
65
  <div class="tsd-signature"><span class="tsd-kind-property">minzoom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
66
66
  <div class="tsd-comment tsd-typography"><p>Lowest zoom level the source has tiles for</p>
67
67
  </div><aside class="tsd-sources">
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L345">src/types.ts:345</a></li></ul></aside></section>
69
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L679">src/types.ts:679</a></li></ul></aside></section>
70
70
  <section class="tsd-panel tsd-member">
71
71
  <h3 class="tsd-anchor-link" id="scheme"><code class="tsd-tag">Optional</code><span>scheme</span><a href="#scheme" 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>
72
72
  <div class="tsd-signature"><span class="tsd-kind-property">scheme</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;xyz&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;tms&quot;</span></div>
73
73
  <div class="tsd-comment tsd-typography"><p><code>xyz</code> (default) or <code>tms</code>, which flips the tile row order</p>
74
74
  </div><aside class="tsd-sources">
75
75
  <ul>
76
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L351">src/types.ts:351</a></li></ul></aside></section>
76
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L685">src/types.ts:685</a></li></ul></aside></section>
77
77
  <section class="tsd-panel tsd-member">
78
78
  <h3 class="tsd-anchor-link" id="tiles"><span>tiles</span><a href="#tiles" 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
79
  <div class="tsd-signature"><span class="tsd-kind-property">tiles</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">string</span><span class="tsd-signature-symbol">[]</span></div>
80
80
  <div class="tsd-comment tsd-typography"><p>URL template, e.g. <code>https://tiles.example.org/{z}/{x}/{y}.png</code></p>
81
81
  </div><aside class="tsd-sources">
82
82
  <ul>
83
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/62f871ee8c2189324f8b92fd4a1c0c138e04de77/src/types.ts#L343">src/types.ts:343</a></li></ul></aside></section></section></details></div>
83
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L677">src/types.ts:677</a></li></ul></aside></section></section></details></div>
84
84
  <div class="col-sidebar">
85
85
  <div class="page-menu">
86
86
  <div class="tsd-navigation settings">
@@ -0,0 +1,102 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SwipableEvents | StoryMapJS API</title><meta name="description" content="Documentation for StoryMapJS API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.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></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">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">StoryMapJS API</a>
3
+ <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"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <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>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">SwipableEvents</a></li></ul>
12
+ <h1>Interface SwipableEvents</h1></div>
13
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">SwipableEvents</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#dragend">dragend</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#dragmove">dragmove</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#dragstart">dragstart</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#momentum">momentum</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#swipe_down">swipe_down</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#swipe_left">swipe_left</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#swipe_nodirection">swipe_nodirection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#swipe_right">swipe_right</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#swipe_up">swipe_up</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
14
+ <ul>
15
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L67">src/ui/Swipable.ts:67</a></li></ul></aside>
16
+ <section class="tsd-panel-group tsd-index-group">
17
+ <section class="tsd-panel tsd-index-panel">
18
+ <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>
19
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
20
+ <div class="tsd-accordion-details">
21
+ <section class="tsd-index-section">
22
+ <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>
23
+ <div class="tsd-index-list"><a href="#dragend" 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>dragend</span></a>
24
+ <a href="#dragmove" 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>dragmove</span></a>
25
+ <a href="#dragstart" 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>dragstart</span></a>
26
+ <a href="#momentum" 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>momentum</span></a>
27
+ <a href="#swipe_down" 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>swipe_<wbr/>down</span></a>
28
+ <a href="#swipe_left" 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>swipe_<wbr/>left</span></a>
29
+ <a href="#swipe_nodirection" 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>swipe_<wbr/>nodirection</span></a>
30
+ <a href="#swipe_right" 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>swipe_<wbr/>right</span></a>
31
+ <a href="#swipe_up" 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>swipe_<wbr/>up</span></a>
32
+ </div></section></div></details></section></section>
33
+ <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>
34
+ <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>
35
+ <section>
36
+ <section class="tsd-panel tsd-member">
37
+ <h3 class="tsd-anchor-link" id="dragend"><span>dragend</span><a href="#dragend" 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>
38
+ <div class="tsd-signature"><span class="tsd-kind-property">dragend</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
39
+ <ul>
40
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L69">src/ui/Swipable.ts:69</a></li></ul></aside></section>
41
+ <section class="tsd-panel tsd-member">
42
+ <h3 class="tsd-anchor-link" id="dragmove"><span>dragmove</span><a href="#dragmove" 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>
43
+ <div class="tsd-signature"><span class="tsd-kind-property">dragmove</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
44
+ <ul>
45
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L70">src/ui/Swipable.ts:70</a></li></ul></aside></section>
46
+ <section class="tsd-panel tsd-member">
47
+ <h3 class="tsd-anchor-link" id="dragstart"><span>dragstart</span><a href="#dragstart" 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>
48
+ <div class="tsd-signature"><span class="tsd-kind-property">dragstart</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
49
+ <ul>
50
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L68">src/ui/Swipable.ts:68</a></li></ul></aside></section>
51
+ <section class="tsd-panel tsd-member">
52
+ <h3 class="tsd-anchor-link" id="momentum"><span>momentum</span><a href="#momentum" 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">momentum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
54
+ <ul>
55
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L71">src/ui/Swipable.ts:71</a></li></ul></aside></section>
56
+ <section class="tsd-panel tsd-member">
57
+ <h3 class="tsd-anchor-link" id="swipe_down"><span>swipe_<wbr/>down</span><a href="#swipe_down" 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>
58
+ <div class="tsd-signature"><span class="tsd-kind-property">swipe_down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
59
+ <ul>
60
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L75">src/ui/Swipable.ts:75</a></li></ul></aside></section>
61
+ <section class="tsd-panel tsd-member">
62
+ <h3 class="tsd-anchor-link" id="swipe_left"><span>swipe_<wbr/>left</span><a href="#swipe_left" 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">swipe_left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
64
+ <ul>
65
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L72">src/ui/Swipable.ts:72</a></li></ul></aside></section>
66
+ <section class="tsd-panel tsd-member">
67
+ <h3 class="tsd-anchor-link" id="swipe_nodirection"><span>swipe_<wbr/>nodirection</span><a href="#swipe_nodirection" 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>
68
+ <div class="tsd-signature"><span class="tsd-kind-property">swipe_nodirection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
69
+ <ul>
70
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L76">src/ui/Swipable.ts:76</a></li></ul></aside></section>
71
+ <section class="tsd-panel tsd-member">
72
+ <h3 class="tsd-anchor-link" id="swipe_right"><span>swipe_<wbr/>right</span><a href="#swipe_right" 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>
73
+ <div class="tsd-signature"><span class="tsd-kind-property">swipe_right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
74
+ <ul>
75
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L73">src/ui/Swipable.ts:73</a></li></ul></aside></section>
76
+ <section class="tsd-panel tsd-member">
77
+ <h3 class="tsd-anchor-link" id="swipe_up"><span>swipe_<wbr/>up</span><a href="#swipe_up" 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
+ <div class="tsd-signature"><span class="tsd-kind-property">swipe_up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragData</span></div><aside class="tsd-sources">
79
+ <ul>
80
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/ui/Swipable.ts#L74">src/ui/Swipable.ts:74</a></li></ul></aside></section></section></details></div>
81
+ <div class="col-sidebar">
82
+ <div class="page-menu">
83
+ <div class="tsd-navigation settings">
84
+ <details class="tsd-accordion"><summary class="tsd-accordion-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>
85
+ <h3>Settings</h3></summary>
86
+ <div class="tsd-accordion-details">
87
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
88
+ <ul id="tsd-filter-options">
89
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
90
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
91
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
92
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
93
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-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>
94
+ <h3>On This Page</h3></summary>
95
+ <div class="tsd-accordion-details">
96
+ <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>
97
+ <div><a href="#dragend"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dragend</span></a><a href="#dragmove"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dragmove</span></a><a href="#dragstart"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dragstart</span></a><a href="#momentum"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>momentum</span></a><a href="#swipe_down"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>swipe_<wbr/>down</span></a><a href="#swipe_left"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>swipe_<wbr/>left</span></a><a href="#swipe_nodirection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>swipe_<wbr/>nodirection</span></a><a href="#swipe_right"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>swipe_<wbr/>right</span></a><a href="#swipe_up"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>swipe_<wbr/>up</span></a></div></details></div></details></div>
98
+ <div class="site-menu">
99
+ <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
100
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
101
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
102
+ <div class="overlay"></div></body></html>
@@ -0,0 +1,66 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TextEvents | StoryMapJS API</title><meta name="description" content="Documentation for StoryMapJS API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.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></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">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">StoryMapJS API</a>
3
+ <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"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <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>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">TextEvents</a></li></ul>
12
+ <h1>Interface TextEvents</h1></div>
13
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TextEvents</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#added">added</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TextData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#loaded">loaded</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TextData</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#removed">removed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TextData</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
14
+ <ul>
15
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/media/types/Text.ts#L21">src/media/types/Text.ts:21</a></li></ul></aside>
16
+ <section class="tsd-panel-group tsd-index-group">
17
+ <section class="tsd-panel tsd-index-panel">
18
+ <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>
19
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
20
+ <div class="tsd-accordion-details">
21
+ <section class="tsd-index-section">
22
+ <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>
23
+ <div class="tsd-index-list"><a href="#added" 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>added</span></a>
24
+ <a href="#loaded" 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>loaded</span></a>
25
+ <a href="#removed" 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>removed</span></a>
26
+ </div></section></div></details></section></section>
27
+ <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>
28
+ <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>
29
+ <section>
30
+ <section class="tsd-panel tsd-member">
31
+ <h3 class="tsd-anchor-link" id="added"><span>added</span><a href="#added" 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>
32
+ <div class="tsd-signature"><span class="tsd-kind-property">added</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TextData</span></div><aside class="tsd-sources">
33
+ <ul>
34
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/media/types/Text.ts#L23">src/media/types/Text.ts:23</a></li></ul></aside></section>
35
+ <section class="tsd-panel tsd-member">
36
+ <h3 class="tsd-anchor-link" id="loaded"><span>loaded</span><a href="#loaded" 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>
37
+ <div class="tsd-signature"><span class="tsd-kind-property">loaded</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TextData</span></div><aside class="tsd-sources">
38
+ <ul>
39
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/media/types/Text.ts#L22">src/media/types/Text.ts:22</a></li></ul></aside></section>
40
+ <section class="tsd-panel tsd-member">
41
+ <h3 class="tsd-anchor-link" id="removed"><span>removed</span><a href="#removed" 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>
42
+ <div class="tsd-signature"><span class="tsd-kind-property">removed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TextData</span></div><aside class="tsd-sources">
43
+ <ul>
44
+ <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/media/types/Text.ts#L24">src/media/types/Text.ts:24</a></li></ul></aside></section></section></details></div>
45
+ <div class="col-sidebar">
46
+ <div class="page-menu">
47
+ <div class="tsd-navigation settings">
48
+ <details class="tsd-accordion"><summary class="tsd-accordion-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>
49
+ <h3>Settings</h3></summary>
50
+ <div class="tsd-accordion-details">
51
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
52
+ <ul id="tsd-filter-options">
53
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
54
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
55
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
56
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
57
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-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>
58
+ <h3>On This Page</h3></summary>
59
+ <div class="tsd-accordion-details">
60
+ <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>
61
+ <div><a href="#added"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>added</span></a><a href="#loaded"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>loaded</span></a><a href="#removed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>removed</span></a></div></details></div></details></div>
62
+ <div class="site-menu">
63
+ <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
64
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
65
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
66
+ <div class="overlay"></div></body></html>
@@ -0,0 +1,66 @@
1
+ # Event reference
2
+
3
+ One table per emitter: the event name, its payload, when it fires, and who
4
+ can subscribe. This is the canonical list;
5
+ `docs/migration-from-knightlab.md` keeps only the migration differences.
6
+ payloads are also typed — see the `*Events` maps exported from
7
+ `src/main.ts` (e.g. `StoryMapEvents`), which make `storymap.on("change", …)`
8
+ a compile error and infer the handler parameter.
9
+
10
+ Every event object carries the payload fields plus the framework's own
11
+ `type` and `target`. `target` is always the object that fired — in
12
+ particular, a re-fired event's `target` is the re-firing viewer, not the
13
+ origin (a payload carrying its own `type`/`target` cannot displace them).
14
+
15
+ ## `StoryMap` — subscribe on the viewer
16
+
17
+ | Event | Payload | Fires when |
18
+ | ----------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
19
+ | `change` | `{ current_slide, current_id }` | any navigation completes (programmatic, slider, map, back-to-start); exactly once per navigation |
20
+ | `loaded` | the storymap data | slider and map both loaded (mapless stories skip the map gate) |
21
+ | `title` | `{ title }` | the story title resolves |
22
+ | `dataloaded` | _none_ | the storymap document is read, before layout |
23
+ | `fontLoaded` | `{ font }` | the font theme finishes loading — or fails to (a missing theme never blocks the story) |
24
+ | `transitionstart` / `transitionend` | `{ current_slide, duration }` / `{ current_slide }` | a slide glide starts / elapses (only the latest transition ever ends) |
25
+ | `error` | `{ message, source, conflict? }` | fetch/validation failure, or a second viewer claiming another locale (`conflict: true`) |
26
+ | `imageready` | `{ source, kind, layer }` (`kind`: `"iiif"` \| `"zoomify"` \| `"tiles"`; `layer` may be `null`) | an image source is actually attached — the only signal the imagery exists (`loaded` can fire earlier) |
27
+ | `annotationsloaded` | `{ stops, searchService, failed }` | `loadAnnotations()` appended external stops |
28
+ | `markerclick` | `{ marker_number, current_slide }` | a marker is clicked (`change` alone does not say _how_ the story moved) |
29
+ | `popupopen` / `popupclose` | `{ marker_number, current_slide }` | a marker card opens / closes (button, Escape, deactivation, dispose) |
30
+ | `basemapchange` | `{ map_type, previous }` | the layer switcher swapped the basemap |
31
+ | `overlaychange` | `{ index, visible }` | the layer switcher toggled an overlay |
32
+
33
+ ## `Map` (engine) — subscribe on `storymap._map`
34
+
35
+ `markerAdded` / `markerRemoved` fire **only here**, never on the viewer.
36
+ (`added` / `removed` from the `DomMixed` mixin exist on the engine too.)
37
+
38
+ | Event | Payload | Fires when |
39
+ | ------------------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------- |
40
+ | `change` | `{ current_marker }` | the engine navigated (consumed internally to drive `_navigate`) |
41
+ | `loaded` | the map data | the engine loaded (guarded against OL `loadend` repeats) |
42
+ | `markerAdded` / `markerRemoved` | the marker | marker created / destroyed |
43
+ | `markerclick` | `{ marker_number }` | a marker is clicked (consumed internally to navigate; re-fired on the viewer) |
44
+ | `popupopen` / `popupclose` | `{ marker_number }` | a marker card opens / closes (re-fired on the viewer) |
45
+ | `imageready` | `{ source, kind, layer }` | a source is usable (re-fired on the viewer; `layer` may be `null`) |
46
+ | `tilesallowed` | _none_ | deferred tile layers attached after a tile consent grant (engine-only, never re-fired on the viewer) |
47
+
48
+ ## Internal emitters
49
+
50
+ Consumed inside the viewer; a host generally observes their effects through
51
+ the `StoryMap` events above.
52
+
53
+ | Emitter | Events |
54
+ | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55
+ | `StorySlider` | `change {current_slide, uniqueid}`, `loaded`, `title {title}`, `colorchange`, `slideAdded`, `nav_next` / `nav_previous` / `nav_left` / `nav_right` (declared but never fired) |
56
+ | `Slide` | `background_change`, `call_to_action`, `loaded`, `added`, `removed` |
57
+ | `SlideNav` | `clicked`, `loaded`, `added`, `removed` |
58
+ | `Media` | `loaded`, `media_loaded`, `media_ended` (fired by media subclasses with a playable element — what `autoplay_media` waits for), `added`, `removed` |
59
+ | `Text` | `loaded`, `added`, `removed` |
60
+ | `MapMarker` | `markerclick`, `popupopen`, `popupclose` (all `{marker_number}`; consumed by the engine) |
61
+ | `MenuBar` | `overview`, `back_to_start`, `fullscreen`, `autoplay_toggle`, `progress_go {slide}` (consumed by the viewer to navigate), `collapse {y, collapsed}`, `basemapchange {map_type}`, `overlaychange {index, visible}` (the last two forwarded from the layer switcher and re-fired on the viewer) |
62
+ | `Message` | `clicked` (consumed by the slider), `loaded`, `added`, `removed` |
63
+ | `Swipable` | `dragstart`, `dragend`, `dragmove`, `momentum`, `swipe_left` / `swipe_right` / `swipe_up` / `swipe_down`, `swipe_nodirection` |
64
+
65
+ `loaded` / `added` / `removed` come from the `DomMixed` mixin (`onLoaded` /
66
+ `onAdd` / `onRemove`); some emitters provide them without ever firing them.