provide links to issues/pull requests in 2.12.md

This commit is contained in:
Éric Lemoine
2012-03-15 09:28:16 +01:00
parent 0786a5c532
commit bb6cf0c2d1
+86 -6
View File
@@ -5,6 +5,11 @@
A simple control to add zoom in/out buttons on the map that can be entirely styled using CSS. A simple control to add zoom in/out buttons on the map that can be entirely styled using CSS.
See it live in this [example](http://openlayers.org/dev/examples/zoom.html). See it live in this [example](http://openlayers.org/dev/examples/zoom.html).
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/291
* https://github.com/openlayers/openlayers/pull/292
## Builds ## Builds
This version of OpenLayers ships with three builds: This version of OpenLayers ships with three builds:
@@ -15,6 +20,11 @@ This version of OpenLayers ships with three builds:
See the README.md file and the docs on docs.openlayers.org for more information. See the README.md file and the docs on docs.openlayers.org for more information.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/254
* https://github.com/openlayers/openlayers/pull/261
## Sensible projection defaults ## Sensible projection defaults
The geographic and web mercator projections define default values for the maxExtent, and units. This simplifies the map and layer configuration. The geographic and web mercator projections define default values for the maxExtent, and units. This simplifies the map and layer configuration.
@@ -37,10 +47,18 @@ can now be created with this:
projection: "EPSG:900913" projection: "EPSG:900913"
}); });
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/219
## Tile Offline Storage ## Tile Offline Storage
With the new `OpenLayers.Control.CacheRead` and `OpenLayers.Control.CacheWrite` controls, applications can cache tiles for offline use or for use with slow connections. With the new `OpenLayers.Control.CacheRead` and `OpenLayers.Control.CacheWrite` controls, applications can cache tiles for offline use or for use with slow connections.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/301
## Tile Animation ## Tile Animation
The displaying of tiles can now be animated, using CSS3 transitions. Transitions operate on the `opacity` property. Here's the CSS rule defined in OpenLayers' default theme: The displaying of tiles can now be animated, using CSS3 transitions. Transitions operate on the `opacity` property. Here's the CSS rule defined in OpenLayers' default theme:
@@ -61,11 +79,19 @@ People can override this rule to use other transition settings. To remove tile a
transition: none; transition: none;
} }
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/127
## Tile Queue ## Tile Queue
The tiling code has been overhauled so tile loading in grid layers is now done in a queue. The tiling code has been overhauled so tile loading in grid layers is now done in a queue.
The tile queue gives more control on the tile requests sent to the server. Pending requests for tiles that are not needed any more (e.g. after zooming or panning) are avoided, which increases performance and reduces server load. The tile queue gives more control on the tile requests sent to the server. Pending requests for tiles that are not needed any more (e.g. after zooming or panning) are avoided, which increases performance and reduces server load.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/179
## Tile Canvas ## Tile Canvas
Image tiles expose a `getCanvasContext` function that can be used for various Image tiles expose a `getCanvasContext` function that can be used for various
@@ -74,15 +100,27 @@ things, like changing the image pixels, save the image using the File API, etc.
See the [osm-grayscale See the [osm-grayscale
example](http://openlayers.org/dev/examples/osm-grayscale.html). example](http://openlayers.org/dev/examples/osm-grayscale.html).
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/160
## Tile Interaction Event Improvements ## Tile Interaction Event Improvements
The layer's `tileloaded` event now returns a reference to the loaded tile. The new `tileloaderror` event does the same, and is fired when a tile could not be loaded. The layer's `tileloaded` event now returns a reference to the loaded tile. The new `tileloaderror` event does the same, and is fired when a tile could not be loaded.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/283
## Tile and Backbuffer Overhaul ## Tile and Backbuffer Overhaul
The whole image tile and backbuffer code (behind `transitionEffect:resize`) has been redesigned and The whole image tile and backbuffer code (behind `transitionEffect:resize`) has been redesigned and
rewritten. This overhaul yields better performance and code simplifications. rewritten. This overhaul yields better performance and code simplifications.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/16
## Continuous Zooming ## Continuous Zooming
Tile layers can now be displayed at resolutions not supported by their tiling Tile layers can now be displayed at resolutions not supported by their tiling
@@ -93,15 +131,24 @@ for single tile layers as well as for tiled layers.
See the [client zoom See the [client zoom
example](http://openlayers.org/dev/examples/clientzoom.html). example](http://openlayers.org/dev/examples/clientzoom.html).
Corresponding issues/pull requests:
* http://trac.osgeo.org/openlayers/ticket/3531
* https://github.com/openlayers/openlayers/pull/5
# Behavior Changes from Past Releases # Behavior Changes from Past Releases
## GPX API change ## GPX API change
The `gpxns` API property has been removed. The GPX namespace is now defined in the `namespaces` property but is not intended to be overriden. The `gpxns` API property has been removed. The GPX namespace is now defined in the `namespaces` property but is not intended to be overriden.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/221
## Function return values ## Function return values
[Previously][prev] a few functions in the library displayed error messages and returned `undefined`, `null` or `false` if the parameters passed in were bad. In 2.12 these functions now just throw an error/exception. People relying on return values to know if a function call is successful may need to change their code. Here are the modified functions: Previously a few functions in the library displayed error messages and returned `undefined`, `null` or `false` if the parameters passed in were bad. In 2.12 these functions now just throw an error/exception. People relying on return values to know if a function call is successful may need to change their code. Here are the modified functions:
* `OpenLayers.Bounds.add` throws a `TypeError` exception if `x` or `y` is null * `OpenLayers.Bounds.add` throws a `TypeError` exception if `x` or `y` is null
* `OpenLayers.LonLat.add` throws a `TypeError` exception if `lon` or `lat` is null * `OpenLayers.LonLat.add` throws a `TypeError` exception if `lon` or `lat` is null
@@ -110,7 +157,9 @@ The `gpxns` API property has been removed. The GPX namespace is now defined in t
* `OpenLayers.Layer.PointTrack.addNodes` throws a `TypeError` exception if `endPoint` isn't actually a point * `OpenLayers.Layer.PointTrack.addNodes` throws a `TypeError` exception if `endPoint` isn't actually a point
* `OpenLayers.Layer.Vector.getFeatureFromEvent` throws an `Error` exception if the layer has no renderer * `OpenLayers.Layer.Vector.getFeatureFromEvent` throws an `Error` exception if the layer has no renderer
[prev]: https://github.com/openlayers/openlayers/commit/6e9a3e4c13e00c29daf28efd92b63c2390e69231 Corresponding issues/pull requests:
* http://trac.osgeo.org/openlayers/ticket/3320
## Changes in formats WMTSCapabilities and SOSCapabilities ## Changes in formats WMTSCapabilities and SOSCapabilities
@@ -122,8 +171,10 @@ Likewise for `SOSCapabilities`.
Looking at the tests is a good way to understand what the requires changes are. See [SOSCapabilities/v1_0_0.html](https://github.com/openlayers/openlayers/blob/master/tests/Format/SOSCapabilities/v1_0_0.html) and [WMTSCapabilities/v1_0_0.html](https://github.com/openlayers/openlayers/blob/master/tests/Format/WMTSCapabilities/v1_0_0.html). Looking at the tests is a good way to understand what the requires changes are. See [SOSCapabilities/v1_0_0.html](https://github.com/openlayers/openlayers/blob/master/tests/Format/SOSCapabilities/v1_0_0.html) and [WMTSCapabilities/v1_0_0.html](https://github.com/openlayers/openlayers/blob/master/tests/Format/WMTSCapabilities/v1_0_0.html).
* Trac ticket: http://trac.osgeo.org/openlayers/ticket/3568 Corresponding issues/pull requests:
* GitHub issue: https://github.com/openlayers/openlayers/pull/40
* http://trac.osgeo.org/openlayers/ticket/3568
* https://github.com/openlayers/openlayers/pull/40
## Rico deprecation ## Rico deprecation
@@ -139,19 +190,31 @@ The `roundedCorner` option of `Control.LayerSwitcher` is deprecated, and it now
border-radius: 10px 0 0 10px; border-radius: 10px 0 0 10px;
} }
See more detail in the Rico deprecation [pull request](https://github.com/openlayers/openlayers/pull/99).
In future releases we intend to move the Rico and `AnchoredBubble` code into deprecated.js. You really should consider stop using Rico-based functionalities in your applications. In future releases we intend to move the Rico and `AnchoredBubble` code into deprecated.js. You really should consider stop using Rico-based functionalities in your applications.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/99
## Changes in Geometry ## Changes in Geometry
The base `OpenLayers.Geometry` class no longer depends on `OpenLayers.Format.WKT` or `OpenLayers.Feature.Vector`. If you want to make use of the `OpenLayers.Geometry.fromWKT` method, you must explicitly include the OpenLayers/Format/WKT.js file in your build. The base `OpenLayers.Geometry` class no longer depends on `OpenLayers.Format.WKT` or `OpenLayers.Feature.Vector`. If you want to make use of the `OpenLayers.Geometry.fromWKT` method, you must explicitly include the OpenLayers/Format/WKT.js file in your build.
Without the WKT format included (by default), the `OpenLayers.Geometry::toString` method now returns "[object Object]." Previously, it returned the Well-Known Text representation of the geometry. To maintain the previous behavior, include the OpenLayers/Format/WKT.js file in your build. Without the WKT format included (by default), the `OpenLayers.Geometry::toString` method now returns "[object Object]." Previously, it returned the Well-Known Text representation of the geometry. To maintain the previous behavior, include the OpenLayers/Format/WKT.js file in your build.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/101
## OSM and Bing Layers ## OSM and Bing Layers
`Layer.OSM` is now defined in its own script file, namely `OpenLayers/Layer/OSM.js`. So people using `Layer.OSM` should now include `OpenLayers/Layer/OSM.js`, as opposed to `OpenLayers/Layer/XYZ.js`, in their OpenLayers builds. (See https://github.com/openlayers/openlayers/issues/138) `Layer.OSM` is now defined in its own script file, namely `OpenLayers/Layer/OSM.js`. So people using `Layer.OSM` should now include `OpenLayers/Layer/OSM.js`, as opposed to `OpenLayers/Layer/XYZ.js`, in their OpenLayers builds.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/issues/138
* https://github.com/openlayers/openlayers/pull/144
The `OpenLayers.Tile.Image` class now has a method to get a canvas context for processing tiles. Since both OSM and Bing set Access-Control-Allow-Origin headers for their tiles, it is possible to manipulate a canvas that these tiles were rendered to even if the tiles come from a remote origin. Especially when working with custom OSM tilesets from servers that do not send Access-Control-Allow-Origin headers, it is now necessary to configure the layer with The `OpenLayers.Tile.Image` class now has a method to get a canvas context for processing tiles. Since both OSM and Bing set Access-Control-Allow-Origin headers for their tiles, it is possible to manipulate a canvas that these tiles were rendered to even if the tiles come from a remote origin. Especially when working with custom OSM tilesets from servers that do not send Access-Control-Allow-Origin headers, it is now necessary to configure the layer with
@@ -192,12 +255,25 @@ New:
In previous releases, coordinate transforms between EPSG:4326 and EPSG:900913 were defined in the SphericalMercator.js script. In 2.12, these default transforms are included in the Projection.js script. The Projection.js script is included as a dependency in builds with any layer types, so no special build configuration is necessary to get the web mercator transforms. In previous releases, coordinate transforms between EPSG:4326 and EPSG:900913 were defined in the SphericalMercator.js script. In 2.12, these default transforms are included in the Projection.js script. The Projection.js script is included as a dependency in builds with any layer types, so no special build configuration is necessary to get the web mercator transforms.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/219
If you were previously using the `OpenLayers.Layer.SphericalMercator.forwardMercator` or `inverseMercator` methods, you may have to explicitly include the SphericalMercator.js script in your build. The Google layer is the only layer that depends on the SphericalMercator mixin. If you are not using the Google layer but want to use the SphericalMercator methods listed above, you have to explicitly include the SphericalMercator.js script in your build. If you were previously using the `OpenLayers.Layer.SphericalMercator.forwardMercator` or `inverseMercator` methods, you may have to explicitly include the SphericalMercator.js script in your build. The Google layer is the only layer that depends on the SphericalMercator mixin. If you are not using the Google layer but want to use the SphericalMercator methods listed above, you have to explicitly include the SphericalMercator.js script in your build.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/153
## QueryStringFilter ## QueryStringFilter
`OpenLayers.Protocol.HTTP` no longer requires `OpenLayers.Format.QueryStringFilter`. It you need this, make sure it is included in your build config file. `OpenLayers.Protocol.HTTP` no longer requires `OpenLayers.Format.QueryStringFilter`. It you need this, make sure it is included in your build config file.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/issues/147
* https://github.com/openlayers/openlayers/pull/148
## Changes in getURLasync ## Changes in getURLasync
The internal `OpenLayers.Layer.getURLasync` function now take a bound, a callback and a scope. The function no longer needs update the passed property but simply to return to url. The internal `OpenLayers.Layer.getURLasync` function now take a bound, a callback and a scope. The function no longer needs update the passed property but simply to return to url.
@@ -212,6 +288,10 @@ To replace a tile that couldn't be loaded with a static image, create a css sele
For more complex tile loading error handling, register a listener to the layer's `tileerror` event. For more complex tile loading error handling, register a listener to the layer's `tileerror` event.
Corresponding issues/pull requests:
* https://github.com/openlayers/openlayers/pull/283
## Deprecated Components ## Deprecated Components
A number of properties, methods, and constructors have been marked as deprecated for multiple releases in the 2.x series. For the 2.12 release this deprecated functionality has been moved to a separate deprecated.js file. If you use any of the constructors or methods below, you will have to explicitly include the deprecated.js file in your build (or add it in a separate `<script>` tag after OpenLayers.js). A number of properties, methods, and constructors have been marked as deprecated for multiple releases in the 2.x series. For the 2.12 release this deprecated functionality has been moved to a separate deprecated.js file. If you use any of the constructors or methods below, you will have to explicitly include the deprecated.js file in your build (or add it in a separate `<script>` tag after OpenLayers.js).