@jupytergis/schema 0.14.1 → 0.16.0-alpha.0

package/lib/_interface/processing/clipRasterByExtent.d.ts

@@ -0,0 +1,39 @@
+/* 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 EmbedOutputClippedRasterInFile = boolean;
+
+/**
+ * ClipRasterByExtent
+ */
+export interface IClipRasterByExtent {
+  /**
+   * The raster layer to clip.
+   */
+  inputLayer: string;
+  /**
+   * Minimum X coordinate (left edge) of the clipping extent.
+   */
+  xMin: number;
+  /**
+   * Minimum Y coordinate (bottom edge) of the clipping extent.
+   */
+  yMin: number;
+  /**
+   * Maximum X coordinate (right edge) of the clipping extent.
+   */
+  xMax: number;
+  /**
+   * Maximum Y coordinate (top edge) of the clipping extent.
+   */
+  yMax: number;
+  /**
+   * Output file name for the clipped raster.
+   */
+  outputFileName?: string;
+  embedOutputLayer?: EmbedOutputClippedRasterInFile;
+}

package/lib/_interface/processing/clipRasterByVector.d.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+/**
+ * Shrink the output extent to the cutline's bounding box. When off, the original raster extent is preserved and pixels outside the cutline are set to nodata.
+ */
+export type CropToCutlineExtent = boolean;
+export type EmbedOutputClippedRasterInJGISFile = boolean;
+
+/**
+ * ClipRasterByVector
+ */
+export interface IClipRasterByVector {
+  /**
+   * The raster layer to clip.
+   */
+  inputLayer: string;
+  /**
+   * The vector layer to use as the cutline boundary.
+   */
+  clipLayer: string;
+  cropToCutline?: CropToCutlineExtent;
+  /**
+   * Output file name for the clipped raster.
+   */
+  outputFileName?: string;
+  embedOutputLayer?: EmbedOutputClippedRasterInJGISFile;
+}

package/lib/_interface/processing/clipVectorByMaskLayer.d.ts

@@ -0,0 +1,28 @@
+/* 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.
+ */
+
+/**
+ * Name for the resulting clipped layer.
+ */
+export type OutputLayerName = string;
+export type EmbedOutputClippedLayerInFile = boolean;
+
+/**
+ * ClipVectorByMaskLayer
+ */
+export interface IClipVectorByMaskLayer {
+  /**
+   * The input layer to clip.
+   */
+  inputLayer: string;
+  /**
+   * The layer to use as the clip boundary.
+   */
+  clipLayer: string;
+  outputLayerName?: OutputLayerName;
+  embedOutputLayer?: EmbedOutputClippedLayerInFile;
+}

package/lib/_interface/processing/rasterize.d.ts

@@ -0,0 +1,42 @@
+/* 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.
+ */
+
+/**
+ * When enabled, the GeoTIFF is base64-embedded inside the .jGIS document instead of being written to disk.
+ */
+export type EmbedOutputGeoTIFFInFile = boolean;
+
+/**
+ * Rasterize
+ */
+export interface IRasterize {
+  /**
+   * The input vector layer to rasterize.
+   */
+  inputLayer: string;
+  /**
+   * Output raster pixel size (in projection units). Must be greater than 0.
+   */
+  pixelSize: number;
+  /**
+   * Optional feature attribute used to burn values. Leave empty to use a fixed burn value.
+   */
+  attributeField?: string;
+  /**
+   * Fixed value burned into raster cells when no attribute field is provided.
+   */
+  burnValue?: number;
+  /**
+   * Value assigned to cells not covered by any feature.
+   */
+  noDataValue?: number;
+  /**
+   * Output GeoTIFF filename, saved next to the project file.
+   */
+  outputFileName: string;
+  embedOutputLayer?: EmbedOutputGeoTIFFInFile;
+}

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

@@ -14,17 +14,19 @@ export type LayerType =
   | "VectorLayer"
   | "VectorTileLayer"
   | "HillshadeLayer"
-  | "WebGlLayer"
+  | "GeoTiffLayer"
   | "ImageLayer"
   | "HeatmapLayer"
   | "StacLayer"
-  | "StorySegmentLayer";
+  | "StorySegmentLayer"
+  | "OpenEOTileLayer";
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema
  * via the `definition` "sourceType".
  */
 export type SourceType =
   | "RasterSource"
+  | "WmsTileSource"
   | "VectorTileSource"
   | "GeoJSONSource"
   | "RasterDemSource"
