@projektemacher/storymapjs 0.10.0 → 0.10.2

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 (36) hide show
  1. package/dist/assets/{demo-DYodj6d7.js → demo-rv3vz65J.js} +1 -1
  2. package/dist/assets/{harness-UkbbPmC4.js → harness-BnQbtq1l.js} +1 -1
  3. package/dist/assets/main-mUk_qlWN.js +17 -0
  4. package/dist/css/storymap.css +11 -2
  5. package/dist/demo.html +3 -3
  6. package/dist/examples/assets/custom-flag.svg +6 -0
  7. package/dist/examples/issue-405-custom-icon.json +63 -0
  8. package/dist/harness.html +3 -3
  9. package/dist/index.html +1 -1
  10. package/dist/js/storymap.d.ts +1431 -0
  11. package/dist/js/storymap.js +4171 -4356
  12. package/dist/js/storymap.js.map +1 -1
  13. package/package.json +15 -9
  14. package/dist/assets/main-BDSRsIiB.js +0 -17
  15. package/dist/assets/main-Bzm6THVj.css +0 -1
  16. package/dist/css/icons/vco-icons.eot +0 -0
  17. package/dist/css/icons/vco-icons.svg +0 -63
  18. package/dist/docs/api/.nojekyll +0 -1
  19. package/dist/docs/api/assets/custom.css +0 -47
  20. package/dist/docs/api/assets/hierarchy.js +0 -1
  21. package/dist/docs/api/assets/highlight.css +0 -22
  22. package/dist/docs/api/assets/icons.js +0 -18
  23. package/dist/docs/api/assets/icons.svg +0 -1
  24. package/dist/docs/api/assets/main.js +0 -60
  25. package/dist/docs/api/assets/navigation.js +0 -1
  26. package/dist/docs/api/assets/search.js +0 -1
  27. package/dist/docs/api/assets/style.css +0 -1648
  28. package/dist/docs/api/classes/StoryMap.html +0 -799
  29. package/dist/docs/api/functions/MediaType.html +0 -51
  30. package/dist/docs/api/functions/loadCSS.html +0 -64
  31. package/dist/docs/api/functions/setLanguage.html +0 -53
  32. package/dist/docs/api/functions/validateStorymap.html +0 -53
  33. package/dist/docs/api/functions/validateStorymapAndReport.html +0 -54
  34. package/dist/docs/api/hierarchy.html +0 -28
  35. package/dist/docs/api/index.html +0 -127
  36. package/dist/docs/api/modules.html +0 -42
