@jupytergis/schema 0.12.1 → 0.13.0

package/lib/_interface/forms.json

@@ -304,7 +304,6 @@
   },
   "StorySegmentLayer": {
     "type": "object",
-    "additionalProperties": false,
     "required": [
       "zoom",
       "extent",
@@ -324,9 +323,11 @@
       },
       "content": {
         "type": "object",
+        "title": "Segment Content",
         "additionalProperties": false,
         "properties": {
           "title": {
+            "title": "Segment Title",
             "type": "string"
           },
           "image": {
@@ -363,6 +364,47 @@
           "type",
           "time"
         ]
+      },
+      "layerOverride": {
+        "type": "array",
+        "title": "Symbology Override",
+        "description": "Symbology overrides to apply to target layers when this story segment is active",
+        "items": {
+          "type": "object",
+          "properties": {
+            "targetLayer": {
+              "type": "string",
+              "title": "Target Layer",
+              "description": "The name of the layer to apply a symbology override to when this story segment is active",
+              "default": ""
+            },
+            "visible": {
+              "type": "boolean",
+              "title": "Visibility",
+              "default": true,
+              "description": "Override the target layer visibility while this story segment is active"
+            },
+            "opacity": {
+              "type": "number",
+              "title": "Opacity",
+              "description": "Override the target layer opacity while this story segment is active",
+              "minimum": 0,
+              "maximum": 1,
+              "multipleOf": 0.1,
+              "default": 1
+            },
+            "symbologyState": {
+              "type": "object",
+              "description": "The symbology state override (renderType, value, method, etc.)",
+              "default": {}
+            },
+            "color": {
+              "type": "object",
+              "description": "The color/style override",
+              "default": {}
+            }
+          }
+        }
       }
     }
   },
@@ -460,6 +502,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": "viridis"
+          },
+          "nClasses": {
+            "type": "string",
+            "default": "9"
+          },
+          "mode": {
+            "type": "string",
+            "default": "equal interval",
+            "enum": [
+              "quantile",
+              "equal interval",
+              "jenks",
+              "pretty",
+              "logarithmic"
+            ]
+          }
+        },
+        "additionalProperties": false
       }
     }
   },

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

@@ -173,6 +173,6 @@ export interface IJGISStoryMap {
    */
   storySegments?: string[];
   presentationBgColor?: PresentationBackgroundColor;
-  presentaionTextColor?: PresentationTextColor;
+  presentationTextColor?: PresentationTextColor;
   [k: string]: any;
 }

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

@@ -5,23 +5,48 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+export type SegmentTitle = string;
+/**
+ * The name of the layer to apply a symbology override to when this story segment is active
+ */
+export type TargetLayer = string;
+/**
+ * Override the target layer visibility while this story segment is active
+ */
+export type Visibility = boolean;
+/**
+ * Override the target layer opacity while this story segment is active
+ */
+export type Opacity = number;
+/**
+ * Symbology overrides to apply to target layers when this story segment is active
+ */
+export type SymbologyOverride = {
+  targetLayer?: TargetLayer;
+  visible?: Visibility;
+  opacity?: Opacity;
+  /**
+   * The symbology state override (renderType, value, method, etc.)
+   */
+  symbologyState?: {
+    [k: string]: any;
+  };
+  /**
+   * The color/style override
+   */
+  color?: {
+    [k: string]: any;
+  };
+  [k: string]: any;
+}[];
+
 /**
  * StorySegmentLayer
  */
 export interface IStorySegmentLayer {
   zoom: number;
   extent: number[];
-  content?: {
-    title?: string;
-    /**
-     * Link to image for the story
-     */
-    image?: string;
-    /**
-     * Markdown string representing the content of the story stop
-     */
-    markdown?: string;
-  };
+  content?: SegmentContent;
   /**
    * Transition configuration between to this story segment
    */
@@ -36,4 +61,17 @@ export interface IStorySegmentLayer {
     time: number;
     [k: string]: any;
   };
+  layerOverride?: SymbologyOverride;
+  [k: string]: any;
+}
+export interface SegmentContent {
+  title?: SegmentTitle;
+  /**
+   * Link to image for the story
+   */
+  image?: string;
+  /**
+   * Markdown string representing the content of the story stop
+   */
+  markdown?: string;
 }

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

