Merge pull request #30 from weareinlog/dev

(polyline): add some new features

Author: caroph

DOCUMENTATION.md

@@ -1,4 +1,4 @@
-# [@inlog/inlog-maps](https://github.com/weareinlog/inlog-maps#readme) *4.2.7*
+# [@inlog/inlog-maps](https://github.com/weareinlog/inlog-maps#readme) *4.3.0*
 
 > A library for using generic layer maps 
 
@@ -1089,6 +1089,30 @@ Use this function to add more paths to a polyline
 
 
 
+#### Map.getPolylinePath(type, condition) 
+
+Use this function to get the path of some polyline
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| type | `string`  |  |   |
+| condition | `any`  |  |   |
+
+
+
+
+##### Returns
+
+
+- `Array.<number>`  
+
+
+
 #### Map.removePolylineHighlight() 
 
 Use this function to clear polyline selected from the currentMap
@@ -1174,6 +1198,54 @@ Use this function to set position of polyline highlight
 
 
 
+##### Returns
+
+
+- `Void`
+
+
+
+#### Map.getObjectPolyline(type, condition) 
+
+
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| type | `string`  |  |   |
+| condition | `any`  |  |   |
+
+
+
+
+##### Returns
+
+
+- `object`  
+
+
+
+#### Map.addPolylineHighlightEvent(event, eventFunction) 
+
+Use this function to add events on polyline highligth / selected polyline
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| event | `InlogMaps.PolylineEventType`  |  |   |
+| eventFunction | `any`  |  |   |
+
+
+
+
 ##### Returns
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inlog/inlog-maps",
-  "version": "4.2.7",
+  "version": "4.3.0",
   "description": "A library for using generic layer maps ",
   "main": "index.js",
   "types": "dist/index.d.ts",

src/map.ts

