umap-project 2.0.4__py3-none-any.whl → 2.1.1__py3-none-any.whl

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

@@ -340,15 +340,6 @@ L.FormBuilder.TextColorPicker = L.FormBuilder.ColorPicker.extend({
   ],
 })
 
-L.FormBuilder.IconClassSwitcher = L.FormBuilder.Select.extend({
-  selectOptions: [
-    ['Default', L._('Default')],
-    ['Circle', L._('Circle')],
-    ['Drop', L._('Drop')],
-    ['Ball', L._('Ball')],
-  ],
-})
-
 L.FormBuilder.ProxyTTLSelect = L.FormBuilder.Select.extend({
   selectOptions: [
     [undefined, L._('No cache')],
@@ -358,24 +349,6 @@ L.FormBuilder.ProxyTTLSelect = L.FormBuilder.Select.extend({
   ],
 })
 
-L.FormBuilder.PopupShape = L.FormBuilder.Select.extend({
-  selectOptions: [
-    ['Default', L._('Popup')],
-    ['Large', L._('Popup (large)')],
-    ['Panel', L._('Side panel')],
-  ],
-})
-
-L.FormBuilder.PopupContent = L.FormBuilder.Select.extend({
-  selectOptions: [
-    ['Default', L._('Default')],
-    ['Table', L._('Table')],
-    ['GeoRSSImage', L._('GeoRSS (title + image)')],
-    ['GeoRSSLink', L._('GeoRSS (only link)')],
-    ['OSM', L._('OpenStreetMap')],
-  ],
-})
-
 L.FormBuilder.LayerTypeChooser = L.FormBuilder.Select.extend({
   getOptions: function () {
     const layer_classes = [
@@ -427,24 +400,6 @@ L.FormBuilder.DataLayerSwitcher = L.FormBuilder.Select.extend({
   },
 })
 
-L.FormBuilder.DefaultView = L.FormBuilder.Select.extend({
-  selectOptions: [
-    ['center', L._('Saved center and zoom')],
-    ['data', L._('Fit all data')],
-    ['latest', L._('Latest feature')],
-    ['locate', L._('User location')],
-  ],
-})
-
-L.FormBuilder.OnLoadPanel = L.FormBuilder.Select.extend({
-  selectOptions: [
-    ['none', L._('None')],
-    ['caption', L._('Caption')],
-    ['databrowser', L._('Data browser')],
-    ['facet', L._('Facet search')],
-  ],
-})
-
 L.FormBuilder.DataFormat = L.FormBuilder.Select.extend({
   selectOptions: [
     [undefined, L._('Choose the data format')],
@@ -457,16 +412,6 @@ L.FormBuilder.DataFormat = L.FormBuilder.Select.extend({
   ],
 })
 
-L.FormBuilder.LabelDirection = L.FormBuilder.Select.extend({
-  selectOptions: [
-    ['auto', L._('Automatic')],
-    ['left', L._('On the left')],
-    ['right', L._('On the right')],
-    ['top', L._('On the top')],
-    ['bottom', L._('On the bottom')],
-  ],
-})
-
 L.FormBuilder.LicenceChooser = L.FormBuilder.Select.extend({
   getOptions: function () {
     const licences = []
@@ -708,7 +653,7 @@ L.FormBuilder.IconUrl = L.FormBuilder.BlurInput.extend({
   },
 
   isDefault: function () {
-    return !this.value() || this.value() === U.DEFAULT_ICON_URL
+    return !this.value() || this.value() === U.SCHEMA.iconUrl.default
   },
 
   addGrid: function (onSearch) {
@@ -905,7 +850,7 @@ L.FormBuilder.TernaryChoices = L.FormBuilder.MultiChoice.extend({
   },
 })
 
-L.FormBuilder.ControlChoice = L.FormBuilder.TernaryChoices.extend({
+L.FormBuilder.NullableChoices = L.FormBuilder.TernaryChoices.extend({
   choices: [
     [true, L._('always')],
     [false, L._('never')],
@@ -913,17 +858,7 @@ L.FormBuilder.ControlChoice = L.FormBuilder.TernaryChoices.extend({
   ],
 })
 
-L.FormBuilder.LabelChoice = L.FormBuilder.TernaryChoices.extend({
-  default: false,
-
-  choices: [
-    [true, L._('always')],
-    [false, L._('never')],
-    ['null', L._('on hover')],
-  ],
-})
-
-L.FormBuilder.DataLayersControl = L.FormBuilder.ControlChoice.extend({
+L.FormBuilder.DataLayersControl = L.FormBuilder.TernaryChoices.extend({
   choices: [
     [true, L._('collapsed')],
     ['expanded', L._('expanded')],
@@ -934,21 +869,11 @@ L.FormBuilder.DataLayersControl = L.FormBuilder.ControlChoice.extend({
   toJS: function () {
     let value = this.value()
     if (value !== 'expanded')
-      value = L.FormBuilder.ControlChoice.prototype.toJS.call(this)
+      value = L.FormBuilder.TernaryChoices.prototype.toJS.call(this)
     return value
   },
 })
 
-L.FormBuilder.OutlinkTarget = L.FormBuilder.MultiChoice.extend({
-  default: 'blank',
-
-  choices: [
-    ['blank', L._('new window')],
-    ['self', L._('iframe')],
-    ['parent', L._('parent window')],
-  ],
-})
-
 L.FormBuilder.Range = L.FormBuilder.FloatInput.extend({
   type: function () {
     return 'range'
@@ -1052,230 +977,55 @@ U.FormBuilder = L.FormBuilder.extend({
     className: 'umap-form',
   },
 
-  defaultOptions: {
-    name: { label: L._('name') },
-    description: {
-      label: L._('description'),
-      handler: 'Textarea',
-      helpEntries: 'textFormatting',
-    },
-    color: {
-      handler: 'ColorPicker',
-      label: L._('color'),
-      helpEntries: 'colorValue',
-      inheritable: true,
-    },
-    iconOpacity: {
-      handler: 'Range',
-      min: 0.1,
-      max: 1,
-      step: 0.1,
-      label: L._('icon opacity'),
-      inheritable: true,
-    },
-    opacity: {
-      handler: 'Range',
-      min: 0.1,
-      max: 1,
-      step: 0.1,
-      label: L._('opacity'),
-      inheritable: true,
-    },
-    stroke: {
-      handler: 'Switch',
-      label: L._('stroke'),
-      helpEntries: 'stroke',
-      inheritable: true,
-    },
-    weight: {
-      handler: 'Range',
-      min: 1,
-      max: 20,
-      step: 1,
-      label: L._('weight'),
-      inheritable: true,
-    },
-    fill: {
-      handler: 'Switch',
-      label: L._('fill'),
-      helpEntries: 'fill',
-      inheritable: true,
-    },
-    fillColor: {
-      handler: 'ColorPicker',
-      label: L._('fill color'),
-      helpEntries: 'fillColor',
-      inheritable: true,
-    },
-    fillOpacity: {
-      handler: 'Range',
-      min: 0.1,
-      max: 1,
-      step: 0.1,
-      label: L._('fill opacity'),
-      inheritable: true,
-    },
-    smoothFactor: {
-      handler: 'Range',
-      min: 0,
-      max: 10,
-      step: 0.5,
-      label: L._('Simplify'),
-      helpEntries: 'smoothFactor',
-      inheritable: true,
-    },
-    dashArray: {
-      label: L._('dash array'),
-      helpEntries: 'dashArray',
-      inheritable: true,
-    },
-    iconClass: {
-      handler: 'IconClassSwitcher',
-      label: L._('Icon shape'),
-      inheritable: true,
-    },
-    iconUrl: {
-      handler: 'IconUrl',
-      label: L._('Icon symbol'),
-      inheritable: true,
-      helpText: U.Help.formatIconSymbol,
-    },
-    popupShape: { handler: 'PopupShape', label: L._('Popup shape'), inheritable: true },
-    popupTemplate: {
-      handler: 'PopupContent',
-      label: L._('Popup content style'),
-      inheritable: true,
-    },
-    popupContentTemplate: {
-      label: L._('Popup content template'),
-      handler: 'Textarea',
-      helpEntries: ['dynamicProperties', 'textFormatting'],
-      placeholder: '# {name}',
-      inheritable: true,
-    },
-    datalayer: {
-      handler: 'DataLayerSwitcher',
-      label: L._('Choose the layer of the feature'),
-    },
-    moreControl: {
-      handler: 'Switch',
-      label: L._('Do you want to display the «more» control?'),
-    },
-    scrollWheelZoom: { handler: 'Switch', label: L._('Allow scroll wheel zoom?') },
-    miniMap: { handler: 'Switch', label: L._('Do you want to display a minimap?') },
-    scaleControl: {
-      handler: 'Switch',
-      label: L._('Do you want to display the scale control?'),
-    },
-    onLoadPanel: {
-      handler: 'OnLoadPanel',
-      label: L._('Do you want to display a panel on load?'),
-    },
-    defaultView: {
-      handler: 'DefaultView',
-      label: L._('Default view'),
-    },
-    displayPopupFooter: {
-      handler: 'Switch',
-      label: L._('Do you want to display popup footer?'),
-    },
-    captionBar: {
-      handler: 'Switch',
-      label: L._('Do you want to display a caption bar?'),
-    },
-    captionMenus: {
-      handler: 'Switch',
-      label: L._('Do you want to display caption menus?'),
-    },
-    zoomTo: {
-      handler: 'IntInput',
-      placeholder: L._('Inherit'),
-      helpEntries: 'zoomTo',
-      label: L._('Default zoom level'),
-      inheritable: true,
-    },
-    showLabel: {
-      handler: 'LabelChoice',
-      label: L._('Display label'),
-      inheritable: true,
-    },
-    labelDirection: {
-      handler: 'LabelDirection',
-      label: L._('Label direction'),
-      inheritable: true,
-    },
-    labelInteractive: {
-      handler: 'Switch',
-      label: L._('Labels are clickable'),
-      inheritable: true,
-    },
-    outlink: {
-      label: L._('Link to…'),
-      helpEntries: 'outlink',
-      placeholder: 'http://...',
-      inheritable: true,
-    },
-    outlinkTarget: {
-      handler: 'OutlinkTarget',
-      label: L._('Open link in…'),
-      inheritable: true,
-    },
-    labelKey: {
-      helpEntries: 'labelKey',
-      placeholder: L._('Default: name'),
-      label: L._('Label key'),
-      inheritable: true,
-    },
-    zoomControl: { handler: 'ControlChoice', label: L._('Display the zoom control') },
-    searchControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the search control'),
-    },
-    fullscreenControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the fullscreen control'),
-    },
-    embedControl: { handler: 'ControlChoice', label: L._('Display the embed control') },
-    locateControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the locate control'),
-    },
-    measureControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the measure control'),
-    },
-    tilelayersControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the tile layers control'),
-    },
-    editinosmControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the control to open OpenStreetMap editor'),
-    },
-    datalayersControl: {
-      handler: 'DataLayersControl',
-      label: L._('Display the data layers control'),
-    },
-    starControl: {
-      handler: 'ControlChoice',
-      label: L._('Display the star map button'),
-    },
-    fromZoom: {
-      handler: 'IntInput',
-      label: L._('From zoom'),
-      helpText: L._('Optional.'),
-    },
-    toZoom: { handler: 'IntInput', label: L._('To zoom'), helpText: L._('Optional.') },
-    interactive: {
-      handler: 'Switch',
-      label: L._('Allow interactions'),
-      helpEntries: 'interactive',
-      inheritable: true,
-    },
+  computeDefaultOptions: function () {
+    for (let [key, schema] of Object.entries(U.SCHEMA)) {
+      if (schema.type === Boolean) {
+        if (schema.nullable) schema.handler = 'NullableChoices'
+        else schema.handler = 'Switch'
+      } else if (schema.type === 'Text') {
+        schema.handler = 'Textarea'
+      } else if (schema.type === Number) {
+        if (schema.step) schema.handler = 'Range'
+        else schema.handler = 'IntInput'
+      } else if (schema.choices) {
+        const text_length = schema.choices.reduce(
+          (acc, [value, label]) => acc + label.length,
+          0
+        )
+        // Try to be smart and use MultiChoice only
+        // for choices where labels are shorts…
+        if (text_length < 40) {
+          schema.handler = 'MultiChoice'
+        } else {
+          schema.handler = 'Select'
+          schema.selectOptions = schema.choices
+        }
+      } else {
+        switch (key) {
+          case 'color':
+          case 'fillColor':
+            schema.handler = 'ColorPicker'
+            break
+          case 'iconUrl':
+            schema.handler = 'IconUrl'
+            break
+          case 'datalayersControl':
+            schema.handler = 'DataLayersControl'
+            break
+          case 'licence':
+            schema.handler = 'LicenceChooser'
+            break
+        }
+      }
+      // FormBuilder use this key for the input type itself
+      delete schema.type
+      this.defaultOptions[key] = schema
+    }
   },
 
   initialize: function (obj, fields, options) {
     this.map = obj.map || obj.getMap()
+    this.computeDefaultOptions()
     L.FormBuilder.prototype.initialize.call(this, obj, fields, options)
     this.on('finish', this.finish)
   },

umap/static/umap/js/umap.icon.js

@@ -19,7 +19,7 @@ U.Icon = L.DivIcon.extend({
 
   _setRecent: function (url) {
     if (L.Util.hasVar(url)) return
-    if (url === U.DEFAULT_ICON_URL) return
+    if (url === U.SCHEMA.iconUrl.default) return
     if (U.Icon.RECENT.indexOf(url) === -1) {
       U.Icon.RECENT.push(url)
     }
@@ -236,7 +236,7 @@ U.Icon.setIconContrast = function (icon, parent, src, bgcolor) {
   if (L.DomUtil.contrastedColor(parent, bgcolor)) {
     // Decide whether to switch svg to white or not, but do it
     // only for internal SVG, as invert could do weird things
-    if (L.Util.isPath(src) && src.endsWith('.svg') && src !== U.DEFAULT_ICON_URL) {
+    if (L.Util.isPath(src) && src.endsWith('.svg') && src !== U.SCHEMA.iconUrl.default) {
       // Must be called after icon container is added to the DOM
       // An image
       icon.style.filter = 'invert(1)'

umap/static/umap/js/umap.js

@@ -2,33 +2,12 @@ L.Map.mergeOptions({
   overlay: null,
   datalayers: [],
   hash: true,
-  default_color: 'DarkBlue',
-  default_smoothFactor: 1.0,
-  default_opacity: 0.5,
-  default_fillOpacity: 0.3,
-  default_stroke: true,
-  default_fill: true,
-  default_weight: 3,
-  default_iconOpacity: 1,
-  default_iconClass: 'Default',
-  default_popupContentTemplate: '# {name}\n{description}',
-  default_interactive: true,
-  default_labelDirection: 'auto',
   maxZoomLimit: 24,
   attributionControl: false,
   editMode: 'advanced',
-  embedControl: true,
-  zoomControl: true,
-  datalayersControl: true,
-  searchControl: true,
-  editInOSMControl: false,
-  editInOSMControlOptions: false,
-  scaleControl: true,
   noControl: false, // Do not render any control.
-  miniMap: false,
   name: '',
   description: '',
-  displayPopupFooter: false,
   // When a TileLayer is in TMS mode, it needs -y instead of y.
   // This is usually handled by the TileLayer instance itself, but
   // we cannot rely on this because of the y is overriden by Leaflet
@@ -44,77 +23,14 @@ L.Map.mergeOptions({
   importPresets: [
     // {url: 'http://localhost:8019/en/datalayer/1502/', label: 'Simplified World Countries', format: 'geojson'}
   ],
-  moreControl: true,
-  captionBar: false,
-  captionMenus: true,
   slideshow: {},
   clickable: true,
-  easing: false,
   permissions: {},
-  permanentCreditBackground: true,
   featuresHaveOwner: false,
 })
 
 U.Map = L.Map.extend({
   includes: [ControlsMixin],
-  editableOptions: {
-    zoom: undefined,
-    scrollWheelZoom: Boolean,
-    scaleControl: Boolean,
-    moreControl: Boolean,
-    miniMap: Boolean,
-    displayPopupFooter: undefined,
-    onLoadPanel: String,
-    defaultView: String,
-    name: String,
-    description: String,
-    licence: undefined,
-    tilelayer: undefined,
-    overlay: undefined,
-    limitBounds: undefined,
-    color: String,
-    iconClass: String,
-    iconUrl: String,
-    smoothFactor: undefined,
-    iconOpacity: undefined,
-    opacity: undefined,
-    weight: undefined,
-    fill: undefined,
-    fillColor: undefined,
-    fillOpacity: undefined,
-    dashArray: undefined,
-    popupShape: String,
-    popupTemplate: String,
-    popupContentTemplate: String,
-    zoomTo: Number,
-    captionBar: Boolean,
-    captionMenus: Boolean,
-    slideshow: undefined,
-    sortKey: undefined,
-    labelKey: String,
-    filterKey: undefined,
-    facetKey: undefined,
-    slugKey: undefined,
-    showLabel: 'NullableBoolean',
-    labelDirection: undefined,
-    labelInteractive: undefined,
-    outlinkTarget: undefined,
-    shortCredit: undefined,
-    longCredit: undefined,
-    permanentCredit: undefined,
-    permanentCreditBackground: undefined,
-    zoomControl: 'NullableBoolean',
-    datalayersControl: 'NullableBoolean',
-    searchControl: 'NullableBoolean',
-    locateControl: 'NullableBoolean',
-    fullscreenControl: 'NullableBoolean',
-    editinosmControl: 'NullableBoolean',
-    embedControl: 'NullableBoolean',
-    measureControl: 'NullableBoolean',
-    tilelayersControl: 'NullableBoolean',
-    starControl: 'NullableBoolean',
-    easing: undefined,
-  },
 
   initialize: function (el, geojson) {
     // Locale name (pt_PT, en_US…)
@@ -133,7 +49,8 @@ U.Map = L.Map.extend({
     geojson.properties.fullscreenControl = false
 
     L.Map.prototype.initialize.call(this, el, geojson.properties)
-    U.DEFAULT_ICON_URL = this.options.default_iconUrl
+
+    if (geojson.properties.schema) this.overrideSchema(geojson.properties.schema)
 
     // After calling parent initialize, as we are doing initCenter our-selves
     if (geojson.geometry) this.options.center = this.latLng(geojson.geometry)
@@ -329,13 +246,11 @@ U.Map = L.Map.extend({
     // FIXME retrocompat
     L.Util.setBooleanFromQueryString(options, 'displayDataBrowserOnLoad')
     L.Util.setBooleanFromQueryString(options, 'displayCaptionOnLoad')
-    for (const [key, type] of Object.entries(this.editableOptions)) {
-      switch (type) {
+    for (const [key, schema] of Object.entries(U.SCHEMA)) {
+      switch (schema.type) {
         case Boolean:
-          L.Util.setBooleanFromQueryString(options, key)
-          break
-        case 'NullableBoolean':
-          L.Util.setNullableBooleanFromQueryString(options, key)
+          if (schema.nullable) L.Util.setNullableBooleanFromQueryString(options, key)
+          else L.Util.setBooleanFromQueryString(options, key)
           break
         case Number:
           L.Util.setNumberFromQueryString(options, key)
@@ -352,6 +267,12 @@ U.Map = L.Map.extend({
     }
   },
 
+  overrideSchema: function (schema) {
+   for (const [key, extra] of Object.entries(schema)) {
+     U.SCHEMA[key] = L.extend({}, U.SCHEMA[key], extra)
+   }
+  },
+
   initControls: function () {
     this.helpMenuActions = {}
     this._controls = {}
@@ -393,7 +314,7 @@ U.Map = L.Map.extend({
       title: { false: L._('View Fullscreen'), true: L._('Exit Fullscreen') },
     })
     this._controls.search = new U.SearchControl()
-    this._controls.embed = new L.Control.Embed(this, this.options.embedOptions)
+    this._controls.embed = new L.Control.Embed(this)
     this._controls.tilelayersChooser = new U.TileLayerChooser(this)
     if (this.options.user) this._controls.star = new U.StarControl(this)
     this._controls.editinosm = new L.Control.EditInOSM({
@@ -459,7 +380,7 @@ U.Map = L.Map.extend({
     let name, status, control
     for (let i = 0; i < this.HIDDABLE_CONTROLS.length; i++) {
       name = this.HIDDABLE_CONTROLS[i]
-      status = this.options[`${name}Control`]
+      status = this.getOption(`${name}Control`)
       if (status === false) continue
       control = this._controls[name]
       if (!control) continue
@@ -468,9 +389,9 @@ U.Map = L.Map.extend({
         L.DomUtil.addClass(control._container, 'display-on-more')
       else L.DomUtil.removeClass(control._container, 'display-on-more')
     }
-    if (this.options.permanentCredit) this._controls.permanentCredit.addTo(this)
-    if (this.options.moreControl) this._controls.more.addTo(this)
-    if (this.options.scaleControl) this._controls.scale.addTo(this)
+    if (this.getOption('permanentCredit')) this._controls.permanentCredit.addTo(this)
+    if (this.getOption('moreControl')) this._controls.more.addTo(this)
+    if (this.getOption('scaleControl')) this._controls.scale.addTo(this)
   },
 
   initDataLayers: async function (datalayers) {
@@ -820,7 +741,7 @@ U.Map = L.Map.extend({
   },
 
   getDefaultOption: function (option) {
-    return this.options[`default_${option}`]
+    return U.SCHEMA[option] && U.SCHEMA[option].default
   },
 
   getOption: function (option) {
@@ -904,7 +825,7 @@ U.Map = L.Map.extend({
 
     let mustReindex = false
 
-    for (const option of Object.keys(this.editableOptions)) {
+    for (const option of Object.keys(U.SCHEMA)) {
       if (typeof importedData.properties[option] !== 'undefined') {
         this.options[option] = importedData.properties[option]
         if (option === 'sortKey') mustReindex = true
@@ -1033,7 +954,7 @@ U.Map = L.Map.extend({
 
   exportOptions: function () {
     const properties = {}
-    for (const option of Object.keys(this.editableOptions)) {
+    for (const option of Object.keys(U.SCHEMA)) {
       if (typeof this.options[option] !== 'undefined') {
         properties[option] = this.options[option]
       }
@@ -1555,35 +1476,11 @@ U.Map = L.Map.extend({
   _editCredits: function (container) {
     const credits = L.DomUtil.createFieldset(container, L._('Credits'))
     const creditsFields = [
-      ['options.licence', { handler: 'LicenceChooser', label: L._('licence') }],
-      [
-        'options.shortCredit',
-        {
-          handler: 'Input',
-          label: L._('Short credits'),
-          helpEntries: ['shortCredit', 'textFormatting'],
-        },
-      ],
-      [
-        'options.longCredit',
-        {
-          handler: 'Textarea',
-          label: L._('Long credits'),
-          helpEntries: ['longCredit', 'textFormatting'],
-        },
-      ],
-      [
-        'options.permanentCredit',
-        {
-          handler: 'Textarea',
-          label: L._('Permanent credits'),
-          helpEntries: ['permanentCredit', 'textFormatting'],
-        },
-      ],
-      [
-        'options.permanentCreditBackground',
-        { handler: 'Switch', label: L._('Permanent credits background') },
-      ],
+      'options.licence',
+      'options.shortCredit',
+      'options.longCredit',
+      'options.permanentCredit',
+      'options.permanentCreditBackground',
     ]
     const creditsBuilder = new U.FormBuilder(this, creditsFields, {
       callback: this.renderControls,
@@ -1691,7 +1588,7 @@ U.Map = L.Map.extend({
       name = L.DomUtil.create('h3', '', container)
     L.DomEvent.disableClickPropagation(container)
     this.permissions.addOwnerLink('span', container)
-    if (this.options.captionMenus) {
+    if (this.getOption('captionMenus')) {
       L.DomUtil.createButton(
         'umap-about-link flat',
         container,