@jupytergis/schema 0.3.0 → 0.4.0

package/lib/_interface/forms.json

@@ -35,6 +35,68 @@
       }
     }
   },
+  "HeatmapLayer": {
+    "type": "object",
+    "required": [
+      "source",
+      "blur",
+      "radius"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "source": {
+        "type": "string",
+        "description": "The id of the source"
+      },
+      "opacity": {
+        "type": "number",
+        "description": "The opacity of the source",
+        "default": 1,
+        "multipleOf": 0.1,
+        "minimum": 0,
+        "maximum": 1
+      },
+      "radius": {
+        "type": "number",
+        "description": "Radius size in pixels",
+        "default": 8
+      },
+      "blur": {
+        "type": "number",
+        "description": "Blur size in pixels",
+        "default": 15
+      },
+      "color": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "default": [
+          "#00f",
+          "#0ff",
+          "#0f0",
+          "#ff0",
+          "#f00"
+        ]
+      },
+      "symbologyState": {
+        "type": "object",
+        "description": "The state of the symbology panel options",
+        "required": [
+          "renderType"
+        ],
+        "properties": {
+          "renderType": {
+            "type": "string"
+          },
+          "colorRamp": {
+            "type": "string",
+            "default": "cool"
+          }
+        }
+      }
+    }
+  },
   "HillshadeLayer": {
     "type": "object",
     "required": [
@@ -276,10 +338,6 @@
         "default": "line",
         "description": "The type of vector layer"
       },
-      "sourceLayer": {
-        "type": "string",
-        "description": "The source layer to use"
-      },
       "color": {
         "type": "object",
         "description": "The color of the the object"
@@ -316,10 +374,6 @@
         "default": "line",
         "description": "The type of vector layer"
       },
-      "sourceLayer": {
-        "type": "string",
-        "description": "The source layer to use"
-      },
       "color": {
         "type": "object",
         "description": "The color of the the object"

package/lib/_interface/heatmapLayer.d.ts

@@ -0,0 +1,37 @@
+/* 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.
+ */
+
+/**
+ * HeatmapLayer
+ */
+export interface IHeatmapLayer {
+  /**
+   * The id of the source
+   */
+  source: string;
+  /**
+   * The opacity of the source
+   */
+  opacity?: number;
+  /**
+   * Radius size in pixels
+   */
+  radius: number;
+  /**
+   * Blur size in pixels
+   */
+  blur: number;
+  color?: string[];
+  /**
+   * The state of the symbology panel options
+   */
+  symbologyState?: {
+    renderType: string;
+    colorRamp?: string;
+    [k: string]: any;
+  };
+}

package/lib/_interface/jgis.d.ts

@@ -15,7 +15,8 @@ export type LayerType =
   | "VectorTileLayer"
   | "HillshadeLayer"
   | "WebGlLayer"
-  | "ImageLayer";
+  | "ImageLayer"
+  | "HeatmapLayer";
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema
  * via the `definition` "sourceType".
@@ -86,9 +87,11 @@ export interface IJGISFilter {
  * via the `definition` "jGISFilterItem".
  */
 export interface IJGISFilterItem {
-  operator: "==" | "!=" | ">" | "<" | ">=" | "<=";
+  operator: "==" | "!=" | ">" | "<" | ">=" | "<=" | "between";
   feature: string;
   value: string | number;
+  betweenMin?: number;
+  betweenMax?: number;
 }
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema

package/lib/_interface/vectorTileLayer.d.ts

@@ -17,10 +17,6 @@ export interface IVectorTileLayer {
    * The type of vector layer
    */
   type: "circle" | "fill" | "line";
-  /**
-   * The source layer to use
-   */
-  sourceLayer?: string;
   /**
    * The color of the the object
    */

package/lib/_interface/vectorlayer.d.ts

@@ -17,10 +17,6 @@ export interface IVectorLayer {
    * The type of vector layer
    */
   type: "circle" | "fill" | "line";
-  /**
-   * The source layer to use
-   */
-  sourceLayer?: string;
   /**
    * The color of the the object
    */

package/lib/doc.js

@@ -259,6 +259,7 @@ export class JupyterGISDoc extends YDocument {
                 }
                 changes.push({
                     id: key,
+                    oldValue: change.oldValue,
                     newValue: JSONExt.deepCopy(event.target.toJSON()[key])
                 });
             });

package/lib/interfaces.d.ts

@@ -1,11 +1,12 @@
 import { Delta, DocumentChange, MapChange, StateChange, YDocument } from '@jupyter/ydoc';
-import { IWidgetTracker } from '@jupyterlab/apputils';
+import { IWidgetTracker, MainAreaWidget } from '@jupyterlab/apputils';
 import { IChangedArgs } from '@jupyterlab/coreutils';
+import { IDocumentManager } from '@jupyterlab/docmanager';
 import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
 import { Contents, User } from '@jupyterlab/services';
+import { JSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { SplitPanel } from '@lumino/widgets';
-import { IDocumentManager } from '@jupyterlab/docmanager';
 import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerItem, IJGISLayers, IJGISLayerTree, IJGISOptions, IJGISSource, IJGISSources, SourceType } from './_interface/jgis';
 import { IRasterSource } from './_interface/rastersource';
 export { IGeoJSONSource } from './_interface/geojsonsource';
@@ -29,6 +30,7 @@ export interface IDict<T = any> {
 export interface IJGISLayerDocChange {
     layerChange?: Array<{
         id: string;
+        oldValue: IDict;
         newValue: IJGISLayer | undefined;
     }>;
 }
@@ -69,6 +71,7 @@ export interface IJupyterGISClientState {
     user: User.IIdentity;
     remoteUser?: number;
     toolbarForm?: IDict;
+    isTemporalControllerActive: boolean;
 }
 export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     options: IJGISOptions;
@@ -78,6 +81,8 @@ export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     metadata: any;
     readonly editable: boolean;
     readonly toJGISEndpoint?: string;
+    getSource(): JSONObject;
+    setSource(value: JSONObject | string): void;
     layerExists(id: string): boolean;
     getLayer(id: string): IJGISLayer | undefined;
     removeLayer(id: string): void;
@@ -128,6 +133,8 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     sharedSourcesChanged: ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
     sharedMetadataChanged: ISignal<IJupyterGISModel, MapChange>;
     zoomToPositionSignal: ISignal<IJupyterGISModel, string>;
+    addFeatureAsMsSignal: ISignal<IJupyterGISModel, string>;
+    updateLayerSignal: ISignal<IJupyterGISModel, string>;
     contentsManager: Contents.IManager | undefined;
     filePath: string;
     getContent(): IJGISContent;
@@ -164,13 +171,23 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     centerOnPosition(id: string): void;
     toggleIdentify(): void;
     isIdentifying: boolean;
+    isTemporalControllerActive: boolean;
+    toggleTemporalController(): void;
+    addFeatureAsMs(id: string, selectedFeature: string): void;
+    triggerLayerUpdate(layerId: string, layer: IJGISLayer): void;
     disposed: ISignal<any, void>;
 }
 export interface IUserData {
     userId: number;
     userData: User.IIdentity;
 }
-export type IJupyterGISWidget = IDocumentWidget<SplitPanel, IJupyterGISModel>;
+export interface IJupyterGISDocumentWidget extends IDocumentWidget<SplitPanel, IJupyterGISModel> {
+    readonly model: IJupyterGISModel;
+}
+export interface IJupyterGISOutputWidget extends MainAreaWidget {
+    model: IJupyterGISModel;
+}
+export type IJupyterGISWidget = IJupyterGISDocumentWidget | IJupyterGISOutputWidget;
 export type IJupyterGISTracker = IWidgetTracker<IJupyterGISWidget>;
 export interface IJGISFormSchemaRegistry {
     /**
@@ -228,8 +245,8 @@ export interface IJGISLayerBrowserRegistry {
 export interface IAnnotationModel {
     updateSignal: ISignal<this, null>;
     user: User.IIdentity | undefined;
-    context: DocumentRegistry.IContext<IJupyterGISModel> | undefined;
-    contextChanged: ISignal<this, void>;
+    model: IJupyterGISModel | undefined;
+    modelChanged: ISignal<this, void>;
     update(): void;
     getAnnotation(id: string): IAnnotation | undefined;
     getAnnotationIds(): string[];

package/lib/model.d.ts

@@ -1,11 +1,11 @@
 import { MapChange } from '@jupyter/ydoc';
 import { IChangedArgs } from '@jupyterlab/coreutils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
+import { Contents } from '@jupyterlab/services';
 import { PartialJSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources } from './_interface/jgis';
-import { IViewPortState, Pointer, IAnnotationModel, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISClientState, IJupyterGISDoc, IJupyterGISModel, ISelection, IUserData, IDict } from './interfaces';
-import { Contents } from '@jupyterlab/services';
+import { IAnnotationModel, IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISClientState, IJupyterGISDoc, IJupyterGISModel, ISelection, IUserData, IViewPortState, Pointer } from './interfaces';
 export declare class JupyterGISModel implements IJupyterGISModel {
     constructor(options: JupyterGISModel.IOptions);
     private _onSharedModelChanged;
@@ -33,6 +33,8 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     get zoomToPositionSignal(): ISignal<this, string>;
     set isIdentifying(isIdentifying: boolean);
     get isIdentifying(): boolean;
+    set isTemporalControllerActive(isActive: boolean);
+    get isTemporalControllerActive(): boolean;
     centerOnPosition(id: string): void;
     private _metadataChangedHandler;
     addMetadata(key: string, value: string): void;
@@ -134,8 +136,13 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     renameLayerGroup(groupName: string, newName: string): void;
     removeLayerGroup(groupName: string): void;
     toggleIdentify(): void;
+    toggleTemporalController(): void;
     private _getLayerTreeInfo;
     private _onClientStateChanged;
+    addFeatureAsMs: (id: string, selectedFeature: string) => void;
+    get addFeatureAsMsSignal(): Signal<this, string>;
+    get updateLayerSignal(): Signal<this, string>;
+    triggerLayerUpdate: (layerId: string, layer: IJGISLayer) => void;
     readonly defaultKernelName: string;
     readonly defaultKernelLanguage: string;
     readonly annotationModel?: IAnnotationModel;
@@ -154,7 +161,10 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _clientStateChanged;
     private _sharedMetadataChanged;
     private _zoomToPositionSignal;
+    private _addFeatureAsMsSignal;
+    private _updateLayerSignal;
     private _isIdentifying;
+    private _isTemporalControllerActive;
     static worker: Worker;
 }
 export declare namespace JupyterGISModel {

package/lib/model.js

@@ -19,6 +19,12 @@ export class JupyterGISModel {
                 this._userChanged.emit(this.users);
             }
         };
+        this.addFeatureAsMs = (id, selectedFeature) => {
+            this.addFeatureAsMsSignal.emit(JSON.stringify({ id, selectedFeature }));
+        };
+        this.triggerLayerUpdate = (layerId, layer) => {
+            this.updateLayerSignal.emit(JSON.stringify({ layerId, layer }));
+        };
         this.defaultKernelName = '';
         this.defaultKernelLanguage = '';
         this._dirty = false;
@@ -32,7 +38,10 @@ export class JupyterGISModel {
         this._clientStateChanged = new Signal(this);
         this._sharedMetadataChanged = new Signal(this);
         this._zoomToPositionSignal = new Signal(this);
+        this._addFeatureAsMsSignal = new Signal(this);
+        this._updateLayerSignal = new Signal(this);
         this._isIdentifying = false;
+        this._isTemporalControllerActive = false;
         const { annotationModel, sharedModel } = options;
         if (sharedModel) {
             this._sharedModel = sharedModel;
@@ -123,6 +132,12 @@ export class JupyterGISModel {
     get isIdentifying() {
         return this._isIdentifying;
     }
+    set isTemporalControllerActive(isActive) {
+        this._isTemporalControllerActive = isActive;
+    }
+    get isTemporalControllerActive() {
+        return this._isTemporalControllerActive;
+    }
     centerOnPosition(id) {
         this._zoomToPositionSignal.emit(id);
     }
@@ -489,6 +504,10 @@ export class JupyterGISModel {
     toggleIdentify() {
         this._isIdentifying = !this._isIdentifying;
     }
+    toggleTemporalController() {
+        this._isTemporalControllerActive = !this._isTemporalControllerActive;
+        this.sharedModel.awareness.setLocalStateField('isTemporalControllerActive', this._isTemporalControllerActive);
+    }
     _getLayerTreeInfo(groupName) {
         const layerTree = this.getLayerTree();
         const indexesPath = Private.findItemPath(layerTree, groupName);
@@ -515,6 +534,12 @@ export class JupyterGISModel {
             mainGroupIndex
         };
     }
+    get addFeatureAsMsSignal() {
+        return this._addFeatureAsMsSignal;
+    }
+    get updateLayerSignal() {
+        return this._updateLayerSignal;
+    }
 }
 (function (JupyterGISModel) {
     /**

package/lib/schema/heatmapLayer.json

@@ -0,0 +1,52 @@
+{
+    "type": "object",
+    "description": "HeatmapLayer",
+    "title": "IHeatmapLayer",
+    "required": ["source", "blur", "radius"],
+    "additionalProperties": false,
+    "properties": {
+        "source": {
+            "type": "string",
+            "description": "The id of the source"
+        },
+        "opacity": {
+            "type": "number",
+            "description": "The opacity of the source",
+            "default": 1,
+            "multipleOf": 0.1,
+            "minimum": 0,
+            "maximum": 1
+        },
+        "radius": {
+            "type": "number",
+            "description": "Radius size in pixels",
+            "default": 8
+        },
+        "blur": {
+            "type": "number",
+            "description": "Blur size in pixels",
+            "default": 15
+        },
+        "color": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "default": ["#00f", "#0ff", "#0f0", "#ff0", "#f00"]
+        },
+        "symbologyState": {
+            "type": "object",
+            "description": "The state of the symbology panel options",
+            "required": ["renderType"],
+            "properties": {
+                "renderType": {
+                    "type": "string"
+                },
+                "colorRamp": {
+                    "type": "string",
+                    "default": "cool"
+                }
+            }
+        }
+    }
+}

package/lib/schema/jgis.json

@@ -35,7 +35,8 @@
                 "VectorTileLayer",
                 "HillshadeLayer",
                 "WebGlLayer",
-                "ImageLayer"
+                "ImageLayer",
+                "HeatmapLayer"
             ]
         },
         "sourceType": {
@@ -205,7 +206,7 @@
             "properties": {
                 "operator": {
                     "type": "string",
-                    "enum": ["==", "!=", ">", "<", ">=", "<="],
+                    "enum": ["==", "!=", ">", "<", ">=", "<=", "between"],
                     "default": "=="
                 },
                 "feature": {
@@ -214,6 +215,12 @@
                 },
                 "value": {
                     "type": ["string", "number"]
+                },
+                "betweenMin": {
+                    "type": ["number"]
+                },
+                "betweenMax": {
+                    "type": ["number"]
                 }
             }
         },

package/lib/schema/vectorTileLayer.json

@@ -15,10 +15,6 @@
             "default": "line",
             "description": "The type of vector layer"
         },
-        "sourceLayer": {
-            "type": "string",
-            "description": "The source layer to use"
-        },
         "color": {
             "type": "object",
             "description": "The color of the the object"

package/lib/schema/vectorlayer.json

@@ -15,10 +15,6 @@
             "default": "line",
             "description": "The type of vector layer"
         },
-        "sourceLayer": {
-            "type": "string",
-            "description": "The source layer to use"
-        },
         "color": {
             "type": "object",
             "description": "The color of the the object"

package/lib/types.d.ts

@@ -13,6 +13,7 @@ export * from './_interface/vectorlayer';
 export * from './_interface/vectorTileLayer';
 export * from './_interface/webGlLayer';
 export * from './_interface/imageLayer';
+export * from './_interface/heatmapLayer';
 export * from './doc';
 export * from './interfaces';
 export * from './model';

package/lib/types.js

@@ -15,6 +15,7 @@ export * from './_interface/vectorlayer';
 export * from './_interface/vectorTileLayer';
 export * from './_interface/webGlLayer';
 export * from './_interface/imageLayer';
+export * from './_interface/heatmapLayer';
 // Other
 export * from './doc';
 export * from './interfaces';

package/package.json

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