jmapcloud-ng-types 1.0.6 → 1.0.8

package/index.ts

@@ -25,6 +25,8 @@ export interface JAppGeometryState {
   isUpdate: boolean
   wizardStep: JAPP_GEOMETRY_WIZARD_STEPS
   draw: JAppDrawState
+  lastSnap: JAppSnap
+  snap: JAppSnap
 }
 
 export interface JAppFeatureState {
@@ -75,6 +77,8 @@ export interface JAppMeasureState {
   isSelectionActive: boolean
   isNewElement: boolean
   draw: JAppDrawState
+  lastSnap: JAppSnap
+  snap: JAppSnap
 }
 
 export interface JAppDrawState {
@@ -91,6 +95,13 @@ export interface JAppAnnotationState {
   annotations: JAppAnnotation[]
   draw: JAppDrawState
   presetColors: string[]
+  lastSnap: JAppSnap
+  snap: JAppSnap
+}
+
+export interface JAppSnap {
+  layerId: JId | undefined
+  isEnabled: boolean
 }
 
 export interface JAppPrintState {
@@ -157,6 +168,8 @@ export interface JAppGeometryService {
   finishCreate(): void
   finishUpdate(): Promise<void>
   closePanel(): void
+  setSnapEnabled(isEnabled: boolean): void
+  setSnapLayerId(LayerId: JId): void
 }
 
 export interface JAppFeatureService {
@@ -187,6 +200,8 @@ export interface JAppAnnotationService {
   setDrawMode(drawMode: JAPP_DRAW_MODES): void
   getDrawType(): JAPP_DRAW_TYPES
   setDrawType(drawType: JAPP_DRAW_TYPES): void
+  setSnapEnabled(isEnabled: boolean): void
+  setSnapLayerId(LayerId: JId): void
   existsById(annotationId: string): boolean
   getById(annotationId: string): JAppAnnotation
   getAll(): JAppAnnotation[]
@@ -302,6 +317,8 @@ export interface JAppMeasureService {
   deleteAllCircles(): number
   setMeasurementSystem(measurementSystem: JAPP_MEASUREMENT_SYSTEMS): void
   getMeasurementSystem(): JAPP_MEASUREMENT_SYSTEMS
+  setSnapEnabled(isEnabled: boolean): void
+  setSnapLayerId(LayerId: JId): void
 }
 
 export interface JAppExtensionService {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-types",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
   "main": "src/app.ts",
   "scripts": {
@@ -23,7 +23,7 @@
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
   "devDependencies": {
     "@types/react": "18.2.21",
-    "jmapcloud-ng-core-types": "1.0.5",
+    "jmapcloud-ng-core-types": "1.0.7",
     "maplibre-gl": "^3.2.1",
     "react": "^18.2.0",
     "typedoc": "^0.24.8"

package/public/app.d.ts

@@ -365,6 +365,36 @@ declare namespace JMap {
        * ```
        */
       function getPresetColors(): string[]
+
+      /**
+       * **JMap.Application.Annotation.setSnapEnabled**
+       *
+       * Enables or disables snap mode.
+       *
+       * @param isEnabled true to enable snap mode, false to disable
+       * @throws if isEnabled is not a boolean
+       * @example ```ts
+       *
+       * // enable snap mode
+       * JMap.Application.Annotation.setSnapEnabled(true)
+       * ```
+       */
+      function setSnapEnabled(isEnabled: boolean): void
+
+      /**
+       * **JMap.Application.Annotation.setSnapLayerId**
+       *
+       * set the layer id to snap on.
+       *
+       * @param layerId the JMap layer id
+       * @throws if layer not found
+       * @example ```ts
+       *
+       * // snap will target the features of the layer having id="36885146-7eed-4071-9f86-8e29c505af91"
+       * JMap.Application.Annotation.setSnapLayerId("36885146-7eed-4071-9f86-8e29c505af91")
+       * ```
+       */
+      function setSnapLayerId(layerId: JId): void
     }
     /**
      * **JMap.Application.Panel**
@@ -676,6 +706,36 @@ declare namespace JMap {
        * ```
        */
       function closePanel(): void
+
+      /**
+       * **JMap.Application.Geometry.setSnapEnabled**
+       *
+       * Enables or disables snap mode.
+       *
+       * @param isEnabled true to enable snap mode, false to disable
+       * @throws if isEnabled is not a boolean
+       * @example ```ts
+       *
+       * // enable snap mode
+       * JMap.Application.Geometry.setSnapEnabled(true)
+       * ```
+       */
+      function setSnapEnabled(isEnabled: boolean): void
+
+      /**
+       * **JMap.Application.Geometry.setSnapLayerId**
+       *
+       * set the layer id to snap on.
+       *
+       * @param layerId the JMap layer id
+       * @throws if layer not found
+       * @example ```ts
+       *
+       * // snap will target the features of the layer having id="36885146-7eed-4071-9f86-8e29c505af91"
+       * JMap.Application.Geometry.setSnapLayerId("36885146-7eed-4071-9f86-8e29c505af91")
+       * ```
+       */
+      function setSnapLayerId(layerId: JId): void
     }
 
     /**
@@ -972,6 +1032,36 @@ declare namespace JMap {
        * ```
        */
       function setMeasurementSystem(measurementSystem: JAPP_MEASUREMENT_SYSTEMS): void
+
+      /**
+       * **JMap.Application.Measure.setSnapEnabled**
+       *
+       * Enables or disables snap mode.
+       *
+       * @param isEnabled true to enable snap mode, false to disable
+       * @throws if isEnabled is not a boolean
+       * @example ```ts
+       *
+       * // enable snap mode
+       * JMap.Application.Measure.setSnapEnabled(true)
+       * ```
+       */
+      function setSnapEnabled(isEnabled: boolean): void
+
+      /**
+       * **JMap.Application.Measure.setSnapLayerId**
+       *
+       * set the layer id to snap on.
+       *
+       * @param layerId the JMap layer id
+       * @throws if layer not found
+       * @example ```ts
+       *
+       * // snap will target the features of the layer having id="36885146-7eed-4071-9f86-8e29c505af91"
+       * JMap.Application.Measure.setSnapLayerId("36885146-7eed-4071-9f86-8e29c505af91")
+       * ```
+       */
+      function setSnapLayerId(layerId: JId): void
     }
 
     /**