@jupytergis/schema 0.14.1 → 0.16.0-alpha.0

package/lib/schema/processing/clipRasterByVector.json

@@ -0,0 +1,33 @@
+{
+    "type": "object",
+    "description": "ClipRasterByVector",
+    "title": "IClipRasterByVector",
+    "required": ["inputLayer", "clipLayer"],
+    "additionalProperties": false,
+    "properties": {
+        "inputLayer": {
+            "type": "string",
+            "description": "The raster layer to clip."
+        },
+        "clipLayer": {
+            "type": "string",
+            "description": "The vector layer to use as the cutline boundary."
+        },
+        "cropToCutline": {
+            "type": "boolean",
+            "title": "Crop to cutline extent",
+            "description": "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.",
+            "default": true
+        },
+        "outputFileName": {
+            "type": "string",
+            "description": "Output file name for the clipped raster.",
+            "default": "clipped.tif"
+        },
+        "embedOutputLayer": {
+            "type": "boolean",
+            "title": "Embed output clipped raster in jGIS file",
+            "default": false
+        }
+    }
+}

package/lib/schema/processing/clipVectorByMaskLayer.json

@@ -0,0 +1,27 @@
+{
+    "type": "object",
+    "description": "ClipVectorByMaskLayer",
+    "title": "IClipVectorByMaskLayer",
+    "required": ["inputLayer", "clipLayer"],
+    "additionalProperties": false,
+    "properties": {
+        "inputLayer": {
+            "type": "string",
+            "description": "The input layer to clip."
+        },
+        "clipLayer": {
+            "type": "string",
+            "description": "The layer to use as the clip boundary."
+        },
+        "outputLayerName": {
+            "type": "string",
+            "title": "Output Layer Name",
+            "description": "Name for the resulting clipped layer."
+        },
+        "embedOutputLayer": {
+            "type": "boolean",
+            "title": "Embed output clipped layer in file",
+            "default": true
+        }
+    }
+}

package/lib/schema/processing/rasterize.json

@@ -0,0 +1,45 @@
+{
+    "type": "object",
+    "description": "Rasterize",
+    "title": "IRasterize",
+    "required": ["inputLayer", "pixelSize", "outputFileName"],
+    "additionalProperties": false,
+    "properties": {
+        "inputLayer": {
+            "type": "string",
+            "description": "The input vector layer to rasterize."
+        },
+        "pixelSize": {
+            "type": "number",
+            "default": 0.1,
+            "exclusiveMinimum": 0,
+            "description": "Output raster pixel size (in projection units). Must be greater than 0."
+        },
+        "attributeField": {
+            "type": "string",
+            "default": "",
+            "description": "Optional feature attribute used to burn values. Leave empty to use a fixed burn value."
+        },
+        "burnValue": {
+            "type": "number",
+            "default": 1,
+            "description": "Fixed value burned into raster cells when no attribute field is provided."
+        },
+        "noDataValue": {
+            "type": "number",
+            "default": 0,
+            "description": "Value assigned to cells not covered by any feature."
+        },
+        "outputFileName": {
+            "type": "string",
+            "default": "rasterized.tif",
+            "description": "Output GeoTIFF filename, saved next to the project file."
+        },
+        "embedOutputLayer": {
+            "type": "boolean",
+            "title": "Embed output GeoTIFF in file",
+            "default": false,
+            "description": "When enabled, the GeoTIFF is base64-embedded inside the .jGIS document instead of being written to disk."
+        }
+    }
+}

package/lib/schema/project/jgis.json