@@ -23,4 +23,15 @@ export interface IVectorTileLayer {
    * 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/interfaces.d.ts

@@ -9,9 +9,8 @@ import { JSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { SplitPanel } from '@lumino/widgets';
 import { FeatureLike } from 'ol/Feature';
-import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerItem, IJGISLayers, IJGISLayerTree, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap, SourceType } from './_interface/project/jgis';
-import { IRasterSource } from './_interface/project/sources/rasterSource';
-import { Modes } from './types';
+import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerItem, IJGISLayers, IJGISLayerTree, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap, LayerType, SourceType } from './_interface/project/jgis';
+import { IGeoJSONSource, IGeoParquetSource, IGeoTiffSource, IHeatmapLayer, IHillshadeLayer, IImageLayer, IImageSource, IMarkerSource, IRasterDemSource, IRasterLayer, IRasterSource, IShapefileSource, IStacLayer, IStorySegmentLayer, IVectorLayer, IVectorTileLayer, IVectorTileSource, IVideoSource, IWebGlLayer, Modes } from './types';
 export { IGeoJSONSource } from './_interface/project/sources/geoJsonSource';
 export interface IJGISStoryMaps {
     [k: string]: IJGISStoryMap;
@@ -232,6 +231,8 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
         storyId: string;
         story: IJGISStoryMap | undefined;
     };
