@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.
- package/CHANGELOG +81 -0
- package/README.md +129 -12
- package/dist/assets/{demo-DBpeF31K.js → demo-bWnOyfUw.js} +1 -1
- package/dist/assets/harness-C3JUv5Ii.js +1 -0
- package/dist/assets/{harness-multi-CYHgI0a9.js → harness-multi-XZNex3tb.js} +1 -1
- package/dist/assets/{harness-support-Do7sIp2j.js → harness-support-CjfZIVeb.js} +1 -1
- package/dist/assets/main-DQ32hWBM.js +17 -0
- package/dist/context.json +13 -2
- package/dist/css/storymap.css +1 -1
- package/dist/demo.html +3 -2
- package/dist/docs/api/assets/navigation.js +1 -1
- package/dist/docs/api/assets/search.js +1 -1
- package/dist/docs/api/classes/StoryMap.html +777 -269
- package/dist/docs/api/functions/MediaType.html +1 -1
- package/dist/docs/api/functions/isPresentation3Collection.html +1 -1
- package/dist/docs/api/functions/isPresentation3Manifest.html +1 -1
- package/dist/docs/api/functions/isSlideshowCollection.html +51 -0
- package/dist/docs/api/functions/loadCSS.html +1 -1
- package/dist/docs/api/functions/manifestToStorymapData.html +1 -1
- package/dist/docs/api/functions/setLanguage.html +1 -1
- package/dist/docs/api/functions/slideshowToStorymapData.html +51 -0
- package/dist/docs/api/functions/slideshowVersion.html +48 -0
- package/dist/docs/api/functions/storymapToManifest.html +1 -1
- package/dist/docs/api/functions/validateStorymap.html +1 -1
- package/dist/docs/api/functions/validateStorymapAndReport.html +1 -1
- package/dist/docs/api/index.html +115 -12
- package/dist/docs/api/interfaces/AnimationHandle.html +2 -2
- package/dist/docs/api/interfaces/ImagereadyPayload.html +4 -4
- package/dist/docs/api/interfaces/LanguageEntry.html +6 -6
- package/dist/docs/api/interfaces/LatLngLiteral.html +4 -4
- package/dist/docs/api/interfaces/LoadOptions.html +2 -2
- package/dist/docs/api/interfaces/MapEvents.html +116 -0
- package/dist/docs/api/interfaces/MapMarkerEvents.html +66 -0
- package/dist/docs/api/interfaces/MarkerEventPayload.html +57 -0
- package/dist/docs/api/interfaces/MediaEvents.html +78 -0
- package/dist/docs/api/interfaces/MenuBarEvents.html +114 -0
- package/dist/docs/api/interfaces/MessageEvents.html +72 -0
- package/dist/docs/api/interfaces/OlLayer.html +1 -1
- package/dist/docs/api/interfaces/OlMap.html +1 -1
- package/dist/docs/api/interfaces/OlSource.html +1 -1
- package/dist/docs/api/interfaces/OlTileLayer.html +1 -1
- package/dist/docs/api/interfaces/OlVectorLayer.html +1 -1
- package/dist/docs/api/interfaces/OlView.html +1 -1
- package/dist/docs/api/interfaces/SlideBackgroundState.html +66 -0
- package/dist/docs/api/interfaces/SlideEvents.html +78 -0
- package/dist/docs/api/interfaces/SlideNavEvents.html +72 -0
- package/dist/docs/api/interfaces/SlideshowPlayerSettings.html +182 -0
- package/dist/docs/api/interfaces/SlideshowToStorymapResult.html +60 -0
- package/dist/docs/api/interfaces/SlideshowTranslatorOptions.html +65 -0
- package/dist/docs/api/interfaces/SlideshowWarning.html +72 -0
- package/dist/docs/api/interfaces/StoryMapEvents.html +146 -0
- package/dist/docs/api/interfaces/StoryMapMarker.html +763 -0
- package/dist/docs/api/interfaces/StorySliderEvents.html +102 -0
- package/dist/docs/api/interfaces/StorymapBasemap.html +69 -0
- package/dist/docs/api/interfaces/StorymapData.html +12 -6
- package/dist/docs/api/interfaces/StorymapDataWrapper.html +2 -2
- package/dist/docs/api/interfaces/StorymapDocument.html +2 -2
- package/dist/docs/api/interfaces/StorymapError.html +3 -3
- package/dist/docs/api/interfaces/StorymapGeoreference.html +5 -5
- package/dist/docs/api/interfaces/StorymapGeoreferenceBody.html +4 -4
- package/dist/docs/api/interfaces/StorymapGroundControlPoint.html +4 -4
- package/dist/docs/api/interfaces/StorymapLanguageMap.html +2 -2
- package/dist/docs/api/interfaces/StorymapManifest.html +12 -12
- package/dist/docs/api/interfaces/StorymapManifestAnnotation.html +43 -11
- package/dist/docs/api/interfaces/StorymapManifestBackground.html +6 -6
- package/dist/docs/api/interfaces/StorymapManifestCanvas.html +65 -17
- package/dist/docs/api/interfaces/StorymapManifestContentResource.html +8 -8
- package/dist/docs/api/interfaces/StorymapManifestFeatureCollection.html +4 -4
- package/dist/docs/api/interfaces/StorymapManifestGeoreferencing.html +7 -7
- package/dist/docs/api/interfaces/StorymapManifestImageService.html +4 -4
- package/dist/docs/api/interfaces/StorymapManifestRange.html +5 -5
- package/dist/docs/api/interfaces/StorymapManifestService.html +4 -4
- package/dist/docs/api/interfaces/StorymapManifestSpecificResource.html +4 -4
- package/dist/docs/api/interfaces/StorymapManifestStatement.html +3 -3
- package/dist/docs/api/interfaces/StorymapMapOptions.html +5 -5
- package/dist/docs/api/interfaces/StorymapOptions.html +277 -75
- package/dist/docs/api/interfaces/StorymapOverlayLayer.html +42 -11
- package/dist/docs/api/interfaces/StorymapSlide.html +70 -16
- package/dist/docs/api/interfaces/StorymapSlideBackground.html +4 -4
- package/dist/docs/api/interfaces/StorymapSlideLocation.html +58 -14
- package/dist/docs/api/interfaces/StorymapSlideMarker.html +8 -9
- package/dist/docs/api/interfaces/StorymapSlideMedia.html +49 -10
- package/dist/docs/api/interfaces/StorymapSlideNarration.html +61 -9
- package/dist/docs/api/interfaces/StorymapSlideText.html +4 -4
- package/dist/docs/api/interfaces/StorymapTilejson.html +8 -8
- package/dist/docs/api/interfaces/SwipableEvents.html +102 -0
- package/dist/docs/api/interfaces/TextEvents.html +66 -0
- package/dist/docs/api/media/events.md +66 -0
- package/dist/docs/api/media/migration-from-knightlab.md +89 -49
- package/dist/docs/api/media/slideshow.md +109 -0
- package/dist/docs/api/media/storymap-as-iiif-manifest.md +1007 -0
- package/dist/docs/api/modules.html +6 -6
- package/dist/docs/api/types/ContentState.html +3 -3
- package/dist/docs/api/types/FiredEvent.html +43 -0
- package/dist/docs/api/types/ImagereadyKind.html +1 -1
- package/dist/docs/api/types/MediaTypeMatch.html +5 -5
- package/dist/docs/api/types/SwipeDirection.html +36 -0
- package/dist/docs/api/types/TileSourceFactory.html +1 -1
- package/dist/docs/authoring.html +20 -7
- package/dist/docs/events.html +263 -0
- package/dist/docs/iiif.html +136 -22
- package/dist/docs/migration.html +66 -19
- package/dist/docs/readme.html +113 -12
- package/dist/embed/index.html +7 -0
- package/dist/examples/font-css-false.json +33 -0
- package/dist/examples/issue-image-region.json +1 -1
- package/dist/examples/layers-control.json +60 -0
- package/dist/examples/map-template-provider.json +36 -0
- package/dist/examples/multi-media.json +71 -0
- package/dist/examples-iiif/annotated-image.json +16 -0
- package/dist/examples-iiif/font-css-false.json +114 -0
- package/dist/examples-iiif/issue-image-region.json +1 -1
- package/dist/examples-iiif/layers-control.json +226 -0
- package/dist/examples-iiif/map-template-provider.json +133 -0
- package/dist/examples-iiif/multi-media.json +237 -0
- package/dist/examples-slideshow/single.json +79 -0
- package/dist/examples-slideshow/static/pixel.png +0 -0
- package/dist/examples-slideshow/static.json +44 -0
- package/dist/harness-multi.html +3 -3
- package/dist/harness.html +4 -3
- package/dist/index.html +3 -2
- package/dist/js/storymap.d.ts +1326 -289
- package/dist/js/storymap.js +6690 -4784
- package/dist/js/storymap.js.map +1 -1
- package/dist/navplace-properties.json +14 -0
- package/dist/site.css +54 -36
- package/docs/migration-from-knightlab.md +89 -49
- package/docs/storymap-as-iiif-manifest.md +199 -126
- package/package.json +4 -2
- package/schema/storymap.schema.json +334 -34
- package/src/core/Util.ts +3 -1
- package/src/core/mixins.ts +42 -28
- package/src/language/Language.ts +7 -0
- package/src/language/locale/.expected-gaps.json +287 -27
- package/src/language/locale/de.json +11 -1
- package/src/language/locale/en.json +11 -1
- package/src/main.ts +51 -0
- package/src/map/Map.ts +44 -6
- package/src/map/MapMarker.ts +16 -3
- package/src/map/openlayers/Map.OpenLayers.ts +787 -62
- package/src/map/openlayers/MapMarker.OpenLayers.ts +113 -13
- package/src/map/slideView.ts +149 -0
- package/src/map/types.ts +2 -0
- package/src/media/EmbedUtil.ts +27 -2
- package/src/media/Media.ts +27 -4
- package/src/media/embedId.ts +6 -0
- package/src/media/types/Flickr.ts +14 -3
- package/src/media/types/HtmlMedia.ts +66 -0
- package/src/media/types/Image.ts +15 -3
- package/src/media/types/SoundCloud.ts +1 -1
- package/src/media/types/Text.ts +27 -8
- package/src/media/types/Twitter.ts +9 -7
- package/src/media/types/Vimeo.ts +1 -1
- package/src/media/types/YouTube.ts +2 -2
- package/src/scss/Typography.scss +15 -15
- package/src/scss/VCO.StoryMap.scss +173 -8
- package/src/scss/core/Reset.scss +5 -18
- package/src/scss/map/VCO.Map.scss +1 -1
- package/src/scss/map/VCO.MapMarker.scss +20 -9
- package/src/scss/map/openlayers/VCO.Map.OpenLayers.scss +7 -4
- package/src/scss/media/VCO.Media.scss +7 -7
- package/src/scss/media/types/VCO.Media.Blockquote.scss +1 -1
- package/src/scss/media/types/VCO.Media.Text.scss +5 -5
- package/src/scss/media/types/VCO.Media.Twitter.scss +4 -4
- package/src/scss/media/types/VCO.Media.Wikipedia.scss +2 -19
- package/src/scss/site/site.scss +55 -36
- package/src/scss/slider/VCO.Slide.scss +49 -11
- package/src/scss/slider/VCO.SlideNav.scss +23 -7
- package/src/scss/slider/VCO.StorySlider.scss +50 -0
- package/src/scss/snapmap/VCO.SnapMap.scss +3 -3
- package/src/scss/ui/VCO.Consent.scss +20 -14
- package/src/scss/ui/VCO.Layers.scss +119 -0
- package/src/scss/ui/VCO.MenuBar.Button.scss +140 -19
- package/src/scss/ui/VCO.MenuBar.scss +9 -2
- package/src/scss/ui/VCO.Message.scss +14 -0
- package/src/slider/Slide.ts +232 -74
- package/src/slider/SlideNav.ts +15 -4
- package/src/slider/StorySlider.ts +203 -22
- package/src/storymap/Consent.ts +22 -0
- package/src/storymap/StoryMap.ts +944 -131
- package/src/storymap/content-state.ts +3 -8
- package/src/storymap/font-css.ts +72 -0
- package/src/storymap/from-slideshow.ts +785 -0
- package/src/storymap/iiif-shared.ts +228 -0
- package/src/storymap/iiif.ts +289 -100
- package/src/storymap/to-iiif.ts +131 -44
- package/src/types.ts +382 -17
- package/src/ui/LayersControl.ts +302 -0
- package/src/ui/MenuBar.ts +232 -21
- package/src/ui/Message.ts +36 -3
- package/src/ui/Swipable.ts +25 -7
- package/dist/assets/harness-Cr0rYpvt.js +0 -1
- package/dist/assets/main-DXalctuR.js +0 -17
- package/src/scss/VCO.StoryMap.Dark.scss +0 -150
- package/src/scss/Variables.Dark.scss +0 -57
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
Presentation is declarative: hosts no longer need to reach into the
|
|
16
16
|
layer objects for blend modes, clips or stacking tweaks.</p>
|
|
17
17
|
</div></section>
|
|
18
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapOverlayLayer</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#attribution">attribution</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="#blendmode">blendMode</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="#classname">className</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="#extent">extent</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="#georeference">georeference</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapGeoreference.html" class="tsd-signature-type tsd-kind-interface">StorymapGeoreference</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#map_type">map_type</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="#opacity">opacity</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="#visible">visible</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapOverlayLayer</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#attribution">attribution</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="#blendmode">blendMode</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="#classname">className</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="#control">control</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="#extent">extent</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="#georeference">georeference</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapGeoreference.html" class="tsd-signature-type tsd-kind-interface">StorymapGeoreference</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#label">label</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span>)<span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#locked">locked</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="#map_type">map_type</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="#opacity">opacity</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="#visible">visible</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
20
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L709">src/types.ts:709</a></li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
23
|
<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>
|
|
@@ -28,8 +28,11 @@ layer objects for blend modes, clips or stacking tweaks.</p>
|
|
|
28
28
|
<div class="tsd-index-list"><a href="#attribution" 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>attribution?</span></a>
|
|
29
29
|
<a href="#blendmode" 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>blend<wbr/>Mode?</span></a>
|
|
30
30
|
<a href="#classname" 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>class<wbr/>Name?</span></a>
|
|
31
|
+
<a href="#control" 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>control?</span></a>
|
|
31
32
|
<a href="#extent" 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>extent?</span></a>
|
|
32
33
|
<a href="#georeference" 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>georeference?</span></a>
|
|
34
|
+
<a href="#label" 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>label?</span></a>
|
|
35
|
+
<a href="#locked" 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>locked?</span></a>
|
|
33
36
|
<a href="#map_type" 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>map_<wbr/>type?</span></a>
|
|
34
37
|
<a href="#opacity" 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>opacity?</span></a>
|
|
35
38
|
<a href="#visible" 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>visible?</span></a>
|
|
@@ -43,14 +46,14 @@ layer objects for blend modes, clips or stacking tweaks.</p>
|
|
|
43
46
|
<div class="tsd-comment tsd-typography"><p>Extra attribution fragment, listed while the overlay is visible</p>
|
|
44
47
|
</div><aside class="tsd-sources">
|
|
45
48
|
<ul>
|
|
46
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
49
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L721">src/types.ts:721</a></li></ul></aside></section>
|
|
47
50
|
<section class="tsd-panel tsd-member">
|
|
48
51
|
<h3 class="tsd-anchor-link" id="blendmode"><code class="tsd-tag">Optional</code><span>blend<wbr/>Mode</span><a href="#blendmode" 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
52
|
<div class="tsd-signature"><span class="tsd-kind-property">blendMode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
50
53
|
<div class="tsd-comment tsd-typography"><p>CSS mix-blend-mode for the layer container (needs className)</p>
|
|
51
54
|
</div><aside class="tsd-sources">
|
|
52
55
|
<ul>
|
|
53
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
56
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L731">src/types.ts:731</a></li></ul></aside></section>
|
|
54
57
|
<section class="tsd-panel tsd-member">
|
|
55
58
|
<h3 class="tsd-anchor-link" id="classname"><code class="tsd-tag">Optional</code><span>class<wbr/>Name</span><a href="#classname" 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
59
|
<div class="tsd-signature"><span class="tsd-kind-property">className</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
@@ -61,14 +64,21 @@ replaces the default wholesale, so keep the <code>ol-layer</code> token
|
|
|
61
64
|
(e.g. <code>"ol-layer historic-sheet"</code>) unless you know why not.</p>
|
|
62
65
|
</div><aside class="tsd-sources">
|
|
63
66
|
<ul>
|
|
64
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
67
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L729">src/types.ts:729</a></li></ul></aside></section>
|
|
68
|
+
<section class="tsd-panel tsd-member">
|
|
69
|
+
<h3 class="tsd-anchor-link" id="control"><code class="tsd-tag">Optional</code><span>control</span><a href="#control" 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">control</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
71
|
+
<div class="tsd-comment tsd-typography"><p>false hides the row from the control without removing the overlay.</p>
|
|
72
|
+
</div><aside class="tsd-sources">
|
|
73
|
+
<ul>
|
|
74
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L748">src/types.ts:748</a></li></ul></aside></section>
|
|
65
75
|
<section class="tsd-panel tsd-member">
|
|
66
76
|
<h3 class="tsd-anchor-link" id="extent"><code class="tsd-tag">Optional</code><span>extent</span><a href="#extent" 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>
|
|
67
77
|
<div class="tsd-signature"><span class="tsd-kind-property">extent</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>
|
|
68
78
|
<div class="tsd-comment tsd-typography"><p>Clip box <code>[west, south, east, north]</code> in lon/lat (mercator maps)</p>
|
|
69
79
|
</div><aside class="tsd-sources">
|
|
70
80
|
<ul>
|
|
71
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
81
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L750">src/types.ts:750</a></li></ul></aside></section>
|
|
72
82
|
<section class="tsd-panel tsd-member">
|
|
73
83
|
<h3 class="tsd-anchor-link" id="georeference"><code class="tsd-tag">Optional</code><span>georeference</span><a href="#georeference" 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
84
|
<div class="tsd-signature"><span class="tsd-kind-property">georeference</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapGeoreference.html" class="tsd-signature-type tsd-kind-interface">StorymapGeoreference</a></div>
|
|
@@ -78,7 +88,28 @@ the geographic map, so this is the manifest-side equivalent of a
|
|
|
78
88
|
georeferenced raster overlay.</p>
|
|
79
89
|
</div><aside class="tsd-sources">
|
|
80
90
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
91
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L757">src/types.ts:757</a></li></ul></aside></section>
|
|
92
|
+
<section class="tsd-panel tsd-member">
|
|
93
|
+
<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>
|
|
94
|
+
<div class="tsd-signature"><span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span>)</div>
|
|
95
|
+
<div class="tsd-comment tsd-typography"><p>Control row label for the layer switcher (<code>show_layers_control</code>).
|
|
96
|
+
Defaults to <code>map_type</code>. A function is re-invoked on every
|
|
97
|
+
<code>refreshLabels()</code> for host i18n — but only when the entry comes from
|
|
98
|
+
constructor options: <code>mergeData()</code> overwrites option keys with the
|
|
99
|
+
storymap JSON, so a document carrying <code>overlays</code> replaces function
|
|
100
|
+
labels with its own strings.</p>
|
|
101
|
+
</div><aside class="tsd-sources">
|
|
102
|
+
<ul>
|
|
103
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L740">src/types.ts:740</a></li></ul></aside></section>
|
|
104
|
+
<section class="tsd-panel tsd-member">
|
|
105
|
+
<h3 class="tsd-anchor-link" id="locked"><code class="tsd-tag">Optional</code><span>locked</span><a href="#locked" 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>
|
|
106
|
+
<div class="tsd-signature"><span class="tsd-kind-property">locked</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
107
|
+
<div class="tsd-comment tsd-typography"><p>Render the row checked and disabled: an overlay the visitor may add
|
|
108
|
+
back but not remove (e.g. a georeferenced scan the story is built on).
|
|
109
|
+
The control never toggles a locked entry.</p>
|
|
110
|
+
</div><aside class="tsd-sources">
|
|
111
|
+
<ul>
|
|
112
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L746">src/types.ts:746</a></li></ul></aside></section>
|
|
82
113
|
<section class="tsd-panel tsd-member">
|
|
83
114
|
<h3 class="tsd-anchor-link" id="map_type"><code class="tsd-tag">Optional</code><span>map_<wbr/>type</span><a href="#map_type" 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
115
|
<div class="tsd-signature"><span class="tsd-kind-property">map_type</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
@@ -87,21 +118,21 @@ the entry carries a <code>georeference</code> (a placed IIIF image instead of
|
|
|
87
118
|
a tile source).</p>
|
|
88
119
|
</div><aside class="tsd-sources">
|
|
89
120
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L715">src/types.ts:715</a></li></ul></aside></section>
|
|
91
122
|
<section class="tsd-panel tsd-member">
|
|
92
123
|
<h3 class="tsd-anchor-link" id="opacity"><code class="tsd-tag">Optional</code><span>opacity</span><a href="#opacity" 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
124
|
<div class="tsd-signature"><span class="tsd-kind-property">opacity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
94
125
|
<div class="tsd-comment tsd-typography"><p>Layer opacity 0..1 (default 1)</p>
|
|
95
126
|
</div><aside class="tsd-sources">
|
|
96
127
|
<ul>
|
|
97
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
128
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L717">src/types.ts:717</a></li></ul></aside></section>
|
|
98
129
|
<section class="tsd-panel tsd-member">
|
|
99
130
|
<h3 class="tsd-anchor-link" id="visible"><code class="tsd-tag">Optional</code><span>visible</span><a href="#visible" 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>
|
|
100
131
|
<div class="tsd-signature"><span class="tsd-kind-property">visible</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
101
132
|
<div class="tsd-comment tsd-typography"><p>Initial visibility (default true)</p>
|
|
102
133
|
</div><aside class="tsd-sources">
|
|
103
134
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
135
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L719">src/types.ts:719</a></li></ul></aside></section></section></details></div>
|
|
105
136
|
<div class="col-sidebar">
|
|
106
137
|
<div class="page-menu">
|
|
107
138
|
<div class="tsd-navigation settings">
|
|
@@ -118,7 +149,7 @@ a tile source).</p>
|
|
|
118
149
|
<h3>On This Page</h3></summary>
|
|
119
150
|
<div class="tsd-accordion-details">
|
|
120
151
|
<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>
|
|
121
|
-
<div><a href="#attribution"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attribution</span></a><a href="#blendmode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>blend<wbr/>Mode</span></a><a href="#classname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>class<wbr/>Name</span></a><a href="#extent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extent</span></a><a href="#georeference"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>georeference</span></a><a href="#map_type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>map_<wbr/>type</span></a><a href="#opacity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity</span></a><a href="#visible"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible</span></a></div></details></div></details></div>
|
|
152
|
+
<div><a href="#attribution"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attribution</span></a><a href="#blendmode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>blend<wbr/>Mode</span></a><a href="#classname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>class<wbr/>Name</span></a><a href="#control"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control</span></a><a href="#extent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extent</span></a><a href="#georeference"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>georeference</span></a><a href="#label"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label</span></a><a href="#locked"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locked</span></a><a href="#map_type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>map_<wbr/>type</span></a><a href="#opacity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity</span></a><a href="#visible"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible</span></a></div></details></div></details></div>
|
|
122
153
|
<div class="site-menu">
|
|
123
154
|
<nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
|
|
124
155
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
@@ -16,14 +16,14 @@
|
|
|
16
16
|
<code>null</code> to mean "explicitly absent" and the viewer seeds its own defaults
|
|
17
17
|
with <code>null</code> before the data is merged in, so a plain <code>?</code> would not type.</p>
|
|
18
18
|
</div></section>
|
|
19
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StorymapSlide</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#background">background</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="StorymapSlideBackground.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideBackground</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="#date">date</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">Record</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> <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="#group">group</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="#language">language</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="#location">location</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideLocation.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideLocation</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="#marker">marker</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMarker.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMarker</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="#media">media</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMedia.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMedia</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="#narration">narration</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideNarration.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideNarration</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="#text">text</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideText.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideText</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="#type">type</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="#uniqueid">uniqueid</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">StorymapSlide</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#background">background</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="StorymapSlideBackground.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideBackground</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="#date">date</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">Record</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> <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="#group">group</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="#imgoverlay">imgoverlay</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapImageOverlay</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="#language">language</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="#location">location</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideLocation.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideLocation</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="#marker">marker</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMarker.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMarker</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="#media">media</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMedia.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMedia</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="#media_extra">media_extra</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMedia.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMedia</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#media_layout">media_layout</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"stack"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#narration">narration</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideNarration.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideNarration</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="#provenance">provenance</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapSlideProvenance</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="#slidetimeout">slidetimeout</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="#text">text</a><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideText.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideText</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="#type">type</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="#uniqueid">uniqueid</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/
|
|
26
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L220">src/types.ts:220</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,11 +34,16 @@ with <code>null</code> before the data is merged in, so a plain <code>?</code> w
|
|
|
34
34
|
<div class="tsd-index-list"><a href="#background" 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>background?</span></a>
|
|
35
35
|
<a href="#date" 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>date?</span></a>
|
|
36
36
|
<a href="#group" 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>group?</span></a>
|
|
37
|
+
<a href="#imgoverlay" 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>imgoverlay?</span></a>
|
|
37
38
|
<a href="#language" 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>language?</span></a>
|
|
38
39
|
<a href="#location" 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>location?</span></a>
|
|
39
40
|
<a href="#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>marker?</span></a>
|
|
40
41
|
<a href="#media" 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>media?</span></a>
|
|
42
|
+
<a href="#media_extra" 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>media_<wbr/>extra?</span></a>
|
|
43
|
+
<a href="#media_layout" 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>media_<wbr/>layout?</span></a>
|
|
41
44
|
<a href="#narration" 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>narration?</span></a>
|
|
45
|
+
<a href="#provenance" 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>provenance?</span></a>
|
|
46
|
+
<a href="#slidetimeout" 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>slidetimeout?</span></a>
|
|
42
47
|
<a href="#text" 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>text?</span></a>
|
|
43
48
|
<a href="#type" 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>type?</span></a>
|
|
44
49
|
<a href="#uniqueid" 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>uniqueid?</span></a>
|
|
@@ -50,64 +55,113 @@ with <code>null</code> before the data is merged in, so a plain <code>?</code> w
|
|
|
50
55
|
<h3 class="tsd-anchor-link" id="background"><code class="tsd-tag">Optional</code><span>background</span><a href="#background" 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
56
|
<div class="tsd-signature"><span class="tsd-kind-property">background</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="StorymapSlideBackground.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideBackground</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
52
57
|
<ul>
|
|
53
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
58
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L252">src/types.ts:252</a></li></ul></aside></section>
|
|
54
59
|
<section class="tsd-panel tsd-member">
|
|
55
60
|
<h3 class="tsd-anchor-link" id="date"><code class="tsd-tag">Optional</code><span>date</span><a href="#date" 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
61
|
<div class="tsd-signature"><span class="tsd-kind-property">date</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">Record</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> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
57
62
|
<ul>
|
|
58
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
63
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L222">src/types.ts:222</a></li></ul></aside></section>
|
|
59
64
|
<section class="tsd-panel tsd-member">
|
|
60
65
|
<h3 class="tsd-anchor-link" id="group"><code class="tsd-tag">Optional</code><span>group</span><a href="#group" 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
66
|
<div class="tsd-signature"><span class="tsd-kind-property">group</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
62
67
|
<ul>
|
|
63
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
68
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L223">src/types.ts:223</a></li></ul></aside></section>
|
|
69
|
+
<section class="tsd-panel tsd-member">
|
|
70
|
+
<h3 class="tsd-anchor-link" id="imgoverlay"><code class="tsd-tag">Optional</code><span>imgoverlay</span><a href="#imgoverlay" 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
|
+
<div class="tsd-signature"><span class="tsd-kind-property">imgoverlay</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapImageOverlay</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div>
|
|
72
|
+
<div class="tsd-comment tsd-typography"><p>Per-slide image overlay on the map (slideshow <code>imgoverlay</code>): a placed
|
|
73
|
+
image shown while this slide is active. Absent means no overlay.
|
|
74
|
+
Honored only with <code>slideshow_source</code>.</p>
|
|
75
|
+
</div><aside class="tsd-sources">
|
|
76
|
+
<ul>
|
|
77
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L273">src/types.ts:273</a></li></ul></aside></section>
|
|
64
78
|
<section class="tsd-panel tsd-member">
|
|
65
79
|
<h3 class="tsd-anchor-link" id="language"><code class="tsd-tag">Optional</code><span>language</span><a href="#language" 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
80
|
<div class="tsd-signature"><span class="tsd-kind-property">language</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
67
|
-
<div class="tsd-comment tsd-typography"><p>The language tag this slide's text was read in
|
|
68
|
-
docs/plans/iiif-interop.md). A IIIF manifest states its text as a
|
|
81
|
+
<div class="tsd-comment tsd-typography"><p>The language tag this slide's text was read in. A IIIF manifest states its text as a
|
|
69
82
|
language map; the reader picks the viewer's configured language and
|
|
70
83
|
reports which one it used, so a host can offer a language switch.
|
|
71
84
|
Absent for language-neutral (<code>none</code>) text, and for a single-language
|
|
72
85
|
storymap.</p>
|
|
73
86
|
</div><aside class="tsd-sources">
|
|
74
87
|
<ul>
|
|
75
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
88
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L231">src/types.ts:231</a></li></ul></aside></section>
|
|
76
89
|
<section class="tsd-panel tsd-member">
|
|
77
90
|
<h3 class="tsd-anchor-link" id="location"><code class="tsd-tag">Optional</code><span>location</span><a href="#location" 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
91
|
<div class="tsd-signature"><span class="tsd-kind-property">location</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideLocation.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideLocation</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
79
92
|
<ul>
|
|
80
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
93
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L232">src/types.ts:232</a></li></ul></aside></section>
|
|
81
94
|
<section class="tsd-panel tsd-member">
|
|
82
95
|
<h3 class="tsd-anchor-link" id="marker"><code class="tsd-tag">Optional</code><span>marker</span><a href="#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>
|
|
83
96
|
<div class="tsd-signature"><span class="tsd-kind-property">marker</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMarker.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMarker</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
84
97
|
<ul>
|
|
85
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
98
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L249">src/types.ts:249</a></li></ul></aside></section>
|
|
86
99
|
<section class="tsd-panel tsd-member">
|
|
87
100
|
<h3 class="tsd-anchor-link" id="media"><code class="tsd-tag">Optional</code><span>media</span><a href="#media" 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
101
|
<div class="tsd-signature"><span class="tsd-kind-property">media</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMedia.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMedia</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
89
102
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
103
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L233">src/types.ts:233</a></li></ul></aside></section>
|
|
104
|
+
<section class="tsd-panel tsd-member">
|
|
105
|
+
<h3 class="tsd-anchor-link" id="media_extra"><code class="tsd-tag">Optional</code><span>media_<wbr/>extra</span><a href="#media_extra" 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>
|
|
106
|
+
<div class="tsd-signature"><span class="tsd-kind-property">media_extra</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideMedia.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideMedia</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div>
|
|
107
|
+
<div class="tsd-comment tsd-typography"><p>Additional visible media for this slide (#358), rendered after <code>media</code>
|
|
108
|
+
in order. Items without a non-empty <code>url</code> are skipped, so a document
|
|
109
|
+
without this field renders identically. In a IIIF manifest these are
|
|
110
|
+
further <code>painting</code> annotations on the canvas; the slide layout
|
|
111
|
+
(<code>media_layout</code>) has no IIIF term and stays viewer-side.</p>
|
|
112
|
+
</div><aside class="tsd-sources">
|
|
113
|
+
<ul>
|
|
114
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L241">src/types.ts:241</a></li></ul></aside></section>
|
|
115
|
+
<section class="tsd-panel tsd-member">
|
|
116
|
+
<h3 class="tsd-anchor-link" id="media_layout"><code class="tsd-tag">Optional</code><span>media_<wbr/>layout</span><a href="#media_layout" 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>
|
|
117
|
+
<div class="tsd-signature"><span class="tsd-kind-property">media_layout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"stack"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row"</span></div>
|
|
118
|
+
<div class="tsd-comment tsd-typography"><p>Layout of a multi-media slide (#358): <code>stack</code> piles the items
|
|
119
|
+
vertically (the panel scrolls), <code>row</code> puts two items side by side.
|
|
120
|
+
Defaults to <code>stack</code>; <code>row</code> with anything but two items falls back to
|
|
121
|
+
<code>stack</code>. Ignored for a single media item.</p>
|
|
122
|
+
</div><aside class="tsd-sources">
|
|
123
|
+
<ul>
|
|
124
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L248">src/types.ts:248</a></li></ul></aside></section>
|
|
91
125
|
<section class="tsd-panel tsd-member">
|
|
92
126
|
<h3 class="tsd-anchor-link" id="narration"><code class="tsd-tag">Optional</code><span>narration</span><a href="#narration" 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
127
|
<div class="tsd-signature"><span class="tsd-kind-property">narration</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideNarration.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideNarration</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
94
128
|
<ul>
|
|
95
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
129
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L250">src/types.ts:250</a></li></ul></aside></section>
|
|
130
|
+
<section class="tsd-panel tsd-member">
|
|
131
|
+
<h3 class="tsd-anchor-link" id="provenance"><code class="tsd-tag">Optional</code><span>provenance</span><a href="#provenance" 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>
|
|
132
|
+
<div class="tsd-signature"><span class="tsd-kind-property">provenance</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StorymapSlideProvenance</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div>
|
|
133
|
+
<div class="tsd-comment tsd-typography"><p>Provenance identifiers for the slide's source (slideshow
|
|
134
|
+
<code>manifest_id</code>/<code>canvas_id</code>/<code>image_id</code>): which manifest, canvas and
|
|
135
|
+
image the stop was translated from. Data-only (deep links, export);
|
|
136
|
+
never rendered.</p>
|
|
137
|
+
</div><aside class="tsd-sources">
|
|
138
|
+
<ul>
|
|
139
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L260">src/types.ts:260</a></li></ul></aside></section>
|
|
140
|
+
<section class="tsd-panel tsd-member">
|
|
141
|
+
<h3 class="tsd-anchor-link" id="slidetimeout"><code class="tsd-tag">Optional</code><span>slidetimeout</span><a href="#slidetimeout" 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>
|
|
142
|
+
<div class="tsd-signature"><span class="tsd-kind-property">slidetimeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
143
|
+
<div class="tsd-comment tsd-typography"><p>Per-slide autoplay dwell in milliseconds (slideshow <code>slidetimeout</code>):
|
|
144
|
+
overrides the global <code>autoplay</code> interval for this slide; <code>0</code> holds on
|
|
145
|
+
this slide. Absent means the global interval. Honored only with
|
|
146
|
+
<code>slideshow_source</code>.</p>
|
|
147
|
+
</div><aside class="tsd-sources">
|
|
148
|
+
<ul>
|
|
149
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L267">src/types.ts:267</a></li></ul></aside></section>
|
|
96
150
|
<section class="tsd-panel tsd-member">
|
|
97
151
|
<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>
|
|
98
152
|
<div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <a href="StorymapSlideText.html" class="tsd-signature-type tsd-kind-interface">StorymapSlideText</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><aside class="tsd-sources">
|
|
99
153
|
<ul>
|
|
100
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
154
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L251">src/types.ts:251</a></li></ul></aside></section>
|
|
101
155
|
<section class="tsd-panel tsd-member">
|
|
102
156
|
<h3 class="tsd-anchor-link" id="type"><code class="tsd-tag">Optional</code><span>type</span><a href="#type" 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
157
|
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
104
158
|
<ul>
|
|
105
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
159
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L221">src/types.ts:221</a></li></ul></aside></section>
|
|
106
160
|
<section class="tsd-panel tsd-member">
|
|
107
161
|
<h3 class="tsd-anchor-link" id="uniqueid"><code class="tsd-tag">Optional</code><span>uniqueid</span><a href="#uniqueid" 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>
|
|
108
162
|
<div class="tsd-signature"><span class="tsd-kind-property">uniqueid</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">
|
|
109
163
|
<ul>
|
|
110
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
164
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L253">src/types.ts:253</a></li></ul></aside></section></section></details></div>
|
|
111
165
|
<div class="col-sidebar">
|
|
112
166
|
<div class="page-menu">
|
|
113
167
|
<div class="tsd-navigation settings">
|
|
@@ -124,7 +178,7 @@ storymap.</p>
|
|
|
124
178
|
<h3>On This Page</h3></summary>
|
|
125
179
|
<div class="tsd-accordion-details">
|
|
126
180
|
<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>
|
|
127
|
-
<div><a href="#background"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>background</span></a><a href="#date"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date</span></a><a href="#group"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group</span></a><a href="#language"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>language</span></a><a href="#location"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>location</span></a><a href="#marker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marker</span></a><a href="#media"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>media</span></a><a href="#narration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>narration</span></a><a href="#text"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uniqueid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uniqueid</span></a></div></details></div></details></div>
|
|
181
|
+
<div><a href="#background"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>background</span></a><a href="#date"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date</span></a><a href="#group"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group</span></a><a href="#imgoverlay"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>imgoverlay</span></a><a href="#language"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>language</span></a><a href="#location"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>location</span></a><a href="#marker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marker</span></a><a href="#media"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>media</span></a><a href="#media_extra"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>media_<wbr/>extra</span></a><a href="#media_layout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>media_<wbr/>layout</span></a><a href="#narration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>narration</span></a><a href="#provenance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provenance</span></a><a href="#slidetimeout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>slidetimeout</span></a><a href="#text"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#uniqueid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uniqueid</span></a></div></details></div></details></div>
|
|
128
182
|
<div class="site-menu">
|
|
129
183
|
<nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
|
|
130
184
|
<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">StorymapSlideBackground</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#color">color</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="#opacity">opacity</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="#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></div><aside class="tsd-sources">
|
|
20
20
|
<ul>
|
|
21
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
21
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L207">src/types.ts:207</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="color"><code class="tsd-tag">Optional</code><span>color</span><a href="#color" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
38
38
|
<div class="tsd-signature"><span class="tsd-kind-property">color</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">
|
|
39
39
|
<ul>
|
|
40
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
40
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L209">src/types.ts:209</a></li></ul></aside></section>
|
|
41
41
|
<section class="tsd-panel tsd-member">
|
|
42
42
|
<h3 class="tsd-anchor-link" id="opacity"><code class="tsd-tag">Optional</code><span>opacity</span><a href="#opacity" 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">opacity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
44
44
|
<ul>
|
|
45
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
45
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L210">src/types.ts:210</a></li></ul></aside></section>
|
|
46
46
|
<section class="tsd-panel tsd-member">
|
|
47
47
|
<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>
|
|
48
48
|
<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">
|
|
49
49
|
<ul>
|
|
50
|
-
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/
|
|
50
|
+
<li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/ffcd40cfccb804f667ff3b975dd61e8cf12bd289/src/types.ts#L208">src/types.ts:208</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">
|