Merge 45854cb into 1da9f2e

ts/consts.ts

@@ -2,12 +2,39 @@
 
 import { PathOptions } from 'leaflet';
 
+/**
+ * Base64 data-url for a transparent 1px png image
+ */
 export const TRANSPARENT_PIXEL: string = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=';
+/**
+ * Default value for delays caused by animations (in milliseconds)
+ */
 export const ANIMATION_DELAY: number = 50;
+/**
+ * Some lorem ipsum test content
+ */
 export const EXAMPLE_CONTENT: string = 'Vel ipsum odit quia velit omnis illo voluptatem ut. Aperiam porro voluptates maiores.';
+/**
+ * URL-schema of the official osm tile-server
+ */
 export const OSM_TILE_LAYER_URL: string = 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png';
-export const IMAGE_OVERLAY_URL: string = 'http://live.osgeo.org/_images/osgeolive_menu6.png';
+/**
+ * URL for an example image for image-overlays
+ */
+export const IMAGE_OVERLAY_URL: string = 'http://download.osgeo.org/livedvd/10.0/desktop10_osmF32.png';
+/**
+ * Base URL for a sample WMS service
+ */
 export const EXAMPLE_WMS_LAYER_URL: string = 'http://www.wms.nrw.de/geobasis/wms_nw_dtk?';
+/**
+ * Layers of the example WMS service
+ */
 export const EXAMPLE_WMS_LAYER_NAMES: string[] = ['nw_dtk_col'];
+/**
+ * Default attribution prefix
+ */
 export const ATTRIBUTION_PREFIX: string = '<a href="https://yagajs.org" title="YAGA">YAGA</a> | <a href="https://leaflet-ng2.yagajs.org" title="Leaflet in Angular2">leaflet-ng2</a>';
+/**
+ * Empty default style
+ */
 export const DEFAULT_STYLE: PathOptions = {};

ts/layer-group.provider.ts

@@ -1,6 +1,10 @@
 import { Injectable } from '@angular/core';
 import { LayerGroup, Map } from 'leaflet';
 
+/**
+ * Injectable Angular provider to structure Leaflet layer-groups with Angulars DI
+ * @link http://leafletjs.com/reference-1.2.0.html#layer-group
+ */
 @Injectable()
 export class LayerGroupProvider {
     public ref: Map | LayerGroup;

ts/layer.provider.ts

@@ -1,6 +1,10 @@
 import { Injectable } from '@angular/core';
 import { Layer } from 'leaflet';
 
+/**
+ * Injectable Angular provider to structure Leaflet layers with Angulars DI
+ * @link http://leafletjs.com/reference-1.2.0.html#layer
+ */
 @Injectable()
 export class LayerProvider {
     public ref: Layer;

ts/layers-control.provider.ts

@@ -1,6 +1,10 @@
 import { Injectable } from '@angular/core';
 import { Control } from 'leaflet';
 
+/**
+ * Injectable Angular provider to reference to Leaflets layer-control
+ * @link http://leafletjs.com/reference-1.2.0.html#layer
+ */
 @Injectable()
 export class LayersControlProvider {
     public ref: Control.Layers;

ts/map.provider.ts

@@ -1,6 +1,10 @@
 import { Injectable } from '@angular/core';
 import { Map } from 'leaflet';
 
+/**
+ * Injectable Angular provider to reference to Leaflets map
+ * @link http://leafletjs.com/reference-1.2.0.html#map
+ */
 @Injectable()
 export class MapProvider {
     public ref: Map;

ts/marker.provider.ts

@@ -1,6 +1,10 @@
 import { Injectable } from '@angular/core';
 import { Marker } from 'leaflet';
 
+/**
+ * Injectable Angular provider for Leaflet icons to apply to them with Angular DI
+ * @link http://leafletjs.com/reference-1.2.0.html#marker
+ */
 @Injectable()
 export class MarkerProvider {
     public ref: Marker;

ts/mouse-event-helper.ts

@@ -1,11 +1,15 @@
 import { LeafletMouseEvent, Map} from 'leaflet';
 
+/**
+ * Helper function to enhance browser mouse events to Leaflet mouse events
+ * @private
+ */
 export function enhanceMouseEvent(originalEvent: MouseEvent, map: Map): LeafletMouseEvent {
     return {
+        ...originalEvent,
         containerPoint: map.mouseEventToContainerPoint(originalEvent),
         latlng: map.mouseEventToLatLng(originalEvent),
         layerPoint: map.mouseEventToLayerPoint(originalEvent),
-        ...originalEvent,
         originalEvent,
     } as any;
 }

ts/path-directives.spec.ts

@@ -11,6 +11,10 @@ import {
 } from './index';
 import { randomNumber } from './spec';
 
+/**
+ * Basic test for all path layers
+ * @private
+ */
 export function createPathTests(Constr: any): void {
     describe('Path compatibility tests', () => {
         let map: MapComponent;

ts/spec.ts

@@ -1,24 +1,44 @@
 import { LatLng, LatLngBounds } from 'leaflet';
 
+/**
+ * Helper function to create random numbers within a range
+ * @private
+ */
 export function randomNumber(max: number = 1, min: number = 0, after: number = 3) {
     return (
         Math.floor(
             Math.random() * (Math.abs(max) + Math.abs(min)) * Math.pow(10, after),
         ) / Math.pow(10, after)) + min;
 }
 
+/**
+ * Helper function to create random latitude values
+ * @private
+ */
 export function randomLat() {
     return randomNumber(90, -90);
 }
 
+/**
+ * Helper function to create random longitude values
+ * @private
+ */
 export function randomLng() {
     return randomNumber(180, -180);
 }
 
+/**
+ * Helper function to create random latitude-longitude values pairs
+ * @private
+ */
 export function randomLatLng(): LatLng {
     return new LatLng(randomLat(), randomLng());
 }
 
+/**
+ * Helper function to create random spatial bounds
+ * @private
+ */
 export function randomLatLngBounds(): LatLngBounds {
     const lat1: number = randomLat();
     const lat2: number = randomLat();
@@ -30,6 +50,10 @@ export function randomLatLngBounds(): LatLngBounds {
     );
 }
 
+/**
+ * Helper function to detect if an element is a child of another
+ * @private
+ */
 export function hasAsChild(root: HTMLElement, child: HTMLElement): boolean {
     const length: number = root.children.length;
     for (let i: number = 0; i < length; i += 1) {