@jupytergis/schema 0.1.6 → 0.2.0

package/lib/_interface/forms.json

@@ -344,6 +344,53 @@
         "multipleOf": 0.1,
         "minimum": 0,
         "maximum": 1
+      },
+      "symbologyState": {
+        "type": "object",
+        "description": "The state of the symbology panel options",
+        "required": [
+          "renderType"
+        ],
+        "properties": {
+          "renderType": {
+            "type": "string",
+            "enum": [
+              "Single Symbol",
+              "Graduated",
+              "Categorized"
+            ]
+          },
+          "value": {
+            "type": "string"
+          },
+          "method": {
+            "type": "string",
+            "enum": [
+              "color",
+              "radius"
+            ]
+          },
+          "colorRamp": {
+            "type": "string",
+            "default": "cool"
+          },
+          "nClasses": {
+            "type": "string",
+            "default": "9"
+          },
+          "mode": {
+            "type": "string",
+            "default": "equal interval",
+            "enum": [
+              "quantile",
+              "equal interval",
+              "jenks",
+              "pretty",
+              "logarithmic"
+            ]
+          }
+        },
+        "additionalProperties": false
       }
     }
   },
@@ -491,6 +538,52 @@
           }
         ],
         "description": "The color of the the object"
+      },
+      "symbologyState": {
+        "type": "object",
+        "description": "The state of the symbology panel options",
+        "required": [
+          "renderType",
+          "band",
+          "interpolation",
+          "colorRamp",
+          "nClasses",
+          "mode"
+        ],
+        "properties": {
+          "renderType": {
+            "type": "string"
+          },
+          "band": {
+            "type": "number"
+          },
+          "interpolation": {
+            "type": "string",
+            "enum": [
+              "discrete",
+              "linear",
+              "exact"
+            ]
+          },
+          "colorRamp": {
+            "type": "string",
+            "default": "cool"
+          },
+          "nClasses": {
+            "type": "string",
+            "default": "9"
+          },
+          "mode": {
+            "type": "string",
+            "default": "equal interval",
+            "enum": [
+              "continuous",
+              "equal interval",
+              "quantile"
+            ]
+          }
+        },
+        "additionalProperties": false
       }
     }
   },

package/lib/_interface/geojson.d.ts

