Enable extending or overriding the layer gallery with settings editor

[mfisher87]

Use case

For example, a domain-specific JupyterHub may want to pre-load the gallery with layers relevant to them.

Preferred solution

Implement two new settings, e.g.:

• galleryEntries: Override the default gallery
• extendGalleryEntries: Extend the default gallery with new items -- would be deep merged with the default gallery

Each would follow the existing gallery schema, so you could define new tabs or add items to existing tabs.

Alternative solutions

No response

[martinRenou]

💯 would love to see this

Gallery items are being defined this way:

{
    "OpenStreetMap": {
        "Mapnik": {
            "thumbnailPath": "rasterlayer_gallery/OpenStreetMap-Mapnik.png",
            "url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
            "max_zoom": 19,
            "html_attribution": "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a> contributors",
            "attribution": "(C) OpenStreetMap contributors",
            "name": "OpenStreetMap.Mapnik"
        },
        "DE": {
            "thumbnailPath": "rasterlayer_gallery/OpenStreetMap-DE.png",
            "url": "https://tile.openstreetmap.de/{z}/{x}/{y}.png",
            "max_zoom": 18,
            "html_attribution": "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a> contributors",
            "attribution": "(C) OpenStreetMap contributors",
            "name": "OpenStreetMap.DE"
        },
        [...]
     },
     "NASAGIBS": {
        "ModisTerraTrueColorCR": {
            "thumbnailPath": "rasterlayer_gallery/NASAGIBS-ModisTerraTrueColorCR.png",
            "url": "https://map1.vis.earthdata.nasa.gov/wmts-webmerc/{variant}/default/{time}/{tilematrixset}{max_zoom}/{z}/{y}/{x}.{format}",
            "html_attribution": "Imagery provided by services from the Global Imagery Browse Services (GIBS), operated by the NASA/GSFC/Earth Science Data and Information System (<a href=\"https://earthdata.nasa.gov\">ESDIS</a>) with funding provided by NASA/HQ.",
            "attribution": "Imagery provided by services from the Global Imagery Browse Services (GIBS), operated by the NASA/GSFC/Earth Science Data and Information System (ESDIS) with funding provided by NASA/HQ.",
            "bounds": [
                [
                    -85.0511287776,
                    -179.999999975
                ],
                [
                    85.0511287776,
                    179.999999975
                ]
            ],
            "min_zoom": 1,
            "max_zoom": 9,
            "format": "jpg",
            "time": "2025-02-26",
            "tilematrixset": "GoogleMapsCompatible_Level",
            "variant": "MODIS_Terra_CorrectedReflectance_TrueColor",
            "name": "NASAGIBS.ModisTerraTrueColorCR"
        },
        [...]
    }
}

So galleryEntries would be a dictionary of collectionName -> galleryCollection.
Each galleryCollection is a dictionary entryName -> galleryEntry.
Each galleryEntry contains at least the properties: "name", "url". It can have more properties like "bounds", "attribution", "thumbnailPath"/"thumbnailUrl" for preview etc.

Today, the gallery is generated by rasterlayer_gallery_generator.py and commited under https://github.com/geojupyter/jupytergis/tree/main/packages/base/rasterlayer_gallery

[mfisher87]

Additional thoughts from @martinRenou (#1101):

#1071 made me think we should allow users to extend the gallery how they see fit.

Maybe the preferred solution is to do that through lab settings.

A setting extra_gallery_entries which is a JSON object following the same format as our gallery entries. And we would extend the default, or even allow to overwrite it completely.

We could also provide a context menu on the layer tree allowing the workflow right click -> save into gallery to save any layer in the extra_gallery_entries setting

[HaudinFlorence]

I can try to work on it.

[martinRenou]

#1071 made gallery entries much simpler, since now one should only provide something like:

{
  "name": "...",
  "description": "...",
  "thumbnail": "../file.png",
  "layerType": ..., # One of "RasterLayer", "VectorLayer"...
  "layerParameters": {...},  
  "sourceType": ..., # One of "RasterTileSource", "GeoJSONSource"...
  "sourceParameters": {...},
}

[mfisher87]

#1071 made gallery entries much simpler

🤩 Beautiful, @HaudinFlorence