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

umap/static/umap/js/{umap.share.js → modules/share.js}

@@ -1,49 +1,11 @@
-U.Share = L.Class.extend({
-  EXPORT_TYPES: {
-    geojson: {
-      formatter: function (map) {
-        return JSON.stringify(map.toGeoJSON(), null, 2)
-      },
-      ext: '.geojson',
-      filetype: 'application/json',
-    },
-    gpx: {
-      formatter: function (map) {
-        return togpx(map.toGeoJSON())
-      },
-      ext: '.gpx',
-      filetype: 'application/gpx+xml',
-    },
-    kml: {
-      formatter: function (map) {
-        return tokml(map.toGeoJSON())
-      },
-      ext: '.kml',
-      filetype: 'application/vnd.google-earth.kml+xml',
-    },
-    csv: {
-      formatter: function (map) {
-        const table = []
-        map.eachFeature((feature) => {
-          const row = feature.toGeoJSON()['properties'],
-            center = feature.getCenter()
-          delete row['_umap_options']
-          row['Latitude'] = center.lat
-          row['Longitude'] = center.lng
-          table.push(row)
-        })
-        return csv2geojson.dsv.csvFormat(table)
-      },
-      ext: '.csv',
-      filetype: 'text/csv',
-    },
-  },
+import { EXPORT_FORMATS } from './formatter.js'
 
-  initialize: function (map) {
+export default class Share {
+  constructor(map) {
     this.map = map
-  },
+  }
 
-  build: function () {
+  build() {
     this.container = L.DomUtil.create('div', '')
     this.title = L.DomUtil.createTitle(
       this.container,
@@ -69,16 +31,10 @@ U.Share = L.Class.extend({
 
     L.DomUtil.add('h4', '', this.container, L._('Download'))
     L.DomUtil.add('small', 'label', this.container, L._("Only visible layers' data"))
-    for (const key in this.EXPORT_TYPES) {
-      if (this.EXPORT_TYPES.hasOwnProperty(key)) {
-        L.DomUtil.createButton(
-          'download-file',
-          this.container,
-          this.EXPORT_TYPES[key].name || key,
-          () => this.download(key),
-          this
-        )
-      }
+    for (const format of Object.keys(EXPORT_FORMATS)) {
+      L.DomUtil.createButton('download-file', this.container, format, () =>
+        this.download(format)
+      )
     }
     L.DomUtil.create('div', 'vspace', this.container)
     L.DomUtil.add(
@@ -141,7 +97,7 @@ U.Share = L.Class.extend({
     for (let i = 0; i < this.map.HIDDABLE_CONTROLS.length; i++) {
       UIFields.push(`queryString.${this.map.HIDDABLE_CONTROLS[i]}Control`)
     }
-    const iframeExporter = new U.IframeExporter(this.map)
+    const iframeExporter = new IframeExporter(this.map)
     const buildIframeCode = () => {
       iframe.textContent = iframeExporter.build()
       exportUrl.value = window.location.protocol + iframeExporter.buildUrl()
@@ -155,24 +111,24 @@ U.Share = L.Class.extend({
       L._('Embed and link options')
     )
     iframeOptions.appendChild(builder.build())
-  },
+  }
 
-  open: function () {
+  open() {
     if (!this.container) this.build()
     this.map.panel.open({ content: this.container })
-  },
+  }
 
-  format: function (mode) {
-    const type = this.EXPORT_TYPES[mode]
-    const content = type.formatter(this.map)
+  async format(mode) {
+    const type = EXPORT_FORMATS[mode]
+    const content = await type.formatter(this.map)
     let name = this.map.options.name || 'data'
     name = name.replace(/[^a-z0-9]/gi, '_').toLowerCase()
     const filename = name + type.ext
     return { content, filetype: type.filetype, filename }
-  },
+  }
 
-  download: function (mode) {
-    const { content, filetype, filename } = this.format(mode)
+  async download(mode) {
+    const { content, filetype, filename } = await this.format(mode)
     const blob = new Blob([content], { type: filetype })
     window.URL = window.URL || window.webkitURL
     const el = document.createElement('a')
@@ -182,50 +138,49 @@ U.Share = L.Class.extend({
     document.body.appendChild(el)
     el.click()
     document.body.removeChild(el)
-  },
-})
-
-U.IframeExporter = L.Evented.extend({
-  options: {
-    includeFullScreenLink: true,
-    currentView: false,
-    keepCurrentDatalayers: false,
-    viewCurrentFeature: false,
-  },
-
-  queryString: {
-    scaleControl: false,
-    miniMap: false,
-    scrollWheelZoom: false,
-    zoomControl: true,
-    editMode: 'disabled',
-    moreControl: true,
-    searchControl: null,
-    tilelayersControl: null,
-    embedControl: null,
-    datalayersControl: true,
-    onLoadPanel: 'none',
-    captionBar: false,
-    captionMenus: true,
-  },
+  }
+}
 
-  dimensions: {
-    width: '100%',
-    height: '300px',
-  },
-
-  initialize: function (map) {
+class IframeExporter {
+  constructor(map) {
     this.map = map
     this.baseUrl = U.Utils.getBaseUrl()
+    this.options = {
+      includeFullScreenLink: true,
+      currentView: false,
+      keepCurrentDatalayers: false,
+      viewCurrentFeature: false,
+    }
+
+    this.queryString = {
+      scaleControl: false,
+      miniMap: false,
+      scrollWheelZoom: false,
+      zoomControl: true,
+      editMode: 'disabled',
+      moreControl: true,
+      searchControl: null,
+      tilelayersControl: null,
+      embedControl: null,
+      datalayersControl: true,
+      onLoadPanel: 'none',
+      captionBar: false,
+      captionMenus: true,
+    }
+
+    this.dimensions = {
+      width: '100%',
+      height: '300px',
+    }
     // Use map default, not generic default
     this.queryString.onLoadPanel = this.map.getOption('onLoadPanel')
-  },
+  }
 
-  getMap: function () {
+  getMap() {
     return this.map
-  },
+  }
 
-  buildUrl: function (options) {
+  buildUrl(options) {
     const datalayers = []
     if (this.options.viewCurrentFeature && this.map.currentFeature) {
       this.queryString.feature = this.map.currentFeature.getSlug()
@@ -245,9 +200,9 @@ U.IframeExporter = L.Evented.extend({
     const currentView = this.options.currentView ? window.location.hash : ''
     const queryString = L.extend({}, this.queryString, options)
     return `${this.baseUrl}?${U.Utils.buildQueryString(queryString)}${currentView}`
-  },
+  }
 
-  build: function () {
+  build() {
     const iframeUrl = this.buildUrl()
     let code = `<iframe width="${this.dimensions.width}" height="${this.dimensions.height}" frameborder="0" allowfullscreen allow="geolocation" src="${iframeUrl}"></iframe>`
     if (this.options.includeFullScreenLink) {
@@ -255,5 +210,5 @@ U.IframeExporter = L.Evented.extend({
       code += `<p><a href="${fullUrl}">${L._('See full screen')}</a></p>`
     }
     return code
-  },
-})
+  }
+}

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

@@ -0,0 +1,141 @@
+import { WithTemplate } from './utils.js'
+import { translate } from './i18n.js'
+
+const TOOLBOX_TEMPLATE = `
+  <ul class="umap-slideshow-toolbox dark">
+    <li class="play" title="${translate('Start slideshow')}" data-ref="play">
+      <div class="spinner" style="animation: none;"></div>
+    </li>
+    <li class="stop" title="${translate('Stop slideshow')}" data-ref="stop"></li>
+    <li class="prev" title="${translate('Zoom to the previous')}" data-ref="previous"></li>
+    <li class="next" title="${translate('Zoom to the next')}" data-ref="next"></li>
+  </ul>
+`
+
+export default class Slideshow extends WithTemplate {
+  constructor(map, options) {
+    super()
+    this.map = map
+    this._id = null
+    this.CLASSNAME = 'umap-slideshow-active'
+    this.setOptions(options)
+    this._current = null
+
+    if (this.options.autoplay) {
+      this.map.onceDataLoaded(function () {
+        this.play()
+      }, this)
+    }
+    this.map.on(
+      'edit:enabled',
+      function () {
+        this.stop()
+      },
+      this
+    )
+  }
+
+  set current(feature) {
+    this._current = feature
+  }
+
+  get current() {
+    if (!this._current) {
+      const datalayer = this.defaultDatalayer()
+      if (datalayer) this._current = datalayer.getFeatureByIndex(0)
+    }
+    return this._current
+  }
+
+  get next() {
+    if (this._current === null) {
+      return this.current
+    }
+    return this.current.getNext()
+  }
+
+  setOptions(options) {
+    this.options = Object.assign(
+      {
+        delay: 5000,
+        autoplay: false,
+      },
+      options
+    )
+  }
+
+  defaultDatalayer() {
+    return this.map.findDataLayer((d) => d.canBrowse())
+  }
+
+  startSpinner() {
+    const time = Number.parseInt(this.options.delay, 10)
+    if (!time) return
+    const css = `rotation ${time / 1000}s infinite linear`
+    const spinner = document.querySelector('.umap-slideshow-toolbox .play .spinner')
+    spinner.style.animation = css
+  }
+
+  stopSpinner() {
+    const spinner = document.querySelector('.umap-slideshow-toolbox .play .spinner')
+    spinner.style.animation = 'none'
+  }
+
+  play() {
+    if (this._id) return
+    if (this.map.editEnabled || !this.map.options.slideshow.active) return
+    L.DomUtil.addClass(document.body, this.CLASSNAME)
+    this._id = window.setInterval(L.bind(this.loop, this), this.options.delay)
+    this.startSpinner()
+    this.loop()
+  }
+
+  loop() {
+    this.current = this.next
+    this.step()
+  }
+
+  pause() {
+    if (this._id) {
+      this.stopSpinner()
+      L.DomUtil.removeClass(document.body, this.CLASSNAME)
+      window.clearInterval(this._id)
+      this._id = null
+    }
+  }
+
+  stop() {
+    this.pause()
+    this.current = null
+  }
+
+  forward() {
+    this.pause()
+    this.current = this.next
+    this.step()
+  }
+
+  backward() {
+    this.pause()
+    if (this.current) this.current = this.current.getPrevious()
+    this.step()
+  }
+
+  step() {
+    if (!this.current) return this.stop()
+    this.current.zoomTo({ easing: this.options.easing })
+    this.current.view()
+  }
+
+  toggle() {
+    this._id ? this.pause() : this.play()
+  }
+
+  renderToolbox(container) {
+    container.appendChild(this.loadTemplate(TOOLBOX_TEMPLATE))
+    this.elements.play.addEventListener('click', this.toggle.bind(this))
+    this.elements.stop.addEventListener('click', this.stop.bind(this))
+    this.elements.previous.addEventListener('click', this.backward.bind(this))
+    this.elements.next.addEventListener('click', this.forward.bind(this))
+  }
+}

umap/static/umap/js/modules/sync/engine.js

@@ -1,5 +1,5 @@
+import { DataLayerUpdater, FeatureUpdater, MapUpdater } from './updaters.js'
 import { WebSocketTransport } from './websocket.js'
-import { MapUpdater, DataLayerUpdater, FeatureUpdater } from './updaters.js'
 
 export class SyncEngine {
   constructor(map) {
@@ -36,8 +36,8 @@ export class SyncEngine {
 
   // This method is called by the transport layer on new messages
   receive({ kind, ...payload }) {
-    if (kind == 'operation') {
-      let updater = this._getUpdater(payload.subject, payload.metadata)
+    if (kind === 'operation') {
+      const updater = this._getUpdater(payload.subject, payload.metadata)
       updater.applyMessage(payload)
     } else {
       throw new Error(`Unknown dispatch kind: ${kind}`)

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

@@ -35,7 +35,7 @@ class BaseUpdater {
   }
 
   applyMessage(payload) {
-    let { verb } = payload
+    const { verb } = payload
     return this[verb](payload)
   }
 }
@@ -69,7 +69,7 @@ export class FeatureUpdater extends BaseUpdater {
 
   // Create or update an object at a specific position
   upsert({ metadata, value }) {
-    let { id, layerId } = metadata
+    const { id, layerId } = metadata
     const datalayer = this.getDataLayerFromID(layerId)
     let feature = this.getFeatureFromMetadata(metadata, value)
 
@@ -84,17 +84,16 @@ export class FeatureUpdater extends BaseUpdater {
 
   // Update a property of an object
   update({ key, metadata, value }) {
-    let feature = this.getFeatureFromMetadata(metadata)
+    const feature = this.getFeatureFromMetadata(metadata)
     if (feature === undefined) {
       console.error(`Unable to find feature with id = ${metadata.id}.`)
     }
-    switch (key) {
-      case 'geometry':
-        const datalayer = this.getDataLayerFromID(metadata.layerId)
-        datalayer.geoJSONToLeaflet({ geometry: value, id: metadata.id, feature })
-      default:
-        this.updateObjectValue(feature, key, value)
-        feature.datalayer.indexProperties(feature)
+    if (key === 'geometry') {
+      const datalayer = this.getDataLayerFromID(metadata.layerId)
+      datalayer.geoJSONToLeaflet({ geometry: value, id: metadata.id, feature })
+    } else {
+      this.updateObjectValue(feature, key, value)
+      feature.datalayer.indexProperties(feature)
     }
 
     feature.render([key])
@@ -103,7 +102,7 @@ export class FeatureUpdater extends BaseUpdater {
   delete({ metadata }) {
     // XXX Distinguish between properties getting deleted
     // and the wole feature getting deleted
-    let feature = this.getFeatureFromMetadata(metadata)
+    const feature = this.getFeatureFromMetadata(metadata)
     if (feature) feature.del(false)
   }
 }

umap/static/umap/js/modules/sync/websocket.js

@@ -15,7 +15,7 @@ export class WebSocketTransport {
   send(kind, payload) {
     const message = { ...payload }
     message.kind = kind
-    let encoded = JSON.stringify(message)
+    const encoded = JSON.stringify(message)
     this.websocket.send(encoded)
   }