umap-project 2.4.1__py3-none-any.whl → 2.5.0__py3-none-any.whl

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

@@ -1,4 +1,4 @@
-import { DomUtil, DomEvent } from '../../../vendors/leaflet/leaflet-src.esm.js'
+import { DomEvent, DomUtil } from '../../../vendors/leaflet/leaflet-src.esm.js'
 import { translate } from '../i18n.js'
 
 export class Panel {
@@ -9,7 +9,7 @@ export class Panel {
     // This will be set once according to the panel configurated at load
     // or by using panels as popups
     this.mode = null
-    this.classname = 'left'
+    this.className = 'left'
     DomEvent.disableClickPropagation(this.container)
     DomEvent.on(this.container, 'contextmenu', DomEvent.stopPropagation) // Do not activate our custom context menu.
     DomEvent.on(this.container, 'wheel', DomEvent.stopPropagation)
@@ -25,9 +25,10 @@ export class Panel {
   }
 
   open({ content, className, actions = [] } = {}) {
-    this.container.className = `with-transition panel window ${this.classname} ${
+    this.container.className = `with-transition panel window ${this.className} ${
       this.mode || ''
     }`
+    document.body.classList.add(`panel-${this.className.split(' ')[0]}-on`)
     this.container.innerHTML = ''
     const actionsContainer = DomUtil.create('ul', 'buttons', this.container)
     const body = DomUtil.create('div', 'body', this.container)
@@ -69,6 +70,7 @@ export class Panel {
   }
 
   close() {
+    document.body.classList.remove(`panel-${this.className.split(' ')[0]}-on`)
     if (DomUtil.hasClass(this.container, 'on')) {
       DomUtil.removeClass(this.container, 'on')
       this.map.invalidateSize({ pan: false })
@@ -80,14 +82,14 @@ export class Panel {
 export class EditPanel extends Panel {
   constructor(map) {
     super(map)
-    this.classname = 'right dark'
+    this.className = 'right dark'
   }
 }
 
 export class FullPanel extends Panel {
   constructor(map) {
     super(map)
-    this.classname = 'full dark'
+    this.className = 'full dark'
     this.mode = 'expanded'
   }
 }

umap/static/umap/js/modules/ui/tooltip.js

@@ -1,8 +1,10 @@
-import { DomUtil, DomEvent } from '../../../vendors/leaflet/leaflet-src.esm.js'
+import { DomEvent, DomUtil } from '../../../vendors/leaflet/leaflet-src.esm.js'
 import { translate } from '../i18n.js'
+import { Positioned } from './base.js'
 
-export default class Tooltip {
+export default class Tooltip extends Positioned {
   constructor(parent) {
+    super()
     this.parent = parent
     this.container = DomUtil.create('div', 'with-transition', this.parent)
     this.container.id = 'umap-tooltip-container'
@@ -13,16 +15,8 @@ export default class Tooltip {
   }
 
   open(opts) {
-    function showIt() {
-      if (opts.anchor && opts.position === 'top') {
-        this.anchorTop(opts.anchor)
-      } else if (opts.anchor && opts.position === 'left') {
-        this.anchorLeft(opts.anchor)
-      } else if (opts.anchor && opts.position === 'bottom') {
-        this.anchorBottom(opts.anchor)
-      } else {
-        this.anchorAbsolute()
-      }
+    const showIt = () => {
+      this.openAt(opts)
       L.DomUtil.addClass(this.parent, 'umap-tooltip')
       this.container.innerHTML = U.Utils.escapeHTML(opts.content)
     }
@@ -34,48 +28,11 @@ export default class Tooltip {
     if (opts.anchor) {
       L.DomEvent.once(opts.anchor, 'mouseout', closeIt)
     }
-    if (opts.duration !== Infinity) {
+    if (opts.duration !== Number.POSITIVE_INFINITY) {
       window.setTimeout(closeIt, opts.duration || 3000)
     }
   }
 
-  anchorAbsolute() {
-    this.container.className = ''
-    const left =
-        this.parent.offsetLeft +
-        this.parent.clientWidth / 2 -
-        this.container.clientWidth / 2,
-      top = this.parent.offsetTop + 75
-    this.setPosition({ top: top, left: left })
-  }
-
-  anchorTop(el) {
-    this.container.className = 'tooltip-top'
-    const coords = this.getPosition(el)
-    this.setPosition({
-      left: coords.left - 10,
-      bottom: this.getDocHeight() - coords.top + 11,
-    })
-  }
-
-  anchorBottom(el) {
-    this.container.className = 'tooltip-bottom'
-    const coords = this.getPosition(el)
-    this.setPosition({
-      left: coords.left,
-      top: coords.bottom + 11,
-    })
-  }
-
-  anchorLeft(el) {
-    this.container.className = 'tooltip-left'
-    const coords = this.getPosition(el)
-    this.setPosition({
-      top: coords.top,
-      right: document.documentElement.offsetWidth - coords.left + 11,
-    })
-  }
-
   close(id) {
     // Clear timetout even if a new tooltip has been added
     // in the meantime. Eg. after a mouseout from the anchor.
@@ -86,31 +43,4 @@ export default class Tooltip {
     this.setPosition({})
     L.DomUtil.removeClass(this.parent, 'umap-tooltip')
   }
-
-  getPosition(el) {
-    return el.getBoundingClientRect()
-  }
-
-  setPosition(coords) {
-    if (coords.left) this.container.style.left = `${coords.left}px`
-    else this.container.style.left = 'initial'
-    if (coords.right) this.container.style.right = `${coords.right}px`
-    else this.container.style.right = 'initial'
-    if (coords.top) this.container.style.top = `${coords.top}px`
-    else this.container.style.top = 'initial'
-    if (coords.bottom) this.container.style.bottom = `${coords.bottom}px`
-    else this.container.style.bottom = 'initial'
-  }
-
-  getDocHeight() {
-    const D = document
-    return Math.max(
-      D.body.scrollHeight,
-      D.documentElement.scrollHeight,
-      D.body.offsetHeight,
-      D.documentElement.offsetHeight,
-      D.body.clientHeight,
-      D.documentElement.clientHeight
-    )
-  }
 }

umap/static/umap/js/modules/urls.js

@@ -10,9 +10,8 @@ export default class URLs {
 
     if (this.urls.hasOwnProperty(urlName)) {
       return template(this.urls[urlName], params)
-    } else {
-      throw `Unable to find a URL for route ${urlName}`
     }
+    throw `Unable to find a URL for route ${urlName}`
   }
 
   // Update if map_id is passed, create otherwise.

umap/static/umap/js/modules/utils.js

@@ -36,7 +36,7 @@ export function checkId(string) {
  */
 export function getImpactsFromSchema(fields, schema) {
   schema = schema || U.SCHEMA
-  let impacted = fields
+  const impacted = fields
     .map((field) => {
       // remove the option prefix for fields
       // And only keep the first part in case of a subfield
@@ -63,9 +63,8 @@ export function getImpactsFromSchema(fields, schema) {
 export default function getPurify() {
   if (typeof window === 'undefined') {
     return DOMPurifyInitializer(new global.JSDOM('').window)
-  } else {
-    return DOMPurifyInitializer(window)
   }
+  return DOMPurifyInitializer(window)
 }
 
 export function escapeHTML(s) {
@@ -114,13 +113,13 @@ export function escapeHTML(s) {
 
 export function toHTML(r, options) {
   if (!r) return ''
-  const target = (options && options.target) || 'blank'
+  const target = options?.target || 'blank'
 
   // unordered lists
   r = r.replace(/^\*\* (.*)/gm, '<ul><ul><li>$1</li></ul></ul>')
   r = r.replace(/^\* (.*)/gm, '<ul><li>$1</li></ul>')
   for (let ii = 0; ii < 3; ii++) {
-    r = r.replace(new RegExp(`</ul>(\r\n|\r|\n)<ul>`, 'g'), '')
+    r = r.replace(/<\/ul>(\r\n|\r|\n)<ul>/g, '')
   }
 
   // headings and hr
@@ -271,8 +270,8 @@ export function sortFeatures(features, sortKey, lang) {
   const sortKeys = (sortKey || 'name').split(',')
 
   const sort = (a, b, i) => {
-    let sortKey = sortKeys[i],
-      reverse = 1
+    let sortKey = sortKeys[i]
+    let reverse = 1
     if (sortKey[0] === '-') {
       reverse = -1
       sortKey = sortKey.substring(1)
@@ -315,19 +314,19 @@ export function getBaseUrl() {
 }
 
 export function hasVar(value) {
-  return typeof value === 'string' && value.indexOf('{') != -1
+  return typeof value === 'string' && value.indexOf('{') !== -1
 }
 
 export function isPath(value) {
-  return value && value.length && value.startsWith('/')
+  return value?.length && value.startsWith('/')
 }
 
 export function isRemoteUrl(value) {
-  return value && value.length && value.startsWith('http')
+  return value?.length && value.startsWith('http')
 }
 
 export function isDataImage(value) {
-  return value && value.length && value.startsWith('data:image')
+  return value?.length && value.startsWith('data:image')
 }
 
 /**
@@ -349,15 +348,16 @@ export function normalize(s) {
 
 // Vendorized from leaflet.utils
 // https://github.com/Leaflet/Leaflet/blob/108c6717b70f57c63645498f9bd66b6677758786/src/core/Util.js#L132-L151
-var templateRe = /\{ *([\w_ -]+) *\}/g
+const templateRe = /\{ *([\w_ -]+) *\}/g
 
 export function template(str, data) {
-  return str.replace(templateRe, function (str, key) {
-    var value = data[key]
+  return str.replace(templateRe, (str, key) => {
+    let value = data[key]
 
     if (value === undefined) {
-      throw new Error('No value provided for variable ' + str)
-    } else if (typeof value === 'function') {
+      throw new Error(`No value provided for variable ${str}`)
+    }
+    if (typeof value === 'function') {
       value = value(data)
     }
     return value
@@ -377,3 +377,23 @@ export function toggleBadge(element, value) {
   if (value) element.dataset.badge = value === true ? ' ' : value
   else delete element.dataset.badge
 }
+
+export function loadTemplate(html) {
+  const template = document.createElement('template')
+  template.innerHTML = html
+    .split('\n')
+    .map((line) => line.trim())
+    .join('')
+  return template.content.firstElementChild
+}
+
+export class WithTemplate {
+  loadTemplate(html) {
+    this.element = loadTemplate(html)
+    this.elements = {}
+    for (const element of this.element.querySelectorAll('[data-ref]')) {
+      this.elements[element.dataset.ref] = element
+    }
+    return this.element
+  }
+}

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

@@ -162,7 +162,7 @@ U.BaseFeatureAction = L.ToolbarAction.extend({
     this.postInit()
   },
 
-  postInit: function () {},
+  postInit: () => {},
 
   hideToolbar: function () {
     this.map.removeLayer(this.toolbar)
@@ -356,7 +356,7 @@ U.DropControl = L.Class.extend({
     this.dropzone.classList.add('umap-dragover')
   },
 
-  dragover: function (e) {
+  dragover: (e) => {
     L.DomEvent.stop(e)
   },
 
@@ -393,7 +393,7 @@ U.EditControl = L.Control.extend({
     L.DomEvent.on(
       enableEditing,
       'mouseover',
-      function () {
+      () => {
         map.tooltip.open({
           content: map.help.displayLabel('TOGGLE_EDIT'),
           anchor: enableEditing,
@@ -434,9 +434,9 @@ U.MoreControls = L.Control.extend({
   },
 
   toggle: function () {
-    const pos = this.getPosition(),
-      corner = this._map._controlCorners[pos],
-      className = 'umap-more-controls'
+    const pos = this.getPosition()
+    const corner = this._map._controlCorners[pos]
+    const className = 'umap-more-controls'
     if (L.DomUtil.hasClass(corner, className)) L.DomUtil.removeClass(corner, className)
     else L.DomUtil.addClass(corner, className)
   },
@@ -454,10 +454,10 @@ U.PermanentCreditsControl = L.Control.extend({
 
   onAdd: function () {
     const paragraphContainer = L.DomUtil.create(
-        'div',
-        'umap-permanent-credits-container'
-      ),
-      creditsParagraph = L.DomUtil.create('p', '', paragraphContainer)
+      'div',
+      'umap-permanent-credits-container'
+    )
+    const creditsParagraph = L.DomUtil.create('p', '', paragraphContainer)
 
     this.paragraphContainer = paragraphContainer
     this.setCredits()
@@ -503,7 +503,7 @@ L.Control.Button = L.Control.extend({
     return container
   },
 
-  afterAdd: function (container) {},
+  afterAdd: (container) => {},
 })
 
 U.DataLayersControl = L.Control.Button.extend({
@@ -745,13 +745,13 @@ const ControlsMixin = {
       L.DomUtil.createLink(
         'umap-user',
         rightContainer,
-        L._(`My Dashboard ({username})`, {
+        L._('My Dashboard ({username})', {
           username: this.options.user.name,
         }),
         this.options.user.url
       )
     }
-    this.help.link(rightContainer, 'edit')
+    this.help.getStartedLink(rightContainer)
     const controlEditCancel = L.DomUtil.createButton(
       'leaflet-control-edit-cancel',
       rightContainer,
@@ -832,10 +832,10 @@ const ControlsMixin = {
       row.dataset.id = L.stamp(datalayer)
     })
     const onReorder = (src, dst, initialIndex, finalIndex) => {
-      const layer = this.datalayers[src.dataset.id],
-        other = this.datalayers[dst.dataset.id],
-        minIndex = Math.min(layer.getRank(), other.getRank()),
-        maxIndex = Math.max(layer.getRank(), other.getRank())
+      const layer = this.datalayers[src.dataset.id]
+      const other = this.datalayers[dst.dataset.id]
+      const minIndex = Math.min(layer.getRank(), other.getRank())
+      const maxIndex = Math.max(layer.getRank(), other.getRank())
       if (finalIndex === 0) layer.bringToTop()
       else if (finalIndex > initialIndex) layer.insertBefore(other)
       else layer.insertAfter(other)
@@ -948,10 +948,10 @@ U.TileLayerChooser = L.Control.extend({
   },
 
   addTileLayerElement: function (tilelayer, options) {
-    const selectedClass = this.map.hasLayer(tilelayer) ? 'selected' : '',
-      el = L.DomUtil.create('li', selectedClass, this._tilelayers_container),
-      img = L.DomUtil.create('img', '', el),
-      name = L.DomUtil.create('div', '', el)
+    const selectedClass = this.map.hasLayer(tilelayer) ? 'selected' : ''
+    const el = L.DomUtil.create('li', selectedClass, this._tilelayers_container)
+    const img = L.DomUtil.create('img', '', el)
+    const name = L.DomUtil.create('div', '', el)
     img.src = U.Utils.template(tilelayer.options.url_template, this.map.demoTileInfos)
     img.loading = 'lazy'
     name.textContent = tilelayer.options.name
@@ -961,7 +961,7 @@ U.TileLayerChooser = L.Control.extend({
       function () {
         this.map.selectTileLayer(tilelayer)
         this.map._controls.tilelayers.setLayers()
-        if (options && options.callback) options.callback(tilelayer)
+        if (options?.callback) options.callback(tilelayer)
       },
       this
     )
@@ -982,8 +982,8 @@ U.AttributionControl = L.Control.Attribution.extend({
     this._container.innerHTML = ''
     const container = L.DomUtil.create('div', 'attribution-container', this._container)
     container.innerHTML = credits
-    const shortCredit = this._map.getOption('shortCredit'),
-      captionMenus = this._map.getOption('captionMenus')
+    const shortCredit = this._map.getOption('shortCredit')
+    const captionMenus = this._map.getOption('captionMenus')
     if (shortCredit) {
       L.DomUtil.element({
         tagName: 'span',
@@ -1205,9 +1205,7 @@ L.Control.MiniMap.include({
     this._miniMap.addLayer(this._layer)
   },
 
-  _cloneLayer: function (layer) {
-    return new L.TileLayer(layer._url, L.Util.extend({}, layer.options))
-  },
+  _cloneLayer: (layer) => new L.TileLayer(layer._url, L.Util.extend({}, layer.options)),
 })
 
 L.Control.Loading.include({
@@ -1312,7 +1310,7 @@ U.Editable = L.Editable.extend({
   },
 
   drawingTooltip: function (e) {
-    if (e.layer instanceof L.Marker && e.type == 'editable:drawing:start') {
+    if (e.layer instanceof L.Marker && e.type === 'editable:drawing:start') {
       this.map.tooltip.open({ content: L._('Click to add a marker') })
     }
     if (!(e.layer instanceof L.Polyline)) {
@@ -1364,7 +1362,7 @@ U.Editable = L.Editable.extend({
     this.map.ui.closeTooltip()
   },
 
-  onVertexRawClick: function (e) {
+  onVertexRawClick: (e) => {
     e.layer.onVertexRawClick(e)
     L.DomEvent.stop(e)
     e.cancel()

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

@@ -1,4 +1,4 @@
-L.Util.copyToClipboard = function (textToCopy) {
+L.Util.copyToClipboard = (textToCopy) => {
   // https://stackoverflow.com/a/65996386
   // Navigator clipboard api needs a secure context (https)
   if (navigator.clipboard && window.isSecureContext) {
@@ -25,10 +25,10 @@ L.Util.copyToClipboard = function (textToCopy) {
   }
 }
 
-L.Util.queryString = function (name, fallback) {
+L.Util.queryString = (name, fallback) => {
   const decode = (s) => decodeURIComponent(s.replace(/\+/g, ' '))
-  const qs = window.location.search.slice(1).split('&'),
-    qa = {}
+  const qs = window.location.search.slice(1).split('&')
+  const qa = {}
   for (const i in qs) {
     const key = qs[i].split('=')
     if (!key) continue
@@ -37,27 +37,27 @@ L.Util.queryString = function (name, fallback) {
   return qa[name] || fallback
 }
 
-L.Util.booleanFromQueryString = function (name) {
+L.Util.booleanFromQueryString = (name) => {
   const value = L.Util.queryString(name)
   return value === '1' || value === 'true'
 }
 
-L.Util.setFromQueryString = function (options, name) {
+L.Util.setFromQueryString = (options, name) => {
   const value = L.Util.queryString(name)
   if (typeof value !== 'undefined') options[name] = value
 }
 
-L.Util.setBooleanFromQueryString = function (options, name) {
+L.Util.setBooleanFromQueryString = (options, name) => {
   const value = L.Util.queryString(name)
-  if (typeof value !== 'undefined') options[name] = value == '1' || value == 'true'
+  if (typeof value !== 'undefined') options[name] = value === '1' || value === 'true'
 }
 
-L.Util.setNumberFromQueryString = function (options, name) {
+L.Util.setNumberFromQueryString = (options, name) => {
   const value = +L.Util.queryString(name)
-  if (!isNaN(value)) options[name] = value
+  if (!Number.isNaN(value)) options[name] = value
 }
 
-L.Util.setNullableBooleanFromQueryString = function (options, name) {
+L.Util.setNullableBooleanFromQueryString = (options, name) => {
   let value = L.Util.queryString(name)
   if (typeof value !== 'undefined') {
     if (value === 'null') value = null
@@ -192,7 +192,7 @@ L.DomUtil.after = (target, el) => {
 // convert colour in range 0-255 to the modifier used within luminance calculation
 L.DomUtil.colourMod = (colour) => {
   const sRGB = colour / 255
-  let mod = Math.pow((sRGB + 0.055) / 1.055, 2.4)
+  let mod = ((sRGB + 0.055) / 1.055) ** 2.4
   if (sRGB < 0.03928) mod = sRGB / 12.92
   return mod
 }
@@ -222,7 +222,11 @@ L.DomUtil.contrastedColor = (el, bgcolor) => {
   let rgb = window.getComputedStyle(el).getPropertyValue('background-color')
   rgb = L.DomUtil.RGBRegex.exec(rgb)
   if (!rgb || rgb.length !== 4) return out
-  rgb = [parseInt(rgb[1], 10), parseInt(rgb[2], 10), parseInt(rgb[3], 10)]
+  rgb = [
+    Number.parseInt(rgb[1], 10),
+    Number.parseInt(rgb[2], 10),
+    Number.parseInt(rgb[3], 10),
+  ]
   out = L.DomUtil.contrastWCAG21(rgb)
   if (bgcolor) _CACHE_CONSTRAST[bgcolor] = out
   return out
@@ -247,9 +251,9 @@ L.DomEvent.once = (el, types, fn, context) => {
 
 L.LatLng.prototype.isValid = function () {
   return (
-    isFinite(this.lat) &&
+    Number.isFinite(this.lat) &&
     Math.abs(this.lat) <= 90 &&
-    isFinite(this.lng) &&
+    Number.isFinite(this.lng) &&
     Math.abs(this.lng) <= 180
   )
 }

umap/static/umap/js/umap.datalayer.permissions.js

@@ -7,15 +7,12 @@ U.DataLayerPermissions = L.Class.extend({
     this.options = L.Util.setOptions(this, datalayer.options.permissions)
     this.datalayer = datalayer
     let isDirty = false
-    const self = this
     try {
       Object.defineProperty(this, 'isDirty', {
-        get: function () {
-          return isDirty
-        },
-        set: function (status) {
+        get: () => isDirty,
+        set: (status) => {
           isDirty = status
-          if (status) self.datalayer.isDirty = status
+          if (status) this.datalayer.isDirty = status
         },
       })
     } catch (e) {
@@ -29,19 +26,19 @@ U.DataLayerPermissions = L.Class.extend({
 
   edit: function (container) {
     const fields = [
-        [
-          'options.edit_status',
-          {
-            handler: 'IntSelect',
-            label: L._('Who can edit "{layer}"', { layer: this.datalayer.getName() }),
-            selectOptions: this.datalayer.map.options.datalayer_edit_statuses,
-          },
-        ],
+      [
+        'options.edit_status',
+        {
+          handler: 'IntSelect',
+          label: L._('Who can edit "{layer}"', { layer: this.datalayer.getName() }),
+          selectOptions: this.datalayer.map.options.datalayer_edit_statuses,
+        },
       ],
-      builder = new U.FormBuilder(this, fields, {
-        className: 'umap-form datalayer-permissions',
-      }),
-      form = builder.build()
+    ]
+    const builder = new U.FormBuilder(this, fields, {
+      className: 'umap-form datalayer-permissions',
+    })
+    const form = builder.build()
     container.appendChild(form)
   },