@jupytergis/schema 0.2.0 → 0.3.0

package/lib/_interface/forms.json

@@ -77,15 +77,15 @@
   "ImageSource": {
     "type": "object",
     "required": [
-      "url",
+      "path",
       "coordinates"
     ],
     "additionalProperties": false,
     "properties": {
-      "url": {
+      "path": {
         "type": "string",
         "readOnly": true,
-        "description": "URL that points to an image"
+        "description": "Path that points to an image"
       },
       "coordinates": {
         "type": "array",
@@ -116,23 +116,10 @@
         "type": "string",
         "description": "The url to the tile provider"
       },
-      "tileSize": {
-        "type": "number",
-        "description": " The tile size",
-        "default": 512
-      },
       "attribution": {
         "type": "string",
         "description": "The attribution for the raster-dem source"
       },
-      "encoding": {
-        "type": "string",
-        "enum": [
-          "terrarium",
-          "mapbox"
-        ],
-        "default": "mapbox"
-      },
       "urlParameters": {
         "type": "object",
         "additionalProperties": {
@@ -543,12 +530,7 @@
         "type": "object",
         "description": "The state of the symbology panel options",
         "required": [
-          "renderType",
-          "band",
-          "interpolation",
-          "colorRamp",
-          "nClasses",
-          "mode"
+          "renderType"
         ],
         "properties": {
           "renderType": {
@@ -557,6 +539,15 @@
           "band": {
             "type": "number"
           },
+          "redBand": {
+            "type": "number"
+          },
+          "greenBand": {
+            "type": "number"
+          },
+          "blueBand": {
+            "type": "number"
+          },
           "interpolation": {
             "type": "string",
             "enum": [

package/lib/_interface/imageSource.d.ts

@@ -10,9 +10,9 @@
  */
 export interface IImageSource {
   /**
-   * URL that points to an image
+   * Path that points to an image
    */
-  url: string;
+  path: string;
   /**
    * Corners of image specified in longitude, latitude pairs
    */

package/lib/_interface/rasterDemSource.d.ts

@@ -13,15 +13,10 @@ export interface IRasterDemSource {
    * The url to the tile provider
    */
   url: string;
-  /**
-   *  The tile size
-   */
-  tileSize?: number;
   /**
    * The attribution for the raster-dem source
    */
   attribution?: string;
-  encoding?: "terrarium" | "mapbox";
   urlParameters?: {
     [k: string]: string;
   };

package/lib/_interface/webGlLayer.d.ts

@@ -26,10 +26,13 @@ export interface IWebGlLayer {
    */
   symbologyState?: {
     renderType: string;
-    band: number;
-    interpolation: "discrete" | "linear" | "exact";
-    colorRamp: string;
-    nClasses: string;
-    mode: "continuous" | "equal interval" | "quantile";
+    band?: number;
+    redBand?: number;
+    greenBand?: number;
+    blueBand?: number;
+    interpolation?: "discrete" | "linear" | "exact";
+    colorRamp?: string;
+    nClasses?: string;
+    mode?: "continuous" | "equal interval" | "quantile";
   };
 }

package/lib/doc.d.ts

@@ -6,7 +6,7 @@ import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChan
 export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> implements IJupyterGISDoc {
     constructor();
     getSource(): JSONObject;
-    setSource(value: JSONObject): void;
+    setSource(value: JSONObject | string): void;
     dispose(): void;
     get version(): string;
     get layers(): IJGISLayers;

package/lib/doc.js

@@ -42,6 +42,10 @@ export class JupyterGISDoc extends YDocument {
         if (!value) {
             return;
         }
+        if (typeof value === 'string') {
+            value = JSON.parse(value);
+        }
+        value = value;
         this.transact(() => {
             var _a, _b, _c, _d, _e;
             const layers = (_a = value['layers']) !== null && _a !== void 0 ? _a : {};

package/lib/interfaces.d.ts

@@ -5,7 +5,7 @@ import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
 import { Contents, User } from '@jupyterlab/services';
 import { ISignal, Signal } from '@lumino/signaling';
 import { SplitPanel } from '@lumino/widgets';
-import { GeoJSON } from './_interface/geojsonsource';
+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';
@@ -127,8 +127,9 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     sharedLayerTreeChanged: ISignal<IJupyterGISDoc, IJGISLayerTreeDocChange>;
     sharedSourcesChanged: ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
     sharedMetadataChanged: ISignal<IJupyterGISModel, MapChange>;
-    zoomToAnnotationSignal: ISignal<IJupyterGISModel, string>;
-    setContentsManager(value: Contents.IManager | undefined, filePath: string): void;
+    zoomToPositionSignal: ISignal<IJupyterGISModel, string>;
+    contentsManager: Contents.IManager | undefined;
+    filePath: string;
     getContent(): IJGISContent;
     getLayers(): IJGISLayers;
     getLayer(id: string): IJGISLayer | undefined;
@@ -143,7 +144,6 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     removeLayer(id: string): void;
     getOptions(): IJGISOptions;
     setOptions(value: IJGISOptions): void;
-    readGeoJSON(filepath: string): Promise<GeoJSON | undefined>;
     removeLayerGroup(groupName: string): void;
     renameLayerGroup(groupName: string, newName: string): void;
     moveItemsToGroup(items: string[], groupName: string, index?: number): void;
@@ -161,7 +161,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     getClientId(): number;
     addMetadata(key: string, value: string): void;
     removeMetadata(key: string): void;
-    centerOnAnnotation(id: string): void;
+    centerOnPosition(id: string): void;
     toggleIdentify(): void;
     isIdentifying: boolean;
     disposed: ISignal<any, void>;
@@ -196,6 +196,7 @@ export interface IJGISFormSchemaRegistry {
      * @memberof IJGISFormSchemaRegistry
      */
     has(name: string): boolean;
+    getDocManager(): IDocumentManager;
 }
 export interface IJGISExternalCommand {
     name: string;

package/lib/model.d.ts

@@ -3,7 +3,6 @@ import { IChangedArgs } from '@jupyterlab/coreutils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { PartialJSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
-import { GeoJSON } from './_interface/geojsonsource';
 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';
@@ -31,10 +30,10 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     get sharedSourcesChanged(): ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
     get disposed(): ISignal<JupyterGISModel, void>;
     get sharedMetadataChanged(): ISignal<this, MapChange>;
-    get zoomToAnnotationSignal(): ISignal<this, string>;
+    get zoomToPositionSignal(): ISignal<this, string>;
     set isIdentifying(isIdentifying: boolean);
     get isIdentifying(): boolean;
-    centerOnAnnotation(id: string): void;
+    centerOnPosition(id: string): void;
     private _metadataChangedHandler;
     addMetadata(key: string, value: string): void;
     removeMetadata(key: string): void;
@@ -46,7 +45,23 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     initialize(): void;
     getWorker(): Worker;
     getContent(): IJGISContent;
-    setContentsManager(value: Contents.IManager | undefined, filePath: string): void;
+    /**
+     * Getter for the contents manager.
+     */
+    get contentsManager(): Contents.IManager | undefined;
+    /**
+     * Setter for the contents manager.
+     * Also updates the file path.
+     */
+    set contentsManager(manager: Contents.IManager | undefined);
+    /**
+     * Getter for the file path associated with the contents manager.
+     */
+    get filePath(): string;
+    /**
+     * Setter for the file path associated with the contents manager.
+     */
+    set filePath(path: string);
     getLayers(): IJGISLayers;
     getSources(): IJGISSources;
     getLayerTree(): IJGISLayerTree;
@@ -66,13 +81,6 @@ export declare class JupyterGISModel implements IJupyterGISModel {
      * @returns a list of layer ids that use the source.
      */
     getLayersBySource(id: string): string[];
-    /**
-     * Read a GeoJSON file.
-     *
-     * @param filepath - the path of the GeoJSON file.
-     * @returns a promise to the GeoJSON data.
-     */
-    readGeoJSON(filepath: string): Promise<GeoJSON | undefined>;
     /**
      * Add a layer group in the layer tree.
      *
@@ -145,7 +153,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _themeChanged;
     private _clientStateChanged;
     private _sharedMetadataChanged;
-    private _zoomToAnnotationSignal;
+    private _zoomToPositionSignal;
     private _isIdentifying;
     static worker: Worker;
 }

package/lib/model.js

@@ -1,4 +1,3 @@
-import { PathExt } from '@jupyterlab/coreutils';
 import { Signal } from '@lumino/signaling';
 import Ajv from 'ajv';
 import { JupyterGISDoc } from './doc';
@@ -32,7 +31,7 @@ export class JupyterGISModel {
         this._themeChanged = new Signal(this);
         this._clientStateChanged = new Signal(this);
         this._sharedMetadataChanged = new Signal(this);
-        this._zoomToAnnotationSignal = new Signal(this);
+        this._zoomToPositionSignal = new Signal(this);
         this._isIdentifying = false;
         const { annotationModel, sharedModel } = options;
         if (sharedModel) {
@@ -115,8 +114,8 @@ export class JupyterGISModel {
     get sharedMetadataChanged() {
         return this._sharedMetadataChanged;
     }
-    get zoomToAnnotationSignal() {
-        return this._zoomToAnnotationSignal;
+    get zoomToPositionSignal() {
+        return this._zoomToPositionSignal;
     }
     set isIdentifying(isIdentifying) {
         this._isIdentifying = isIdentifying;
@@ -124,8 +123,8 @@ export class JupyterGISModel {
     get isIdentifying() {
         return this._isIdentifying;
     }
-    centerOnAnnotation(id) {
-        this._zoomToAnnotationSignal.emit(id);
+    centerOnPosition(id) {
+        this._zoomToPositionSignal.emit(id);
     }
     _metadataChangedHandler(_, args) {
         this._sharedMetadataChanged.emit(args);
@@ -198,9 +197,30 @@ export class JupyterGISModel {
             metadata: this.sharedModel.metadata
         };
     }
-    setContentsManager(value, filePath) {
-        this._contentsManager = value;
-        this._filePath = filePath;
+    /**
+     * Getter for the contents manager.
+     */
+    get contentsManager() {
+        return this._contentsManager;
+    }
+    /**
+     * Setter for the contents manager.
+     * Also updates the file path.
+     */
+    set contentsManager(manager) {
+        this._contentsManager = manager;
+    }
+    /**
+     * Getter for the file path associated with the contents manager.
+     */
+    get filePath() {
+        return this._filePath;
+    }
+    /**
+     * Setter for the file path associated with the contents manager.
+     */
+    set filePath(path) {
+        this._filePath = path;
     }
     getLayers() {
         return this.sharedModel.layers;
@@ -247,25 +267,6 @@ export class JupyterGISModel {
         });
         return usingLayers;
     }
-    /**
-     * Read a GeoJSON file.
-     *
-     * @param filepath - the path of the GeoJSON file.
-     * @returns a promise to the GeoJSON data.
-     */
-    async readGeoJSON(filepath) {
-        if (!this._contentsManager) {
-            return;
-        }
-        const absolutePath = PathExt.resolve(PathExt.dirname(this._filePath), filepath);
-        const file = await this._contentsManager.get(absolutePath, {
-            content: true
-        });
-        if (typeof file.content === 'string') {
-            return JSON.parse(file.content);
-        }
-        return file.content;
-    }
     /**
      * Add a layer group in the layer tree.
      *

package/lib/schema/imageSource.json

@@ -2,13 +2,13 @@
     "type": "object",
     "description": "ImageSource",
     "title": "IImageSource",
-    "required": ["url", "coordinates"],
+    "required": ["path", "coordinates"],
     "additionalProperties": false,
     "properties": {
-        "url": {
+        "path": {
             "type": "string",
             "readOnly": true,
-            "description": "URL that points to an image"
+            "description": "Path that points to an image"
         },
         "coordinates": {
             "type": "array",

package/lib/schema/rasterDemSource.json

@@ -9,20 +9,10 @@
             "type": "string",
             "description": "The url to the tile provider"
         },
-        "tileSize": {
-            "type": "number",
-            "description": " The tile size",
-            "default": 512
-        },
         "attribution": {
             "type": "string",
             "description": "The attribution for the raster-dem source"
         },
-        "encoding": {
-            "type": "string",
-            "enum": ["terrarium", "mapbox"],
-            "default": "mapbox"
-        },
         "urlParameters": {
             "type": "object",
             "additionalProperties": {

package/lib/schema/webGlLayer.json

@@ -51,14 +51,7 @@
         "symbologyState": {
             "type": "object",
             "description": "The state of the symbology panel options",
-            "required": [
-                "renderType",
-                "band",
-                "interpolation",
-                "colorRamp",
-                "nClasses",
-                "mode"
-            ],
+            "required": ["renderType"],
             "properties": {
                 "renderType": {
                     "type": "string"
@@ -66,6 +59,15 @@
                 "band": {
                     "type": "number"
                 },
+                "redBand": {
+                    "type": "number"
+                },
+                "greenBand": {
+                    "type": "number"
+                },
+                "blueBand": {
+                    "type": "number"
+                },
                 "interpolation": {
                     "type": "string",
                     "enum": ["discrete", "linear", "exact"]

package/package.json

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