Merge pull request #84 from felix-mu/81-persist-layer-selection-as-panel-configuration

feat: add toggle to make a data layer visible or invisible by default

closes #81

Author: felix-mu

src/GeomapPanel.tsx

@@ -533,6 +533,12 @@ export class GeomapPanel extends Component<Props, State> {
       const handler = await item.create(this.map!, overlay, config.theme2);
       // If it is a basemap create group with title to make it visible in the legend: https://github.com/walkermatt/ol-layerswitcher/blob/main/examples/layerswitcher.js#L10
       const layer = item.isBaseMap ? new Group({layers: [handler.init()], title: overlay.name, combine: true,} as GroupLayerOptions) : handler.init();
+      
+      // Set visible to false if toggle is not set to make layer not selected in switch layer control
+      if (overlay.visible !== undefined && overlay.visible === false) {
+        layer.setVisible(false)
+      }
+
       (layer as any).___handler = handler;
       this.map!.addLayer(layer);
       this.layers.push({

src/editor/BaseLayerEditor.tsx

@@ -24,5 +24,5 @@ export const BaseLayerEditor: FC<StandardEditorProps<ExtendMapLayerOptions, any,
     return <div>The base layer is configured by the server admin.</div>;
   }
 
-  return <LayerEditor options={value} data={context.data} onChange={onChange} filter={baseMapFilter} showNameField={false} />;
+  return <LayerEditor options={value} data={context.data} onChange={onChange} filter={baseMapFilter} showNameField={false} isBaselayerEditor={true} />;
 };

src/editor/LayerEditor.tsx

@@ -23,9 +23,10 @@ export interface LayerEditorProps<TConfig = any> {
   onChange: (options: ExtendMapLayerOptions<TConfig>) => void;
   filter: (item: ExtendMapLayerRegistryItem) => boolean;
   showNameField?: boolean; // Show the name field in the options
+  isBaselayerEditor?: boolean;
 }
 
-export const LayerEditor: FC<LayerEditorProps> = ({ options, onChange, data, filter, showNameField }) => {
+export const LayerEditor: FC<LayerEditorProps> = ({ options, onChange, data, filter, showNameField, isBaselayerEditor = false }) => {
   // all basemaps
   const layerTypes = useMemo(() => {
     return geomapLayerRegistry.selectOptions(
@@ -210,23 +211,31 @@ export const LayerEditor: FC<LayerEditorProps> = ({ options, onChange, data, fil
       builder.addSliderInput({
         path: 'opacity',
         name: 'Opacity',
-        defaultValue: 1,
         settings: {
           min: 0,
           max: 1,
           step: 0.1,
         },
+        defaultValue: 1,
+      });
+    }
+
+    if (!isBaselayerEditor) {
+      builder.addBooleanSwitch({
+        path: 'visible',
+        name: 'Layer is selected by default in the layer switch control',
+        description: 'If toggled the layer is selected by default in the layer switch control. Uncheck to have the layer invisible by default.',
+        settings: {},
+        defaultValue: true
       });
     }
 
     if (layer.registerOptionsUI) {
       layer.registerOptionsUI(builder);
     }
 
-
-
     return builder;
-  }, [options?.type, showNameField]);
+  }, [options?.type, showNameField, isBaselayerEditor]);
 
   // The react components
   const layerOptions = useMemo(() => {
@@ -243,11 +252,13 @@ export const LayerEditor: FC<LayerEditorProps> = ({ options, onChange, data, fil
     const context: StandardEditorContext<any> = {
       data,
       // options: options,
-      options: {...options, opacity: options?.opacity === undefined && layer.showOpacity ? 1.0 : options?.opacity}
+      options: {
+        ...options, 
+        opacity: options?.opacity === undefined && layer.showOpacity ? 1.0 : options?.opacity,
+        visible: options?.visible === undefined ? true : options?.visible
+      }
     };
 
-    
-
     const currentOptions = { ...options, type: layer.id, config: { ...layer.defaultOptions, ...options?.config } };
 
     // Update the panel options if not set

src/extension.ts

@@ -50,6 +50,7 @@ export interface ExtendMapLayerOptions<TConfig = any> {
   displayProperties?: string[];
   titleField?: string;
   timeField?: string;
+  visible?: boolean
 }
 
 export interface ExtendMapLayerRegistryItem<TConfig = ExtendMapLayerOptions> extends RegistryItemWithOptions {