@vcmap/core 5.0.0-rc.12 → 5.0.0-rc.13

package/index.d.ts

@@ -1153,6 +1153,7 @@ export class CesiumTilesetLayer extends FeatureLayer implements SplitLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -1193,6 +1194,10 @@ export class CesiumTilesetLayer extends FeatureLayer implements SplitLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1241,6 +1246,7 @@ export class CzmlLayer extends DataSourceLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -1281,6 +1287,10 @@ export class CzmlLayer extends DataSourceLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1354,6 +1364,7 @@ export class DataSourceLayer extends Layer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -1394,6 +1405,10 @@ export class DataSourceLayer extends Layer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1494,6 +1509,7 @@ export class FeatureLayer extends Layer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -1534,6 +1550,10 @@ export class FeatureLayer extends Layer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -1708,6 +1728,7 @@ export class FeatureStoreLayer extends VectorLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -1747,6 +1768,10 @@ export class FeatureStoreLayer extends VectorLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -2114,6 +2139,7 @@ export class GeoJSONLayer extends VectorLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -2153,6 +2179,10 @@ export class GeoJSONLayer extends VectorLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -2314,6 +2344,7 @@ export class Layer extends VcsObject {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -2349,6 +2380,10 @@ export class Layer extends VcsObject {
     readonly exclusive: boolean;
     exclusiveGroups: any;
     zIndex: any;
+    /**
+     * sets the locale and reloads the layer the if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * creates an array of layer implementations for the given map.
      * @param map - Map
@@ -2609,6 +2644,7 @@ export class OpenStreetMapLayer extends Layer implements SplitLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -2649,6 +2685,10 @@ export class OpenStreetMapLayer extends Layer implements SplitLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -2916,6 +2956,7 @@ export class PointCloudLayer extends CesiumTilesetLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -2956,6 +2997,10 @@ export class PointCloudLayer extends CesiumTilesetLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3057,6 +3102,7 @@ export class RasterLayer extends Layer implements SplitLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -3097,6 +3143,10 @@ export class RasterLayer extends Layer implements SplitLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3165,6 +3215,7 @@ export class SingleImageLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -3205,6 +3256,10 @@ export class SingleImageLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3280,6 +3335,7 @@ export class TerrainLayer extends Layer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -3320,6 +3376,10 @@ export class TerrainLayer extends Layer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3354,6 +3414,10 @@ export class MVTTileProvider extends TileProvider {
     static getDefaultOptions(): MVTTileProviderOptions;
     url: string;
     idProperty: string | undefined;
+    /**
+     * sets the locale and clears the Cache if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * Cesium Webmercator TilingScheme
      */
@@ -3439,6 +3503,7 @@ export class StaticGeoJSONTileProvider extends TileProvider {
      * use setTileCacheSize to change
      */
     readonly tileCacheSize: number;
+    locale: string;
     /**
      * unique Name
      */
@@ -3538,6 +3603,10 @@ export class TileProvider extends VcsObject {
      * use setTileCacheSize to change
      */
     readonly tileCacheSize: number;
+    /**
+     * sets the locale and reloads the layer the if the URL is a locale aware Object.
+     */
+    locale: any;
     setTileCacheSize(value: number): Promise<any>;
     /**
      * returns the closest baseLevel for the given resolution
@@ -3618,9 +3687,9 @@ export interface URLTemplateTileProviderOptions extends TileProviderOptions {
 /**
  * replaces {x}, {y}, {z} with the x, y, z tiling coordinates
  * replaces {minx}, {miny}, {maxx}, {maxy} with extent of the tile if tilingExtent is provided
- * replaces {locale} with the current locale
+ * replaces {locale} with the given locale
  */
-export function getURL(url: string, x: number, y: number, z: number, tilingExtent?: import("@vcmap/cesium").Rectangle): string;
+export function getURL(url: string, x: number, y: number, z: number, tilingExtent?: import("@vcmap/cesium").Rectangle, locale?: string): string;
 
 /**
  * TileProvider loads GeojsonLayer from the provided URL. The URL has placeholders:
@@ -3633,6 +3702,10 @@ export class URLTemplateTileProvider extends TileProvider {
     static readonly className: any;
     static getDefaultOptions(): URLTemplateTileProviderOptions;
     url: string;
+    /**
+     * sets the locale and clears the Cache if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * Cesium Webmercator TilingScheme
      */
@@ -3725,6 +3798,7 @@ export class TMSLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -3765,6 +3839,10 @@ export class TMSLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -3981,6 +4059,7 @@ export class VectorLayer extends FeatureLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -4020,6 +4099,10 @@ export class VectorLayer extends FeatureLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -4296,6 +4379,10 @@ export class VectorTileLayer extends FeatureLayer {
      */
     vectorProperties: VectorProperties;
     tileProvider: TileProvider;
+    /**
+     * sets the locale and reloads the layer the if the URL is a locale aware Object.
+     */
+    locale: any;
     /**
      * rerenders the specified tiles
      * rendering happens async
@@ -4342,6 +4429,7 @@ export class VectorTileLayer extends FeatureLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -4485,6 +4573,7 @@ export class WFSLayer extends VectorLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -4524,6 +4613,10 @@ export class WFSLayer extends VectorLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -4646,6 +4739,7 @@ export class WMSLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -4686,6 +4780,10 @@ export class WMSLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -4771,6 +4869,7 @@ export class WMTSLayer extends RasterLayer {
      * The class names of the supported maps.
      */
     protected _supportedMaps: string[];
+    protected _url: string | any;
     /**
      * Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.
      */
@@ -4811,6 +4910,10 @@ export class WMTSLayer extends RasterLayer {
      */
     readonly exclusiveGroups: any;
     zIndex: number;
+    /**
+     * returns the currently set locale. Can be used to provide locale specific URLs.
+     */
+    locale: string;
     /**
      * unique Name
      */
@@ -6750,16 +6853,6 @@ export class Collection<T extends any> {
     destroy(): void;
 }
 
-export function getShortLocaleDate(date: Date, locale?: string): string;
-
-export function getShortLocaleTime(date: Date, locale?: string): string;
-
-export function getISODateString(date: Date): string;
-
-export function getDayOfYear(date: Date): number;
-
-export function isLeapYear(date: Date): boolean;
-
 /**
  * Tracks layer exclusivity, added to every {@link LayerCollection}.
  */
@@ -7007,25 +7100,22 @@ export class LayerCollection extends IndexedCollection<Layer> {
      * Set global hider for these maps.
      */
     globalHider: any;
+    locale: any;
     /**
      * Adds a layer to the collection. Can optionally be passed an index at which to insert the layer.
+     * The layer locale will be set to the same locale of the layerCollection. This will trigger a forceRedraw
+     * of the layer if the layer locale is different and the layer is locale aware.
      * @returns returns the layer index or null, if the layers name is not unique
      */
     add(layer: Layer, index?: number): number | null;
     protected _remove(layer: Layer): number;
 }
 
-export function getLocaleChangedEvent(): VcsEvent<string>;
-
 /**
  * returns the default browserLocale, if not possible 'en'
  */
 export function detectBrowserLocale(): string;
 
-export function getCurrentLocale(): string;
-
-export function setCurrentLocale(value: string): void;
-
 export interface MapCollectionInitializationError {
     error: Error;
     map: VcsMap;
@@ -7399,6 +7489,12 @@ export class ViewPoint extends VcsObject {
 
 export class VcsApp {
     readonly id: string;
+    /**
+     * sets the locale of the vcsApp and the linked layerCollection.
+     * This will trigger the localeChanged Event.
+     */
+    locale: any;
+    readonly localeChanged: VcsEvent<string>;
     readonly maps: OverrideMapCollection;
     readonly layers: OverrideLayerCollection;
     readonly obliqueCollections: OverrideCollection<ObliqueCollection>;

package/index.js

@@ -116,7 +116,6 @@ export { default as ClippingObject } from './src/util/clipping/clippingObject.js
 export { default as ClippingObjectManager } from './src/util/clipping/clippingObjectManager.js';
 export { createClippingPlaneCollection, copyClippingPlanesToCollection, clearClippingPlanes, setClippingPlanes, createClippingFeature, getClippingOptions } from './src/util/clipping/clippingPlaneHelper.js';
 export { default as Collection } from './src/util/collection.js';
-export { getShortLocaleDate, getShortLocaleTime, getISODateString, getDayOfYear, isLeapYear } from './src/util/dateTime.js';
 export { default as ExclusiveManager } from './src/util/exclusiveManager.js';
 export { default as Extent } from './src/util/extent.js';
 export { validateCircle, default as circleToCesium } from './src/util/featureconverter/circleToCesium.js';
@@ -131,7 +130,7 @@ export { getFlatCoordinatesFromSimpleGeometry, getFlatCoordinatesFromGeometry, c
 export { default as IndexedCollection } from './src/util/indexedCollection.js';
 export { isMobile } from './src/util/isMobile.js';
 export { default as LayerCollection } from './src/util/layerCollection.js';
-export { getLocaleChangedEvent, detectBrowserLocale, getCurrentLocale, setCurrentLocale } from './src/util/locale.js';
+export { detectBrowserLocale } from './src/util/locale.js';
 export { default as MapCollection } from './src/util/mapCollection.js';
 export { coordinateAtDistance, initialBearingBetweenCoords, cartesian2DDistance, cartesian3DDistance } from './src/util/math.js';
 export { isOverrideCollection, default as makeOverrideCollection } from './src/util/overrideCollection.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.12",
+  "version": "5.0.0-rc.13",
   "description": "",
   "main": "index.js",
   "type": "module",

package/src/layer/layer.js

@@ -5,7 +5,6 @@ import Extent from '../util/extent.js';
 import { vcsLayerName } from './layerSymbols.js';
 import LayerState from './layerState.js';
 import VcsEvent from '../vcsEvent.js';
-import { getCurrentLocale, getLocaleChangedEvent } from '../util/locale.js';
 import { layerClassRegistry } from '../classRegistry.js';
 import GlobalHider from './globalHider.js';
 
@@ -187,16 +186,10 @@ class Layer extends VcsObject {
 
     /**
      * @type {string|Object}
-     * @private
+     * @protected
      */
     this._url = options.url;
 
-    /**
-     * @type {Function}
-     * @private
-     */
-    this._localeChangedListener = null;
-
     /**
      * @type {number}
      * @private
@@ -271,6 +264,12 @@ class Layer extends VcsObject {
      * @api
      */
     this.featureProvider = undefined;
+
+    /**
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -335,9 +334,8 @@ class Layer extends VcsObject {
       if (typeof this._url === 'string') {
         return this._url;
       }
-      const locale = getCurrentLocale();
-      if (this._url[locale]) {
-        return this._url[locale];
+      if (this._url[this._locale]) {
+        return this._url[this._locale];
       }
       return Object.values(this._url)[0];
     }
@@ -445,6 +443,29 @@ class Layer extends VcsObject {
     }
   }
 
+  /**
+   * returns the currently set locale. Can be used to provide locale specific URLs.
+   * @type {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * sets the locale and reloads the layer the if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    check(value, String);
+
+    if (this._locale !== value) {
+      this._locale = value;
+      if (this._url && typeof this._url === 'object' && this._url[this._locale]) {
+        this.reload();
+      }
+    }
+  }
+
   /**
    * creates an array of layer implementations for the given map.
    * @param {import("@vcmap/core").VcsMap} map Map
@@ -540,25 +561,11 @@ class Layer extends VcsObject {
     return null;
   }
 
-  /**
-   * recreates the implementations on locale change, if the url of this layer is an Object
-   * @param {string} locale
-   * @private
-   */
-  _handleLocaleChange(locale) {
-    if (this._url && typeof this._url === 'object' && this._url[locale]) {
-      this.reload();
-    }
-  }
-
   /**
    * initializes the layer, can be used to defer loading
    * @returns {Promise<void>}
    */
   initialize() {
-    if (!this.initialized) {
-      this._localeChangedListener = getLocaleChangedEvent().addEventListener(this._handleLocaleChange.bind(this));
-    }
     this._initialized = true;
     return Promise.resolve();
   }
@@ -779,10 +786,6 @@ class Layer extends VcsObject {
         impl.destroy();
       });
 
-    if (this._localeChangedListener) {
-      this._localeChangedListener();
-      this._localeChangedListener = null;
-    }
     this._initialized = false;
     this._implementations.clear();
     this.stateChanged.destroy();

package/src/layer/tileProvider/mvtTileProvider.js

@@ -62,6 +62,26 @@ class MVTTileProvider extends TileProvider {
     this._MVTFormat = new MVT({ featureClass: Feature });
   }
 
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return super.locale;
+  }
+
+  /**
+   * sets the locale and clears the Cache if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    if (this.locale !== value) {
+      super.locale = value;
+      if (this.url.includes('{locale}')) {
+        this.clearCache();
+      }
+    }
+  }
+
   /**
    * @inheritDoc
    * @param {number} x
@@ -71,7 +91,7 @@ class MVTTileProvider extends TileProvider {
    */
   async loader(x, y, z) {
     const rectangle = this.tilingScheme.tileXYToRectangle(x, y, z);
-    const url = getURL(this.url, x, y, z, rectangle);
+    const url = getURL(this.url, x, y, z, rectangle, this.locale);
     const extent = rectangleToExtent(rectangle);
     const center = getCenter(extent);
     const data = await requestArrayBuffer(url);

package/src/layer/tileProvider/tileProvider.js

@@ -1,5 +1,6 @@
 import { v4 as uuidv4 } from 'uuid';
 import RBush from 'rbush';
+import { check } from '@vcsuite/check';
 import { Rectangle, Math as CesiumMath, WebMercatorTilingScheme, Cartographic } from '@vcmap/cesium';
 import LRUCache from 'ol/structs/LRUCache.js';
 import { buffer, createOrUpdateFromCoordinate } from 'ol/extent.js';
@@ -176,6 +177,12 @@ class TileProvider extends VcsObject {
      * @api
      */
     this.tileLoadedEvent = new VcsEvent();
+
+    /**
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -188,6 +195,26 @@ class TileProvider extends VcsObject {
     return this._tileCacheSize;
   }
 
+
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * sets the locale and reloads the layer the if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    check(value, String);
+    if (this._locale !== value) {
+      this._locale = value;
+    }
+  }
+
+
   /**
    * @param {number} value
    * @returns {Promise<*>}

package/src/layer/tileProvider/urlTemplateTileProvider.js

@@ -1,7 +1,6 @@
 import { Math as CesiumMath, Rectangle } from '@vcmap/cesium';
 import { parseGeoJSON } from '../geojsonHelpers.js';
 import TileProvider from './tileProvider.js';
-import { getCurrentLocale } from '../../util/locale.js';
 import { requestJson } from '../../util/fetch.js';
 import { tileProviderClassRegistry } from '../../classRegistry.js';
 
@@ -14,16 +13,17 @@ import { tileProviderClassRegistry } from '../../classRegistry.js';
 /**
  * replaces {x}, {y}, {z} with the x, y, z tiling coordinates
  * replaces {minx}, {miny}, {maxx}, {maxy} with extent of the tile if tilingExtent is provided
- * replaces {locale} with the current locale
+ * replaces {locale} with the given locale
  *
  * @param {string} url
  * @param {number} x
  * @param {number} y
  * @param {number} z
  * @param {import("@vcmap/cesium").Rectangle=} tilingExtent
+ * @param {string=} locale
  * @returns {string}
  */
-export function getURL(url, x, y, z, tilingExtent) {
+export function getURL(url, x, y, z, tilingExtent, locale = 'en') {
   let replacedURL = url;
   if (tilingExtent) {
     const southwest = Rectangle.southwest(tilingExtent);
@@ -43,7 +43,7 @@ export function getURL(url, x, y, z, tilingExtent) {
     .replace(/\{x\}/, String(x))
     .replace(/\{y\}/, String(y))
     .replace(/\{z\}/, String(z))
-    .replace(/\{locale\}/, getCurrentLocale());
+    .replace(/\{locale\}/, locale);
   return replacedURL;
 }
 
@@ -87,6 +87,27 @@ class URLTemplateTileProvider extends TileProvider {
     this.url = options.url || defaultOptions.url;
   }
 
+
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return super.locale;
+  }
+
+  /**
+   * sets the locale and clears the Cache if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    if (this.locale !== value) {
+      super.locale = value;
+      if (this.url.includes('{locale}')) {
+        this.clearCache();
+      }
+    }
+  }
+
   /**
    * @inheritDoc
    * @param {number} x
@@ -96,7 +117,7 @@ class URLTemplateTileProvider extends TileProvider {
    */
   async loader(x, y, z) {
     const rectangle = this.tilingScheme.tileXYToRectangle(x, y, z);
-    const url = getURL(this.url, x, y, z, rectangle);
+    const url = getURL(this.url, x, y, z, rectangle, this.locale);
     const data = await requestJson(url);
     const { features } = parseGeoJSON(data, { dynamicStyle: true });
     return features;

package/src/layer/vectorTileLayer.js

@@ -138,6 +138,9 @@ class VectorTileLayer extends FeatureLayer {
     this.tileProvider = options.tileProvider instanceof TileProvider ? // XXX this now throws if not passing in a tileProvider.
       options.tileProvider :
       getObjectFromClassRegistry(tileProviderClassRegistry, options.tileProvider);
+    if (this.tileProvider) {
+      this.tileProvider.locale = this.locale;
+    }
 
     /**
      * @type {number|undefined}
@@ -177,6 +180,25 @@ class VectorTileLayer extends FeatureLayer {
     this._styleZIndex = 0;
   }
 
+  /**
+   * returns the currently set locale. Can be used to provide locale specific URLs.
+   * @type {string}
+   */
+  get locale() {
+    return super.locale;
+  }
+
+  /**
+   * sets the locale and reloads the layer the if the URL is a locale aware Object.
+   * @param {string} value
+   */
+  set locale(value) {
+    if (this.tileProvider) {
+      this.tileProvider.locale = super.locale;
+    }
+    super.locale = value;
+  }
+
   /**
    * initializes the layer, can be used to defer loading
    * @returns {Promise<void>}

package/src/util/layerCollection.js

@@ -70,6 +70,15 @@ class LayerCollection extends IndexedCollection {
      * @private
      */
     this._globalHider = new GlobalHider();
+
+    /**
+     * Locale for this layerCollection, will be synchronized by the vcsApp, if part of an vcsApp.
+     * This Locale will be set on all Member Layers. On setting the Locale this will trigger a reload of all locale
+     * aware layers.
+     * @type {string}
+     * @private
+     */
+    this._locale = 'en';
   }
 
   /**
@@ -102,6 +111,27 @@ class LayerCollection extends IndexedCollection {
     });
   }
 
+  /**
+   * @type {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * @param {string} value
+   */
+  set locale(value) {
+    check(value, String);
+
+    if (this._locale !== value) {
+      this._locale = value;
+      [...this].forEach((layer) => {
+        layer.locale = this._locale;
+      });
+    }
+  }
+
   /**
    * @param {import("@vcmap/core").Layer} layer
    * @private
@@ -188,6 +218,8 @@ class LayerCollection extends IndexedCollection {
 
   /**
    * Adds a layer to the collection. Can optionally be passed an index at which to insert the layer.
+   * The layer locale will be set to the same locale of the layerCollection. This will trigger a forceRedraw
+   * of the layer if the layer locale is different and the layer is locale aware.
    * @param {import("@vcmap/core").Layer} layer
    * @param {number=} index
    * @returns {number|null} returns the layer index or null, if the layers name is not unique
@@ -202,6 +234,7 @@ class LayerCollection extends IndexedCollection {
     if (insertedAt != null) {
       layer[this._zIndexSymbol] = layer.zIndex;
       layer.setGlobalHider(this._globalHider);
+      layer.locale = this.locale;
       this._ensureLocalZIndex(layer);
       this._listenToLayerEvents(layer);
       this.exclusiveManager.registerLayer(layer);

package/src/util/locale.js

@@ -1,20 +1,4 @@
-import VcsEvent from '../vcsEvent.js';
-
-/**
- * @type {VcsEvent<string>}
- */
-let localeChangedEvent;
-
-/**
- * @returns {VcsEvent<string>}
- */
-export function getLocaleChangedEvent() {
-  if (!localeChangedEvent) {
-    localeChangedEvent = new VcsEvent();
-  }
-  return localeChangedEvent;
-}
-
+/* eslint-disable import/prefer-default-export */
 /**
  * returns the default browserLocale, if not possible 'en'
  * @returns {string}
@@ -26,28 +10,3 @@ export function detectBrowserLocale() {
   }
   return 'en';
 }
-
-/**
- * @type {string}
- */
-let currentLocale;
-
-/**
- * @returns {string}
- */
-export function getCurrentLocale() {
-  if (!currentLocale) {
-    currentLocale = detectBrowserLocale();
-  }
-  return currentLocale;
-}
-
-/**
- * @param {string} value
- */
-export function setCurrentLocale(value) {
-  if (typeof value === 'string') {
-    currentLocale = value;
-    getLocaleChangedEvent().raiseEvent(value);
-  }
-}

package/src/vcsApp.js

@@ -33,6 +33,7 @@ import ClassRegistry, {
   styleClassRegistry,
   tileProviderClassRegistry,
 } from './classRegistry.js';
+import { detectBrowserLocale } from './util/locale.js';
 
 /**
  * @returns {import("@vcsuite/logger").Logger}
@@ -69,6 +70,20 @@ class VcsApp {
 
     const getDynamicContextId = () => this._dynamicContext.id;
 
+    /**
+     * represents the current Locale.
+     * @type {string}
+     * @private
+     */
+    this._locale = detectBrowserLocale();
+
+    /**
+     * fires if the current Locale changes.
+     * @type {VcsEvent<string>}
+     * @private
+     */
+    this._localeChanged = new VcsEvent();
+
     /**
      * @type {OverrideClassRegistry<VcsMap>}
      * @private
@@ -104,6 +119,8 @@ class VcsApp {
       Layer,
       getLayerIndex,
     );
+    this._layers.locale = this.locale;
+
     /**
      * @type {OverrideCollection<import("@vcmap/core").ObliqueCollection>}
      * @private
@@ -184,6 +201,7 @@ class VcsApp {
      * @private
      */
     this._featureProviderClassRegsitry = new OverrideClassRegistry(featureProviderClassRegistry);
+
     vcsApps.set(this._id, this);
   }
 
@@ -193,6 +211,40 @@ class VcsApp {
    */
   get id() { return this._id; }
 
+  /**
+   * @returns {string}
+   */
+  get locale() {
+    return this._locale;
+  }
+
+  /**
+   * sets the locale of the vcsApp and the linked layerCollection.
+   * This will trigger the localeChanged Event.
+   * @param {string} value new locale with 2 letters
+   */
+  set locale(value) {
+    check(value, String);
+
+    if (value.length !== 2) {
+      getLogger().warning('Provide a valid locale, for example "en", "de" with max. 2 letters');
+      return;
+    }
+    if (this._locale !== value) {
+      this._locale = value;
+      this.layers.locale = value;
+      this._localeChanged.raiseEvent(value);
+    }
+  }
+
+  /**
+   * @type {VcsEvent<string>}
+   * @readonly
+   */
+  get localeChanged() {
+    return this._localeChanged;
+  }
+
   /**
    * @type {OverrideMapCollection}
    * @readonly
@@ -454,6 +506,7 @@ class VcsApp {
     this._featureProviderClassRegsitry.destroy();
     this.destroyed.raiseEvent();
     this.destroyed.destroy();
+    this.localeChanged.destroy();
   }
 }
 

package/src/util/dateTime.js

@@ -1,60 +0,0 @@
-/**
- * @param {Date} date
- * @param {string=} locale
- * @returns {string}
- */
-export function getShortLocaleDate(date, locale) {
-  // dateStyle is not within the standard yet
-  // @ts-ignore
-  return new Intl.DateTimeFormat(locale, { dateStyle: 'short' }).format(date);
-}
-
-/**
- * @param {Date} date
- * @param {string=} locale
- * @returns {string}
- */
-export function getShortLocaleTime(date, locale) {
-  // timeStyle is not within the standard yet
-  // @ts-ignore
-  return new Intl.DateTimeFormat(locale, { timeStyle: 'short' }).format(date);
-}
-
-/**
- * @param {Date} date
- * @returns {string}
- */
-export function getISODateString(date) {
-  const month = date.getMonth() + 1;
-  const day = date.getDate();
-  return `${date.getFullYear()}-${month > 9 ? '' : 0}${month}-${day > 9 ? '' : 0}${day}`;
-}
-
-/**
- * @param {Date} date
- * @returns {number}
- */
-export function getDayOfYear(date) {
-  const start = new Date(date.getFullYear(), 0, 0);
-  // TS cant handle date manipulation
-  // @ts-ignore
-  const diff = (date - start) + ((start.getTimezoneOffset() - date.getTimezoneOffset()) * 60 * 1000);
-  const oneDay = 1000 * 60 * 60 * 24;
-  return Math.floor(diff / oneDay);
-}
-
-/**
- * @param {Date} date
- * @returns {boolean}
- */
-export function isLeapYear(date) {
-  const currentYear = date.getFullYear();
-  if (currentYear % 4 !== 0) {
-    return false;
-  } else if (currentYear % 100 !== 0) {
-    return true;
-  } else if (currentYear % 400 !== 0) {
-    return false;
-  }
-  return true;
-}