From 79d8837b1f4982e69b9c2f4ff893261f700b5304 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20S=C3=A1nchez=20Ortega?= Date: Mon, 26 Sep 2016 15:21:40 +0200 Subject: [PATCH] Version bump to 1.0.0; update 1.0.0 docs based on leafdoc (#4940) --- docs/reference-1.0.0.html | 324 +++++++++++++++++++++++++++++++------- package.json | 2 +- 2 files changed, 269 insertions(+), 57 deletions(-) diff --git a/docs/reference-1.0.0.html b/docs/reference-1.0.0.html index 9ca721c6..ee91124f 100644 --- a/docs/reference-1.0.0.html +++ b/docs/reference-1.0.0.html @@ -6,7 +6,7 @@ bodyclass: api-page

API Reference

-

This reference reflects Leaflet 1.0.0-rc3.

+

This reference reflects Leaflet 1.0.0.

Docs for 0.7 are available here. @@ -693,13 +693,13 @@ for the first time). zoom Event - Fired repeteadly during any change in zoom level, including zoom + Fired repeatedly during any change in zoom level, including zoom and fly animations. move Event - Fired repeteadly during any movement of the map, including pan and + Fired repeatedly during any movement of the map, including pan and fly animations. @@ -825,7 +825,7 @@ for a second (also called long press). keypress - Event + KeyboardEvent Fired when the user presses a key from the keyboard while the map is focused. @@ -1125,7 +1125,7 @@ pan by default.

- flyTo(<LatLng> latlng, <Number> zoom?, <Zoom/Pan options> options?) + flyTo(<LatLng> latlng, <Number> zoom?, <Zoom/pan options> options?) this

Sets the view of the map (geographical center and zoom) performing a smooth pan-zoom animation.

@@ -2109,7 +2109,7 @@ panning inertia). icon Icon * - Icon class to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. Set to new L.Icon.Default() by default. + Icon class to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. If not specified, a new L.Icon.Default is used. draggable @@ -2929,6 +2929,12 @@ off of the screen while it is open. the popup closing when user clicks the map (set globally by the Map's closePopupOnClick option). + + className + String + '' + A custom CSS class name to assign to the popup. + @@ -2957,19 +2963,6 @@ the Map's closePopupOnClick option).The offset of the popup position. Useful to control the anchor of the popup when opening it on some overlays. - - zoomAnimation - Boolean - true - Whether to animate the popup on zoom. Disable it if you have -problems with Flash content inside popups. - - - className - String - '' - A custom CSS class name to assign to the popup. - pane String @@ -3600,13 +3593,6 @@ position on the map. Description - - zoomAnimation - Boolean - true - Whether to animate the popup on zoom. Disable it if you have -problems with Flash content inside popups. - className String @@ -4237,7 +4223,8 @@ from maxNativeZoom level and auto-scaled. Boolean false Whether the layer is wrapped around the antimeridian. If true, the -GridLayer will only be displayed once at low zoom levels. +GridLayer will only be displayed once at low zoom levels. Has no +effect when the map CRS doesn't wrap around. pane @@ -4504,7 +4491,7 @@ Classes extending TileLayer can override t getContainer() - String + HTMLElement

Returns the HTML element that contains the tiles for this layer.

@@ -5117,7 +5104,8 @@ from maxNativeZoom level and auto-scaled. Boolean false Whether the layer is wrapped around the antimeridian. If true, the -GridLayer will only be displayed once at low zoom levels. +GridLayer will only be displayed once at low zoom levels. Has no +effect when the map CRS doesn't wrap around. pane @@ -5389,7 +5377,7 @@ callback is called when the tile has been loaded.

getContainer() - String + HTMLElement

Returns the HTML element that contains the tiles for this layer.

@@ -6028,7 +6016,7 @@ for a second (also called long press). - setOpacity() + setOpacity(<Number> opacity) this

Sets the opacity of the overlay.

@@ -11303,6 +11291,33 @@ e.g. 0.1 would be 10% of map view in each direction +
+ +
+
+ + + + + + + + + + + + + + + +
EventDataDescription
update + EventFired when the renderer updates its bounds, center and zoom, for example when +its map has moved
+ +
+
+
+
@@ -11866,6 +11881,33 @@ e.g. 0.1 would be 10% of map view in each direction +
+ +
+
+ + + + + + + + + + + + + + + +
EventDataDescription
update + EventFired when the renderer updates its bounds, center and zoom, for example when +its map has moved
+ +
+
+
+
@@ -12854,7 +12896,14 @@ properties. The event might can optionally be propagated to event parents.

-

FeatureGroup

Extended LayerGroup that also has mouse events (propagated from members of the group) and a shared bindPopup method.

+

FeatureGroup

Extended LayerGroup that makes it easier to do the same thing to all its member layers:

+
    +
  • bindPopup binds a popup to all of the layers at once (likewise with bindTooltip)
    • +
  • Events are propagated to the FeatureGroup, so if the group has an event +handler, it will handle events from any of the layers. This includes mouse events +and custom events.
    • +
  • Has layeradd and layerremove events
    • +

Usage example

@@ -12867,7 +12916,7 @@ properties. The event might can optionally be propagated to event parents.

L.featureGroup([marker1, marker2, polyline])
     .bindPopup('Hello world!')
-    .on('click', function() { alert('Clicked on a group!'); })
+    .on('click', function() { alert('Clicked on a member of the group!'); })
     .addTo(map);
@@ -12934,11 +12983,35 @@ properties. The event might can optionally be propagated to event parents.

-

Events

+

Events