package/dist/docs/api/functions/MediaType.html DELETED
@@ -1,51 +0,0 @@
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>MediaType | 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">MediaType</a></li></ul>
12
- <h1>Function MediaType</h1></div>
13
- <section class="tsd-panel tsd-comment">
14
- <div class="tsd-comment tsd-typography"><p>Resolve the media type (YouTube, Vimeo, image, ...) for a media URL.</p>
15
- </div></section>
16
- <section class="tsd-panel">
17
- <ul class="tsd-signatures">
18
- <li class="">
19
- <div class="tsd-signature tsd-anchor-link" id="mediatype"><span class="tsd-kind-call-signature">MediaType</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">m</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StorymapSlideMedia</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">MediaTypeMatch</span><a href="#mediatype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
20
- <div class="tsd-description">
21
- <div class="tsd-comment tsd-typography"><p>Resolve the media handler for a slide's media object: matches the URL (and
22
- optional explicit <code>type</code>) against the supported media types — YouTube,
23
- Vimeo, images, audio, video, ...</p>
24
- </div>
25
- <div class="tsd-parameters">
26
- <h4 class="tsd-parameters-title">Parameters</h4>
27
- <ul class="tsd-parameter-list">
28
- <li><span><span class="tsd-kind-parameter">m</span>: <span class="tsd-signature-type">StorymapSlideMedia</span></span>
29
- <div class="tsd-comment tsd-typography"><p>The slide media definition.</p>
30
- </div></li></ul></div>
31
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">false</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">MediaTypeMatch</span></h4><p>The matching media type entry, or <code>false</code> for unknown media.</p>
32
- <aside class="tsd-sources">
33
- <ul>
34
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/a101b177bf4cc3e6876dc5bb87bec6db43c39228/src/media/MediaType.ts#L47">media/MediaType.ts:47</a></li></ul></aside></div></li></ul></section></div>
35
- <div class="col-sidebar">
36
- <div class="page-menu">
37
- <div class="tsd-navigation settings">
38
- <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>
39
- <h3>Settings</h3></summary>
40
- <div class="tsd-accordion-details">
41
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
42
- <ul id="tsd-filter-options">
43
- <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>
44
- <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>
45
- <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>
46
- <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></div>
47
- <div class="site-menu">
48
- <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
49
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
50
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
51
- <div class="overlay"></div></body></html>
package/dist/docs/api/functions/loadCSS.html DELETED
@@ -1,64 +0,0 @@
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>loadCSS | 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">loadCSS</a></li></ul>
12
- <h1>Function loadCSS</h1></div>
13
- <section class="tsd-panel tsd-comment">
14
- <div class="tsd-comment tsd-typography"><p>Append a stylesheet <code>&lt;link&gt;</code> to the document head.</p>
15
- </div>
16
- <div class="tsd-comment tsd-typography">
17
- <div class="tsd-tag-param">
18
- <h4 class="tsd-anchor-link" id="param-href">Param: href<a href="#param-href" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The stylesheet URL.</p>
19
- </div>
20
- <div class="tsd-tag-param">
21
- <h4 class="tsd-anchor-link" id="param-callback">Param: callback<a href="#param-callback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Invoked once the stylesheet has loaded (or failed).</p>
22
- </div></div></section>
23
- <section class="tsd-panel">
24
- <ul class="tsd-signatures">
25
- <li class="">
26
- <div class="tsd-signature tsd-anchor-link" id="loadcss"><span class="tsd-kind-call-signature">loadCSS</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">urls</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><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</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">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">context</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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#loadcss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
27
- <div class="tsd-description">
28
- <div class="tsd-comment tsd-typography"><p>Append one or more stylesheets to the document head.</p>
29
- </div>
30
- <div class="tsd-parameters">
31
- <h4 class="tsd-parameters-title">Parameters</h4>
32
- <ul class="tsd-parameter-list">
33
- <li><span><span class="tsd-kind-parameter">urls</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>
34
- <div class="tsd-comment tsd-typography"><p>A stylesheet URL or a list of URLs.</p>
35
- </div></li>
36
- <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</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">=&gt;</span> <span class="tsd-signature-type">void</span></span>
37
- <div class="tsd-comment tsd-typography"><p>Invoked when the stylesheets have finished loading.</p>
38
- </div></li>
39
- <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type">unknown</span></span>
40
- <div class="tsd-comment tsd-typography"><p>Optional context object passed back to the callback.</p>
41
- </div></li>
42
- <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">unknown</span></span>
43
- <div class="tsd-comment tsd-typography"><p>Optional identifier carried through the loader.</p>
44
- </div></li></ul></div>
45
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
46
- <ul>
47
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/a101b177bf4cc3e6876dc5bb87bec6db43c39228/src/core/Load.ts#L271">core/Load.ts:271</a></li></ul></aside></div></li></ul></section></div>
48
- <div class="col-sidebar">
49
- <div class="page-menu">
50
- <div class="tsd-navigation settings">
51
- <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>
52
- <h3>Settings</h3></summary>
53
- <div class="tsd-accordion-details">
54
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
55
- <ul id="tsd-filter-options">
56
- <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>
57
- <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>
58
- <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>
59
- <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></div>
60
- <div class="site-menu">
61
- <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
62
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
63
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
64
- <div class="overlay"></div></body></html>
package/dist/docs/api/functions/setLanguage.html DELETED
@@ -1,53 +0,0 @@
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>setLanguage | 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">setLanguage</a></li></ul>
12
- <h1>Function setLanguage</h1></div>
13
- <section class="tsd-panel tsd-comment">
14
- <div class="tsd-comment tsd-typography"><p>Switch the UI language at runtime.</p>
15
- </div>
16
- <div class="tsd-comment tsd-typography">
17
- <div class="tsd-tag-param">
18
- <h4 class="tsd-anchor-link" id="param-language">Param: language<a href="#param-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></h4><p>Locale code matching a locale file (e.g. <code>&quot;en&quot;</code>, <code>&quot;es&quot;</code>).</p>
19
- </div></div></section>
20
- <section class="tsd-panel">
21
- <ul class="tsd-signatures">
22
- <li class="">
23
- <div class="tsd-signature tsd-anchor-link" id="setlanguage"><span class="tsd-kind-call-signature">setLanguage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LanguageEntry</span><a href="#setlanguage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
24
- <div class="tsd-description">
25
- <div class="tsd-comment tsd-typography"><p>Switch the active UI language.</p>
26
- </div>
27
- <div class="tsd-parameters">
28
- <h4 class="tsd-parameters-title">Parameters</h4>
29
- <ul class="tsd-parameter-list">
30
- <li><span><span class="tsd-kind-parameter">code</span>: <span class="tsd-signature-type">string</span></span>
31
- <div class="tsd-comment tsd-typography"><p>A locale code for which a locale file exists (e.g. <code>&quot;en&quot;</code>).</p>
32
- </div></li></ul></div>
33
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">LanguageEntry</span></h4><p>The language entry that is now active.</p>
34
- <aside class="tsd-sources">
35
- <ul>
36
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/a101b177bf4cc3e6876dc5bb87bec6db43c39228/src/language/Language.ts#L36">language/Language.ts:36</a></li></ul></aside></div></li></ul></section></div>
37
- <div class="col-sidebar">
38
- <div class="page-menu">
39
- <div class="tsd-navigation settings">
40
- <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>
41
- <h3>Settings</h3></summary>
42
- <div class="tsd-accordion-details">
43
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
44
- <ul id="tsd-filter-options">
45
- <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>
46
- <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>
47
- <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>
48
- <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></div>
49
- <div class="site-menu">
50
- <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
51
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
52
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
53
- <div class="overlay"></div></body></html>
package/dist/docs/api/functions/validateStorymap.html DELETED
@@ -1,53 +0,0 @@
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>validateStorymap | 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">validateStorymap</a></li></ul>
12
- <h1>Function validateStorymap</h1></div>
13
- <section class="tsd-panel tsd-comment">
14
- <div class="tsd-comment tsd-typography"><p>Validate a storymap document against the bundled JSON Schema.</p>
15
- </div>
16
- <div class="tsd-comment tsd-typography">
17
- <div class="tsd-tag-param">
18
- <h4 class="tsd-anchor-link" id="param-data">Param: data<a href="#param-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The storymap document to validate.</p>
19
- </div>
20
- <div class="tsd-tag-returns">
21
- <h4 class="tsd-anchor-link" id="returns">Returns<a href="#returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The list of validation error messages (empty when valid).</p>
22
- </div></div></section>
23
- <section class="tsd-panel">
24
- <ul class="tsd-signatures">
25
- <li class="">
26
- <div class="tsd-signature tsd-anchor-link" id="validatestorymap"><span class="tsd-kind-call-signature">validateStorymap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</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">StorymapError</span><span class="tsd-signature-symbol">[]</span><a href="#validatestorymap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
27
- <div class="tsd-description">
28
- <div class="tsd-comment tsd-typography"><p>Validate storymap JSON (the object containing a &quot;storymap&quot; property).</p>
29
- </div>
30
- <div class="tsd-parameters">
31
- <h4 class="tsd-parameters-title">Parameters</h4>
32
- <ul class="tsd-parameter-list">
33
- <li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div>
34
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">StorymapError</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
35
- <ul>
36
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/a101b177bf4cc3e6876dc5bb87bec6db43c39228/src/storymap/validate.ts#L159">storymap/validate.ts:159</a></li></ul></aside></div></li></ul></section></div>
37
- <div class="col-sidebar">
38
- <div class="page-menu">
39
- <div class="tsd-navigation settings">
40
- <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>
41
- <h3>Settings</h3></summary>
42
- <div class="tsd-accordion-details">
43
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
44
- <ul id="tsd-filter-options">
45
- <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>
46
- <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>
47
- <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>
48
- <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></div>
49
- <div class="site-menu">
50
- <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
51
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
52
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
53
- <div class="overlay"></div></body></html>
package/dist/docs/api/functions/validateStorymapAndReport.html DELETED
@@ -1,54 +0,0 @@
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>validateStorymapAndReport | 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">validateStorymapAndReport</a></li></ul>
12
- <h1>Function validateStorymapAndReport</h1></div>
13
- <section class="tsd-panel tsd-comment">
14
- <div class="tsd-comment tsd-typography"><p>Validate a storymap document against the bundled JSON Schema.</p>
15
- </div>
16
- <div class="tsd-comment tsd-typography">
17
- <div class="tsd-tag-param">
18
- <h4 class="tsd-anchor-link" id="param-data">Param: data<a href="#param-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The storymap document to validate.</p>
19
- </div>
20
- <div class="tsd-tag-returns">
21
- <h4 class="tsd-anchor-link" id="returns">Returns<a href="#returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The list of validation error messages (empty when valid).</p>
22
- </div></div></section>
23
- <section class="tsd-panel">
24
- <ul class="tsd-signatures">
25
- <li class="">
26
- <div class="tsd-signature tsd-anchor-link" id="validatestorymapandreport"><span class="tsd-kind-call-signature">validateStorymapAndReport</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#validatestorymapandreport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
27
- <div class="tsd-description">
28
- <div class="tsd-comment tsd-typography"><p>Validate and report all errors to the JavaScript console. Returns true when valid.</p>
29
- </div>
30
- <div class="tsd-parameters">
31
- <h4 class="tsd-parameters-title">Parameters</h4>
32
- <ul class="tsd-parameter-list">
33
- <li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">unknown</span></span></li>
34
- <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
35
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
36
- <ul>
37
- <li>Defined in <a href="https://github.com/cmahnke/StoryMapJS/blob/a101b177bf4cc3e6876dc5bb87bec6db43c39228/src/storymap/validate.ts#L172">storymap/validate.ts:172</a></li></ul></aside></div></li></ul></section></div>
38
- <div class="col-sidebar">
39
- <div class="page-menu">
40
- <div class="tsd-navigation settings">
41
- <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>
42
- <h3>Settings</h3></summary>
43
- <div class="tsd-accordion-details">
44
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
45
- <ul id="tsd-filter-options">
46
- <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>
47
- <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>
48
- <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>
49
- <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></div>
50
- <div class="site-menu">
51
- <nav class="tsd-navigation"><a href="../modules.html">StoryMapJS API</a>
52
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
53
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
54
- <div class="overlay"></div></body></html>
package/dist/docs/api/hierarchy.html DELETED
@@ -1,28 +0,0 @@
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>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
- <h1>StoryMapJS API</h1></div>
11
- <h2>Hierarchy Summary</h2></div>
12
- <div class="col-sidebar">
13
- <div class="page-menu">
14
- <div class="tsd-navigation settings">
15
- <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>
16
- <h3>Settings</h3></summary>
17
- <div class="tsd-accordion-details">
18
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
19
- <ul id="tsd-filter-options">
20
- <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>
21
- <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>
22
- <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>
23
- <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></div>
24
- <div class="site-menu">
25
- <nav class="tsd-navigation"><a href="modules.html">StoryMapJS API</a>
26
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
27
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
28
- <div class="overlay"></div></body></html>
package/dist/docs/api/index.html DELETED
@@ -1,127 +0,0 @@
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>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
- <h1>StoryMapJS API</h1></div>
11
- <div class="tsd-panel tsd-typography"><h1 id="storymapjs-maps-that-tell-stories" class="tsd-anchor-link">StoryMapJS: Maps that tell stories.<a href="#storymapjs-maps-that-tell-stories" 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></h1>
12
- <blockquote>
13
- <p><strong>Important:</strong> this is an <strong>unofficial, unapproved fork</strong> of the original
14
- <a href="https://github.com/NUKnightLab/StoryMapJS">NUKnightLab/StoryMapJS</a>
15
- repository. It is a proof of concept for an AI-based renovation of the
16
- codebase, built using the model <strong>GLM 5.3 Flash</strong>. It is not endorsed by,
17
- affiliated with, or supported by Northwestern University Knight Lab.</p>
18
- </blockquote>
19
- <p><a href="http://storymap.knightlab.com">StoryMapJS</a> is a simple tool to help you tell stories with maps. If you're not a programmer, you don't need to spend much time on the GitHub page—instead, go <a href="http://storymap.knightlab.com">StoryMapJS</a></p>
20
- <p>If you want information on creating JSON with your own code and embedding it, see the <a href="http://storymap.knightlab.com/advanced.html">&quot;Advanced&quot;</a> documentation on the StoryMap website.</p>
21
- <h2 id="development" class="tsd-anchor-link">Development<a href="#development" 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>
22
- <p>See <a href="http://DEVELOPMENT.md">DEVELOPMENT.md</a> to get setup for local development of StoryMapJS. This
23
- repository is the viewer library only (TypeScript + Vite + OpenLayers);
24
- StoryMap JSON is validated against the schema in <code>schema/</code> on load and via
25
- <code>npm run validate</code>.</p>
26
- <h2 id="contributing-language-translations" class="tsd-anchor-link">Contributing language translations<a href="#contributing-language-translations" 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>
27
- <p>StoryMap's older sibling, <a href="http://timeline.knightlab.com">TimelineJS</a> has proven internationally popular, in part because users have contributed translation support for dozens of languages. StoryMap is also ready to be used in languages other than English, but once again, we'll need your help.</p>
28
- <p>For each language, we need a simple file with a name like <code>xx.json</code>, where <code>xx</code> is the two letter code for the language. (Technically, it's the ISO 639-1 code—you can find a <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">list of them on Wikipedia</a>.) The file defines a JSON object with language specific translations. To make one for your language, copy one of the existing files (like <a href="https://github.com/NUKnightLab/StoryMapJS/blob/master/src/language/locale/es.json">this one for Spanish</a>) and edit the quoted strings. Please <em>don't</em> change the &quot;keys&quot;—the unquoted strings. If you know how to use GitHub to make a pull request, that's the best way to submit it to us. If that's not your thing, you can <a href="https://knightlab.zendesk.com/entries/33066836-Help-us-translate-StoryMapJS-into-other-languages">add a comment to this support thread</a> and upload your translation as an attachment.</p>
29
- <h2 id="iiif-images" class="tsd-anchor-link">IIIF images<a href="#iiif-images" 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>
30
- <p>Large images served over the IIIF Image API are rendered so when set to be map_as_image the entire image is shown. When set as cartography the zoom will set so that all the markers fit.</p>
31
- <p>Points are set to only display on mouseover in image mode, but you can set map_as_image to false in the config options to always show the points. The points are hidden when the intent is an image so that nothing obstructs the image the viewer is looking at. Looking at a painting is hard with a bunch of points on it.</p>
32
- <h2 id="map-options" class="tsd-anchor-link">Map Options<a href="#map-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
33
- <p>To disable connecting lines on maps use the StoryMap options: &quot;Treat as Image&quot; (as opposed to the default, &quot;Treat as Cartography&quot;)</p>
34
- <p>The menubar buttons can be disabled individually:</p>
35
- <pre><code>show_overview: true, // map overview button
36
- show_back_to_start: true, // back to the beginning button
37
- fullscreen: true, // fullscreen toggle
38
- </code></pre>
39
- <p>More config options available to do what you want with the line:</p>
40
- <pre><code>line_follows_path: true, // Map history path follows default line, if false it will connect previous and current only
41
- line_color: &quot;#c34528&quot;,
42
- line_color_inactive: &quot;#CCC&quot;,
43
- line_join: &quot;miter&quot;,
44
- line_weight: 3,
45
- line_opacity: 0.80,
46
- line_dash: &quot;5,5&quot;,
47
- show_lines: true,
48
- show_history_line: true,
49
- </code></pre>
50
- <p>To disable zoom calculation/edit zoom level set calculate_zoom to false in the config options.</p>
51
- <p>Images can now be used in place of map pins.
52
- Use <code>image</code> inside the location object and include a url to use. <code>use_custom_markers</code> also has to be set to <code>true</code> in the story map options. Same goes for custom icons except you need <code>icon</code> inside the location object and include a url to use.</p>
53
- <h3 id="limit-the-map-to-a-bounding-box" class="tsd-anchor-link">Limit the map to a bounding box<a href="#limit-the-map-to-a-bounding-box" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
54
- <p>Set <code>map_bbox</code> to <code>[west, south, east, north]</code> (lon/lat) to constrain the map —
55
- nothing outside of the box can be visible:</p>
56
- <pre><code>map_bbox: [-11, 34, 32, 71], // or null (the default) to leave the map unconstrained
57
- </code></pre>
58
- <p>For image-space (IIIF) maps the coordinates are raw image pixels. When the
59
- slide content panel is opaque (a solid background that hides the map behind it),
60
- the initial fit accounts for the covered area so the story stays inside the
61
- visible region.</p>
62
- <h2 id="custom-html-in-slide-content" class="tsd-anchor-link">Custom HTML in slide content<a href="#custom-html-in-slide-content" 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>
63
- <p>Slide text is rendered as HTML: the <code>text</code> (and <code>headline</code>) fields accept
64
- arbitrary markup. If the text contains no <code>&lt;p&gt;</code> tag, it is wrapped in one
65
- automatically; otherwise it is used as-is. This means you can use links,
66
- images, lists, emphasis and spans in your slides, e.g.:</p>
67
- <pre><code>{
68
- &quot;headline&quot;: &quot;1920: An American in the Making&quot;,
69
- &quot;text&quot;: &quot;Immigrants arriving at &lt;a href=\&quot;https://example.org\&quot;&gt;Ellis Island&lt;/a&gt;.&lt;br&gt;&lt;span class='vco-note'&gt;Photograph: Library of Congress.&lt;/span&gt;&quot;
70
- }
71
- </code></pre>
72
- <p>The <code>vco-note</code> span renders as a small grey note, like the built-in credits.</p>
73
- <p><strong>Caution:</strong> the text is rendered raw — it is not sanitized. Only load
74
- storymaps from sources you trust.</p>
75
- <h2 id="gdpr-consent-for-external-services" class="tsd-anchor-link">GDPR consent for external services<a href="#gdpr-consent-for-external-services" 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>
76
- <p>Set the <code>consent_required</code> option to <code>true</code> to ask for permission before
77
- anything is loaded from external services (media embeds such as YouTube,
78
- Twitter or SoundCloud, map tiles, and external font CSS):</p>
79
- <pre><code>{
80
- &quot;consent_required&quot;: true,
81
- ...
82
- }
83
- </code></pre>
84
- <p>Each service asks once per page load with an Allow/Deny panel; answering one
85
- panel resolves every pending panel of the same service. Denied services show a
86
- placeholder instead of the media, and the map renders without tiles until they
87
- are allowed. Decisions are stored in a cookie (<code>storymapjs-consent</code>) for 90
88
- days — clearing cookies asks again.</p>
89
- <h2 id="bundled-credentials" class="tsd-anchor-link">Bundled credentials<a href="#bundled-credentials" 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>
90
- <p>The viewer ships no credentials. Mapbox/Stadia tiles need a token passed via
91
- <code>map_access_token</code>, and <code>flickr.com/photos</code> API URLs need <code>api_key_flickr</code>
92
- (both settable in the storymap options).</p>
93
- <h2 id="troubleshooting" class="tsd-anchor-link">Troubleshooting<a href="#troubleshooting" 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>
94
- <p>Users may be directed to our userinfo page to help with troubleshooting. This page provides information about the user's account and saved storymaps. The endpoint is <code>https://storymap.knightlab.com/userinfo/</code></p>
95
- </div></div>
96
- <div class="col-sidebar">
97
- <div class="page-menu">
98
- <div class="tsd-navigation settings">
99
- <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>
100
- <h3>Settings</h3></summary>
101
- <div class="tsd-accordion-details">
102
- <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
103
- <ul id="tsd-filter-options">
104
- <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>
105
- <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>
106
- <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>
107
- <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>
108
- <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>
109
- <h3>On This Page</h3></summary>
110
- <div class="tsd-accordion-details"><a href="#storymapjs-maps-that-tell-stories"><span>Story<wbr/>Map<wbr/>JS: <wbr/>Maps that tell stories.</span></a>
111
- <ul>
112
- <li><a href="#development"><span>Development</span></a></li>
113
- <li><a href="#contributing-language-translations"><span>Contributing language translations</span></a></li>
114
- <li><a href="#iiif-images"><span>IIIF images</span></a></li>
115
- <li><a href="#map-options"><span>Map <wbr/>Options</span></a></li>
116
- <li>
117
- <ul>
118
- <li><a href="#limit-the-map-to-a-bounding-box"><span>Limit the map to a bounding box</span></a></li></ul></li>
119
- <li><a href="#custom-html-in-slide-content"><span>Custom <wbr/>HTML in slide content</span></a></li>
120
- <li><a href="#gdpr-consent-for-external-services"><span>GDPR consent for external services</span></a></li>
121
- <li><a href="#bundled-credentials"><span>Bundled credentials</span></a></li>
122
- <li><a href="#troubleshooting"><span>Troubleshooting</span></a></li></ul></div></details></div>
123
- <div class="site-menu">
124
- <nav class="tsd-navigation"><a href="modules.html">StoryMapJS API</a>
125
- <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
126
- <li>Loading...</li></ul></nav></div></div></div><footer></footer>
127
- <div class="overlay"></div></body></html>