@@ -6,7 +6,7 @@
     "properties": {
         "schemaVersion": {
             "type": "string",
-            "default": "0.5.0"
+            "default": "0.6.0"
         },
         "layers": {
             "$ref": "#/definitions/jGISLayers"
@@ -23,6 +23,9 @@
         "stories": {
             "$ref": "#/definitions/jGISStoryMap"
         },
+        "viewState": {
+            "$ref": "#/definitions/jGISViewState"
+        },
         "metadata": {
             "type": "object",
             "patternProperties": {
@@ -41,17 +44,19 @@
                 "VectorLayer",
                 "VectorTileLayer",
                 "HillshadeLayer",
-                "WebGlLayer",
+                "GeoTiffLayer",
                 "ImageLayer",
                 "HeatmapLayer",
                 "StacLayer",
-                "StorySegmentLayer"
+                "StorySegmentLayer",
+                "OpenEOTileLayer"
             ]
         },
         "sourceType": {
             "type": "string",
             "enum": [
                 "RasterSource",
+                "WmsTileSource",
                 "VectorTileSource",
                 "GeoJSONSource",
                 "RasterDemSource",
@@ -59,8 +64,11 @@
                 "ImageSource",
                 "ShapefileSource",
                 "GeoTiffSource",
+                "GeoPackageVectorSource",
+                "GeoPackageRasterSource",
                 "GeoParquetSource",
-                "MarkerSource"
+                "MarkerSource",
+                "OpenEOTileSource"
             ]
         },
         "jGISLayer": {
@@ -153,7 +161,7 @@
                 "storyType": {
                     "type": "string",
                     "title": "Story Type",
-                    "enum": ["guided", "unguided"],
+                    "enum": ["guided", "unguided", "Vertical Scroll"],
                     "description": "The type of story map"
                 },
                 "storySegments": {
@@ -206,6 +214,28 @@
                 "$ref": "#/definitions/jGISLayerItem"
             }
         },
+        "jGISViewState": {
+            "title": "IJGISViewState",
+            "type": "object",
+            "default": {},
+            "additionalProperties": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "extent": {
+                        "type": "array",
+                        "items": { "type": "number" }
+                    },
+                    "zoom": {
+                        "type": "number"
+                    },
+                    "projection": {
+                        "type": "string"
+                    }
+                },
+                "required": ["extent"]
+            }
+        },
         "jGISOptions": {
             "title": "IJGISOptions",
             "type": "object",

package/lib/schema/project/layers/{webGlLayer.json → geoTiffLayer.json}

@@ -1,7 +1,7 @@
 {
     "type": "object",
-    "description": "WebGlLayer",
-    "title": "IWebGlLayer",
+    "description": "GeoTiffLayer",
+    "title": "IGeoTiffLayer",
     "required": ["source"],
     "additionalProperties": false,
     "properties": {
@@ -51,8 +51,14 @@
         "symbologyState": {
             "type": "object",
             "description": "The state of the symbology panel options",
-            "required": ["renderType"],
             "properties": {
+                "layers": {
+                    "type": "array",
+                    "description": "Grammar rendering layers.",
+                    "items": {
+                        "$ref": "project/symbology.json#/definitions/IGrammarLayer"
+                    }
+                },
                 "renderType": {
                     "type": "string",
                     "default": "Singleband Pseudocolor"

package/lib/schema/project/layers/heatmapLayer.json

@@ -29,6 +29,7 @@
         },
         "color": {
             "type": "array",
+            "description": "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.",
             "items": {
                 "type": "string"
             },
@@ -36,7 +37,7 @@
         },
         "symbologyState": {
             "type": "object",
-            "description": "The state of the symbology panel options",
+            "description": "The symbology configuration. Source of truth for how the heatmap is rendered.",
             "required": ["renderType"],
             "properties": {
                 "renderType": {
@@ -46,6 +47,11 @@
                 "colorRamp": {
                     "type": "string",
                     "default": "viridis"
+                },
+                "gradient": {
+                    "type": "array",
+                    "description": "Ordered list of CSS color strings used to build the heatmap gradient.",
+                    "items": { "type": "string" }
                 }
             },
             "default": {}

package/lib/schema/project/layers/openeoTileLayer.json

@@ -0,0 +1,21 @@
+{
+    "type": "object",
+    "description": "OpenEOTileLayer",
+    "title": "IOpenEOTileLayer",
+    "required": ["source"],
+    "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
+        }
+    }
+}

package/lib/schema/project/layers/storySegmentLayer.json

@@ -16,10 +16,16 @@
             }
         },
         "content": {
-            "type": "object",
             "title": "Segment Content",
-            "additionalProperties": false,
+            "type": "object",
             "properties": {
+                "contentMode": {
+                    "type": "string",
+                    "title": "Content Mode",
+                    "description": "Display map or markdown content while this segment is active",
+                    "enum": ["map", "markdown"],
+                    "default": "map"
+                },
                 "title": {
                     "title": "Segment Title",
                     "type": "string",
@@ -36,7 +42,12 @@
                     "default": ""
                 }
             },
-            "default": {}
+            "required": ["contentMode"],
+            "default": {
+                "contentMode": "map",
+                "title": "",
+                "image": ""
+            }
         },
         "transition": {
             "type": "object",

package/lib/schema/project/layers/vectorLayer.json

@@ -11,7 +11,7 @@
         },
         "color": {
             "type": "object",
-            "description": "The color of the the object",
+            "description": "DEPRECATED. Legacy OpenLayers FlatStyle cache. New files should not set this; symbologyState is the source of truth. Retained only so that legacy .jGIS files can be migrated on load.",
             "default": {}
         },
         "opacity": {
@@ -24,17 +24,8 @@
         },
         "symbologyState": {
             "type": "object",
-            "description": "The state of the symbology panel options",
-            "required": ["renderType"],
+            "description": "The symbology configuration. This is the single source of truth for how the layer is rendered; the OpenLayers style is derived from it on the fly.",
             "properties": {
-                "renderType": {
-                    "type": "string",
-                    "enum": ["Single Symbol", "Graduated", "Categorized"],
-                    "default": "Single Symbol"
-                },
-                "value": {
-                    "type": "string"
-                },
                 "method": {
                     "type": "string",
                     "enum": ["color", "radius"],
@@ -48,7 +39,7 @@
                     "type": "number",
                     "default": 9.0
                 },
-                "reverse": {
+                "reverseRamp": {
                     "type": "boolean",
                     "default": false
                 },
@@ -62,14 +53,102 @@
                         "pretty",
                         "logarithmic"
                     ]
+                },
+                "vmin": {
+                    "type": "number",
+                    "description": "Minimum value for color mapping"
+                },
+                "vmax": {
+                    "type": "number",
+                    "description": "Maximum value for color mapping"
+                },
+                "fallbackColor": {
+                    "type": "array",
+                    "description": "RGBA fallback color for features with no matching category or outside the gradient range",
+                    "items": { "type": "number" },
+                    "minItems": 4,
+                    "maxItems": 4
+                },
+                "strokeFollowsFill": {
+                    "type": "boolean",
+                    "description": "Whether the stroke color follows the fill color expression",
+                    "default": false
+                },
+                "fillColor": {
+                    "type": "array",
+                    "description": "Manual RGBA fill color. Used for Single Symbol, and as the base fill for Categorized when no stops are defined.",
+                    "items": { "type": "number" },
+                    "minItems": 4,
+                    "maxItems": 4
+                },
+                "strokeColor": {
+                    "type": "array",
+                    "description": "Manual RGBA stroke color",
+                    "items": { "type": "number" },
+                    "minItems": 4,
+                    "maxItems": 4
+                },
+                "strokeWidth": {
+                    "type": "number",
+                    "description": "Stroke width in pixels",
+                    "default": 1.25
+                },
+                "radius": {
+                    "type": "number",
+                    "description": "Circle radius in pixels for point geometries (Single Symbol, and the base for Graduated radius)",
+                    "default": 5
+                },
+                "joinStyle": {
+                    "type": "string",
+                    "enum": ["bevel", "round", "miter"],
+                    "default": "round"
+                },
+                "capStyle": {
+                    "type": "string",
+                    "enum": ["butt", "round", "square"],
+                    "default": "round"
+                },
+                "geometryType": {
+                    "type": "string",
+                    "enum": ["fill", "circle", "line"],
+                    "description": "The type of geometry."
+                },
+                "stopsOverride": {
+                    "type": "array",
+                    "description": "User-customized color stops that override the computed classification. Saved only when the user manually edits stop colors in the dialog.",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "value": {},
+                            "color": {
+                                "type": "array",
+                                "items": { "type": "number" },
+                                "minItems": 4,
+                                "maxItems": 4
+                            }
+                        }
+                    }
+                },
+                "rules": {
+                    "type": "array",
+                    "description": "Legacy top-level encoding rules (backward compatibility). New files should use layers.",
+                    "items": {
+                        "$ref": "project/symbology.json#/definitions/IEncodingRule"
+                    }
+                },
+                "layers": {
+                    "type": "array",
+                    "description": "Grammar rendering layers. Each layer is an independent rendering pipeline with optional preprocess transforms and encoding rules.",
+                    "items": {
+                        "$ref": "project/symbology.json#/definitions/IGrammarLayer"
+                    }
                 }
             },
             "additionalProperties": false,
             "default": {
-                "renderType": "Single Symbol",
                 "method": "color",
                 "colorRamp": "viridis",
-                "nClasses": "9",
+                "nClasses": 9,
                 "mode": "equal interval"
             }
         }

