@vcmap/core 5.0.0-rc.18 → 5.0.0-rc.20

package/index.d.ts

@@ -163,6 +163,19 @@ export interface VcsAppConfig {
     obliqueCollections?: ObliqueCollectionOptions[];
 }
 
+/**
+ * The id of the volatile context. Objects with this id shall never be serialized.
+ */
+export const volatileContextId: string;
+
+/**
+ * This marks an object as "volatile". This ensures, that an object added to the {@see VcsApp}
+ * will never be serialized into a context, regardless of the current dynamic context. Typical use case is a scratch layer
+ * which represents temporary features.
+ * @param object - the object to mark as volatile
+ */
+export function markVolatile(object: VcsObject | any): void;
+
 export class Context {
     constructor(config: VcsAppConfig);
     readonly id: string;
@@ -4790,7 +4803,7 @@ export class WMSLayer extends RasterLayer {
 
 export interface WMTSOptions extends RasterLayerOptions {
     layer: string;
-    style?: string | undefined;
+    wmtsStyle?: string | undefined;
     format?: string | undefined;
     tileMatrixSetID?: string | undefined;
     tileMatrixPrefix?: string | undefined;
@@ -4822,7 +4835,7 @@ export class WMTSLayer extends RasterLayer {
     numberOfLevelZeroTilesX: number;
     numberOfLevelZeroTilesY: number;
     layer: string;
-    style: string;
+    wmtsStyle: string;
     format: string;
     tileMatrixPrefix: string;
     tileMatrixSetID: string;
@@ -7058,6 +7071,12 @@ export class IndexedCollection<T extends any> extends Collection<T> {
     destroy(): void;
 }
 
+/**
+ * The largest integer zindex which can be safely assigned to a layer (equal to Number.MAX_SAFE_INTEGER)
+ * You should use this to ensure layers are always rendered on top.
+ */
+export const maxZIndex: number;
+
 /**
  * A collection of layers. Manages rendering order and layer exclusivity. Emits state changes for convenience. Passed to
  * {@link Map} for layers available to said map. Layers must have unique names.

package/index.js

@@ -11,7 +11,7 @@ export { default as AppBackedCategory } from './src/category/appBackedCategory.j
 export { default as Category } from './src/category/category.js';
 export { default as CategoryCollection } from './src/category/categoryCollection.js';
 export { layerClassRegistry, tileProviderClassRegistry, featureProviderClassRegistry, mapClassRegistry, styleClassRegistry, categoryClassRegistry, getObjectFromClassRegistry, default as ClassRegistry } from './src/classRegistry.js';
-export { default as Context } from './src/context.js';
+export { volatileContextId, markVolatile, default as Context } from './src/context.js';
 export { default as AbstractFeatureProvider } from './src/featureProvider/abstractFeatureProvider.js';
 export { getGenericFeatureFromProvidedFeature } from './src/featureProvider/featureProviderHelpers.js';
 export { isProvidedFeature, showProvidedFeature } from './src/featureProvider/featureProviderSymbols.js';
@@ -130,7 +130,7 @@ export { requestUrl, requestJson, requestArrayBuffer } from './src/util/fetch.js
 export { getFlatCoordinatesFromSimpleGeometry, getFlatCoordinatesFromGeometry, circleFromCenterRadius, convertGeometryToPolygon, enforceEndingVertex, removeEndingVertex, removeEndingVertexFromGeometry, enforceRightHand } from './src/util/geometryHelpers.js';
 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 { maxZIndex, default as LayerCollection } from './src/util/layerCollection.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';

package/package.json

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

package/src/context.js

@@ -1,4 +1,5 @@
-import { v5 as uuidv5 } from 'uuid';
+import { v5 as uuidv5, v4 as uuidv4 } from 'uuid';
+import { contextIdSymbol } from './vcsAppContextHelpers.js';
 
 /**
  * @typedef {Object} VcsAppConfig
@@ -19,6 +20,22 @@ import { v5 as uuidv5 } from 'uuid';
  */
 const uniqueNamespace = '9c27cc2d-552f-4637-9194-09329ed4c1dc';
 
+/**
+ * The id of the volatile context. Objects with this id shall never be serialized.
+ * @type {string}
+ */
+export const volatileContextId = uuidv4();
+
+/**
+ * This marks an object as "volatile". This ensures, that an object added to the {@see VcsApp}
+ * will never be serialized into a context, regardless of the current dynamic context. Typical use case is a scratch layer
+ * which represents temporary features.
+ * @param {import("@vcmap/core").VcsObject|Object} object - the object to mark as volatile
+ */
+export function markVolatile(object) {
+  object[contextIdSymbol] = volatileContextId;
+}
+
 /**
  * @class
  */

package/src/layer/wmtsLayer.js

@@ -10,7 +10,7 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {RasterLayerOptions} WMTSOptions
  * @property {string} layer
- * @property {string|undefined} style
+ * @property {string|undefined} [wmtsStyle]
  * @property {string|undefined} format
  * @property {string|undefined} tileMatrixSetID
  * @property {string|undefined} tileMatrixPrefix
@@ -76,7 +76,7 @@ class WMTSLayer extends RasterLayer {
       numberOfLevelZeroTilesX: 1,
       numberOfLevelZeroTilesY: 1,
       layer: '',
-      style: '',
+      wmtsStyle: '',
       format: '',
       tileMatrixPrefix: '',
       tileMatrixSetID: '',
@@ -115,7 +115,7 @@ class WMTSLayer extends RasterLayer {
     this.layer = options.layer || defaultOptions.layer;
 
     /** @type {string} */
-    this.style = options.style || defaultOptions.style;
+    this.wmtsStyle = options.wmtsStyle || defaultOptions.wmtsStyle;
 
     /** @type {string} */
     this.format = options.format || defaultOptions.format;
@@ -144,7 +144,7 @@ class WMTSLayer extends RasterLayer {
     return {
       ...super.getImplementationOptions(),
       layer: this.layer,
-      style: this.style,
+      style: this.wmtsStyle,
       format: this.format,
       tileMatrixSetID: this.tileMatrixSetID,
       tileSize: this.tileSize,
@@ -197,8 +197,8 @@ class WMTSLayer extends RasterLayer {
       config.layer = this.layer;
     }
 
-    if (this.style !== defaultOptions.style) {
-      config.style = this.style;
+    if (this.wmtsStyle !== defaultOptions.wmtsStyle) {
+      config.wmtsStyle = this.wmtsStyle;
     }
 
     if (this.format !== defaultOptions.format) {

package/src/util/featureconverter/pointToCesium.js

@@ -107,9 +107,13 @@ export function getLabelOptions(feature, style, heightReference, vectorPropertie
 
     options.heightReference = heightReference;
 
-    const offsetX = textStyle.getOffsetX() || 0;
-    const offsetY = textStyle.getOffsetY() || 0;
+    const offsetX = textStyle.getOffsetX() ?? 0;
+    const offsetY = textStyle.getOffsetY() ?? 0;
     options.pixelOffset = new Cartesian2(offsetX, offsetY);
+    const scale = textStyle.getScale();
+    if (scale) {
+      options.scale = Array.isArray(scale) ? scale[0] : scale;
+    }
 
     const font = textStyle.getFont();
     if (font) {
@@ -171,7 +175,6 @@ export function getLabelOptions(feature, style, heightReference, vectorPropertie
     options.verticalOrigin = verticalOrigin;
     options.eyeOffset = vectorProperties.getEyeOffset(feature);
     options.scaleByDistance = vectorProperties.getScaleByDistance(feature);
-
     return options;
   }
   return null;

package/src/util/layerCollection.js

@@ -5,6 +5,13 @@ import LayerState from '../layer/layerState.js';
 import VcsEvent from '../vcsEvent.js';
 import GlobalHider from '../layer/globalHider.js';
 
+/**
+ * The largest integer zindex which can be safely assigned to a layer (equal to Number.MAX_SAFE_INTEGER)
+ * You should use this to ensure layers are always rendered on top.
+ * @type {number}
+ */
+export const maxZIndex = Number.MAX_SAFE_INTEGER;
+
 /**
  * A collection of layers. Manages rendering order and layer exclusivity. Emits state changes for convenience. Passed to
  * {@link Map} for layers available to said map. Layers must have unique names.