jmapcloud-ng-types 1.1.0 → 1.1.2

package/index.ts

@@ -276,6 +276,7 @@ export interface JApplicationUIService {
 export interface JAppEventService {
   Main: JAppAppEventModule
   Layer: JAppLayerEventModule
+  Measure: JAppMeasureEventModule
   UI: JAppUIEventModule
   Extension: JAppExtensionEventModule
   MapContext: JAppMapContextEventModule
@@ -432,6 +433,12 @@ export interface JAppLayerEventModule extends JEventModule {
   }
 }
 
+export interface JAppMeasureEventModule extends JEventModule {
+  on: {
+    creation(listenerId: string, fn: (params: JAppMeasureCreationEventParams) => void): void
+  }
+}
+
 export interface JAppExtensionEventModule extends JEventModule {
   on: {
     registration(listenerId: string, fn: (params: JAppExtensionEventParams) => void): void

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "jmapcloud-ng-types",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
   "main": "src/app.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "pub": "export NODE_ENV='production'; node build/buildfile.js publish;",
-    "copy": "export NODE_ENV='production'; node build/buildfile.js copy;",
-    "commit-doc": "export NODE_ENV='production'; node build/buildfile.js commit-doc;",
-    "doc-test": "export DOC_DIR='./docs/latest'; node build/buildfile.js doc-test;",
-    "copy-latest": "node build/buildfile.js copy-latest;"
+    "pub-github": "node build/buildfile.js publish-github;",
+    "doc-test": "node build/buildfile.js doc-test;"
   },
   "repository": {
     "type": "git",

package/public/app.d.ts

@@ -2812,6 +2812,92 @@ declare namespace JMap {
         function remove(listenerId: string): void
       }
 
+      /**
+       * ***JMap.Application.Event.Measure***
+       *
+       * Here you can manage all JMap Cloud NG measure event listeners.
+       *
+       * Click to see all events available: ***{@link JMap.Application.Event.Measure.on}***.
+       */
+      namespace Measure {
+        /**
+         * ***JMap.Application.Event.Measure.on***
+         *
+         * Here you have all JMap Cloud NG available measure events on which you can attach a listener.
+         */
+        namespace on {
+          /**
+           * **JMap.Application.Measure.on.creation**
+           *
+           * This event is triggered when a measure is created
+           *
+           * @example
+           * ```ts
+           * // log a message in the console when a measure is created
+           * JMap.Application.Event.Measure.on.creation(
+           *   "custom-measure-created",
+           *   params => console.log(`The measure id "${params.measure.id}" has been created`)
+           * )
+           * ```
+           */
+          function creation(listenerId: string, fn: (params: JAppMeasureCreationEventParams) => void): void
+        }
+
+        /**
+         * ***JMap.Application.Event.Measure.activate***
+         *
+         * Activates the listener.
+         *
+         * If the listener is already active, does nothing.
+         *
+         * If the listener is inactive, it will be reactivated and will be called again ...
+         *
+         * @param listenerId The listener id
+         * @example
+         * ```ts
+         * // activate the listener "my-measure-listener"
+         * JMap.Application.Event.Measure.activate("my-measure-listener")
+         * ```
+         */
+        function activate(listenerId: string): void
+
+        /**
+         * ***JMap.Application.Event.Measure.deactivate***
+         *
+         * Deactivates the listener.
+         *
+         * If the listener id doesn't exist or if the listener is already inactive, does nothing.
+         *
+         * If the listener is active, it will be deactivated and will be ignored ...
+         *
+         * @param listenerId The listener id
+         * @example
+         * ```ts
+         * // deactivate the listener "my-measure-listener"
+         * JMap.Application.Event.Measure.deactivate("my-measure-listener")
+         * ```
+         */
+        function deactivate(listenerId: string): void
+
+        /**
+         * ***JMap.Application.Event.Measure.remove***
+         *
+         * Removes the listener.
+         *
+         * If the listener doesn't exist, does nothing.
+         *
+         * Removes the listener from JMap Cloud NG. The listener is deleted and never called again after that.
+         *
+         * @param listenerId The listener id
+         * @example
+         * ```ts
+         * // remove the listener "my-measure-listener"
+         * JMap.Application.Event.Measure.remove("my-measure-listener")
+         * ```
+         */
+        function remove(listenerId: string): void
+      }
+
       /**
        * ***JMap.Application.Event.UI***
        *

package/public/measure.d.ts

@@ -23,3 +23,7 @@ declare interface JAppMeasure {
   area: number
   radius: number
 }
+
+declare interface JAppMeasureCreationEventParams {
+  measure: JAppMeasure
+}