package/lib/schema/project/layers/vectorTileLayer.json

@@ -25,17 +25,7 @@
         "symbologyState": {
             "type": "object",
             "description": "The state of the symbology panel options",
-            "required": ["renderType"],
             "properties": {
-                "renderType": {
-                    "type": "string",
-                    "enum": ["Single Symbol", "Graduated", "Categorized"],
-                    "default": "Single Symbol"
-                },
-                "value": {
-                    "type": "string",
-                    "default": ""
-                },
                 "method": {
                     "type": "string",
                     "enum": ["color", "radius"],
@@ -59,6 +49,40 @@
                         "pretty",
                         "logarithmic"
                     ]
+                },
+                "vmin": {
+                    "type": "number",
+                    "description": "Minimum value for color mapping"
+                },
+                "vmax": {
+                    "type": "number",
+                    "description": "Maximum value for color mapping"
+                },
+                "fallbackColor": {
+                    "type": "array",
+                    "description": "RGBA fallback color for features with no matching category or outside the gradient range",
+                    "items": { "type": "number" },
+                    "minItems": 4,
+                    "maxItems": 4
+                },
+                "strokeFollowsFill": {
+                    "type": "boolean",
+                    "description": "Whether the stroke color follows the fill color expression",
+                    "default": false
+                },
+                "rules": {
+                    "type": "array",
+                    "description": "Legacy top-level encoding rules (backward compatibility). New files should use layers.",
+                    "items": {
+                        "$ref": "project/symbology.json#/definitions/IEncodingRule"
+                    }
+                },
+                "layers": {
+                    "type": "array",
+                    "description": "Grammar rendering layers. Each layer is an independent rendering pipeline with optional preprocess transforms and encoding rules.",
+                    "items": {
+                        "$ref": "project/symbology.json#/definitions/IGrammarLayer"
+                    }
                 }
             },
             "additionalProperties": false,

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

