= ({
placeholder
*/}
+ {tile.sourceType}
- {tile.source.attribution}
+ {tile.description}
@@ -244,7 +241,7 @@ export const LayerBrowserComponent: React.FC = ({
export interface ILayerBrowserOptions {
model: IJupyterGISModel;
- registry: IRasterLayerGalleryEntry[];
+ registry: ILayerGalleryEntry[];
formSchemaRegistry: IJGISFormSchemaRegistry;
}
diff --git a/packages/base/src/tools.ts b/packages/base/src/tools.ts
index eda87e541..cf19f4fde 100644
--- a/packages/base/src/tools.ts
+++ b/packages/base/src/tools.ts
@@ -4,7 +4,7 @@ import {
IJGISOptions,
IJGISSource,
IJupyterGISModel,
- IRasterLayerGalleryEntry,
+ ILayerGalleryEntry,
SourceType,
} from '@jupytergis/schema';
import { showErrorMessage } from '@jupyterlab/apputils';
@@ -15,7 +15,7 @@ import { compressors } from 'hyparquet-compressors';
import Protobuf from 'pbf';
import shp from 'shpjs';
-import RASTER_LAYER_GALLERY from '@/rasterlayer_gallery/raster_layer_gallery.json';
+import LAYER_GALLERY from '@/layer_gallery.json';
export const debounce = (
func: CallableFunction,
@@ -151,7 +151,7 @@ export function deepCopy>(value: T): T {
export function createDefaultLayerRegistry(
layerBrowserRegistry: IJGISLayerBrowserRegistry,
): void {
- const RASTER_THUMBNAILS: { [key: string]: string } = {};
+ const LAYER_THUMBNAILS: { [key: string]: string } = {};
/**
* Generate object to hold thumbnail URLs
@@ -159,28 +159,30 @@ export function createDefaultLayerRegistry(
const importAll = (r: __WebpackModuleApi.RequireContext) => {
r.keys().forEach(key => {
const imageName = key.replace('./', '').replace(/\.\w+$/, '');
- RASTER_THUMBNAILS[imageName] = r(key);
+ LAYER_THUMBNAILS[imageName] = r(key);
});
};
const context = require.context(
- '../rasterlayer_gallery',
+ '../layer_gallery',
false,
/\.(png|jpe?g|gif|svg)$/,
);
importAll(context);
- for (const entry of Object.keys(RASTER_LAYER_GALLERY)) {
- const xyzprovider: any = (RASTER_LAYER_GALLERY as any)[entry];
+ for (const entry of Object.keys(LAYER_GALLERY)) {
+ const layerProvider: any = (LAYER_GALLERY as any)[entry];
- if ('url' in xyzprovider) {
- const tile = convertToRegistryEntry(entry, xyzprovider);
+ if ('thumbnailPath' in layerProvider) {
+ /*flat layer provider*/
+ const tile = convertToRegistryEntry(entry, layerProvider);
layerBrowserRegistry.addRegistryLayer(tile);
} else {
- Object.keys(xyzprovider).forEach(mapName => {
+ /* nested layer provider */
+ Object.keys(layerProvider).forEach(mapName => {
const tile = convertToRegistryEntry(
- xyzprovider[mapName]['name'],
- xyzprovider[mapName],
+ layerProvider[mapName]['name'],
+ layerProvider[mapName],
entry,
);
@@ -194,40 +196,24 @@ export function createDefaultLayerRegistry(
* Parse tile information from providers to be usable in the layer registry
*
* @param entry - The name of the entry, which may also serve as the default provider name if none is specified.
- * @param xyzprovider - An object containing the XYZ provider's details, including name, URL, zoom levels, attribution, and possibly other properties relevant to the provider.
+ * @param layerProvider - An object containing the provider's details, including name, URL, zoom levels, attribution, and possibly other properties relevant to the provider.
* @param provider - Optional. Specifies the provider name. If not provided, the `entry` parameter is used as the default provider name.
* @returns - An object representing the registry entry
*/
function convertToRegistryEntry(
entry: string,
- xyzprovider: { [x: string]: any },
+ layerProvider: { [x: string]: any },
provider?: string | undefined,
- ): IRasterLayerGalleryEntry {
- const urlParameters: any = {};
- if (xyzprovider.time) {
- urlParameters.time = xyzprovider.time;
- }
- if (xyzprovider.variant) {
- urlParameters.variant = xyzprovider.variant;
- }
- if (xyzprovider.tilematrixset) {
- urlParameters.tilematrixset = xyzprovider.tilematrixset;
- }
- if (xyzprovider.format) {
- urlParameters.format = xyzprovider.format;
- }
-
+ ): ILayerGalleryEntry {
return {
name: entry,
- thumbnail: RASTER_THUMBNAILS[xyzprovider['name'].replace('.', '-')],
- source: {
- url: xyzprovider['url'],
- minZoom: xyzprovider['min_zoom'] || 0,
- maxZoom: xyzprovider['max_zoom'] || 24,
- attribution: xyzprovider['attribution'] || '',
- provider: provider ?? entry,
- urlParameters,
- },
+ thumbnail: LAYER_THUMBNAILS[layerProvider['name'].replace('.', '-')],
+ sourceType: layerProvider['sourceType'],
+ layerType: layerProvider['layerType'],
+ sourceParameters: layerProvider['sourceParameters'],
+ layerParameters: layerProvider['layerParameters'],
+ provider: provider ?? entry.split('.', 1)[0],
+ description: layerProvider['description'],
};
}
}
diff --git a/packages/schema/src/interfaces.ts b/packages/schema/src/interfaces.ts
index f1990e934..d33f81b62 100644
--- a/packages/schema/src/interfaces.ts
+++ b/packages/schema/src/interfaces.ts
@@ -27,10 +27,32 @@ import {
IJGISSource,
IJGISSources,
IJGISStoryMap,
+ LayerType,
SourceType,
} from './_interface/project/jgis';
-import { IRasterSource } from './_interface/project/sources/rasterSource';
-import { Modes } from './types';
+
+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 {
@@ -356,21 +378,44 @@ export interface IJGISExternalCommandRegistry {
}
/**
- * 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;
}
diff --git a/python/jupytergis_core/src/layerBrowserRegistry.ts b/python/jupytergis_core/src/layerBrowserRegistry.ts
index fdd08e7ac..4151ecdf4 100644
--- a/python/jupytergis_core/src/layerBrowserRegistry.ts
+++ b/python/jupytergis_core/src/layerBrowserRegistry.ts
@@ -1,6 +1,6 @@
import {
IJGISLayerBrowserRegistry,
- IRasterLayerGalleryEntry,
+ ILayerGalleryEntry,
} from '@jupytergis/schema';
/**
@@ -11,7 +11,7 @@ import {
* @implements IJGISLayerBrowserRegistry
*/
export class JupyterGISLayerBrowserRegistry implements IJGISLayerBrowserRegistry {
- private _registry: IRasterLayerGalleryEntry[];
+ private _registry: ILayerGalleryEntry[];
constructor() {
this._registry = [];
@@ -22,7 +22,7 @@ export class JupyterGISLayerBrowserRegistry implements IJGISLayerBrowserRegistry
* Returns a copy of the internal registry array to prevent external modifications.
* @returns The current state of the registry layers.
*/
- getRegistryLayers(): IRasterLayerGalleryEntry[] {
+ getRegistryLayers(): ILayerGalleryEntry[] {
return [...this._registry];
}
@@ -30,7 +30,7 @@ export class JupyterGISLayerBrowserRegistry implements IJGISLayerBrowserRegistry
* Adds a new raster layer gallery entry to the registry.
* @param data - The raster layer gallery entry to add.
*/
- addRegistryLayer(data: IRasterLayerGalleryEntry): void {
+ addRegistryLayer(data: ILayerGalleryEntry): void {
this._registry.push(data);
}