Fix event listener types for Annotation and Overlay (#2)

* fix addEventListener types of mapkit.Annotation * simplify AnnotationEvent type * fix listner types for mapkit.Overlay * update mapkit.Map select/deselect event * rename type for clarity
wsmd · Feb 22, 2019 · a3d0c50 · a3d0c50
1 parent 8ea6c25
commit a3d0c50
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 21 deletions.
diff --git a/mapkit/mapkit.Annotation.d.ts b/mapkit/mapkit.Annotation.d.ts
@@ -30,9 +30,9 @@ declare namespace mapkit {
      * @param thisObject An object to be set as the this keyword on the
      * listener function.
      */
-    addEventListener<K extends keyof AnnotationEvents<this>>(
-      type: K,
-      listener: () => void,
+    addEventListener(
+      type: AnnotationEventType,
+      listener: (event: EventBase<Map>) => void,
       thisObject?: object,
     ): void;
     /**
@@ -44,9 +44,9 @@ declare namespace mapkit {
      * @param thisObject An object to be set as the this keyword on the listener
      * function.
      */
-    removeEventListener<K extends keyof AnnotationEvents<this>>(
-      type: K,
-      listener: () => void,
+    removeEventListener(
+      type: AnnotationEventType,
+      listener: (event: EventBase<Map>) => void,
       thisObject?: object,
     ): void;
     /**
@@ -381,11 +381,10 @@ declare namespace mapkit {
   }
 
   // prettier-ignore
-  interface AnnotationEvents<T> {
-    'select': EventBase<T> & { annotation: Annotation; overlay: Overlay };
-    'deselect': EventBase<T> & { annotation: Annotation; overlay: Overlay };
-    'drag-start': EventBase<T> & { annotation: Annotation };
-    'dragging': EventBase<T> & { annotation: Annotation; coordinate: Coordinate };
-    'drag-end': EventBase<T> & { annotation: Annotation };
-  }
+  type AnnotationEventType =
+    | 'select'
+    | 'deselect'
+    | 'drag-start'
+    | 'dragging'
+    | 'drag-end';
 }
diff --git a/mapkit/mapkit.Map.d.ts b/mapkit/mapkit.Map.d.ts
@@ -462,19 +462,28 @@ declare namespace mapkit {
     target: T;
   }
 
-  interface UserLocationEvents<T> {
-    'user-location-change': EventBase<T> & { coordinate: Coordinate; timestamp: Date };
-    'user-location-error': EventBase<T> & { code: number; message: string };
-  }
-
-  interface MapEvents<T> extends AnnotationEvents<T>, UserLocationEvents<T> {
+  // prettier-ignore
+  interface MapEvents<T> {
     'region-change-start': EventBase<T>;
     'region-change-end': EventBase<T>;
     'scroll-start': EventBase<T>;
     'scroll-end': EventBase<T>;
     'zoom-start': EventBase<T>;
     'zoom-end': EventBase<T>;
     'map-type-change': EventBase<T>;
+
+    // Annotation Events
+
+    'select': EventBase<T> & { annotation?: Annotation; overlay?: Overlay };
+    'deselect': EventBase<T> & { annotation?: Annotation; overlay?: Overlay };
+    'drag-start': EventBase<T> & { annotation: Annotation };
+    'dragging': EventBase<T> & { annotation: Annotation; coordinate: Coordinate };
+    'drag-end': EventBase<T> & { annotation: Annotation };
+
+    // User Location Events
+
+    'user-location-change': EventBase<T> & { coordinate: Coordinate; timestamp: Date };
+    'user-location-error': EventBase<T> & { code: number; message: string };
   }
 
   /**

diff --git a/mapkit/mapkit.Overlay.d.ts b/mapkit/mapkit.Overlay.d.ts
@@ -10,11 +10,19 @@ declare namespace mapkit {
     /**
      * Starts listening for the specified type of event.
      */
-    addEventListener(type: string, listener: () => {}, thisObject?: object): void;
+    addEventListener(
+      type: OverlayEventType,
+      listener: (event: EventBase<this>) => void,
+      thisObject?: object,
+    ): void;
     /**
      * Stops listening for the specified type of event.
      */
-    addEventListener(type: string, listener: () => {}, thisObject?: object): void;
+    removeEventListener(
+      type: OverlayEventType,
+      listener: (event: EventBase<this>) => void,
+      thisObject?: object,
+    ): void;
     /**
      * Custom data to associate with this overlay.
      */
@@ -129,4 +137,6 @@ declare namespace mapkit {
   interface StylesOverlayOptions extends OverlayOptions {
     style?: mapkit.Style;
   }
+
+  type OverlayEventType = 'select' | 'deselect';
 }
diff --git a/test/mapkit-test.ts b/test/mapkit-test.ts
@@ -13,6 +13,16 @@ mapkit.addEventListener('configuration-change', event => {
 
 const map = new mapkit.Map(document.createElement('div'));
 
+map.addEventListener('select', event => {
+  const annotations: mapkit.Annotation[] = event.target.annotations;
+  if (event.annotation) {
+    const annotation: mapkit.Annotation = event.annotation;
+  }
+  if (event.overlay) {
+    const overlay: mapkit.Overlay = event.overlay;
+  }
+});
+
 mapkit.removeEventListener('configuration-change', () => {});
 
 const annotation = new mapkit.ImageAnnotation(new mapkit.Coordinate(1, 1), {
@@ -201,6 +211,26 @@ people.forEach(function(person) {
     data: { role: person.role, building: person.building },
   };
   var annotation = new mapkit.Annotation(person.coordinate, factory, options);
+  annotation.addEventListener('deselect', event => {
+    let map: mapkit.Map = event.target;
+    let type: string = event.type;
+  });
+  annotation.addEventListener('select', event => {
+    let map: mapkit.Map = event.target;
+    let type: string = event.type;
+  });
+  annotation.addEventListener('dragging', event => {
+    let map: mapkit.Map = event.target;
+    let type: string = event.type;
+  });
+  annotation.addEventListener('drag-end', event => {
+    let map: mapkit.Map = event.target;
+    let type: string = event.type;
+  });
+  annotation.addEventListener('drag-start', event => {
+    let map: mapkit.Map = event.target;
+    let type: string = event.type;
+  });
   map.addAnnotation(annotation);
 });
 
@@ -229,3 +259,9 @@ new mapkit.MarkerAnnotation(new mapkit.Coordinate(40.6892, -74.0445), {
   subtitle: 'Subtitle',
   callout: calloutDelegate,
 });
+
+const overlay = new mapkit.CircleOverlay(coordinate, 1000);
+
+overlay.addEventListener('select', event => {
+  let radius: number = event.target.radius;
+});