@@ -13,6 +13,19 @@
             "type": "object",
             "description": "The GeoJSON data",
             "$ref": "./geojson.json"
+        },
+        "useProxy": {
+            "type": "boolean",
+            "description": "Route requests through the Jupyter server proxy to avoid CORS issues.",
+            "default": false
+        },
+        "httpHeaders": {
+            "type": "string",
+            "description": "HTTP headers forwarded to the upstream server when useProxy is true.",
+            "default": "",
+            "additionalProperties": {
+                "type": "string"
+            }
         }
     }
 }

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

@@ -0,0 +1,45 @@
+{
+    "type": "object",
+    "description": "GeoPackageRasterSource",
+    "title": "IGeoPackageRasterSource",
+    "required": ["path"],
+    "additionalProperties": false,
+    "properties": {
+        "path": {
+            "type": "string",
+            "description": "The path to the GeoPackage source"
+        },
+        "minZoom": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 24,
+            "readOnly": true,
+            "description": "The minimum zoom level for the raster source",
+            "default": 0
+        },
+        "maxZoom": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 24,
+            "readOnly": true,
+            "description": "The maximum zoom level for the raster source",
+            "default": 24
+        },
+        "tables": {
+            "type": "string",
+            "description": "The names of the tables in the GeoPackage to use as a source (optional). If left empty, all tables will be used.",
+            "default": ""
+        },
+        "attribution": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The attribution for the GeoPackage source",
+            "default": ""
+        },
+        "interpolate": {
+            "type": "boolean",
+            "description": "Interpolate between grid cells when overzooming?",
+            "default": false
+        }
+    }
+}

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

@@ -0,0 +1,29 @@
+{
+    "type": "object",
+    "description": "GeoPackageVectorSource",
+    "title": "IGeoPackageVectorSource",
+    "required": ["path"],
+    "additionalProperties": false,
+    "properties": {
+        "path": {
+            "type": "string",
+            "description": "The path to the GeoPackage source"
+        },
+        "attribution": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The attribution for the GeoPackage source.",
+            "default": ""
+        },
+        "projection": {
+            "type": "string",
+            "description": "The projection information for the GeoPackage data (optional).",
+            "default": "EPSG:3857"
+        },
+        "tables": {
+            "type": "string",
+            "description": "The names of the tables in the GeoPackage to use as a source (optional). If left empty, all tables will be used.",
+            "default": ""
+        }
+    }
+}

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

@@ -20,6 +20,19 @@
             "type": "string",
             "description": "The projection information for the GeoParquet data (optional).",
             "default": "EPSG:4326"
+        },
+        "useProxy": {
+            "type": "boolean",
+            "description": "Route requests through the Jupyter server proxy to avoid CORS issues.",
+            "default": false
+        },
+        "httpHeaders": {
+            "type": "string",
+            "description": "HTTP headers forwarded to the upstream server when useProxy is true.",
+            "default": "",
+            "additionalProperties": {
+                "type": "string"
+            }
         }
     }
 }

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

@@ -43,6 +43,19 @@
             "type": "boolean",
             "description": "Interpolate between grid cells when overzooming?",
             "default": false
+        },
+        "useProxy": {
+            "type": "boolean",
+            "description": "Route requests through the Jupyter server proxy to avoid CORS issues.",
+            "default": false
+        },
+        "httpHeaders": {
+            "type": "string",
+            "description": "HTTP headers forwarded to the upstream server when useProxy is true.",
+            "default": "",
+            "additionalProperties": {
+                "type": "string"
+            }
         }
     }
 }