umap-project 2.7.3__py3-none-any.whl → 2.8.0__py3-none-any.whl

umap/static/umap/js/modules/data/features.js

@@ -18,8 +18,9 @@ import {
 import loadPopup from '../rendering/popup.js'
 
 class Feature {
-  constructor(datalayer, geojson = {}, id = null) {
-    this.sync = datalayer.map.sync_engine.proxy(this)
+  constructor(umap, datalayer, geojson = {}, id = null) {
+    this._umap = umap
+    this.sync = umap.sync_engine.proxy(this)
     this._marked_for_deletion = false
     this._isDirty = false
     this._ui = null
@@ -69,10 +70,6 @@ class Feature {
     return this._ui
   }
 
-  get map() {
-    return this.datalayer?.map
-  }
-
   get center() {
     return this.ui.getCenter()
   }
@@ -139,7 +136,7 @@ class Feature {
       subject: 'feature',
       metadata: {
         id: this.id,
-        layerId: this.datalayer?.umap_id || null,
+        layerId: this.datalayer.id,
         featureType: this.getClassName(),
       },
     }
@@ -168,7 +165,9 @@ class Feature {
   }
 
   getSlug() {
-    return this.properties[this.map.getOption('slugKey') || 'name'] || ''
+    return (
+      this.properties[this._umap.getProperty('slugKey') || U.DEFAULT_LABEL_KEY] || ''
+    )
   }
 
   getPermalink() {
@@ -196,12 +195,13 @@ class Feature {
       return
     }
     // TODO deal with an event instead?
-    if (this.map.slideshow) {
-      this.map.slideshow.current = this
+    if (this._umap.slideshow) {
+      this._umap.slideshow.current = this
     }
-    this.map.currentFeature = this
-    this.attachPopup()
-    this.ui.openPopup(latlng || this.center)
+    this._umap.currentFeature = this
+    this.attachPopup().then(() => {
+      this.ui.openPopup(latlng || this.center)
+    })
   }
 
   render(fields) {
@@ -209,7 +209,7 @@ class Feature {
       return field.startsWith('properties.')
     })
     if (impactData) {
-      if (this.map.currentFeature === this) {
+      if (this._umap.currentFeature === this) {
         this.view()
       }
     }
@@ -217,7 +217,7 @@ class Feature {
   }
 
   edit(event) {
-    if (!this.map.editEnabled || this.isReadOnly()) return
+    if (!this._umap.editEnabled || this.isReadOnly()) return
     const container = DomUtil.create('div', 'umap-feature-container')
     DomUtil.createTitle(
       container,
@@ -237,15 +237,23 @@ class Feature {
     container.appendChild(builder.build())
 
     const properties = []
+    let labelKeyFound = undefined
     for (const property of this.datalayer._propertiesIndex) {
-      if (['name', 'description'].includes(property)) {
+      if (!labelKeyFound && U.LABEL_KEYS.includes(property)) {
+        labelKeyFound = property
+        continue
+      }
+      if (property === 'description') {
         continue
       }
       properties.push([`properties.${property}`, { label: property }])
     }
     // We always want name and description for now (properties management to come)
     properties.unshift('properties.description')
-    properties.unshift('properties.name')
+    if (!labelKeyFound) {
+      labelKeyFound = U.DEFAULT_LABEL_KEY
+    }
+    properties.unshift([`properties.${labelKeyFound}`, { label: labelKeyFound }])
     builder = new U.FormBuilder(this, properties, {
       id: 'umap-feature-properties',
     })
@@ -256,12 +264,12 @@ class Feature {
       translate('Advanced actions')
     )
     this.getAdvancedEditActions(advancedActions)
-    const onLoad = this.map.editPanel.open({ content: container })
+    const onLoad = this._umap.editPanel.open({ content: container })
     onLoad.then(() => {
-      builder.helpers['properties.name'].input.focus()
+      builder.helpers[`properties.${labelKeyFound}`].input.focus()
     })
-    this.map.editedFeature = this
-    if (!this.ui.isOnScreen(this.map.getBounds())) this.zoomTo(event)
+    this._umap.editedFeature = this
+    if (!this.ui.isOnScreen(this._umap._leafletMap.getBounds())) this.zoomTo(event)
   }
 
   getAdvancedEditActions(container) {
@@ -270,7 +278,7 @@ class Feature {
         <i class="icon icon-24 icon-delete"></i>${translate('Delete')}
       </button>`)
     button.addEventListener('click', () => {
-      this.confirmDelete().then(() => this.map.editPanel.close())
+      this.confirmDelete().then(() => this._umap.editPanel.close())
     })
     container.appendChild(button)
   }
@@ -319,21 +327,28 @@ class Feature {
 
   endEdit() {}
 
-  getDisplayName(fallback) {
-    if (fallback === undefined) fallback = this.datalayer.getName()
-    const key = this.getOption('labelKey') || 'name'
+  getDisplayName() {
+    const keys = U.LABEL_KEYS.slice() // Copy.
+    const labelKey = this.getOption('labelKey')
     // Variables mode.
-    if (U.Utils.hasVar(key))
-      return U.Utils.greedyTemplate(key, this.extendedProperties())
-    // Simple mode.
-    return this.properties[key] || this.properties.title || fallback
+    if (labelKey) {
+      if (Utils.hasVar(labelKey)) {
+        return Utils.greedyTemplate(labelKey, this.extendedProperties())
+      }
+      keys.unshift(labelKey)
+    }
+    for (const key of keys) {
+      const value = this.properties[key]
+      if (value) return value
+    }
+    return this.datalayer.getName()
   }
 
   hasPopupFooter() {
     if (this.datalayer.isRemoteLayer() && this.datalayer.options.remoteData.dynamic) {
       return false
     }
-    return this.map.getOption('displayPopupFooter')
+    return this._umap.getProperty('displayPopupFooter')
   }
 
   getPopupClass() {
@@ -341,13 +356,15 @@ class Feature {
     return loadPopup(this.getOption('popupShape') || old)
   }
 
-  attachPopup() {
+  async attachPopup() {
     const Class = this.getPopupClass()
-    this.ui.bindPopup(new Class(this))
+    const popup = new Class(this)
+    this.ui.bindPopup(popup)
+    return popup.loadContent()
   }
 
   async confirmDelete() {
-    const confirmed = await this.map.dialog.confirm(
+    const confirmed = await this._umap.dialog.confirm(
       translate('Are you sure you want to delete the feature?')
     )
     if (confirmed) {
@@ -359,7 +376,7 @@ class Feature {
 
   del(sync) {
     this.isDirty = true
-    this.map.closePopup()
+    this._umap._leafletMap.closePopup()
     if (this.datalayer) {
       this.datalayer.removeFeature(this, sync)
     }
@@ -417,34 +434,37 @@ class Feature {
     let value = fallback
     if (typeof this.staticOptions[option] !== 'undefined') {
       value = this.staticOptions[option]
-    } else if (U.Utils.usableOption(this.properties._umap_options, option)) {
+    } else if (Utils.usableOption(this.properties._umap_options, option)) {
       value = this.properties._umap_options[option]
     } else if (this.datalayer) {
       value = this.datalayer.getOption(option, this)
     } else {
-      value = this.map.getOption(option)
+      value = this._umap.getProperty(option)
     }
     return value
   }
 
-  getDynamicOption(option, fallback) {
-    let value = this.getOption(option, fallback)
+  getDynamicOption(key, fallback) {
+    let value = this.getOption(key, fallback)
     // There is a variable inside.
-    if (U.Utils.hasVar(value)) {
-      value = U.Utils.greedyTemplate(value, this.properties, true)
-      if (U.Utils.hasVar(value)) value = this.map.getDefaultOption(option)
+    if (Utils.hasVar(value)) {
+      value = Utils.greedyTemplate(value, this.properties, true)
+      if (Utils.hasVar(value)) value = SCHEMA[key]?.default
     }
     return value
   }
 
   zoomTo({ easing, latlng, callback } = {}) {
-    if (easing === undefined) easing = this.map.getOption('easing')
-    if (callback) this.map.once('moveend', callback.bind(this))
+    if (easing === undefined) easing = this._umap.getProperty('easing')
+    if (callback) this._umap._leafletMap.once('moveend', callback.bind(this))
     if (easing) {
-      this.map.flyTo(this.center, this.getBestZoom())
+      this._umap._leafletMap.flyTo(this.center, this.getBestZoom())
     } else {
       latlng = latlng || this.center
-      this.map.setView(latlng, this.getBestZoom() || this.map.getZoom())
+      this._umap._leafletMap.setView(
+        latlng,
+        this.getBestZoom() || this._umap._leafletMap.getZoom()
+      )
     }
   }
 
@@ -494,13 +514,9 @@ class Feature {
     return [U.ToggleEditAction, U.DeleteFeatureAction]
   }
 
-  getMap() {
-    return this.map
-  }
-
   isFiltered() {
     const filterKeys = this.datalayer.getFilterKeys()
-    const filter = this.map.browser.options.filter
+    const filter = this._umap.browser.options.filter
     if (filter && !this.matchFilter(filter, filterKeys)) return true
     if (!this.matchFacets()) return true
     return false
@@ -525,10 +541,10 @@ class Feature {
   }
 
   matchFacets() {
-    const selected = this.map.facets.selected
+    const selected = this._umap.facets.selected
     for (const [name, { type, min, max, choices }] of Object.entries(selected)) {
       let value = this.properties[name]
-      const parser = this.map.facets.getParser(type)
+      const parser = this._umap.facets.getParser(type)
       value = parser(value)
       switch (type) {
         case 'date':
@@ -562,10 +578,10 @@ class Feature {
 
   extendedProperties() {
     // Include context properties
-    const properties = this.map.getGeoContext()
+    const properties = this._umap.getGeoContext()
     const locale = L.getLocale()
     if (locale) properties.locale = locale
-    if (L.lang) properties.lang = L.lang
+    if (U.lang) properties.lang = U.lang
     properties.rank = this.getRank() + 1
     properties.layer = this.datalayer.getName()
     if (this.ui._map && this.hasGeom()) {
@@ -578,7 +594,7 @@ class Feature {
         properties.measure = this.ui.getMeasure()
       }
     }
-    return L.extend(properties, this.properties)
+    return Object.assign(properties, this.properties)
   }
 
   getRank() {
@@ -612,10 +628,10 @@ class Feature {
       label: translate('Copy as GeoJSON'),
       action: () => {
         L.Util.copyToClipboard(JSON.stringify(this.toGeoJSON()))
-        this.map.tooltip.open({ content: L._('✅ Copied!') })
+        this._umap.tooltip.open({ content: L._('✅ Copied!') })
       },
     })
-    if (this.map.editEnabled && !this.isReadOnly()) {
+    if (this._umap.editEnabled && !this.isReadOnly()) {
       items = items.concat(this.getContextMenuEditItems(event))
     }
     return items
@@ -623,7 +639,7 @@ class Feature {
 
   getContextMenuEditItems() {
     let items = ['-']
-    if (this.map.editedFeature !== this) {
+    if (this._umap.editedFeature !== this) {
       items.push({
         label: `${translate('Edit this feature')} (⇧+Click)`,
         action: () => this.edit(),
@@ -631,7 +647,7 @@ class Feature {
     }
     items = items.concat(
       {
-        label: this.map.help.displayLabel('EDIT_FEATURE_LAYER'),
+        label: this._umap.help.displayLabel('EDIT_FEATURE_LAYER'),
         action: () => this.datalayer.edit(),
       },
       {
@@ -645,11 +661,23 @@ class Feature {
     )
     return items
   }
+
+  isActive() {
+    return this._umap.activeFeature === this
+  }
+
+  activate() {
+    this._umap.activeFeature = this
+  }
+
+  deactivate() {
+    if (this._umap.activeFeature === this) this._umap.activeFeature = undefined
+  }
 }
 
 export class Point extends Feature {
-  constructor(datalayer, geojson, id) {
-    super(datalayer, geojson, id)
+  constructor(umap, datalayer, geojson, id) {
+    super(umap, datalayer, geojson, id)
     this.staticOptions = {
       mainColor: 'color',
       className: 'marker',
@@ -750,17 +778,17 @@ class Path extends Feature {
   }
 
   edit(event) {
-    if (this.map.editEnabled) {
+    if (this._umap.editEnabled) {
       super.edit(event)
       if (!this.ui.editEnabled()) this.ui.makeGeometryEditable()
     }
   }
 
   _toggleEditing(event) {
-    if (this.map.editEnabled) {
+    if (this._umap.editEnabled) {
       if (this.ui.editEnabled()) {
         this.endEdit()
-        this.map.editPanel.close()
+        this._umap.editPanel.close()
       } else {
         this.edit(event)
       }
@@ -786,7 +814,10 @@ class Path extends Feature {
   }
 
   getBestZoom() {
-    return this.getOption('zoomTo') || this.map.getBoundsZoom(this.bounds, true)
+    return (
+      this.getOption('zoomTo') ||
+      this._umap._leafletMap.getBoundsZoom(this.bounds, true)
+    )
   }
 
   endEdit() {
@@ -825,11 +856,14 @@ class Path extends Feature {
 
   zoomTo({ easing, callback }) {
     // Use bounds instead of centroid for paths.
-    easing = easing || this.map.getOption('easing')
+    easing = easing || this._umap.getProperty('easing')
     if (easing) {
-      this.map.flyToBounds(this.bounds, this.getBestZoom())
+      this._umap._leafletMap.flyToBounds(this.bounds, this.getBestZoom())
     } else {
-      this.map.fitBounds(this.bounds, this.getBestZoom() || this.map.getZoom())
+      this._umap._leafletMap.fitBounds(
+        this.bounds,
+        this.getBestZoom() || this._umap._leafletMap.getZoom()
+      )
     }
     if (callback) callback.call(this)
   }
@@ -840,7 +874,7 @@ class Path extends Feature {
       label: translate('Display measure'),
       action: () => Alert.info(this.ui.getMeasure()),
     })
-    if (this.map.editEnabled && !this.isReadOnly() && this.isMulti()) {
+    if (this._umap.editEnabled && !this.isReadOnly() && this.isMulti()) {
       items.push(...this.getContextMenuMultiItems(event))
     }
     return items
@@ -871,11 +905,14 @@ class Path extends Feature {
 
   getContextMenuEditItems(event) {
     const items = super.getContextMenuEditItems(event)
-    if (this.map?.editedFeature !== this && this.isSameClass(this.map.editedFeature)) {
+    if (
+      this._umap?.editedFeature !== this &&
+      this.isSameClass(this._umap.editedFeature)
+    ) {
       items.push({
         label: translate('Transfer shape to edited feature'),
         action: () => {
-          this.transferShape(event.latlng, this.map.editedFeature)
+          this.transferShape(event.latlng, this._umap.editedFeature)
         },
       })
     }
@@ -892,8 +929,8 @@ class Path extends Feature {
 }
 
 export class LineString extends Path {
-  constructor(datalayer, geojson, id) {
-    super(datalayer, geojson, id)
+  constructor(umap, datalayer, geojson, id) {
+    super(umap, datalayer, geojson, id)
     this.staticOptions = {
       stroke: true,
       fill: false,
@@ -977,8 +1014,8 @@ export class LineString extends Path {
     }
     const a = toMerge[0]
     const b = toMerge[1]
-    const p1 = this.map.latLngToContainerPoint(a[a.length - 1])
-    const p2 = this.map.latLngToContainerPoint(b[0])
+    const p1 = this._umap._leafletMap.latLngToContainerPoint(a[a.length - 1])
+    const p2 = this._umap._leafletMap.latLngToContainerPoint(b[0])
     const tolerance = 5 // px on screen
     if (Math.abs(p1.x - p2.x) <= tolerance && Math.abs(p1.y - p2.y) <= tolerance) {
       a.pop()
@@ -1022,7 +1059,7 @@ export class LineString extends Path {
         })
       } else if (index === 0 || index === event.vertex.getLastIndex()) {
         items.push({
-          label: this.map.help.displayLabel('CONTINUE_LINE'),
+          label: this._umap.help.displayLabel('CONTINUE_LINE'),
           action: () => event.vertex.continue(),
         })
       }
@@ -1038,11 +1075,16 @@ export class LineString extends Path {
     })
     return items
   }
+
+  extendedProperties() {
+    const [gain, loss] = this.ui.getElevation()
+    return Object.assign({ gain, loss }, super.extendedProperties())
+  }
 }
 
 export class Polygon extends Path {
-  constructor(datalayer, geojson, id) {
-    super(datalayer, geojson, id)
+  constructor(umap, datalayer, geojson, id) {
+    super(umap, datalayer, geojson, id)
     this.staticOptions = {
       mainColor: 'fillColor',
       className: 'polygon',