umap-project 2.3.0__py3-none-any.whl → 2.3.1__py3-none-any.whl

umap/static/umap/js/modules/caption.js

@@ -0,0 +1,118 @@
+import { DomUtil } from '../../vendors/leaflet/leaflet-src.esm.js'
+import { translate } from './i18n.js'
+import * as Utils from './utils.js'
+
+export default class Caption {
+  constructor(map) {
+    this.map = map
+  }
+
+  isOpen() {
+    return Boolean(document.querySelector('.on .umap-caption'))
+  }
+
+  refresh() {
+    if (!this.isOpen()) return
+    this.open()
+  }
+
+  open() {
+    const container = DomUtil.create('div', 'umap-caption')
+    DomUtil.createTitle(container, this.map.options.name, 'icon-caption')
+    this.map.permissions.addOwnerLink('h5', container)
+    if (this.map.options.description) {
+      const description = DomUtil.element({
+        tagName: 'div',
+        className: 'umap-map-description',
+        safeHTML: Utils.toHTML(this.map.options.description),
+        parent: container,
+      })
+    }
+    const datalayerContainer = DomUtil.create('div', 'datalayer-container', container)
+    this.map.eachDataLayer((datalayer) =>
+      this.addDataLayer(datalayer, datalayerContainer)
+    )
+    const creditsContainer = DomUtil.create('div', 'credits-container', container)
+    this.addCredits(creditsContainer)
+    this.map.panel.open({ content: container })
+  }
+
+  addDataLayer(datalayer, container) {
+    if (!datalayer.options.inCaption) return
+    const p = DomUtil.create('p', 'datalayer-legend', container),
+      legend = DomUtil.create('span', '', p),
+      headline = DomUtil.create('strong', '', p)
+    datalayer.onceLoaded(() => {
+      datalayer.renderLegend(legend)
+      if (datalayer.options.description) {
+        DomUtil.element({
+          tagName: 'span',
+          parent: p,
+          safeHTML: Utils.toHTML(datalayer.options.description),
+        })
+      }
+    })
+    datalayer.renderToolbox(headline)
+    DomUtil.add('span', '', headline, `${datalayer.options.name} `)
+  }
+
+  addCredits(container) {
+    const credits = DomUtil.createFieldset(container, translate('Credits'))
+    let title = DomUtil.add('h5', '', credits, translate('User content credits'))
+    if (this.map.options.shortCredit || this.map.options.longCredit) {
+      DomUtil.element({
+        tagName: 'p',
+        parent: credits,
+        safeHTML: Utils.toHTML(
+          this.map.options.longCredit || this.map.options.shortCredit
+        ),
+      })
+    }
+    if (this.map.options.licence) {
+      const licence = DomUtil.add(
+        'p',
+        '',
+        credits,
+        `${translate('Map user content has been published under licence')} `
+      )
+      DomUtil.createLink(
+        '',
+        licence,
+        this.map.options.licence.name,
+        this.map.options.licence.url
+      )
+    } else {
+      DomUtil.add('p', '', credits, translate('No licence has been set'))
+    }
+    title = DomUtil.create('h5', '', credits)
+    title.textContent = translate('Map background credits')
+    const tilelayerCredit = DomUtil.create('p', '', credits)
+    DomUtil.element({
+      tagName: 'strong',
+      parent: tilelayerCredit,
+      textContent: `${this.map.selected_tilelayer.options.name} `,
+    })
+    DomUtil.element({
+      tagName: 'span',
+      parent: tilelayerCredit,
+      safeHTML: this.map.selected_tilelayer.getAttribution(),
+    })
+    const urls = {
+      leaflet: 'http://leafletjs.com',
+      django: 'https://www.djangoproject.com',
+      umap: 'https://umap-project.org/',
+      changelog: 'https://docs.umap-project.org/en/master/changelog/',
+      version: this.map.options.umap_version,
+    }
+    const creditHTML = translate(
+      `
+      Powered by <a href="{leaflet}">Leaflet</a> and
+      <a href="{django}">Django</a>,
+      glued by <a href="{umap}">uMap project</a>
+      (version <a href="{changelog}">{version}</a>).
+      `,
+      urls
+    )
+    DomUtil.element({ tagName: 'p', innerHTML: creditHTML, parent: credits })
+  }
+}

