@jupytergis/schema 0.9.2 → 0.10.0

package/lib/_interface/forms.json

@@ -575,10 +575,12 @@
       },
       "normalize": {
         "type": "boolean",
+        "description": "Enable to normalize values between 0 and 1 and displayed as RGB values; disable to keep raw band values",
         "default": true
       },
       "wrapX": {
         "type": "boolean",
+        "description": "Wrap the map horizontally?",
         "default": false
       },
       "interpolate": {
@@ -624,6 +626,36 @@
       }
     }
   },
+  "MarkerSource": {
+    "type": "object",
+    "required": [
+      "feature"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "color": {
+        "type": "string",
+        "description": "Color of the marker icon (hex, rgb, rgba, or named color)"
+      },
+      "feature": {
+        "type": "object",
+        "description": "Info for the marker",
+        "required": [
+          "coords"
+        ],
+        "properties": {
+          "coords": {
+            "type": "array",
+            "minItems": 2,
+            "maxItems": 2,
+            "items": {
+              "type": "number"
+            }
+          }
+        }
+      }
+    }
+  },
   "RasterDemSource": {
     "type": "object",
     "required": [

package/lib/_interface/project/jgis.d.ts

@@ -31,7 +31,8 @@ export type SourceType =
   | "ImageSource"
   | "ShapefileSource"
   | "GeoTiffSource"
-  | "GeoParquetSource";
+  | "GeoParquetSource"
+  | "MarkerSource";
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema
  * via the `definition` "jGISLayerItem".

package/lib/_interface/project/sources/geoTiffSource.d.ts

@@ -26,7 +26,13 @@ export interface IGeoTiffSource {
       [k: string]: any;
     }[]
   ];
+  /**
+   * Enable to normalize values between 0 and 1 and displayed as RGB values; disable to keep raw band values
+   */
   normalize?: boolean;
+  /**
+   * Wrap the map horizontally?
+   */
   wrapX?: boolean;
   /**
    * Interpolate between grid cells when overzooming?

package/lib/_interface/project/sources/markerSource.d.ts

@@ -0,0 +1,23 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * MarkerSource
+ */
+export interface IMarkerSource {
+  /**
+   * Color of the marker icon (hex, rgb, rgba, or named color)
+   */
+  color?: string;
+  /**
+   * Info for the marker
+   */
+  feature: {
+    coords: [number, number];
+    [k: string]: any;
+  };
+}

package/lib/interfaces.d.ts

@@ -11,6 +11,7 @@ import { SplitPanel } from '@lumino/widgets';
 import { FeatureLike } from 'ol/Feature';
 import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerItem, IJGISLayers, IJGISLayerTree, IJGISOptions, IJGISSource, IJGISSources, SourceType } from './_interface/project/jgis';
 import { IRasterSource } from './_interface/project/sources/rasterSource';
