ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Layer.Grid - better docs for transitionEffect, removeBackBufferDelay, and className

Browse Source
This commit is contained in:
Éric Lemoine
2012-04-02 20:59:16 +02:00
parent d8473f9249
commit d650ba20d9
1 changed files with 37 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/OpenLayers/Layer/Grid.js
+37 -10
View File
@@ -94,13 +94,13 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
/** /**
* APIProperty: transitionEffect * APIProperty: transitionEffect
* {String} The transition effect to use when the map is zoomed. * {String} The transition effect to use when the map is zoomed.
*
* Two posible values: * Two posible values:
* - *null* No transition effect (the default). *
* - *resize* Existing tiles are resized on zoom to provide a visual * null - No transition effect (the default).
* effect of the zoom having taken place immediately. As the * "resize" - Existing tiles are resized on zoom to provide a visual
* new tiles become available, they are drawn over top of the * effect of the zoom having taken place immediately. As the
* resized tiles. * new tiles become available, they are drawn over top of the
* resized tiles.
* *
* Using "resize" on non-opaque layers can cause undesired visual * Using "resize" on non-opaque layers can cause undesired visual
* effects. This is therefore discouraged. * effects. This is therefore discouraged.
@@ -201,15 +201,42 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
* {Number} Delay for removing the backbuffer when all tiles have finished * {Number} Delay for removing the backbuffer when all tiles have finished
* loading. Can be set to 0 when no css opacity transitions for the * loading. Can be set to 0 when no css opacity transitions for the
* olTileImage class are used. Default is 0 for <singleTile> layers, * olTileImage class are used. Default is 0 for <singleTile> layers,
* 2500 for tiled layers. * 2500 for tiled layers. See <className> for more information on
* tile animation.
*/ */
removeBackBufferDelay: null, removeBackBufferDelay: null,
/** /**
* APIProperty: className * APIProperty: className
* {String} Name of the class added to the layer div. Default is * {String} Name of the class added to the layer div. If not set in the
* "olLayerGridSingleTile" for <singleTile> layers, and * options passed to the constructor then className defaults to
* "olLayerGridTile" for non-<singleTile> layers. * "olLayerGridSingleTile" for single tile layers (see <singleTile>),
* and "olLayerGridTile" for non single tile layers.
*
* Note:
*
* The displaying of tiles is not animated by default for single tile
* layers - OpenLayers' default theme (style.css) includes this:
* (code)
* .olLayerGridTile .olTileImage {
* -webkit-transition: opacity 0.2s linear;
* -moz-transition: opacity 0.2s linear;
* -o-transition: opacity 0.2s linear;
* transition: opacity 0.2s linear;
* }
* (end)
* To animate tile displaying for any grid layer the following
* CSS rule can be used:
* (code)
* .olTileImage {
* -webkit-transition: opacity 0.2s linear;
* -moz-transition: opacity 0.2s linear;
* -o-transition: opacity 0.2s linear;
* transition: opacity 0.2s linear;
* }
* (end)
* In that case, to avoid flash effects, <removeBackBufferDelay>
* should not be zero.
*/ */
className: null, className: null,