umap/static/umap/js/modules/global.js

@@ -1,6 +1,7 @@
 import URLs from './urls.js'
 import Browser from './browser.js'
 import Facets from './facets.js'
+import Caption from './caption.js'
 import { Panel, EditPanel, FullPanel } from './panel.js'
 import * as Utils from './utils.js'
 import { SCHEMA } from './schema.js'
@@ -25,4 +26,5 @@ window.U = {
   Utils,
   SCHEMA,
   Orderable,
+  Caption,
 }

umap/static/umap/js/modules/panel.js

@@ -6,7 +6,9 @@ export class Panel {
     this.parent = map._controlContainer
     this.map = map
     this.container = DomUtil.create('div', '', this.parent)
-    this.mode = 'condensed'
+    // This will be set once according to the panel configurated at load
+    // or by using panels as popups
+    this.mode = null
     this.classname = 'left'
     DomEvent.disableClickPropagation(this.container)
     DomEvent.on(this.container, 'contextmenu', DomEvent.stopPropagation) // Do not activate our custom context menu.
@@ -14,8 +16,12 @@ export class Panel {
     DomEvent.on(this.container, 'MozMousePixelScroll', DomEvent.stopPropagation)
   }
 
+  setDefaultMode(mode) {
+    if (!this.mode) this.mode = mode
+  }
+
   open({ content, className, actions = [] } = {}) {
-    this.container.className = `with-transition panel ${this.classname} ${this.mode}`
+    this.container.className = `with-transition panel ${this.classname} ${this.mode || ''}`
     this.container.innerHTML = ''
     const actionsContainer = DomUtil.create('ul', 'toolbox', this.container)
     const body = DomUtil.create('div', 'body', this.container)
@@ -40,14 +46,14 @@ export class Panel {
   }
 
   resize() {
-    if (this.mode === 'expanded') {
-      this.mode = 'condensed'
-      this.container.classList.remove('expanded')
-      this.container.classList.add('condensed')
-    } else {
+    if (this.mode === 'condensed') {
       this.mode = 'expanded'
       this.container.classList.remove('condensed')
       this.container.classList.add('expanded')
+    } else {
+      this.mode = 'condensed'
+      this.container.classList.remove('expanded')
+      this.container.classList.add('condensed')
     }
   }
 

umap/static/umap/js/umap.controls.js

@@ -530,7 +530,7 @@ U.CaptionControl = L.Control.Button.extend({
   },
 
   onClick: function () {
-    this.map.displayCaption()
+    this.map.openCaption()
   },
 })
 
@@ -607,15 +607,14 @@ U.DataLayer.include({
           if (!this.isVisible()) return
           if (!confirm(L._('Are you sure you want to delete this layer?'))) return
           this._delete()
-          this.map.editPanel.close()
         },
         this
       )
     }
     L.DomEvent.on(toggle, 'click', this.toggle, this)
     L.DomEvent.on(zoomTo, 'click', this.zoomTo, this)
-    L.DomUtil.addClass(container, this.getHidableClass())
-    L.DomUtil.classIf(container, 'off', !this.isVisible())
+    container.classList.add(this.getHidableClass())
+    container.classList.toggle('off', !this.isVisible())
   },
 
   getHidableElements: function () {
@@ -626,10 +625,17 @@ U.DataLayer.include({
     return `show_with_datalayer_${L.stamp(this)}`
   },
 
+  propagateDelete: function () {
+    const els = this.getHidableElements()
+    for (const el of els) {
+      L.DomUtil.remove(el)
+    }
+  },
+
   propagateRemote: function () {
     const els = this.getHidableElements()
-    for (let i = 0; i < els.length; i++) {
-      L.DomUtil.classIf(els[i], 'remotelayer', this.isRemoteLayer())
+    for (const el of els) {
+      el.classList.toggle('remotelayer', this.isRemoteLayer())
     }
   },
 
@@ -653,6 +659,7 @@ U.DataLayer.include({
 U.DataLayer.addInitHook(function () {
   this.on('hide', this.propagateHide)
   this.on('show', this.propagateShow)
+  this.on('erase', this.propagateDelete)
   if (this.isVisible()) this.propagateShow()
 })
 
@@ -671,96 +678,6 @@ const ControlsMixin = {
     'tilelayers',
   ],
 
-  displayCaption: function () {
-    const container = L.DomUtil.create('div', 'umap-caption')
-    L.DomUtil.createTitle(container, this.options.name, 'icon-caption')
-    this.permissions.addOwnerLink('h5', container)
-    if (this.options.description) {
-      const description = L.DomUtil.element({
-        tagName: 'div',
-        className: 'umap-map-description',
-        safeHTML: U.Utils.toHTML(this.options.description),
-        parent: container,
-      })
-    }
-    const datalayerContainer = L.DomUtil.create('div', 'datalayer-container', container)
-    this.eachVisibleDataLayer((datalayer) => {
-      if (!datalayer.options.inCaption) return
-      const p = L.DomUtil.create('p', 'datalayer-legend', datalayerContainer),
-        legend = L.DomUtil.create('span', '', p),
-        headline = L.DomUtil.create('strong', '', p)
-      datalayer.onceLoaded(function () {
-        datalayer.renderLegend(legend)
-        if (datalayer.options.description) {
-          L.DomUtil.element({
-            tagName: 'span',
-            parent: p,
-            safeHTML: U.Utils.toHTML(datalayer.options.description),
-          })
-        }
-      })
-      datalayer.renderToolbox(headline)
-      L.DomUtil.add('span', '', headline, `${datalayer.options.name} `)
-    })
-    const creditsContainer = L.DomUtil.create('div', 'credits-container', container),
-      credits = L.DomUtil.createFieldset(creditsContainer, L._('Credits'))
-    title = L.DomUtil.add('h5', '', credits, L._('User content credits'))
-    if (this.options.shortCredit || this.options.longCredit) {
-      L.DomUtil.element({
-        tagName: 'p',
-        parent: credits,
-        safeHTML: U.Utils.toHTML(this.options.longCredit || this.options.shortCredit),
-      })
-    }
-    if (this.options.licence) {
-      const licence = L.DomUtil.add(
-        'p',
-        '',
-        credits,
-        `${L._('Map user content has been published under licence')} `
-      )
-      L.DomUtil.createLink(
-        '',
-        licence,
-        this.options.licence.name,
-        this.options.licence.url
-      )
-    } else {
-      L.DomUtil.add('p', '', credits, L._('No licence has been set'))
-    }
-    title = L.DomUtil.create('h5', '', credits)
-    title.textContent = L._('Map background credits')
-    const tilelayerCredit = L.DomUtil.create('p', '', credits)
-    L.DomUtil.element({
-      tagName: 'strong',
-      parent: tilelayerCredit,
-      textContent: `${this.selected_tilelayer.options.name} `,
-    })
-    L.DomUtil.element({
-      tagName: 'span',
-      parent: tilelayerCredit,
-      safeHTML: this.selected_tilelayer.getAttribution(),
-    })
-    const urls = {
-      leaflet: 'http://leafletjs.com',
-      django: 'https://www.djangoproject.com',
-      umap: 'http://wiki.openstreetmap.org/wiki/UMap',
-      changelog: 'https://umap-project.readthedocs.io/en/master/changelog/',
-      version: this.options.umap_version,
-    }
-    const creditHTML = L._(
-      `
-      Powered by <a href="{leaflet}">Leaflet</a> and
-      <a href="{django}">Django</a>,
-      glued by <a href="{umap}">uMap project</a>
-      (version <a href="{changelog}">{version}</a>).
-      `,
-      urls
-    )
-    L.DomUtil.element({ tagName: 'p', innerHTML: creditHTML, parent: credits })
-    this.panel.open({ content: container })
-  },
-
   renderEditToolbar: function () {
     const container = L.DomUtil.create(
       'div',
@@ -910,7 +827,7 @@ const ControlsMixin = {
       L.DomUtil.createIcon(row, 'icon-drag', L._('Drag to reorder'))
       datalayer.renderToolbox(row)
       const title = L.DomUtil.add('span', '', row, datalayer.options.name)
-      L.DomUtil.classIf(row, 'off', !datalayer.isVisible())
+      row.classList.toggle('off', !datalayer.isVisible())
       title.textContent = datalayer.options.name
       row.dataset.id = L.stamp(datalayer)
     })
@@ -1077,7 +994,7 @@ U.AttributionControl = L.Control.Attribution.extend({
     if (captionMenus) {
       const link = L.DomUtil.add('a', '', container, ` — ${L._('About')}`)
       L.DomEvent.on(link, 'click', L.DomEvent.stop)
-        .on(link, 'click', this._map.displayCaption, this._map)
+        .on(link, 'click', this._map.openCaption, this._map)
         .on(link, 'dblclick', L.DomEvent.stop)
     }
     if (window.top === window.self && captionMenus) {
@@ -1121,8 +1038,17 @@ U.Locate = L.Control.Locate.extend({
   _activate: function () {
     this._map = this.map
     L.Control.Locate.prototype._activate.call(this)
-    this._map = null
   },
+
+  remove: function () {
+    // Prevent to call remove if the control is not really added to the map
+    // This occurs because we do create the control and call its activate
+    // method before adding the control button itself to the map, in the
+    // case where the map defaultView is set to "location"
+    if (!this._container || !this._container.parentNode) return
+    return L.Control.Locate.prototype.remove.call(this)
+  },
+
 })
 
 U.Search = L.PhotonSearch.extend({

umap/static/umap/js/umap.core.js

@@ -162,11 +162,6 @@ L.DomUtil.createCopiableInput = (parent, label, value) => {
   return input
 }
 
-L.DomUtil.classIf = (el, className, bool) => {
-  if (bool) L.DomUtil.addClass(el, className)
-  else L.DomUtil.removeClass(el, className)
-}
-
 L.DomUtil.element = ({ tagName, parent, ...attrs }) => {
   const el = document.createElement(tagName)
   if (attrs.innerHTML) {
@@ -556,7 +551,9 @@ U.Help = L.Class.extend({
     'Comma separated list of properties to use for sorting features. To reverse the sort, put a minus sign (-) before. Eg. mykey,-otherkey.'
   ),
   slugKey: L._('The name of the property to use as feature unique identifier.'),
-  filterKey: L._('Comma separated list of properties to use when filtering features by text input'),
+  filterKey: L._(
+    'Comma separated list of properties to use when filtering features by text input'
+  ),
   facetKey: L._(
     'Comma separated list of properties to use for filters (eg.: mykey,otherkey). To control label, add it after a | (eg.: mykey|My Key,otherkey|Other Key). To control input field type, add it after another | (eg.: mykey|My Key|checkbox,otherkey|Other Key|datetime). Allowed values for the input field type are checkbox (default), radio, number, date and datetime.'
   ),

umap/static/umap/js/umap.forms.js

@@ -745,14 +745,12 @@ L.FormBuilder.Switch = L.FormBuilder.CheckBox.extend({
 })
 
 L.FormBuilder.FacetSearchBase = L.FormBuilder.Element.extend({
-
   buildLabel: function () {
     this.label = L.DomUtil.element({
       tagName: 'legend',
       textContent: this.options.label,
     })
-  }
-
+  },
 })
 L.FormBuilder.FacetSearchChoices = L.FormBuilder.FacetSearchBase.extend({
   build: function () {
@@ -865,13 +863,13 @@ L.FormBuilder.MinMaxBase = L.FormBuilder.FacetSearchBase.extend({
   },
 
   isMinModified: function () {
-    const default_ = this.minInput.getAttribute("value")
+    const default_ = this.minInput.getAttribute('value')
     const current = this.minInput.value
     return current != default_
   },
 
   isMaxModified: function () {
-    const default_ = this.maxInput.getAttribute("value")
+    const default_ = this.maxInput.getAttribute('value')
     const current = this.maxInput.value
     return current != default_
   },
@@ -943,7 +941,11 @@ L.FormBuilder.MultiChoice = L.FormBuilder.Element.extend({
     if (!this.container.querySelector(`input[type="radio"][value="${value}"]`)) {
       value = this.options.default !== undefined ? this.options.default : this.default
     }
-    this.container.querySelector(`input[type="radio"][value="${value}"]`).checked = true
+    const choices = this.getChoices().map(([value, label]) => value)
+    if (choices.includes(value)) {
+      this.container.querySelector(`input[type="radio"][value="${value}"]`).checked =
+        true
+    }
   },
 
   value: function () {

umap/static/umap/js/umap.js

@@ -214,15 +214,17 @@ U.Map = L.Map.extend({
       if (L.Util.queryString('share')) {
         this.share.open()
       } else if (this.options.onLoadPanel === 'databrowser') {
+        this.panel.setDefaultMode('expanded')
         this.openBrowser('data')
       } else if (this.options.onLoadPanel === 'datalayers') {
+        this.panel.setDefaultMode('condensed')
         this.openBrowser('layers')
       } else if (this.options.onLoadPanel === 'datafilters') {
-        this.panel.mode = 'expanded'
+        this.panel.setDefaultMode('expanded')
         this.openBrowser('filters')
       } else if (this.options.onLoadPanel === 'caption') {
-        this.panel.mode = 'condensed'
-        this.displayCaption()
+        this.panel.setDefaultMode('condensed')
+        this.openCaption()
       }
       if (L.Util.queryString('edit')) {
         if (this.hasEditMode()) this.enableEdit()
@@ -382,6 +384,7 @@ U.Map = L.Map.extend({
     else this.scrollWheelZoom.disable()
     this.browser = new U.Browser(this)
     this.facets = new U.Facets(this)
+    this.caption = new U.Caption(this)
     this.importer = new U.Importer(this)
     this.drop = new U.DropControl(this)
     this.share = new U.Share(this)
@@ -389,17 +392,10 @@ U.Map = L.Map.extend({
   },
 
   renderControls: function () {
-    L.DomUtil.classIf(
-      document.body,
-      'umap-caption-bar-enabled',
-      this.options.captionBar ||
-        (this.options.slideshow && this.options.slideshow.active)
-    )
-    L.DomUtil.classIf(
-      document.body,
-      'umap-slideshow-enabled',
-      this.options.slideshow && this.options.slideshow.active
-    )
+    const hasSlideshow = Boolean(this.options.slideshow && this.options.slideshow.active)
+    const barEnabled = this.options.captionBar || hasSlideshow
+    document.body.classList.toggle('umap-caption-bar-enabled', barEnabled)
+    document.body.classList.toggle('umap-slideshow-enabled', hasSlideshow)
     for (const control of Object.values(this._controls)) {
       this.removeControl(control)
     }
@@ -474,6 +470,7 @@ U.Map = L.Map.extend({
 
   onDataLayersChanged: function () {
     if (this.browser) this.browser.update()
+    this.caption.refresh()
   },
 
   ensurePanesOrder: function () {
@@ -517,11 +514,11 @@ U.Map = L.Map.extend({
 
   initShortcuts: function () {
     const globalShortcuts = function (e) {
-      const key = e.keyCode,
-        modifierKey = e.ctrlKey || e.metaKey
+      const key = e.keyCode
+      const hasModifier = (e.ctrlKey || e.metaKey) && !e.shiftKey
 
       /* Generic shortcuts */
-      if (key === U.Keys.F && modifierKey) {
+      if (key === U.Keys.F && hasModifier) {
         L.DomEvent.stop(e)
         this.search()
       } else if (e.keyCode === U.Keys.ESC) {
@@ -537,44 +534,44 @@ U.Map = L.Map.extend({
       if (!this.hasEditMode()) return
 
       /* Edit mode only shortcuts */
-      if (key === U.Keys.E && modifierKey && !this.editEnabled) {
+      if (key === U.Keys.E && hasModifier && !this.editEnabled) {
         L.DomEvent.stop(e)
         this.enableEdit()
-      } else if (key === U.Keys.E && modifierKey && this.editEnabled && !this.isDirty) {
+      } else if (key === U.Keys.E && hasModifier && this.editEnabled && !this.isDirty) {
         L.DomEvent.stop(e)
         this.disableEdit()
       }
-      if (key === U.Keys.S && modifierKey) {
+      if (key === U.Keys.S && hasModifier) {
         L.DomEvent.stop(e)
         if (this.isDirty) {
           this.save()
         }
       }
-      if (key === U.Keys.Z && modifierKey && this.isDirty) {
+      if (key === U.Keys.Z && hasModifier && this.isDirty) {
         L.DomEvent.stop(e)
         this.askForReset()
       }
-      if (key === U.Keys.M && modifierKey && this.editEnabled) {
+      if (key === U.Keys.M && hasModifier && this.editEnabled) {
         L.DomEvent.stop(e)
         this.editTools.startMarker()
       }
-      if (key === U.Keys.P && modifierKey && this.editEnabled) {
+      if (key === U.Keys.P && hasModifier && this.editEnabled) {
         L.DomEvent.stop(e)
         this.editTools.startPolygon()
       }
-      if (key === U.Keys.L && modifierKey && this.editEnabled) {
+      if (key === U.Keys.L && hasModifier && this.editEnabled) {
         L.DomEvent.stop(e)
         this.editTools.startPolyline()
       }
-      if (key === U.Keys.I && modifierKey && this.editEnabled) {
+      if (key === U.Keys.I && hasModifier && this.editEnabled) {
         L.DomEvent.stop(e)
         this.importer.open()
       }
-      if (key === U.Keys.O && modifierKey && this.editEnabled) {
+      if (key === U.Keys.O && hasModifier && this.editEnabled) {
         L.DomEvent.stop(e)
         this.importer.openFiles()
       }
-      if (key === U.Keys.H && modifierKey && this.editEnabled) {
+      if (key === U.Keys.H && hasModifier && this.editEnabled) {
         L.DomEvent.stop(e)
         this.help.show('edit')
       }
@@ -911,9 +908,11 @@ U.Map = L.Map.extend({
   },
 
   openBrowser: function (mode) {
-    this.onceDatalayersLoaded(function () {
-      this.browser.open(mode)
-    })
+    this.onceDatalayersLoaded(() => this.browser.open(mode))
+  },
+
+  openCaption: function () {
+    this.onceDatalayersLoaded(() => this.caption.open())
   },
 
   eachDataLayer: function (method, context) {
@@ -965,7 +964,7 @@ U.Map = L.Map.extend({
   },
 
   checkDirty: function () {
-    L.DomUtil.classIf(this._container, 'umap-is-dirty', this.isDirty)
+    this._container.classList.toggle('umap-is-dirty', this.isDirty)
   },
 
   addDirtyDatalayer: function (datalayer) {
@@ -1060,7 +1059,6 @@ U.Map = L.Map.extend({
       else window.location = data.url
       alert.content = data.info || alert.content
       this.once('saved', () => this.ui.alert(alert))
-      this.editPanel.close()
       this.permissions.save()
     }
   },
@@ -1591,7 +1589,7 @@ U.Map = L.Map.extend({
         'umap-about-link flat',
         container,
         L._('About'),
-        this.displayCaption,
+        this.openCaption,
         this
       )
       L.DomUtil.createButton(
@@ -1758,7 +1756,7 @@ U.Map = L.Map.extend({
     items.push(
       {
         text: L._('About'),
-        callback: this.displayCaption,
+        callback: this.openCaption,
       },
       {
         text: this.help.displayLabel('SEARCH'),

umap/static/umap/js/umap.layer.js

@@ -863,7 +863,7 @@ U.DataLayer = L.Evented.extend({
   },
 
   isRemoteLayer: function () {
-    return !!(
+    return Boolean(
       this.options.remoteData &&
       this.options.remoteData.url &&
       this.options.remoteData.format
@@ -1528,7 +1528,7 @@ U.DataLayer = L.Evented.extend({
   },
 
   isVisible: function () {
-    return this.layer && this.map.hasLayer(this.layer)
+    return Boolean(this.layer && this.map.hasLayer(this.layer))
   },
 
   getFeatureByIndex: function (index) {

umap/static/umap/js/umap.popup.js

@@ -55,6 +55,7 @@ U.Popup.Panel = U.Popup.extend({
   },
 
   onAdd: function (map) {
+    map.panel.setDefaultMode('expanded')
     map.panel.open({
       content: this._content,
       actions: [U.Browser.backButton(map)],