+import { Modes } from './types';
 export { IGeoJSONSource } from './_interface/project/sources/geoJsonSource';
 export type JgisCoordinates = {
     x: number;
@@ -49,7 +50,6 @@ export type SelectionType = 'layer' | 'source' | 'group';
 export interface ISelection {
     type: SelectionType;
     parent?: string;
-    selectedNodeId?: string;
 }
 export interface IJupyterGISClientState {
     selected: {
@@ -133,7 +133,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     geolocation: JgisCoordinates;
     localState: IJupyterGISClientState | null;
     annotationModel?: IAnnotationModel;
-    currentMode: 'panning' | 'identifying';
+    currentMode: Modes;
     themeChanged: Signal<IJupyterGISModel, IChangedArgs<string, string | null, string>>;
     clientStateChanged: ISignal<IJupyterGISModel, Map<number, IJupyterGISClientState>>;
     sharedOptionsChanged: ISignal<IJupyterGISDoc, MapChange>;
@@ -186,6 +186,19 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     syncSelected(value: {
         [key: string]: ISelection;
     }, emitter?: string): void;
+    selected: {
+        [key: string]: ISelection;
+    } | undefined;
+    setEditingItem(type: SelectionType, itemId: string): void;
+    clearEditingItem(): void;
+    readonly editing: {
+        type: SelectionType;
+        itemId: string;
+    } | null;
+    editingChanged: ISignal<IJupyterGISModel, {
+        type: SelectionType;
+        itemId: string;
+    } | null>;
     syncPointer(pointer?: Pointer, emitter?: string): void;
     syncIdentifiedFeatures(features: IDict<any>, emitter?: string): void;
     setUserToFollow(userId?: number): void;
@@ -193,7 +206,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     addMetadata(key: string, value: string): void;
     removeMetadata(key: string): void;
     centerOnPosition(id: string): void;
-    toggleIdentify(): void;
+    toggleMode(mode: Modes): void;
     isTemporalControllerActive: boolean;
     toggleTemporalController(): void;
     addFeatureAsMs(id: string, selectedFeature: string): void;

package/lib/model.d.ts

@@ -7,7 +7,8 @@ import { PartialJSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { FeatureLike } from 'ol/Feature';
 import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources } from './_interface/project/jgis';
-import { IAnnotationModel, IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISClientState, IJupyterGISDoc, IJupyterGISModel, ISelection, IUserData, IViewPortState, JgisCoordinates, Pointer, IJupyterGISSettings } from './interfaces';
+import { IAnnotationModel, IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISClientState, IJupyterGISDoc, IJupyterGISModel, ISelection, IUserData, IViewPortState, JgisCoordinates, Pointer, IJupyterGISSettings, SelectionType } from './interfaces';
+import { Modes } from './types';
 export declare class JupyterGISModel implements IJupyterGISModel {
     constructor(options: JupyterGISModel.IOptions);
     /**
@@ -137,8 +138,24 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     syncSelected(value: {
         [key: string]: ISelection;
     }, emitter?: string): void;
+    get selected(): {
+        [key: string]: ISelection;
+    } | undefined;
+    set selected(value: {
+        [key: string]: ISelection;
+    } | undefined);
     syncIdentifiedFeatures(features: IDict<any>, emitter?: string): void;
     setUserToFollow(userId?: number): void;
+    setEditingItem(type: SelectionType, itemId: string): void;
+    clearEditingItem(): void;
+    get editing(): {
+        type: SelectionType;
+        itemId: string;
+    } | null;
+    get editingChanged(): ISignal<this, {
+        type: SelectionType;
+        itemId: string;
+    } | null>;
     getClientId(): number;
     /**
      * Add an item in the layer tree.
@@ -160,9 +177,14 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _removeLayerTreeItem;
     renameLayerGroup(groupName: string, newName: string): void;
     removeLayerGroup(groupName: string): void;
-    toggleIdentify(): void;
-    get currentMode(): 'panning' | 'identifying';
-    set currentMode(value: 'panning' | 'identifying');
+    /**
+     * Toggle a map interaction mode on or off.
+     * Toggleing off sets the mode to 'panning'.
+     * @param mode The mode to be toggled
+     */
+    toggleMode(mode: Modes): void;
+    get currentMode(): Modes;
+    set currentMode(value: Modes);
     toggleTemporalController(): void;
     private _getLayerTreeInfo;
     private _onClientStateChanged;
@@ -200,6 +222,8 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _addFeatureAsMsSignal;
     private _updateLayerSignal;
     private _isTemporalControllerActive;
+    private _editing;
+    private _editingChanged;
     static worker: Worker;
     private _geolocation;
     private _geolocationChanged;

package/lib/model.js

@@ -3,6 +3,17 @@ import Ajv from 'ajv';
 import { JupyterGISDoc } from './doc';
 import jgisSchema from './schema/project/jgis.json';
 const SETTINGS_ID = '@jupytergis/jupytergis-core:jupytergis-settings';
+const DEFAULT_SETTINGS = {
+    proxyUrl: 'https://corsproxy.io',
+    leftPanelDisabled: false,
+    rightPanelDisabled: false,
+    layersDisabled: false,
+    stacBrowserDisabled: false,
+    filtersDisabled: false,
+    objectPropertiesDisabled: false,
+    annotationsDisabled: false,
+    identifyDisabled: false,
+};
 export class JupyterGISModel {
     constructor(options) {
         this._onSharedModelChanged = (sender, changes) => {
@@ -45,6 +56,8 @@ export class JupyterGISModel {
         this._addFeatureAsMsSignal = new Signal(this);
         this._updateLayerSignal = new Signal(this);
         this._isTemporalControllerActive = false;
+        this._editing = null;
+        this._editingChanged = new Signal(this);
         this._geolocationChanged = new Signal(this);
         this._tileFeatureCache = new Map();
         const { annotationModel, sharedModel, settingRegistry } = options;
@@ -61,17 +74,7 @@ export class JupyterGISModel {
         this.settingRegistry = settingRegistry;
         this._pathChanged = new Signal(this);
         this._settingsChanged = new Signal(this);
-        this._jgisSettings = {
-            proxyUrl: 'https://corsproxy.io',
-            leftPanelDisabled: false,
-            rightPanelDisabled: false,
-            layersDisabled: false,
-            stacBrowserDisabled: false,
-            filtersDisabled: false,
-            objectPropertiesDisabled: false,
-            annotationsDisabled: false,
-            identifyDisabled: false,
-        };
+        this._jgisSettings = Object.assign({}, DEFAULT_SETTINGS);
         this.initSettings();
     }
     /**
@@ -87,17 +90,7 @@ export class JupyterGISModel {
                     const oldSettings = Object.assign({}, this._jgisSettings);
                     this._updateLocalSettings();
                     const newSettings = this._jgisSettings;
-                    const keys = [
-                        'proxyUrl',
-                        'leftPanelDisabled',
-                        'rightPanelDisabled',
-                        'layersDisabled',
-                        'stacBrowserDisabled',
-                        'filtersDisabled',
-                        'objectPropertiesDisabled',
-                        'annotationsDisabled',
-                        'identifyDisabled',
-                    ];
+                    const keys = Object.keys(DEFAULT_SETTINGS);
                     keys.forEach(key => {
                         if (oldSettings[key] !== newSettings[key]) {
                             this._settingsChanged.emit(key);
@@ -107,34 +100,18 @@ export class JupyterGISModel {
             }
             catch (error) {
                 console.error(`Failed to load settings for ${SETTINGS_ID}:`, error);
-                this._jgisSettings = {
-                    proxyUrl: 'https://corsproxy.io',
-                    leftPanelDisabled: false,
-                    rightPanelDisabled: false,
-                    layersDisabled: false,
-                    stacBrowserDisabled: false,
-                    filtersDisabled: false,
-                    objectPropertiesDisabled: false,
-                    annotationsDisabled: false,
-                    identifyDisabled: false,
-                };
+                this._jgisSettings = Object.assign({}, DEFAULT_SETTINGS);
             }
         }
     }
     _updateLocalSettings() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const composite = this._settings.composite;
-        this._jgisSettings = {
-            proxyUrl: (_a = composite.proxyUrl) !== null && _a !== void 0 ? _a : 'https://corsproxy.io',
-            leftPanelDisabled: (_b = composite.leftPanelDisabled) !== null && _b !== void 0 ? _b : false,
-            rightPanelDisabled: (_c = composite.rightPanelDisabled) !== null && _c !== void 0 ? _c : false,
-            layersDisabled: (_d = composite.layersDisabled) !== null && _d !== void 0 ? _d : false,
-            stacBrowserDisabled: (_e = composite.stacBrowserDisabled) !== null && _e !== void 0 ? _e : false,
-            filtersDisabled: (_f = composite.filtersDisabled) !== null && _f !== void 0 ? _f : false,
-            objectPropertiesDisabled: (_g = composite.objectPropertiesDisabled) !== null && _g !== void 0 ? _g : false,
-            annotationsDisabled: (_h = composite.annotationsDisabled) !== null && _h !== void 0 ? _h : false,
-            identifyDisabled: (_j = composite.identifyDisabled) !== null && _j !== void 0 ? _j : false,
-        };
+        this._jgisSettings = Object.entries(DEFAULT_SETTINGS).reduce((acc, [key, defaultValue]) => {
+            const typedKey = key;
+            const compositeValue = composite[typedKey];
+            acc[typedKey] = compositeValue !== null && compositeValue !== void 0 ? compositeValue : defaultValue;
+            return acc;
+        }, {});
     }
     get jgisSettings() {
         return this._jgisSettings;
@@ -458,6 +435,13 @@ export class JupyterGISModel {
             emitter,
         });
     }
+    get selected() {
+        var _a, _b;
+        return (_b = (_a = this.localState) === null || _a === void 0 ? void 0 : _a.selected) === null || _b === void 0 ? void 0 : _b.value;
+    }
+    set selected(value) {
+        this.syncSelected(value || {}, this.getClientId().toString());
+    }
     syncIdentifiedFeatures(features, emitter) {
         this.sharedModel.awareness.setLocalStateField('identifiedFeatures', {
             value: features,
@@ -469,6 +453,20 @@ export class JupyterGISModel {
             this._sharedModel.awareness.setLocalStateField('remoteUser', userId);
         }
     }
+    setEditingItem(type, itemId) {
+        this._editing = { type, itemId };
+        this._editingChanged.emit(this._editing);
+    }
+    clearEditingItem() {
+        this._editing = null;
+        this._editingChanged.emit(null);
+    }
+    get editing() {
+        return this._editing;
+    }
+    get editingChanged() {
+        return this._editingChanged;
+    }
     getClientId() {
         return this.sharedModel.awareness.clientID;
     }
@@ -588,7 +586,7 @@ export class JupyterGISModel {
             this._sharedModel.updateLayerTreeItem(layerTreeInfo.mainGroupIndex, layerTreeInfo.mainGroup);
         }
         else {
-            console.log('Something went wrong when renaming layer');
+            console.error('Layer group rename failed -- could not get layer tree.');
         }
     }
     removeLayerGroup(groupName) {
@@ -612,13 +610,13 @@ export class JupyterGISModel {
             this._sharedModel.updateLayerTreeItem(layerTreeInfo.mainGroupIndex, updatedLayerTree[layerTreeInfo.mainGroupIndex]);
         }
     }
-    toggleIdentify() {
-        if (this._currentMode === 'identifying') {
-            this._currentMode = 'panning';
-        }
-        else {
-            this._currentMode = 'identifying';
-        }
+    /**
+     * Toggle a map interaction mode on or off.
+     * Toggleing off sets the mode to 'panning'.
+     * @param mode The mode to be toggled
+     */
+    toggleMode(mode) {
+        this._currentMode = this._currentMode === mode ? 'panning' : mode;
     }
     get currentMode() {
         return this._currentMode;

package/lib/processing/_generated/exportProcessingSchema.d.ts

@@ -1,6 +1,6 @@
-export * from '../../_interface/processing/dissolve';
 export * from '../../_interface/processing/centroids';
 export * from '../../_interface/processing/convexHull';
+export * from '../../_interface/processing/concaveHull';
 export * from '../../_interface/processing/buffer';
+export * from '../../_interface/processing/dissolve';
 export * from '../../_interface/processing/boundingBoxes';
-export * from '../../_interface/processing/concaveHull';

package/lib/processing/_generated/exportProcessingSchema.js

@@ -1,7 +1,7 @@
 //Generated automatically please don't modify directly
-export * from '../../_interface/processing/dissolve';
 export * from '../../_interface/processing/centroids';
 export * from '../../_interface/processing/convexHull';
+export * from '../../_interface/processing/concaveHull';
 export * from '../../_interface/processing/buffer';
+export * from '../../_interface/processing/dissolve';
 export * from '../../_interface/processing/boundingBoxes';
-export * from '../../_interface/processing/concaveHull';

package/lib/processing/_generated/processingType.d.ts

@@ -1,2 +1,2 @@
-export type ProcessingType = 'Dissolve' | 'Centroids' | 'ConvexHull' | 'Buffer' | 'BoundingBoxes' | 'ConcaveHull';
+export type ProcessingType = 'Centroids' | 'ConvexHull' | 'ConcaveHull' | 'Buffer' | 'Dissolve' | 'BoundingBoxes';
 export declare const processingList: string[];

package/lib/processing/_generated/processingType.js

@@ -1,8 +1,8 @@
 export const processingList = [
-    'Dissolve',
     'Centroids',
     'ConvexHull',
+    'ConcaveHull',
     'Buffer',
+    'Dissolve',
     'BoundingBoxes',
-    'ConcaveHull',
 ];

package/lib/processing/_generated/processing_merge.json

@@ -1,17 +1,4 @@
 [
-    {
-        "description": "Dissolve",
-        "name": "dissolve",
-        "operationParams": [
-            "dissolveField"
-        ],
-        "label": "Dissolve",
-        "operations": {
-            "gdalFunction": "ogr2ogr",
-            "sql": "SELECT ST_Union(geometry) AS geometry, {dissolveField} FROM \"{layerName}\" GROUP BY {dissolveField}"
-        },
-        "type": "vector"
-    },
     {
         "description": "Centroids",
         "name": "centroids",
@@ -34,6 +21,20 @@
         },
         "type": "vector"
     },
+    {
+        "description": "ConcaveHull",
+        "name": "concaveHull",
+        "operationParams": [
+            "pctconvex",
+            "allowHoles"
+        ],
+        "label": "Concave Hull",
+        "operations": {
+            "sql": "SELECT ST_ConcaveHull(geometry,{pctconvex},{allowHoles}) AS geometry, * FROM \"{layerName}\"",
+            "gdalFunction": "ogr2ogr"
+        },
+        "type": "vector"
+    },
     {
         "description": "Buffer",
         "name": "buffer",
@@ -48,26 +49,25 @@
         "type": "vector"
     },
     {
-        "description": "BoundingBoxes",
-        "name": "boundingBoxes",
-        "operationParams": [],
-        "label": "Bounding Boxes",
+        "description": "Dissolve",
+        "name": "dissolve",
+        "operationParams": [
+            "dissolveField"
+        ],
+        "label": "Dissolve",
         "operations": {
-            "sql": "SELECT ST_Envelope(geometry) AS geometry, * FROM \"{layerName}\"",
-            "gdalFunction": "ogr2ogr"
+            "gdalFunction": "ogr2ogr",
+            "sql": "SELECT ST_Union(geometry) AS geometry, {dissolveField} FROM \"{layerName}\" GROUP BY {dissolveField}"
         },
         "type": "vector"
     },
     {
-        "description": "ConcaveHull",
-        "name": "concaveHull",
-        "operationParams": [
-            "pctconvex",
-            "allowHoles"
-        ],
-        "label": "Concave Hull",
+        "description": "BoundingBoxes",
+        "name": "boundingBoxes",
+        "operationParams": [],
+        "label": "Bounding Boxes",
         "operations": {
-            "sql": "SELECT ST_ConcaveHull(geometry,{pctconvex},{allowHoles}) AS geometry, * FROM \"{layerName}\"",
+            "sql": "SELECT ST_Envelope(geometry) AS geometry, * FROM \"{layerName}\"",
             "gdalFunction": "ogr2ogr"
         },
         "type": "vector"

package/lib/schema/project/jgis.json

@@ -55,7 +55,8 @@
                 "ImageSource",
                 "ShapefileSource",
                 "GeoTiffSource",
-                "GeoParquetSource"
+                "GeoParquetSource",
+                "MarkerSource"
             ]
         },
         "jGISLayer": {

package/lib/schema/project/sources/geoTiffSource.json

@@ -26,10 +26,12 @@
         },
         "normalize": {
             "type": "boolean",
+            "description": "Enable to normalize values between 0 and 1 and displayed as RGB values; disable to keep raw band values",
             "default": true
         },
         "wrapX": {
             "type": "boolean",
+            "description": "Wrap the map horizontally?",
             "default": false
         },
         "interpolate": {

package/lib/schema/project/sources/markerSource.json

@@ -0,0 +1,28 @@
+{
+    "type": "object",
+    "description": "MarkerSource",
+    "title": "IMarkerSource",
+    "required": ["feature"],
+    "additionalProperties": false,
+    "properties": {
+        "color": {
+            "type": "string",
+            "description": "Color of the marker icon (hex, rgb, rgba, or named color)"
+        },
+        "feature": {
+            "type": "object",
+            "description": "Info for the marker",
+            "required": ["coords"],
+            "properties": {
+                "coords": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": {
+                        "type": "number"
+                    }
+                }
+            }
+        }
+    }
+}

package/lib/types.d.ts

@@ -8,6 +8,7 @@ export * from './_interface/project/sources/shapefileSource';
 export * from './_interface/project/sources/vectorTileSource';
 export * from './_interface/project/sources/videoSource';
 export * from './_interface/project/sources/geoParquetSource';
+export * from './_interface/project/sources/markerSource';
 export * from './_interface/project/layers/heatmapLayer';
 export * from './_interface/project/layers/hillshadeLayer';
 export * from './_interface/project/layers/rasterLayer';
@@ -24,3 +25,4 @@ export * from './index';
 export * from './interfaces';
 export * from './model';
 export * from './token';
+export type Modes = 'panning' | 'identifying' | 'marking';

package/lib/types.js

@@ -9,6 +9,7 @@ export * from './_interface/project/sources/shapefileSource';
 export * from './_interface/project/sources/vectorTileSource';
 export * from './_interface/project/sources/videoSource';
 export * from './_interface/project/sources/geoParquetSource';
+export * from './_interface/project/sources/markerSource';
 // Layers
 export * from './_interface/project/layers/heatmapLayer';
 export * from './_interface/project/layers/hillshadeLayer';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupytergis/schema",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "description": "A JupyterGIS schema package.",
   "keywords": [
     "jupytergis"