umap-project 2.1.3__py3-none-any.whl → 2.2.0b0__py3-none-any.whl

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

@@ -1,46 +1,60 @@
 import { translate } from './i18n.js'
 
+// Possible impacts
+// ['ui', 'data', 'limit-bounds', 'datalayer-index', 'remote-data', 'background']
+
 export const SCHEMA = {
-  zoom: {
-    type: Number,
-  },
-  scrollWheelZoom: {
+  browsable: {
+    impacts: ['ui'],
     type: Boolean,
-    label: translate('Allow scroll wheel zoom?'),
   },
-  scaleControl: {
+  captionBar: {
     type: Boolean,
-    label: translate('Do you want to display the scale control?'),
-    default: true,
+    impacts: ['ui'],
+    label: translate('Do you want to display a caption bar?'),
+    default: false,
   },
-  moreControl: {
+  captionMenus: {
     type: Boolean,
-    label: translate('Do you want to display the «more» control?'),
+    impacts: ['ui'],
+    label: translate('Do you want to display caption menus?'),
     default: true,
   },
-  miniMap: {
-    type: Boolean,
-    label: translate('Do you want to display a minimap?'),
-    default: false,
+  color: {
+    type: String,
+    impacts: ['data'],
+    handler: 'ColorPicker',
+    label: translate('color'),
+    helpEntries: 'colorValue',
+    inheritable: true,
+    default: 'DarkBlue',
   },
-  displayPopupFooter: {
-    type: Boolean,
-    label: translate('Do you want to display popup footer?'),
-    default: false,
+  choropleth: {
+    type: Object,
+    impacts: ['data'],
   },
-  onLoadPanel: {
+  cluster: {
+    type: Object,
+    impacts: ['data'],
+  },
+  dashArray: {
     type: String,
-    label: translate('Do you want to display a panel on load?'),
-    choices: [
-      ['none', translate('None')],
-      ['caption', translate('Caption')],
-      ['databrowser', translate('Data browser')],
-      ['facet', translate('Facet search')],
-    ],
-    default: 'none',
+    impacts: ['data'],
+    label: translate('dash array'),
+    helpEntries: 'dashArray',
+    inheritable: true,
+  },
+  datalayersControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    handler: 'DataLayersControl',
+    label: translate('Display the data layers control'),
+    default: true,
   },
   defaultView: {
     type: String,
+    impacts: [], // no need to update the ui, only useful when loading the map
     label: translate('Default view'),
     choices: [
       ['center', translate('Saved center and zoom')],
@@ -50,96 +64,48 @@ export const SCHEMA = {
     ],
     default: 'center',
   },
-  name: {
-    type: String,
-    label: translate('name'),
-  },
   description: {
-    label: translate('description'),
     type: 'Text',
+    impacts: ['ui'],
+    label: translate('description'),
     helpEntries: 'textFormatting',
   },
-  licence: {
-    type: String,
-    label: translate('licence'),
-  },
-  tilelayer: {
-    type: Object,
+  displayOnLoad: {
+    type: Boolean,
+    impacts: [],
   },
-  overlay: {
-    type: Object,
+  displayPopupFooter: {
+    type: Boolean,
+    impacts: ['ui'],
+    label: translate('Do you want to display popup footer?'),
+    default: false,
   },
-  limitBounds: {
-    type: Object,
+  easing: {
+    type: Boolean,
+    impacts: [],
+    default: false
   },
-  color: {
-    type: String,
-    handler: 'ColorPicker',
-    label: translate('color'),
-    helpEntries: 'colorValue',
-    inheritable: true,
-    default: 'DarkBlue',
+  editinosmControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    label: translate('Display the control to open OpenStreetMap editor'),
+    default: null,
   },
-  iconClass: {
-    type: String,
-    label: translate('Icon shape'),
-    inheritable: true,
-    choices: [
-      ['Default', translate('Default')],
-      ['Circle', translate('Circle')],
-      ['Drop', translate('Drop')],
-      ['Ball', translate('Ball')],
-    ],
-    default: 'Default',
+  embedControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    label: translate('Display the embed control'),
+    default: true,
   },
-  iconUrl: {
+  facetKey: {
     type: String,
-    handler: 'IconUrl',
-    label: translate('Icon symbol'),
-    inheritable: true,
-    // helpText: translate(
-    //   'Symbol can be either a unicode character or an URL. You can use feature properties as variables: ex.: with "http://myserver.org/images/{name}.png", the {name} variable will be replaced by the "name" value of each marker.'
-    // ),
-  },
-  smoothFactor: {
-    type: Number,
-    min: 0,
-    max: 10,
-    step: 0.5,
-    label: translate('Simplify'),
-    helpEntries: 'smoothFactor',
-    inheritable: true,
-    default: 1.0,
-  },
-  iconOpacity: {
-    type: Number,
-    min: 0.1,
-    max: 1,
-    step: 0.1,
-    label: translate('icon opacity'),
-    inheritable: true,
-    default: 1,
-  },
-  opacity: {
-    type: Number,
-    min: 0.1,
-    max: 1,
-    step: 0.1,
-    label: translate('opacity'),
-    inheritable: true,
-    default: 0.5,
-  },
-  weight: {
-    type: Number,
-    min: 1,
-    max: 20,
-    step: 1,
-    label: translate('weight'),
-    inheritable: true,
-    default: 3,
+    impacts: ['ui'],
   },
   fill: {
     type: Boolean,
+    impacts: ['data'],
     label: translate('fill'),
     helpEntries: 'fill',
     inheritable: true,
@@ -147,6 +113,7 @@ export const SCHEMA = {
   },
   fillColor: {
     type: String,
+    impacts: ['data'],
     handler: 'ColorPicker',
     label: translate('fill color'),
     helpEntries: 'fillColor',
@@ -154,6 +121,7 @@ export const SCHEMA = {
   },
   fillOpacity: {
     type: Number,
+    impacts: ['data'],
     min: 0.1,
     max: 1,
     step: 0.1,
@@ -161,110 +129,175 @@ export const SCHEMA = {
     inheritable: true,
     default: 0.3,
   },
-  dashArray: {
+  filterKey: {
     type: String,
-    label: translate('dash array'),
-    helpEntries: 'dashArray',
-    inheritable: true,
+    impacts: [],
   },
-  popupShape: {
-    type: String,
-    label: translate('Popup shape'),
-    inheritable: true,
-    choices: [
-      ['Default', translate('Popup')],
-      ['Large', translate('Popup (large)')],
-      ['Panel', translate('Side panel')],
-    ],
-    default: 'Default',
+  fromZoom: {
+    type: Number,
+    impacts: [], // not needed
+    label: translate('From zoom'),
+    helpText: translate('Optional.'),
   },
-  popupTemplate: {
+  fullscreenControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    label: translate('Display the fullscreen control'),
+    default: true,
+  },
+  heat: {
+    type: Object,
+    impacts: ['data'],
+  },
+  iconClass: {
     type: String,
-    label: translate('Popup content style'),
+    impacts: ['data'],
+    label: translate('Icon shape'),
     inheritable: true,
     choices: [
       ['Default', translate('Default')],
-      ['Table', translate('Table')],
-      ['GeoRSSImage', translate('GeoRSS (title + image)')],
-      ['GeoRSSLink', translate('GeoRSS (only link)')],
-      ['OSM', translate('OpenStreetMap')],
+      ['Circle', translate('Circle')],
+      ['Drop', translate('Drop')],
+      ['Ball', translate('Ball')],
     ],
     default: 'Default',
   },
-  popupContentTemplate: {
-    type: 'Text',
-    label: translate('Popup content template'),
-    helpEntries: ['dynamicProperties', 'textFormatting'],
-    placeholder: '# {name}',
+  iconOpacity: {
+    type: Number,
+    impacts: ['data'],
+    min: 0.1,
+    max: 1,
+    step: 0.1,
+    label: translate('icon opacity'),
     inheritable: true,
-    default: '# {name}\n{description}',
+    default: 1,
   },
-  zoomTo: {
-    type: Number,
-    placeholder: translate('Inherit'),
-    helpEntries: 'zoomTo',
-    label: translate('Default zoom level'),
+  iconUrl: {
+    type: String,
+    impacts: ['data'],
+    handler: 'IconUrl',
+    label: translate('Icon symbol'),
     inheritable: true,
   },
-  captionBar: {
+  inCaption: {
     type: Boolean,
-    label: translate('Do you want to display a caption bar?'),
-    default: false,
+    impacts: ['ui'],
   },
-  captionMenus: {
+
+  interactive: {
     type: Boolean,
-    label: translate('Do you want to display caption menus?'),
+    impacts: ['data'],
+    label: translate('Allow interactions'),
+    helpEntries: 'interactive',
+    inheritable: true,
     default: true,
   },
-  slideshow: {
-    type: Object,
-  },
-  sortKey: {
+  labelDirection: {
     type: String,
+    impacts: ['data'],
+    label: translate('Label direction'),
+    inheritable: true,
+    choices: [
+      ['auto', translate('Automatic')],
+      ['left', translate('On the left')],
+      ['right', translate('On the right')],
+      ['top', translate('On the top')],
+      ['bottom', translate('On the bottom')],
+    ],
+    default: 'auto',
+  },
+  labelInteractive: {
+    type: Boolean,
+    impacts: ['data'],
+    label: translate('Labels are clickable'),
+    inheritable: true,
   },
   labelKey: {
     type: String,
+    impacts: ['data'],
     helpEntries: 'labelKey',
     placeholder: translate('Default: name'),
     label: translate('Label key'),
     inheritable: true,
   },
-  filterKey: {
+  licence: {
     type: String,
+    impacts: ['ui'],
+    label: translate('licence'),
   },
-  facetKey: {
-    type: String,
+  limitBounds: {
+    type: Object,
+    impacts: ['limit-bounds'],
   },
-  slugKey: {
-    type: String,
+  locateControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    label: translate('Display the locate control'),
   },
-  showLabel: {
+  longCredit: {
+    type: 'Text',
+    impacts: ['ui'],
+    label: translate('Long credits'),
+    helpEntries: ['longCredit', 'textFormatting'],
+  },
+  measureControl: {
     type: Boolean,
+    impacts: ['ui'],
     nullable: true,
-    label: translate('Display label'),
-    inheritable: true,
+    label: translate('Display the measure control'),
+  },
+  miniMap: {
+    type: Boolean,
+    impacts: ['ui'],
+    label: translate('Do you want to display a minimap?'),
     default: false,
   },
-  labelDirection: {
+  moreControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    label: translate('Do you want to display the «more» control?'),
+    default: true,
+  },
+  name: {
     type: String,
-    label: translate('Label direction'),
-    inheritable: true,
+    impacts: ['ui', 'data'],
+    label: translate('name'),
+  },
+  onLoadPanel: {
+    type: String,
+    impacts: [], // This is what happens during the map instantiation
+    label: translate('Do you want to display a panel on load?'),
     choices: [
-      ['auto', translate('Automatic')],
-      ['left', translate('On the left')],
-      ['right', translate('On the right')],
-      ['top', translate('On the top')],
-      ['bottom', translate('On the bottom')],
+      ['none', translate('None')],
+      ['caption', translate('Caption')],
+      ['databrowser', translate('Data browser')],
+      ['datalayers', translate('Layers')],
+      ['facet', translate('Facet search')],
     ],
-    default: 'auto',
+    default: 'none',
   },
-  labelInteractive: {
-    type: Boolean,
-    label: translate('Labels are clickable'),
+  opacity: {
+    type: Number,
+    impacts: ['data'],
+    min: 0.1,
+    max: 1,
+    step: 0.1,
+    label: translate('opacity'),
+    inheritable: true,
+    default: 0.5,
+  },
+  outlink: {
+    type: String,
+    label: translate('Link to…'),
+    helpEntries: 'outlink',
+    placeholder: 'http://...',
     inheritable: true,
   },
   outlinkTarget: {
     type: String,
+    impacts: [],
     label: translate('Open link in…'),
     inheritable: true,
     default: 'blank',
@@ -274,115 +307,183 @@ export const SCHEMA = {
       ['parent', translate('parent window')],
     ],
   },
-  shortCredit: {
-    type: String,
-    label: translate('Short credits'),
-    helpEntries: ['shortCredit', 'textFormatting'],
-  },
-  longCredit: {
-    type: 'Text',
-    label: translate('Long credits'),
-    helpEntries: ['longCredit', 'textFormatting'],
+  overlay: {
+    type: Object,
+    impacts: ['background'],
   },
   permanentCredit: {
     type: 'Text',
+    impacts: ['ui'],
     label: translate('Permanent credits'),
     helpEntries: ['permanentCredit', 'textFormatting'],
   },
   permanentCreditBackground: {
     type: Boolean,
+    impacts: ['ui'],
     label: translate('Permanent credits background'),
     default: true,
   },
-  zoomControl: {
+  popupContentTemplate: {
+    type: 'Text',
+    impacts: [], // not needed
+    label: translate('Popup content template'),
+    helpEntries: ['dynamicProperties', 'textFormatting'],
+    placeholder: '# {name}',
+    inheritable: true,
+    default: '# {name}\n{description}',
+  },
+  popupShape: {
+    type: String,
+    impacts: [], // not needed
+    label: translate('Popup shape'),
+    inheritable: true,
+    choices: [
+      ['Default', translate('Popup')],
+      ['Large', translate('Popup (large)')],
+      ['Panel', translate('Side panel')],
+    ],
+    default: 'Default',
+  },
+  popupTemplate: {
+    type: String,
+    impacts: [], // not needed
+    label: translate('Popup content style'),
+    inheritable: true,
+    choices: [
+      ['Default', translate('Default')],
+      ['Table', translate('Table')],
+      ['GeoRSSImage', translate('GeoRSS (title + image)')],
+      ['GeoRSSLink', translate('GeoRSS (only link)')],
+      ['OSM', translate('OpenStreetMap')],
+    ],
+    default: 'Default',
+  },
+  remoteData: {
+    type: Object,
+    impacts: ['remote-data'],
+  },
+  scaleControl: {
     type: Boolean,
-    nullable: true,
-    label: translate('Display the zoom control'),
+    impacts: ['ui'],
+    label: translate('Do you want to display the scale control?'),
     default: true,
   },
-  datalayersControl: {
+  scrollWheelZoom: {
+    type: Boolean,
+    impacts: ['ui'],
+    label: translate('Allow scroll wheel zoom?'),
+  },
+  captionControl: {
     type: Boolean,
     nullable: true,
-    handler: 'DataLayersControl',
-    label: translate('Display the data layers control'),
+    label: translate('Display the caption control'),
     default: true,
   },
   searchControl: {
     type: Boolean,
+    impacts: ['ui'],
     nullable: true,
     label: translate('Display the search control'),
     default: true,
   },
-  locateControl: {
-    type: Boolean,
-    nullable: true,
-    label: translate('Display the locate control'),
+  shortCredit: {
+    type: String,
+    impacts: ['ui'],
+    label: translate('Short credits'),
+    helpEntries: ['shortCredit', 'textFormatting'],
   },
-  fullscreenControl: {
+  showLabel: {
     type: Boolean,
+    impacts: ['data'],
     nullable: true,
-    label: translate('Display the fullscreen control'),
-    default: true,
+    label: translate('Display label'),
+    inheritable: true,
+    default: false,
   },
-  editinosmControl: {
-    type: Boolean,
-    nullable: true,
-    label: translate('Display the control to open OpenStreetMap editor'),
-    default: null,
+  slideshow: {
+    type: Object,
+    impacts: ['ui'],
   },
-  embedControl: {
-    type: Boolean,
-    nullable: true,
-    label: translate('Display the embed control'),
-    default: true,
+  slugKey: {
+    type: String,
+    impacts: [],
   },
-  measureControl: {
-    type: Boolean,
-    nullable: true,
-    label: translate('Display the measure control'),
+  smoothFactor: {
+    type: Number,
+    impacts: ['data'],
+    min: 0,
+    max: 10,
+    step: 0.5,
+    label: translate('Simplify'),
+    helpEntries: 'smoothFactor',
+    inheritable: true,
+    default: 1.0,
   },
-  tilelayersControl: {
-    type: Boolean,
-    nullable: true,
-    label: translate('Display the tile layers control'),
+  sortKey: {
+    type: String,
+    impacts: ['datalayer-index', 'data'],
   },
   starControl: {
     type: Boolean,
+    impacts: ['ui'],
     nullable: true,
     label: translate('Display the star map button'),
   },
-  easing: {
-    type: Boolean,
-    default: false,
-  },
-  interactive: {
+  stroke: {
     type: Boolean,
-    label: translate('Allow interactions'),
-    helpEntries: 'interactive',
+    impacts: ['data'],
+    label: translate('stroke'),
+    helpEntries: 'stroke',
     inheritable: true,
     default: true,
   },
-  fromZoom: {
-    type: Number,
-    label: translate('From zoom'),
-    helpText: translate('Optional.'),
+  tilelayer: {
+    type: Object,
+    impacts: ['background'],
+  },
+  tilelayersControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    label: translate('Display the tile layers control'),
   },
   toZoom: {
     type: Number,
+    impacts: [], // not needed
     label: translate('To zoom'),
     helpText: translate('Optional.'),
   },
-  stroke: {
-    type: Boolean,
-    label: translate('stroke'),
-    helpEntries: 'stroke',
+  type: {
+    type: 'String',
+    impacts: ['data'],
+  },
+  weight: {
+    type: Number,
+    impacts: ['data'],
+    min: 1,
+    max: 20,
+    step: 1,
+    label: translate('weight'),
     inheritable: true,
+    default: 3,
+  },
+  zoom: {
+    type: Number,
+    impacts: [], // default zoom, doesn't need to be updated
+  },
+  zoomControl: {
+    type: Boolean,
+    impacts: ['ui'],
+    nullable: true,
+    label: translate('Display the zoom control'),
     default: true,
   },
-  outlink: {
-    label: translate('Link to…'),
-    helpEntries: 'outlink',
-    placeholder: 'http://...',
+  zoomTo: {
+    type: Number,
+    impacts: [], // not need to update the view
+    placeholder: translate('Inherit'),
+    helpEntries: 'zoomTo',
+    label: translate('Default zoom level'),
     inheritable: true,
   },
 }