@@ -0,0 +1,387 @@
+/* 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.
+ */
+
+export type GeoJSON =
+  | GeoJSONPoint
+  | GeoJSONLineString
+  | GeoJSONPolygon
+  | GeoJSONMultiPoint
+  | GeoJSONMultiLineString
+  | GeoJSONMultiPolygon
+  | GeoJSONGeometryCollection
+  | GeoJSONFeature
+  | GeoJSONFeatureCollection;
+
+export interface GeoJSONPoint {
+  type: "Point";
+  coordinates: [number, number, ...number[]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONLineString {
+  type: "LineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPolygon {
+  type: "Polygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPoint {
+  type: "MultiPoint";
+  coordinates: [number, number, ...number[]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiLineString {
+  type: "MultiLineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPolygon {
+  type: "MultiPolygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONGeometryCollection {
+  type: "GeometryCollection";
+  geometries: (
+    | GeoJSONPoint1
+    | GeoJSONLineString1
+    | GeoJSONPolygon1
+    | GeoJSONMultiPoint1
+    | GeoJSONMultiLineString1
+    | GeoJSONMultiPolygon1
+  )[];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPoint1 {
+  type: "Point";
+  coordinates: [number, number, ...number[]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONLineString1 {
+  type: "LineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPolygon1 {
+  type: "Polygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPoint1 {
+  type: "MultiPoint";
+  coordinates: [number, number, ...number[]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiLineString1 {
+  type: "MultiLineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPolygon1 {
+  type: "MultiPolygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONFeature {
+  type: "Feature";
+  id?: number | string;
+  properties: null | {
+    [k: string]: any;
+  };
+  geometry:
+    | null
+    | GeoJSONPoint2
+    | GeoJSONLineString2
+    | GeoJSONPolygon2
+    | GeoJSONMultiPoint2
+    | GeoJSONMultiLineString2
+    | GeoJSONMultiPolygon2
+    | GeoJSONGeometryCollection1;
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPoint2 {
+  type: "Point";
+  coordinates: [number, number, ...number[]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONLineString2 {
+  type: "LineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPolygon2 {
+  type: "Polygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPoint2 {
+  type: "MultiPoint";
+  coordinates: [number, number, ...number[]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiLineString2 {
+  type: "MultiLineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPolygon2 {
+  type: "MultiPolygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONGeometryCollection1 {
+  type: "GeometryCollection";
+  geometries: (
+    | GeoJSONPoint3
+    | GeoJSONLineString3
+    | GeoJSONPolygon3
+    | GeoJSONMultiPoint3
+    | GeoJSONMultiLineString3
+    | GeoJSONMultiPolygon3
+  )[];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPoint3 {
+  type: "Point";
+  coordinates: [number, number, ...number[]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONLineString3 {
+  type: "LineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPolygon3 {
+  type: "Polygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPoint3 {
+  type: "MultiPoint";
+  coordinates: [number, number, ...number[]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiLineString3 {
+  type: "MultiLineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPolygon3 {
+  type: "MultiPolygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONFeatureCollection {
+  type: "FeatureCollection";
+  features: GeoJSONFeature1[];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONFeature1 {
+  type: "Feature";
+  id?: number | string;
+  properties: null | {
+    [k: string]: any;
+  };
+  geometry:
+    | null
+    | GeoJSONPoint4
+    | GeoJSONLineString4
+    | GeoJSONPolygon4
+    | GeoJSONMultiPoint4
+    | GeoJSONMultiLineString4
+    | GeoJSONMultiPolygon4
+    | GeoJSONGeometryCollection2;
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPoint4 {
+  type: "Point";
+  coordinates: [number, number, ...number[]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONLineString4 {
+  type: "LineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPolygon4 {
+  type: "Polygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPoint4 {
+  type: "MultiPoint";
+  coordinates: [number, number, ...number[]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiLineString4 {
+  type: "MultiLineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPolygon4 {
+  type: "MultiPolygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONGeometryCollection2 {
+  type: "GeometryCollection";
+  geometries: (
+    | GeoJSONPoint5
+    | GeoJSONLineString5
+    | GeoJSONPolygon5
+    | GeoJSONMultiPoint5
+    | GeoJSONMultiLineString5
+    | GeoJSONMultiPolygon5
+  )[];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPoint5 {
+  type: "Point";
+  coordinates: [number, number, ...number[]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONLineString5 {
+  type: "LineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONPolygon5 {
+  type: "Polygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPoint5 {
+  type: "MultiPoint";
+  coordinates: [number, number, ...number[]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiLineString5 {
+  type: "MultiLineString";
+  coordinates: [[number, number, ...number[]], [number, number, ...number[]], ...[number, number, ...number[]][]][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}
+export interface GeoJSONMultiPolygon5 {
+  type: "MultiPolygon";
+  coordinates: [
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    [number, number, ...number[]],
+    ...[number, number, ...number[]][]
+  ][][];
+  bbox?: [number, number, number, number, ...number[]];
+  [k: string]: any;
+}

package/lib/_interface/jgis.d.ts

@@ -45,6 +45,13 @@ export interface IJGISContent {
   sources: IJGISSources;
   layerTree?: IJGISLayerTree;
   options?: IJGISOptions;
+  metadata?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^.*$".
+     */
+    [k: string]: string;
+  };
 }
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema

package/lib/_interface/vectorlayer.d.ts

@@ -31,4 +31,15 @@ export interface IVectorLayer {
    * The opacity of the the object
    */
   opacity?: number;
+  /**
+   * The state of the symbology panel options
+   */
+  symbologyState?: {
+    renderType: "Single Symbol" | "Graduated" | "Categorized";
+    value?: string;
+    method?: "color" | "radius";
+    colorRamp?: string;
+    nClasses?: string;
+    mode?: "quantile" | "equal interval" | "jenks" | "pretty" | "logarithmic";
+  };
 }

package/lib/_interface/webGlLayer.d.ts

@@ -21,4 +21,15 @@ export interface IWebGlLayer {
    * The color of the the object
    */
   color?: string | number | (string | number | (number | string | (number | string)[])[])[];
+  /**
+   * The state of the symbology panel options
+   */
+  symbologyState?: {
+    renderType: string;
+    band: number;
+    interpolation: "discrete" | "linear" | "exact";
+    colorRamp: string;
+    nClasses: string;
+    mode: "continuous" | "equal interval" | "quantile";
+  };
 }

package/lib/doc.d.ts

@@ -1,9 +1,12 @@
 import { MapChange, YDocument } from '@jupyter/ydoc';
+import { JSONObject } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
 import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources } from './_interface/jgis';
 import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISDoc, IJupyterGISDocChange } from './interfaces';
 export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> implements IJupyterGISDoc {
     constructor();
+    getSource(): JSONObject;
+    setSource(value: JSONObject): void;
     dispose(): void;
     get version(): string;
     get layers(): IJGISLayers;
@@ -13,7 +16,7 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     get layerTree(): IJGISLayerTree;
     set layerTree(layerTree: IJGISLayerTree);
     getLayer(id: string): IJGISLayer | undefined;
-    getSource(id: string): IJGISSource | undefined;
+    getLayerSource(id: string): IJGISSource | undefined;
     set options(options: IJGISOptions);
     get options(): IJGISOptions;
     get layersChanged(): ISignal<IJupyterGISDoc, IJGISLayerDocChange>;
@@ -34,6 +37,14 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     updateSource(id: string, value: any): void;
     getOption(key: keyof IJGISOptions): IDict | undefined;
     setOption(key: keyof IJGISOptions, value: IDict): void;
+    getMetadata(key: string): string | undefined;
+    setMetadata(key: string, value: string): void;
+    removeMetadata(key: string): void;
+    get metadata(): JSONObject;
+    set metadata(metadata: {
+        [k: string]: string;
+    });
+    get metadataChanged(): ISignal<IJupyterGISDoc, MapChange>;
     static create(): IJupyterGISDoc;
     editable: boolean;
     private _getLayerAsYMap;
@@ -42,12 +53,15 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     private _layerTreeObserver;
     private _sourcesObserver;
     private _optionsObserver;
+    private _metaObserver;
     private _layers;
     private _layerTree;
     private _sources;
     private _options;
+    private _metadata;
     private _optionsChanged;
     private _layersChanged;
     private _layerTreeChanged;
     private _sourcesChanged;
+    private _metadataChanged;
 }

package/lib/doc.js

@@ -8,14 +8,19 @@ export class JupyterGISDoc extends YDocument {
         this._optionsObserver = (event) => {
             this._optionsChanged.emit(event.keys);
         };
+        this._metaObserver = (event) => {
+            this._metadataChanged.emit(event.keys);
+        };
         this._optionsChanged = new Signal(this);
         this._layersChanged = new Signal(this);
         this._layerTreeChanged = new Signal(this);
         this._sourcesChanged = new Signal(this);
+        this._metadataChanged = new Signal(this);
         this._options = this.ydoc.getMap('options');
         this._layers = this.ydoc.getMap('layers');
         this._layerTree = this.ydoc.getArray('layerTree');
         this._sources = this.ydoc.getMap('sources');
+        this._metadata = this.ydoc.getMap('metadata');
         this.undoManager.addToScope(this._layers);
         this.undoManager.addToScope(this._sources);
         this.undoManager.addToScope(this._layerTree);
@@ -23,6 +28,35 @@ export class JupyterGISDoc extends YDocument {
         this._layerTree.observe(this._layerTreeObserver.bind(this));
         this._sources.observeDeep(this._sourcesObserver.bind(this));
         this._options.observe(this._optionsObserver.bind(this));
+        this._metadata.observe(this._metaObserver.bind(this));
+    }
+    getSource() {
+        const layers = this._layers.toJSON();
+        const layerTree = this._layerTree.toJSON();
+        const options = this._options.toJSON();
+        const sources = this._sources.toJSON();
+        const metadata = this._metadata.toJSON();
+        return { layers, layerTree, sources, options, metadata };
+    }
+    setSource(value) {
+        if (!value) {
+            return;
+        }
+        this.transact(() => {
+            var _a, _b, _c, _d, _e;
+            const layers = (_a = value['layers']) !== null && _a !== void 0 ? _a : {};
+            Object.entries(layers).forEach(([key, val]) => this._layers.set(key, val));
+            const layerTree = (_b = value['layerTree']) !== null && _b !== void 0 ? _b : [];
+            layerTree.forEach(layer => {
+                this._layerTree.push([layer]);
+            });
+            const options = (_c = value['options']) !== null && _c !== void 0 ? _c : {};
+            Object.entries(options).forEach(([key, val]) => this._options.set(key, val));
+            const sources = (_d = value['sources']) !== null && _d !== void 0 ? _d : {};
+            Object.entries(sources).forEach(([key, val]) => this._sources.set(key, val));
+            const metadata = (_e = value['metadata']) !== null && _e !== void 0 ? _e : {};
+            Object.entries(metadata).forEach(([key, val]) => this._metadata.set(key, val));
+        });
     }
     dispose() {
         super.dispose();
@@ -65,7 +99,7 @@ export class JupyterGISDoc extends YDocument {
         }
         return JSONExt.deepCopy(this._layers.get(id));
     }
-    getSource(id) {
+    getLayerSource(id) {
         if (!this._sources.has(id)) {
             return undefined;
         }
@@ -129,7 +163,7 @@ export class JupyterGISDoc extends YDocument {
         if (layer) {
             return layer;
         }
-        const source = this.getSource(id);
+        const source = this.getLayerSource(id);
         if (source) {
             return source;
         }
@@ -140,7 +174,7 @@ export class JupyterGISDoc extends YDocument {
             layer.parameters = Object.assign(Object.assign({}, layer.parameters), value);
             this.updateLayer(id, layer);
         }
-        const source = this.getSource(id);
+        const source = this.getLayerSource(id);
         if (source) {
             source.parameters = Object.assign(Object.assign({}, source.parameters), value);
             this.updateSource(id, source);
@@ -172,6 +206,30 @@ export class JupyterGISDoc extends YDocument {
     setOption(key, value) {
         this.transact(() => void this._options.set(key, value));
     }
+    getMetadata(key) {
+        return this._metadata.get(key);
+    }
+    setMetadata(key, value) {
+        this.transact(() => void this._metadata.set(key, value));
+    }
+    removeMetadata(key) {
+        if (this._metadata.has(key)) {
+            this._metadata.delete(key);
+        }
+    }
+    get metadata() {
+        return JSONExt.deepCopy(this._metadata.toJSON());
+    }
+    set metadata(metadata) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(metadata)) {
+                this._metadata.set(key, value);
+            }
+        });
+    }
+    get metadataChanged() {
+        return this._metadataChanged;
+    }
     static create() {
         return new JupyterGISDoc();
     }