@@ -32,8 +34,11 @@ export type SourceType =
   | "ImageSource"
   | "ShapefileSource"
   | "GeoTiffSource"
+  | "GeoPackageVectorSource"
+  | "GeoPackageRasterSource"
   | "GeoParquetSource"
-  | "MarkerSource";
+  | "MarkerSource"
+  | "OpenEOTileSource";
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema
  * via the `definition` "jGISLayerItem".
@@ -52,7 +57,7 @@ export type Title = string;
 /**
  * The type of story map
  */
-export type StoryType = "guided" | "unguided";
+export type StoryType = "guided" | "unguided" | "Vertical Scroll";
 /**
  * Toggle the gradient background in presentation mode.
  */
@@ -73,6 +78,7 @@ export interface IJGISContent {
   layerTree?: IJGISLayerTree;
   options?: IJGISOptions;
   stories?: IJGISStoryMap;
+  viewState?: IJGISViewState;
   metadata?: {
     /**
      * This interface was referenced by `undefined`'s JSON-Schema definition
@@ -181,3 +187,14 @@ export interface IJGISStoryMap {
   presentationTextColor?: PresentationTextColor;
   [k: string]: any;
 }
+/**
+ * This interface was referenced by `IJGISContent`'s JSON-Schema
+ * via the `definition` "jGISViewState".
+ */
+export interface IJGISViewState {
+  [k: string]: {
+    extent: number[];
+    zoom?: number;
+    projection?: string;
+  };
+}

package/lib/_interface/project/layers/geoTiffLayer.d.ts

@@ -0,0 +1,351 @@
+/* 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.
+ */
+
+/**
+ * GeoTiffLayer
+ */
+export interface IGeoTiffLayer {
+  /**
+   * The id of the source
+   */
+  source: string;
+  /**
+   * The opacity of the source
+   */
+  opacity?: number;
+  /**
+   * The color of the the object
+   */
+  color?: string | number | (string | number | (number | string | (number | string)[])[])[];
+  /**
+   * The state of the symbology panel options
+   */
+  symbologyState?: {
+    /**
+     * Grammar rendering layers.
+     */
+    layers?: {
+      /**
+       * Stable UUID.
+       */
+      id: string;
+      /**
+       * Render-side transforms (KDE, cluster) applied before encoding rules.
+       */
+      preprocess?: (
+        | {
+            type: "kde";
+            radius: number;
+            blur: number;
+            weightField?: string;
+          }
+        | {
+            type: "cluster";
+            radius: number;
+          }
+      )[];
+      /**
+       * Encoding rules compiled into a flat-style expression for this layer.
+       */
+      rules: {
+        /**
+         * Stable UUID.
+         */
+        id: string;
+        /**
+         * Input field name(s). Absent for constant rules.
+         */
+        fields?: string[];
+        /**
+         * (scale, channels) pairs sharing these input fields.
+         */
+        mappings: [
+          {
+            scale:
+              | {
+                  scheme: "colorRamp";
+                  params: {
+                    name: string;
+                    domain?: [number, number];
+                    nShades: number;
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    reverse: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "categorical";
+                  params: {
+                    colorRamp: string;
+                    nShades?: number;
+                    reverse?: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: string | number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "scalar";
+                  params: {
+                    domain: [number, number];
+                    range: [number, number];
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    nStops: number;
+                    fallback: number;
+                    scalarStops?: {
+                      stop: number;
+                      output: number;
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "constant_rgba";
+                  params: {
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    value: [number, number, number, number];
+                  };
+                }
+              | {
+                  scheme: "constant_num";
+                  params: {
+                    value: number;
+                  };
+                }
+              | {
+                  scheme: "identity";
+                }
+              | {
+                  scheme: "expression";
+                  params: {
+                    expr: string;
+                    fallback: number | [number, number, number, number];
+                  };
+                };
+            /**
+             * Target output channel names.
+             */
+            channels: [
+              (
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              ),
+              ...(
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              )[]
+            ];
+          },
+          ...{
+            scale:
+              | {
+                  scheme: "colorRamp";
+                  params: {
+                    name: string;
+                    domain?: [number, number];
+                    nShades: number;
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    reverse: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "categorical";
+                  params: {
+                    colorRamp: string;
+                    nShades?: number;
+                    reverse?: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: string | number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "scalar";
+                  params: {
+                    domain: [number, number];
+                    range: [number, number];
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    nStops: number;
+                    fallback: number;
+                    scalarStops?: {
+                      stop: number;
+                      output: number;
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "constant_rgba";
+                  params: {
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    value: [number, number, number, number];
+                  };
+                }
+              | {
+                  scheme: "constant_num";
+                  params: {
+                    value: number;
+                  };
+                }
+              | {
+                  scheme: "identity";
+                }
+              | {
+                  scheme: "expression";
+                  params: {
+                    expr: string;
+                    fallback: number | [number, number, number, number];
+                  };
+                };
+            /**
+             * Target output channel names.
+             */
+            channels: [
+              (
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              ),
+              ...(
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              )[]
+            ];
+          }[]
+        ];
+        /**
+         * Guard predicates for this rule.
+         */
+        when?: (
+          | {
+              type: "geometryType";
+              value: "Point" | "LineString" | "Polygon";
+            }
+          | {
+              type: "hasField";
+              field: string;
+            }
+          | {
+              type: "fieldEquals";
+              field: string;
+              value: string | number;
+            }
+          | {
+              type: "fieldCompare";
+              field: string;
+              op: ">" | "<" | ">=" | "<=" | "!=";
+              value: number;
+            }
+          | {
+              type: "between";
+              field: string;
+              min: number;
+              max: number;
+            }
+        )[];
+        /**
+         * Logical combinator for when predicates. Defaults to 'all'.
+         */
+        whenOp?: "all" | "any";
+      }[];
+      /**
+       * Guard predicates applied to every rule in this layer.
+       */
+      when?: (
+        | {
+            type: "geometryType";
+            value: "Point" | "LineString" | "Polygon";
+          }
+        | {
+            type: "hasField";
+            field: string;
+          }
+        | {
+            type: "fieldEquals";
+            field: string;
+            value: string | number;
+          }
+        | {
+            type: "fieldCompare";
+            field: string;
+            op: ">" | "<" | ">=" | "<=" | "!=";
+            value: number;
+          }
+        | {
+            type: "between";
+            field: string;
+            min: number;
+            max: number;
+          }
+      )[];
+      /**
+       * Logical combinator for when predicates. Defaults to 'all'.
+       */
+      whenOp?: "all" | "any";
+    }[];
+    renderType?: string;
+    band?: number;
+    redBand?: number;
+    greenBand?: number;
+    blueBand?: number;
+    alphaBand?: number;
+    interpolation?: "discrete" | "linear" | "exact";
+    colorRamp?: string;
+    nClasses?: string;
+    mode?: "continuous" | "equal interval" | "quantile";
+  };
+}

package/lib/_interface/project/layers/heatmapLayer.d.ts

@@ -25,13 +25,20 @@ export interface IHeatmapLayer {
    * Blur size in pixels
    */
   blur: number;
+  /**
+   * DEPRECATED. Legacy gradient cache. New files should not set this; symbologyState.gradient is the source of truth. Retained only so that legacy .jGIS files can be migrated on load.
+   */
   color?: string[];
   /**
-   * The state of the symbology panel options
+   * The symbology configuration. Source of truth for how the heatmap is rendered.
    */
   symbologyState?: {
     renderType: string;
     colorRamp?: string;
+    /**
+     * Ordered list of CSS color strings used to build the heatmap gradient.
+     */
+    gradient?: string[];
     [k: string]: any;
   };
 }

package/lib/_interface/project/layers/openeoTileLayer.d.ts

@@ -0,0 +1,20 @@
+/* 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.
+ */
+
+/**
+ * OpenEOTileLayer
+ */
+export interface IOpenEOTileLayer {
+  /**
+   * The id of the source
+   */
+  source: string;
+  /**
+   * The opacity of the source
+   */
+  opacity?: number;
+}

package/lib/_interface/project/layers/storySegmentLayer.d.ts

@@ -5,6 +5,10 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+/**
+ * Display map or markdown content while this segment is active
+ */
+export type ContentMode = "map" | "markdown";
 export type SegmentTitle = string;
 /**
  * The name of the layer to apply a layer override to when this story segment is active
@@ -71,6 +75,7 @@ export interface IStorySegmentLayer {
   [k: string]: any;
 }
 export interface SegmentContent {
+  contentMode: ContentMode;
   title?: SegmentTitle;
   /**
    * Link to image for the story
@@ -80,4 +85,5 @@ export interface SegmentContent {
    * Markdown string representing the content of the story stop
    */
   markdown?: string;
+  [k: string]: any;
 }