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

umap/static/umap/js/modules/rules.js

@@ -2,6 +2,7 @@ import { DomEvent, DomUtil, stamp } from '../../vendors/leaflet/leaflet-src.esm.
 import { translate } from './i18n.js'
 import * as Utils from './utils.js'
 import { AutocompleteDatalist } from './autocomplete.js'
+import Orderable from './orderable.js'
 
 const EMPTY_VALUES = ['', undefined, null]
 
@@ -21,10 +22,10 @@ class Rule {
 
   set isDirty(status) {
     this._isDirty = status
-    if (status) this.map.isDirty = status
+    if (status) this._umap.isDirty = status
   }
 
-  constructor(map, condition = '', options = {}) {
+  constructor(umap, condition = '', options = {}) {
     // TODO make this public properties when browser coverage is ok
     // cf https://caniuse.com/?search=public%20class%20field
     this._condition = null
@@ -37,14 +38,14 @@ class Rule {
       ['!=', this.not_equal],
       ['=', this.equal],
     ]
-    this.map = map
+    this._umap = umap
     this.active = true
     this.options = options
     this.condition = condition
   }
 
   render(fields) {
-    this.map.render(fields)
+    this._umap.render(fields)
   }
 
   equal(other) {
@@ -101,10 +102,6 @@ class Rule {
     return this.operator(this.cast(props[this.key]))
   }
 
-  getMap() {
-    return this.map
-  }
-
   getOption(option) {
     return this.options[option]
   }
@@ -136,7 +133,7 @@ class Rule {
     const defaultShapeProperties = DomUtil.add('div', '', container)
     defaultShapeProperties.appendChild(builder.build())
     const autocomplete = new AutocompleteDatalist(builder.helpers.condition.input)
-    const properties = this.map.allProperties()
+    const properties = this._umap.allProperties()
     autocomplete.suggestions = properties
     autocomplete.input.addEventListener('input', (event) => {
       const value = event.target.value
@@ -144,12 +141,12 @@ class Rule {
         autocomplete.suggestions = [`${value}=`, `${value}!=`, `${value}>`, `${value}<`]
       } else if (value.endsWith('=')) {
         const key = value.split('!')[0].split('=')[0]
-        autocomplete.suggestions = this.map
+        autocomplete.suggestions = this._umap
           .sortedValues(key)
           .map((str) => `${value}${str || ''}`)
       }
     })
-    this.map.editPanel.open({ content: container })
+    this._umap.editPanel.open({ content: container })
   }
 
   renderToolbox(row) {
@@ -176,7 +173,7 @@ class Rule {
       function () {
         if (!confirm(translate('Are you sure you want to delete this rule?'))) return
         this._delete()
-        this.map.editPanel.close()
+        this._umap.editPanel.close()
       },
       this
     )
@@ -186,27 +183,27 @@ class Rule {
     DomEvent.on(toggle, 'click', () => {
       this.active = !this.active
       row.classList.toggle('off', !this.active)
-      this.map.render(['rules'])
+      this._umap.render(['rules'])
     })
   }
 
   _delete() {
-    this.map.rules.rules = this.map.rules.rules.filter((rule) => rule !== this)
+    this._umap.rules.rules = this._umap.rules.rules.filter((rule) => rule !== this)
   }
 }
 
 export default class Rules {
-  constructor(map) {
-    this.map = map
+  constructor(umap) {
+    this._umap = umap
     this.rules = []
-    this.loadRules()
+    this.load()
   }
 
-  loadRules() {
-    if (!this.map.options.rules?.length) return
-    for (const { condition, options } of this.map.options.rules) {
+  load() {
+    if (!this._umap.properties.rules?.length) return
+    for (const { condition, options } of this._umap.properties.rules) {
       if (!condition) continue
-      this.rules.push(new Rule(this.map, condition, options))
+      this.rules.push(new Rule(this._umap, condition, options))
     }
   }
 
@@ -225,7 +222,7 @@ export default class Rules {
     else newIdx = referenceIdx + 1
     this.rules.splice(newIdx, 0, moved)
     moved.isDirty = true
-    this.map.render(['rules'])
+    this._umap.render(['rules'])
   }
 
   edit(container) {
@@ -236,21 +233,21 @@ export default class Rules {
         rule.renderToolbox(DomUtil.create('li', 'orderable', ul))
       }
 
-      const orderable = new U.Orderable(ul, this.onReorder.bind(this))
+      const orderable = new Orderable(ul, this.onReorder.bind(this))
     }
 
     DomUtil.createButton('umap-add', body, translate('Add rule'), this.addRule, this)
   }
 
   addRule() {
-    const rule = new Rule(this.map)
+    const rule = new Rule(this._umap)
     rule.isDirty = true
     this.rules.push(rule)
     rule.edit(map)
   }
 
   commit() {
-    this.map.options.rules = this.rules.map((rule) => {
+    this._umap.properties.rules = this.rules.map((rule) => {
       return {
         condition: rule.condition,
         options: rule.options,

umap/static/umap/js/modules/saving.js

@@ -0,0 +1,47 @@
+const _queue = new Set()
+
+export let isDirty = false
+
+export async function save() {
+  for (const obj of _queue) {
+    const ok = await obj.save()
+    if (!ok) break
+    remove(obj)
+  }
+}
+
+function add(obj) {
+  _queue.add(obj)
+  onUpdate()
+}
+
+function remove(obj) {
+  _queue.delete(obj)
+  onUpdate()
+}
+
+function has(obj) {
+  return _queue.has(obj)
+}
+
+function onUpdate() {
+  isDirty = Boolean(_queue.size)
+  document.body.classList.toggle('umap-is-dirty', isDirty)
+}
+
+export class ServerStored {
+  set isDirty(status) {
+    if (status) {
+      add(this)
+    } else {
+      remove(this)
+    }
+    this.onDirty(status)
+  }
+
+  get isDirty() {
+    return has(this)
+  }
+
+  onDirty(status) {}
+}

umap/static/umap/js/modules/schema.js

@@ -563,4 +563,9 @@ export const SCHEMA = {
     type: Object,
     impacts: ['data'],
   },
+
+  _referenceVersion: {
+    type: Number,
+    impacts: ['data'],
+  },
 }

umap/static/umap/js/modules/share.js

@@ -4,8 +4,8 @@ import { translate } from './i18n.js'
 import * as Utils from './utils.js'
 
 export default class Share {
-  constructor(map) {
-    this.map = map
+  constructor(umap) {
+    this._umap = umap
   }
 
   build() {
@@ -22,11 +22,11 @@ export default class Share {
       window.location.protocol + Utils.getBaseUrl()
     )
 
-    if (this.map.options.shortUrl) {
+    if (this._umap.properties.shortUrl) {
       DomUtil.createCopiableInput(
         this.container,
         translate('Short link'),
-        this.map.options.shortUrl
+        this._umap.properties.shortUrl
       )
     }
 
@@ -60,8 +60,8 @@ export default class Share {
       this.container,
       translate('All data and settings of the map')
     )
-    const downloadUrl = Utils.template(this.map.options.urls.map_download, {
-      map_id: this.map.options.umap_id,
+    const downloadUrl = this._umap.urls.get('map_download', {
+      map_id: this._umap.id,
     })
     const link = Utils.loadTemplate(`
       <div>
@@ -115,10 +115,11 @@ export default class Share {
       'queryString.captionBar',
       'queryString.captionMenus',
     ]
-    for (let i = 0; i < this.map.HIDDABLE_CONTROLS.length; i++) {
-      UIFields.push(`queryString.${this.map.HIDDABLE_CONTROLS[i]}Control`)
+    // TODO: move HIDDABLE_CONTROLS to SCHEMA ?
+    for (const name of this._umap._leafletMap.HIDDABLE_CONTROLS) {
+      UIFields.push(`queryString.${name}Control`)
     }
-    const iframeExporter = new IframeExporter(this.map)
+    const iframeExporter = new IframeExporter(this._umap)
     const buildIframeCode = () => {
       iframe.textContent = iframeExporter.build()
       exportUrl.value = window.location.protocol + iframeExporter.buildUrl()
@@ -136,13 +137,13 @@ export default class Share {
 
   open() {
     if (!this.container) this.build()
-    this.map.panel.open({ content: this.container })
+    this._umap.panel.open({ content: this.container })
   }
 
   async format(mode) {
     const type = EXPORT_FORMATS[mode]
-    const content = await type.formatter(this.map)
-    const filename = Utils.slugify(this.map.options.name) + type.ext
+    const content = await type.formatter(this._umap)
+    const filename = Utils.slugify(this._umap.properties.name) + type.ext
     return { content, filetype: type.filetype, filename }
   }
 
@@ -161,8 +162,8 @@ export default class Share {
 }
 
 class IframeExporter {
-  constructor(map) {
-    this.map = map
+  constructor(umap) {
+    this._umap = umap
     this.baseUrl = Utils.getBaseUrl()
     this.options = {
       includeFullScreenLink: true,
@@ -192,24 +193,20 @@ class IframeExporter {
       height: '300px',
     }
     // Use map default, not generic default
-    this.queryString.onLoadPanel = this.map.getOption('onLoadPanel')
-  }
-
-  getMap() {
-    return this.map
+    this.queryString.onLoadPanel = this._umap.getProperty('onLoadPanel')
   }
 
   buildUrl(options) {
     const datalayers = []
-    if (this.options.viewCurrentFeature && this.map.currentFeature) {
-      this.queryString.feature = this.map.currentFeature.getSlug()
+    if (this.options.viewCurrentFeature && this._umap.currentFeature) {
+      this.queryString.feature = this._umap.currentFeature.getSlug()
     } else {
       delete this.queryString.feature
     }
     if (this.options.keepCurrentDatalayers) {
-      this.map.eachDataLayer((datalayer) => {
-        if (datalayer.isVisible() && datalayer.umap_id) {
-          datalayers.push(datalayer.umap_id)
+      this._umap.eachDataLayer((datalayer) => {
+        if (datalayer.isVisible() && datalayer.createdOnServer) {
+          datalayers.push(datalayer.id)
         }
       })
       this.queryString.datalayers = datalayers.join(',')

umap/static/umap/js/modules/slideshow.js

@@ -13,26 +13,22 @@ const TOOLBOX_TEMPLATE = `
 `
 
 export default class Slideshow extends WithTemplate {
-  constructor(map, options) {
+  constructor(umap, leafletMap, properties) {
     super()
-    this.map = map
+    this._umap = umap
     this._id = null
     this.CLASSNAME = 'umap-slideshow-active'
-    this.setOptions(options)
+    this.load()
     this._current = null
 
-    if (this.options.autoplay) {
-      this.map.onceDataLoaded(function () {
+    if (this.properties.autoplay) {
+      this._umap.onceDataLoaded(function () {
         this.play()
       }, this)
     }
-    this.map.on(
-      'edit:enabled',
-      function () {
-        this.stop()
-      },
-      this
-    )
+    leafletMap.on('edit:enabled', () => {
+      this.stop()
+    })
   }
 
   set current(feature) {
@@ -54,22 +50,26 @@ export default class Slideshow extends WithTemplate {
     return this.current.getNext()
   }
 
-  setOptions(options) {
-    this.options = Object.assign(
+  load() {
+    this.setProperties(this._umap.properties.slideshow)
+  }
+
+  setProperties(properties = {}) {
+    this.properties = Object.assign(
       {
         delay: 5000,
         autoplay: false,
       },
-      options
+      properties
     )
   }
 
   defaultDatalayer() {
-    return this.map.findDataLayer((d) => d.canBrowse())
+    return this._umap.findDataLayer((d) => d.canBrowse())
   }
 
   startSpinner() {
-    const time = Number.parseInt(this.options.delay, 10)
+    const time = Number.parseInt(this.properties.delay, 10)
     if (!time) return
     const css = `rotation ${time / 1000}s infinite linear`
     const spinner = document.querySelector('.umap-slideshow-toolbox .play .spinner')
@@ -81,11 +81,15 @@ export default class Slideshow extends WithTemplate {
     spinner.style.animation = 'none'
   }
 
+  isEnabled() {
+    return Boolean(this.properties.active)
+  }
+
   play() {
     if (this._id) return
-    if (this.map.editEnabled || !this.map.options.slideshow.active) return
+    if (this._umap.editEnabled || !this.isEnabled()) return
     L.DomUtil.addClass(document.body, this.CLASSNAME)
-    this._id = window.setInterval(L.bind(this.loop, this), this.options.delay)
+    this._id = window.setInterval(L.bind(this.loop, this), this.properties.delay)
     this.startSpinner()
     this.loop()
   }
@@ -123,7 +127,7 @@ export default class Slideshow extends WithTemplate {
 
   step() {
     if (!this.current) return this.stop()
-    this.current.zoomTo({ easing: this.options.easing })
+    this.current.zoomTo({ easing: this.properties.easing })
     this.current.view()
   }
 

umap/static/umap/js/modules/sync/updaters.js

@@ -6,8 +6,8 @@ import { fieldInSchema } from '../utils.js'
  */
 
 class BaseUpdater {
-  constructor(map) {
-    this.map = map
+  constructor(umap) {
+    this._umap = umap
   }
 
   updateObjectValue(obj, key, value) {
@@ -32,8 +32,7 @@ class BaseUpdater {
   }
 
   getDataLayerFromID(layerId) {
-    if (layerId) return this.map.getDataLayerByUmapId(layerId)
-    return this.map.defaultEditDataLayer()
+    return this._umap.getDataLayerByUmapId(layerId)
   }
 
   applyMessage(payload) {
@@ -45,18 +44,17 @@ class BaseUpdater {
 export class MapUpdater extends BaseUpdater {
   update({ key, value }) {
     if (fieldInSchema(key)) {
-      this.updateObjectValue(this.map, key, value)
+      this.updateObjectValue(this._umap, key, value)
     }
 
-    this.map.render([key])
+    this._umap.render([key])
   }
 }
 
 export class DataLayerUpdater extends BaseUpdater {
   upsert({ value }) {
-    // Inserts does not happen (we use multiple updates instead).
-    this.map.createDataLayer(value, false)
-    this.map.render([])
+    // Upsert only happens when a new datalayer is created.
+    this._umap.createDataLayer(value, false)
   }
 
   update({ key, metadata, value }) {

umap/static/umap/js/modules/tableeditor.js

@@ -14,10 +14,11 @@ const TEMPLATE = `
 `
 
 export default class TableEditor extends WithTemplate {
-  constructor(datalayer) {
+  constructor(umap, datalayer, leafletMap) {
     super()
     this.datalayer = datalayer
-    this.map = this.datalayer.map
+    this._umap = umap
+    this._leafletMap = leafletMap
     this.contextmenu = new ContextMenu({ className: 'dark' })
     this.table = this.loadTemplate(TEMPLATE)
     if (!this.datalayer.isRemoteLayer()) {
@@ -36,20 +37,20 @@ export default class TableEditor extends WithTemplate {
   openHeaderMenu(property) {
     const actions = []
     let filterItem
-    if (this.map.facets.has(property)) {
+    if (this._umap.facets.has(property)) {
       filterItem = {
         label: translate('Remove filter for this column'),
         action: () => {
-          this.map.facets.remove(property)
-          this.map.browser.open('filters')
+          this._umap.facets.remove(property)
+          this._umap.browser.open('filters')
         },
       }
     } else {
       filterItem = {
         label: translate('Add filter for this column'),
         action: () => {
-          this.map.facets.add(property)
-          this.map.browser.open('filters')
+          this._umap.facets.add(property)
+          this._umap.browser.open('filters')
         },
       }
     }
@@ -86,8 +87,8 @@ export default class TableEditor extends WithTemplate {
   }
 
   renderBody() {
-    const bounds = this.map.getBounds()
-    const inBbox = this.map.browser.options.inBbox
+    const bounds = this._leafletMap.getBounds()
+    const inBbox = this._umap.browser.options.inBbox
     let html = ''
     this.datalayer.eachFeature((feature) => {
       if (feature.isFiltered()) return
@@ -104,7 +105,7 @@ export default class TableEditor extends WithTemplate {
   resetProperties() {
     this.properties = this.datalayer._propertiesIndex
     if (this.properties.length === 0) {
-      this.properties = ['name', 'description']
+      this.properties = [U.DEFAULT_LABEL_KEY, 'description']
     }
   }
 
@@ -121,7 +122,7 @@ export default class TableEditor extends WithTemplate {
   }
 
   renameProperty(property) {
-    this.map.dialog
+    this._umap.dialog
       .prompt(translate('Please enter the new name of this property'))
       .then(({ prompt }) => {
         if (!prompt || !this.validateName(prompt)) return
@@ -135,7 +136,7 @@ export default class TableEditor extends WithTemplate {
   }
 
   deleteProperty(property) {
-    this.map.dialog
+    this._umap.dialog
       .confirm(
         translate('Are you sure you want to delete this property on all the features?')
       )
@@ -150,7 +151,7 @@ export default class TableEditor extends WithTemplate {
   }
 
   addProperty() {
-    this.map.dialog
+    this._umap.dialog
       .prompt(translate('Please enter the name of the property'))
       .then(({ prompt }) => {
         if (!prompt || !this.validateName(prompt)) return
@@ -187,10 +188,10 @@ export default class TableEditor extends WithTemplate {
       <button class="flat" type="button" data-ref="filters">
         <i class="icon icon-16 icon-filters"></i>${translate('Filter data')}
       </button>`)
-    filterButton.addEventListener('click', () => this.map.browser.open('filters'))
+    filterButton.addEventListener('click', () => this._umap.browser.open('filters'))
     actions.push(filterButton)
 
-    this.map.fullPanel.open({
+    this._umap.fullPanel.open({
       content: this.table,
       className: 'umap-table-editor',
       actions: actions,
@@ -304,7 +305,7 @@ export default class TableEditor extends WithTemplate {
   deleteRows() {
     const selectedRows = this.getSelectedRows()
     if (!selectedRows.length) return
-    this.map.dialog
+    this._umap.dialog
       .confirm(
         translate('Found {count} rows. Are you sure you want to delete all?', {
           count: selectedRows.length,
@@ -320,9 +321,9 @@ export default class TableEditor extends WithTemplate {
         this.datalayer.show()
         this.datalayer.dataChanged()
         this.renderBody()
-        if (this.map.browser.isOpen()) {
-          this.map.browser.resetFilters()
-          this.map.browser.open('filters')
+        if (this._umap.browser.isOpen()) {
+          this._umap.browser.resetFilters()
+          this._umap.browser.open('filters')
         }
       })
   }