+    getCurrentSegmentIndex(): number;
+    setCurrentSegmentIndex(index: number): void;
     addStorySegment(): {
         storySegmentId: string;
         storyId: string;
@@ -290,20 +291,23 @@ export interface IJGISExternalCommandRegistry {
     registerCommand(command: IJGISExternalCommand): void;
 }
 /**
- * Defines the structure for entries in a raster layer gallery.
- * Each entry consists of a name, a thumbnail URL, and source information.
- * The source information is expected to conform to the IRasterSource interface.
+ * Defines the structure for entries in a layer gallery.
  *
- * @interface IRasterLayerGalleryEntry
+ * @interface ILayerGalleryEntry
  */
-export interface IRasterLayerGalleryEntry {
+export type ILayerGalleryEntry = {
     name: string;
     thumbnail: string;
-    source: IRasterSource;
-}
+    layerType: LayerType;
+    layerParameters: IHeatmapLayer | IHillshadeLayer | IImageLayer | IRasterLayer | IStacLayer | IStorySegmentLayer | IVectorLayer | IVectorTileLayer | IWebGlLayer;
+    sourceType: SourceType;
+    sourceParameters: IGeoJSONSource | IGeoParquetSource | IGeoTiffSource | IImageSource | IMarkerSource | IRasterDemSource | IRasterSource | IShapefileSource | IVectorTileSource | IVideoSource;
+    provider: string;
+    description: string;
+};
 export interface IJGISLayerBrowserRegistry {
-    getRegistryLayers(): IRasterLayerGalleryEntry[];
-    addRegistryLayer(data: IRasterLayerGalleryEntry): void;
+    getRegistryLayers(): ILayerGalleryEntry[];
+    addRegistryLayer(data: ILayerGalleryEntry): void;
     removeRegistryLayer(name: string): void;
     clearRegistry(): void;
 }

package/lib/model.d.ts

@@ -172,6 +172,14 @@ export declare class JupyterGISModel implements IJupyterGISModel {
         storyId: string;
         story: IJGISStoryMap | undefined;
     };
+    /**
+     * Current slide index for the selected story (0-based).
+     */
+    getCurrentSegmentIndex(): number;
+    /**
+     * Set current slide index for the selected story.
+     */
+    setCurrentSegmentIndex(index: number): void;
     /**
      * Adds a story segment from the current map view
      * @returns Object with storySegmentId and storyMapId, or null if no extent/zoom found
@@ -256,6 +264,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _geolocation;
     private _geolocationChanged;
     private _tileFeatureCache;
+    private _currentSegmentIndex;
     stories: Map<string, IJGISStoryMap>;
 }
 export declare namespace JupyterGISModel {

package/lib/model.js

@@ -408,6 +408,7 @@ export class JupyterGISModel {
             this.sharedModel.addLayer(id, layer);
         }
         this._addLayerTreeItem(id, groupName, position);
+        this.syncSelected({ [id]: { type: 'layer' } }, this.getClientId().toString());
     }
     removeLayer(layer_id) {
         var _a;
@@ -513,6 +514,18 @@ export class JupyterGISModel {
             story: this.sharedModel.getStoryMap(storyId),
         };
     }
+    /**
+     * Current slide index for the selected story (0-based).
+     */
+    getCurrentSegmentIndex() {
+        return this._currentSegmentIndex;
+    }
+    /**
+     * Set current slide index for the selected story.
+     */
+    setCurrentSegmentIndex(index) {
+        this._currentSegmentIndex = index;
+    }
     /**
      * Adds a story segment from the current map view
      * @returns Object with storySegmentId and storyMapId, or null if no extent/zoom found

package/lib/schema/project/jgis.json

@@ -169,7 +169,7 @@
                     "title": "Presentation Background Color",
                     "description": "The background color of the story map"
                 },
-                "presentaionTextColor": {
+                "presentationTextColor": {
                     "type": "string",
                     "title": "Presentation Text Color",
                     "description": "The text color of the story map"

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

@@ -2,7 +2,6 @@
     "type": "object",
     "description": "StorySegmentLayer",
     "title": "IStorySegmentLayer",
-    "additionalProperties": false,
     "required": ["zoom", "extent", "transition"],
     "properties": {
         "zoom": {
@@ -18,9 +17,11 @@
         },
         "content": {
             "type": "object",
+            "title": "Segment Content",
             "additionalProperties": false,
             "properties": {
                 "title": {
+                    "title": "Segment Title",
                     "type": "string"
                 },
                 "image": {
@@ -50,6 +51,47 @@
                 }
             },
             "required": ["type", "time"]
+        },
+        "layerOverride": {
+            "type": "array",
+            "title": "Symbology Override",
+            "description": "Symbology overrides to apply to target layers when this story segment is active",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "targetLayer": {
+                        "type": "string",
+                        "title": "Target Layer",
+                        "description": "The name of the layer to apply a symbology override to when this story segment is active",
+                        "default": ""
+                    },
+                    "visible": {
+                        "type": "boolean",
+                        "title": "Visibility",
+                        "default": true,
+                        "description": "Override the target layer visibility while this story segment is active"
+                    },
+                    "opacity": {
+                        "type": "number",
+                        "title": "Opacity",
+                        "description": "Override the target layer opacity while this story segment is active",
+                        "minimum": 0,
+                        "maximum": 1,
+                        "multipleOf": 0.1,
+                        "default": 1.0
+                    },
+                    "symbologyState": {
+                        "type": "object",
+                        "description": "The symbology state override (renderType, value, method, etc.)",
+                        "default": {}
+                    },
+                    "color": {
+                        "type": "object",
+                        "description": "The color/style override",
+                        "default": {}
+                    }
+                }
+            }
         }
     }
 }

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

@@ -20,6 +20,44 @@
             "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": "viridis"
+                },
+                "nClasses": {
+                    "type": "string",
+                    "default": "9"
+                },
+                "mode": {
+                    "type": "string",
+                    "default": "equal interval",
+                    "enum": [
+                        "quantile",
+                        "equal interval",
+                        "jenks",
+                        "pretty",
+                        "logarithmic"
+                    ]
+                }
+            },
+            "additionalProperties": false
         }
     }
 }

package/package.json

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