Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/api/config/config-api.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,24 +87,26 @@ export declare class ConfigApi {
* @param {string} geoviewLayerName - The display name of the layer.
* @param {TypeInitialGeoviewLayerType} layerType - The type of GeoView layer to initialize (e.g., 'esriDynamic', 'ogcWms', 'GeoJSON', etc.).
* @param {string} layerURL - The URL endpoint associated with the layer (e.g., service URL, file path).
* @param {TypeDisplayLanguage} language - The language, used for the geocore layer types to know which language to use when extracting layer information.
* @param {string} mapId - The map id, used for the geocore layer types, to determine the layer id.
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {boolean?} [isTimeAware] - Indicates whether the layer supports time-based filtering.
* @param {TypeDisplayLanguage} [language] - The language, used for the geocore layer types to know which language to use when extracting layer information.
* @param {string} [mapId] - The map id, used for the geocore layer types, to determine the layer id.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of the process.
* @returns {Promise<TypeGeoviewLayerConfig>} A Promise of a fully initialized `TypeGeoviewLayerConfig`.
* @throws {NotSupportedError} If the provided layer type is not recognized or supported.
*/
static createInitConfigFromType(layerType: TypeInitialGeoviewLayerType, geoviewLayerId: string, geoviewLayerName: string, layerURL: string, language?: TypeDisplayLanguage, mapId?: string, abortSignal?: AbortSignal | undefined): Promise<TypeGeoviewLayerConfig>;
static createInitConfigFromType(layerType: TypeInitialGeoviewLayerType, geoviewLayerId: string, geoviewLayerName: string, layerURL: string, isTimeAware?: boolean, language?: TypeDisplayLanguage, mapId?: string, abortSignal?: AbortSignal): Promise<TypeGeoviewLayerConfig>;
/**
* Processes the layer to generate a list of ConfigBaseClass objects.
* @param {TypeInitialGeoviewLayerType} layerType - The layer type
* @param {string} geoviewLayerId - The geoview layer id
* @param {string} geoviewLayerName - The geoview layer name
* @param {string} layerURL - The layer url
* @param {number[] | string[]} layerIds - The layer ids for each layer entry config.
* @param {boolean} isTimeAware - Indicates if the layer is time aware.
* @returns {Promise<ConfigBaseClass[]>} A Promise of a list of ConfigBaseClass objects.
* @throws {NotSupportedError} If the provided layer type is not recognized or supported.
*/
static processLayerFromType(layerType: TypeInitialGeoviewLayerType, geoviewLayerId: string, geoviewLayerName: string, layerURL: string, layerIds: number[] | string[]): Promise<ConfigBaseClass[]>;
static processLayerFromType(layerType: TypeInitialGeoviewLayerType, geoviewLayerId: string, geoviewLayerName: string, layerURL: string, layerIds: number[] | string[], isTimeAware: boolean): Promise<ConfigBaseClass[]>;
/**
* Utility function to serialize to string a TypeGeoviewLayerConfig object.
* @param {TypeGeoviewLayerConfig} geoviewLayerConfig - The TypeGeoviewLayerConfig to serialize.
Expand Down
2 changes: 1 addition & 1 deletion src/api/config/config-api.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/api/config/config-validation.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export declare class ConfigValidation {
static validateLayersConfigAgainstSchema(listOfGeoviewLayerConfig: MapConfigLayerEntry[], onErrorCallback: ErrorCallbackDelegate): MapConfigLayerEntry[];
/**
* Validate and adjust the list of GeoView layer configuration.
* Errors, when expected, are logged and not thrown so that each MapConfigLayerEntry can be processed independently.
* @param {MapConfigLayerEntry[]} listOfMapConfigLayerEntry - The list of GeoView layer configuration to adjust and
* validate.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/api/config/config-validation.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions src/api/config/geocore.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,20 @@ export declare class GeoCore {
* @param {TypeDisplayLanguage} language - The language.
* @param {string} mapId - The optional map id.
* @param {GeoCoreLayerConfig?} layerConfig - The optional layer configuration.
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of the process.
* @returns {Promise<GeoCoreLayerConfigResponse>} List of layer configurations to add to the map.
*/
static createLayerConfigFromUUID(uuid: string, language: TypeDisplayLanguage, mapId?: string, layerConfig?: GeoCoreLayerConfig, abortSignal?: AbortSignal): Promise<GeoCoreLayerConfigResponse>;
/**
* Gets GeoView layer configurations list from the RCS UUIDs of the list of layer entry configurations.
* @param {string} uuid - The UUID of the layer.
* @param {TypeDisplayLanguage} language - The language.
* @param {string} mapId - The optional map id.
* @param {RCSLayerConfig?} layerConfig - The optional layer configuration.
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of fetch.
* @returns {Promise<TypeGeoviewLayerConfig>} List of layer configurations to add to the map.
*/
static createLayerConfigFromRCSUUID(uuid: string, language: TypeDisplayLanguage, layerConfig?: RCSLayerConfig, abortSignal?: AbortSignal): Promise<TypeGeoviewLayerConfig>;
static createLayerConfigFromRCSUUID(uuid: string, language: TypeDisplayLanguage, mapId: string, layerConfig?: RCSLayerConfig, abortSignal?: AbortSignal): Promise<TypeGeoviewLayerConfig>;
}
export type GeoCoreLayerConfigResponse = {
config: TypeGeoviewLayerConfig;
Expand Down
2 changes: 1 addition & 1 deletion src/api/config/geocore.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/api/config/reader/geopackage-reader.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export declare class GeoPackageReader {
/**
* Generates a WKB layer config from a GeoPackage.
* @param {GeoPackageLayerConfig} layerConfig - the config to convert
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of the process.
* @returns {Promise<TypeWkbLayerConfig>} A WKB layer config
*/
static createLayerConfigFromGeoPackage(layerConfig: GeoPackageLayerConfig, abortSignal?: AbortSignal): Promise<TypeWkbLayerConfig>;
Expand Down
2 changes: 1 addition & 1 deletion src/api/config/reader/geopackage-reader.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/api/config/reader/shapefile-reader.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export declare class ShapefileReader {
/**
* Generates GeoJson layer config from a shapefile.
* @param {TypeShapefileLayerConfig} layerConfig - The config to convert.
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of the process.
* @returns {Promise<TypeGeoJSONLayerConfig>} A geojson layer config
*/
static convertShapefileConfigToGeoJson(layerConfig: ShapefileLayerConfig, abortSignal?: AbortSignal): Promise<TypeGeoJSONLayerConfig>;
Expand Down
2 changes: 1 addition & 1 deletion src/api/config/reader/shapefile-reader.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/api/config/reader/uuid-config-reader.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export declare class UUIDmapConfigReader {
* @param {string} baseUrl - The base url of GeoCore API
* @param {TypeDisplayLanguage} lang - The language to get the config for
* @param {string[]} uuids - A list of uuids to get the configurations for
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of the process.
* @returns {Promise<UUIDmapConfigReaderResponse>} Layers and Geocharts read and parsed from uuids results from GeoCore
*/
static getGVConfigFromUUIDs(baseUrl: string, lang: TypeDisplayLanguage, uuids: string[], abortSignal?: AbortSignal): Promise<UUIDmapConfigReaderResponse>;
Expand All @@ -22,7 +22,7 @@ export declare class UUIDmapConfigReader {
* @param {string} baseUrl - The base url of GeoCore API
* @param {TypeDisplayLanguage} lang - The language to get the config for
* @param {string[]} uuids - A list of uuids to get the configurations for
* @param {AbortSignal | undefined} abortSignal - Abort signal to handle cancelling of fetch.
* @param {AbortSignal?} [abortSignal] - Abort signal to handle cancelling of the process.
* @returns {Promise<UUIDmapConfigReaderResponse>} Layers read and parsed from uuids results from Geonetwork RCS
*/
static getGVConfigFromUUIDsRCS(baseUrl: string, lang: TypeDisplayLanguage, uuids: string[], abortSignal?: AbortSignal): Promise<UUIDmapConfigReaderResponse>;
Expand Down
Loading