+ +
+ + + + + + + + + + + + + + + +
EventDataDescription
layeradd + LayerEventFired when a layer is added to this FeatureGroup
layerremove + LayerEventFired when a layer is removed from this FeatureGroup
+ +
+ +
@@ -13493,7 +13566,7 @@ GeoJSON data and display it on the map. Extends Fe -
L.geoJson(data, {
+
L.geoJSON(data, {
     style: function (feature) {
         return {color: feature.properties.color};
     }
@@ -13639,6 +13712,37 @@ The default is the coordsToLatLng static method.
 
 
 
+

+	FeatureGroup
+	

+		

+
+
+
+
+
+	
+		
+		
+		
+	
+	
+	
+		
+		
+	
+	
+		
+		
+	
+
EventDataDescription
layeradd
+		LayerEventFired when a layer is added to this FeatureGroup
layerremove
+		LayerEventFired when a layer is removed from this FeatureGroup

+
+

+	

+

+
 

 	
 	

@@ -14425,7 +14529,8 @@ GridLayer can be extended to create a tiled grid of HTML elements like <
 		Boolean
 		false
 		Whether the layer is wrapped around the antimeridian. If true, the
-GridLayer will only be displayed once at low zoom levels.
+GridLayer will only be displayed once at low zoom levels. Has no
+effect when the map CRS doesn't wrap around.
 	
 	
 		pane
@@ -14628,7 +14733,7 @@ GridLayer will only be displayed once at low zoom levels.
 	
 	
 		getContainer()
-		String
+		HTMLElement
 		
Returns the HTML element that contains the tiles for this layer.

 
 	
@@ -15664,7 +15769,7 @@ overlap if their intersection is an area.

 });
 L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
 

-
L.Icon.Default extends L.Icon and is the blue icon Leaflet uses for markers by default.

+
L.Icon.Default extends L.Icon and is the blue icon Leaflet uses for markers by default.

 
 
 
@@ -16245,6 +16350,42 @@ properties. The event might can optionally be propagated to event parents.
+
+ +
+

Icon.Default

+ +
+ + + +
A trivial subclass of Icon, represents the icon to use in Markers when +no icon is specified. Points to the blue marker image distributed with Leaflet +releases. +In order to change the default icon, just change the properties of L.Icon.Default.prototype.options +(which is a set of Icon options).
+ + + + + + + + + + + + + + +
OptionTypeDefaultDescription
imagePathString + L.Icon.Default will try to auto-detect the absolute location of the +blue icon images. If you are placing these images in a non-standard +way, set this option to point to the right absolute path.
+ +
+ +

DivIcon

Represents a lightweight icon for markers that uses a simple <div> element instead of an image. Inherits from Icon but ignores the iconUrl and shadow options.

@@ -20567,18 +20708,18 @@ pixel coordinates for a particular zoom. For example, it returns zoom(<Number> scale) Number -

Inverse of scale(), returns the zoom level correspondingto a scale +

Inverse of scale(), returns the zoom level corresponding to a scale factor of scale.

- getProjectedBounds(zoom) + getProjectedBounds(<Number> zoom) Bounds

Returns the projection's bounds scaled and transformed for the provided zoom.

- distance(<LatLng> latlng1) + distance(<LatLng> latlng1, <LatLng> latlng2) Number

Returns the distance between two geographical coordinates.

@@ -20618,14 +20759,14 @@ CRS's wrapLat and wrapLng properties, if they are wrapLng Number[] - An array of two numbers defining whether the longitude coordinate axis -wraps around a given range and how. Defaults to [-180, 180] in most -geographical CRSs. + An array of two numbers defining whether the longitude (horizontal) coordinate +axis wraps around a given range and how. Defaults to [-180, 180] in most +geographical CRSs. If undefined, the longitude axis does not wrap around. wrapLat Number[] - Like wrapLng, but for the latitude axis. + Like wrapLng, but for the latitude (vertical) axis. infinite @@ -20749,11 +20890,31 @@ e.g. 0.1 would be 10% of map view in each direction
-

Events

+

Events

+ +
+ + + + + + + + + + + +
EventDataDescription
update + EventFired when the renderer updates its bounds, center and zoom, for example when +its map has moved
+ +
+ +
@@ -21201,6 +21362,64 @@ information about the event. For example:

+ + +
+

KeyboardEvent

+ +
+ + + + + + + + + + + + + + + +
PropertyTypeDescription
originalEvent + DOMEventThe original DOM KeyboardEvent that triggered this Leaflet event.
+ +
+ + +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
type + StringThe event type (e.g. 'click').
target + ObjectThe object that fired the event.
+ +
+
+
+
@@ -21235,8 +21454,8 @@ information about the event. For example:

originalEvent - DOM MouseEvent - The original DOM mouse event fired by the browser. + DOMEvent + The original DOM MouseEvent or DOM TouchEvent that triggered this Leaflet event. @@ -22016,13 +22235,6 @@ information about the event. For example:

Point(0, 7) The offset of the popup position. Useful to control the anchor of the popup when opening it on some overlays. - - - zoomAnimation - Boolean - true - Whether to animate the popup on zoom. Disable it if you have -problems with Flash content inside popups. className @@ -22499,7 +22711,7 @@ var Leaflet = L.noConflict();
-

© 2015 Vladimir Agafonkin. Maps © OpenStreetMap contributors.

+

© 2016 Vladimir Agafonkin. Maps © OpenStreetMap contributors.

diff --git a/package.json b/package.json index 19147c2a..46b2b416 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "leaflet", - "version": "1.0.0-rc.3", + "version": "1.0.0", "description": "JavaScript library for mobile-friendly interactive maps", "devDependencies": { "eslint": "^3.5.0 <3.6.0",