@@ -30,8 +30,8 @@ export default class Map {
 
     /**
      * Use this to initialize map
-     * @param {InlogMaps.MapType} mapType  
-     * @param {any} options 
+     * @param {InlogMaps.MapType} mapType
+     * @param {any} options
      * @param {string} elementId default: 'inlog-map' [nullable]
      * @returns {Promisse<any>}
      */
@@ -199,7 +199,7 @@ export default class Map {
 
     /**
      * This functions returns if marker exists
-     * @param type 
+     * @param type
      * @param condition [nullable]
      * @returns {boolean}
      */
@@ -210,9 +210,9 @@ export default class Map {
 
     /**
      * Use this function to count markers by type
-     * @param {string} type 
+     * @param {string} type
      * @param {boolean} onlyOnMap exclude hidden markers, default true
-     * @param {any} condition 
+     * @param {any} condition
      * @returns {number}
      */
     public countMarkers(type: string, onlyOnMap: boolean = true, condition?: any): number {
@@ -230,9 +230,9 @@ export default class Map {
 
     /**
      * This function add new events on marker
-     * @param {string} type 
-     * @param {InlogMaps.MarkerEventType} event 
-     * @param {any} eventFunction 
+     * @param {string} type
+     * @param {InlogMaps.MarkerEventType} event
+     * @param {any} eventFunction
      * @param {any} condition [nullable]
      */
     public addMarkerEvent(type: string, event: MarkerEventType, eventFunction: any, condition?: any): void {
@@ -243,8 +243,8 @@ export default class Map {
 
     /**
      * This function remove events of marker
-     * @param {string} type 
-     * @param {InlogMaps.MarkerEventType} event 
+     * @param {string} type
+     * @param {InlogMaps.MarkerEventType} event
      * @param {any} condition [nullable]
      */
     public removeMarkerEvent(type: string, event: MarkerEventType, condition?: any): void {
@@ -257,7 +257,7 @@ export default class Map {
     /**
      * Use this function to add MarkerClusterer on the map
      * @param {string} type same type of markers
-     * @param {InlogMaps.MarkerClusterConfig} config 
+     * @param {InlogMaps.MarkerClusterConfig} config
      */
     public addMarkerClusterer(type: string, config: MarkerClustererConfig): void {
         this.markerClusterer[type] = this.map.addMarkerClusterer(config);
@@ -266,7 +266,7 @@ export default class Map {
     /**
      * Use this function to alter clusterer options
      * @param type same type of markers
-     * @param {InlogMaps.MarkerClusterConfig} config 
+     * @param {InlogMaps.MarkerClusterConfig} config
      */
     public alterMarkerClustererConfig(type: string, config: MarkerClustererConfig): void {
         if (this.markerClusterer[type]) {
@@ -394,7 +394,7 @@ export default class Map {
 
     /**
      * This functions returns if polygon exists
-     * @param type 
+     * @param type
      * @param condition [nullable]
      * @returns {boolean}
      */
@@ -405,9 +405,9 @@ export default class Map {
 
     /**
      * This function add new events on polygon
-     * @param {string} type 
-     * @param {InlogMaps.PolygonEventType} event 
-     * @param {any} eventFunction 
+     * @param {string} type
+     * @param {InlogMaps.PolygonEventType} event
+     * @param {any} eventFunction
      * @param {any} condition [nullable]
      */
     public addPolygonEvent(type: string, event: PolygonEventType, eventFunction: any, condition?: any): void {
@@ -418,8 +418,8 @@ export default class Map {
 
     /**
      * This function remove events of polygon
-     * @param {string} type 
-     * @param {InlogMaps.PolygonEventType} event 
+     * @param {string} type
+     * @param {InlogMaps.PolygonEventType} event
      * @param {any} condition [nullable]
      */
     public removePolygonEvent(type: string, event: PolygonEventType, condition?: any): void {
@@ -514,7 +514,7 @@ export default class Map {
 
     /**
      * This functions returns if circle exists
-     * @param {string} type 
+     * @param {string} type
      * @param {any} condition [nullable]
      * @returns {boolean}
      */
@@ -525,7 +525,7 @@ export default class Map {
 
     /**
      * This function return circle center
-     * @param {string} type 
+     * @param {string} type
      * @param {any} condition [nullable]
      * @returns {number[]}
      */
@@ -541,9 +541,9 @@ export default class Map {
 
     /**
      * This function add new events on circle
-     * @param {string} type 
-     * @param {InlogMaps.CircleEventType} event 
-     * @param {any} eventFunction 
+     * @param {string} type
+     * @param {InlogMaps.CircleEventType} event
+     * @param {any} eventFunction
      * @param {any} condition [nullable]
      */
     public addCircleEvent(type: string, event: CircleEventType, eventFunction: any, condition?: any): void {
@@ -554,8 +554,8 @@ export default class Map {
 
     /**
      * This function remove events of circle
-     * @param {string} type 
-     * @param {InlogMaps.CircleEventType} event 
+     * @param {string} type
+     * @param {InlogMaps.CircleEventType} event
      * @param {any} condition [nullable]
      */
     public removeCircleEvent(type: string, event: CircleEventType, condition?: any): void {
@@ -610,7 +610,7 @@ export default class Map {
 
     /**
      * Use this function to remove polylines
-     * @param {string} type 
+     * @param {string} type
      * @param {any} condition remove polyline with the condition [nullable]
      */
     public removePolylines(type: string, condition?: any): void {
@@ -637,7 +637,7 @@ export default class Map {
     /**
      * Use this function to alter polyline options
      * @param {string} type
-     * @param {InlogMaps.PolylineOptions} options 
+     * @param {InlogMaps.PolylineOptions} options
      * @param {any} condition alter polyline with the condition [nullable]
      */
     public alterPolylineOptions(type: string, options: PolylineOptions, condition?: any): void {
@@ -692,6 +692,20 @@ export default class Map {
         }
     }
 
+    /**
+     * Use this function to get the path of some polyline
+     * @param {string} type
+     * @param {any} condition
+     * @returns {number[]}
+     */
+    public getPolylinePath(type: string, condition?: any): number[] {
+        const polyline = this.getPolylines(type, condition);
+
+        if (polyline && polyline.length) {
+            return this.map.getPolylinePath(polyline[0]);
+        }
+    }
+
     /**
      * Use this function to clear polyline selected from the currentMap
      */
@@ -701,9 +715,9 @@ export default class Map {
 
     /**
      * Use this function to add listeners on polyline
-     * @param {string} type 
-     * @param {InlogMaps.PolylineEventType} event 
-     * @param {any} eventFunction 
+     * @param {string} type
+     * @param {InlogMaps.PolylineEventType} event
+     * @param {any} eventFunction
      * @param {any} condition [nullable]
      */
     public addPolylineEvent(type: string, event: PolylineEventType, eventFunction: any, condition?: any): void {
@@ -714,8 +728,8 @@ export default class Map {
 
     /**
      * Use this function to remove listeners of polyline
-     * @param {string} type 
-     * @param {InlogMaps.PolylineEventType} event 
+     * @param {string} type
+     * @param {InlogMaps.PolylineEventType} event
      * @param {any} condition [nullable]
      */
     public removePolylineEvent(type: string, event: PolylineEventType, condition?: any): void {
@@ -726,8 +740,8 @@ export default class Map {
 
     /**
      * Use this function to set position of polyline highlight
-     * @param {string} type 
-     * @param {number} initialIndex 
+     * @param {string} type
+     * @param {number} initialIndex
      * @param {any} condition [nullable]
      */
     public setIndexPolylineHighlight(type: string, initialIndex: number, condition?: any) {
@@ -738,6 +752,31 @@ export default class Map {
         }
     }
 
+    /**
+     *
+     * @param {string} type
+     * @param {any} condition
+     * @returns {object}
+     */
+    public getObjectPolyline(type: string, condition?: any): object {
+        const polylines = this.getPolylines(type, condition);
+
+        if (polylines && polylines.length) {
+            return this.map.getObjectPolyline(polylines[0]);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Use this function to add events on polyline highligth / selected polyline
+     * @param {InlogMaps.PolylineEventType} event
+     * @param {any} eventFunction
+     */
+    public addPolylineHighlightEvent(event: PolylineEventType, eventFunction: any) {
+        this.map.addPolylineHighlightEvent(event, eventFunction);
+    }
+
     /* Info Windows */
     /**
      * Use this function to draw popups on the currentMap
@@ -780,8 +819,8 @@ export default class Map {
     }
 
     /**
-     * 
-     * @param {string} type 
+     *
+     * @param {string} type
      * @returns {object}
      */
     public getObjectOpenPopup(type: string): object {
@@ -867,8 +906,8 @@ export default class Map {
 
     /**
      * Returns the coordinates from pixels
-     * @param {number} offsetx 
-     * @param {number} offsety 
+     * @param {number} offsetx
+     * @param {number} offsety
      * @returns {number[]}
      */
     public pixelsToLatLng(offsetx: number, offsety: number): number[] {