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

Add constrainCenter documentation

Browse Source
This commit is contained in:
Frederic Junod
2014-05-26 13:41:34 +02:00
parent ff1a9d420d
commit c15987a14d
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/ol/view2d.js
View File

@@ -59,14 +59,13 @@ ol.View2DProperty = {
* that is passed to a setter will effectively be the value set in the view, * that is passed to a setter will effectively be the value set in the view,
* and returned by the corresponding getter. * and returned by the corresponding getter.
* *
* But an `ol.View2D` object also has a *resolution constraint* and a * But an `ol.View2D` object also has a *resolution constraint*, a
* *rotation constraint*. There's currently no *center constraint*, but * *rotation constraint* and a *center constraint*.
* this may change in the future.
* *
* As said above no constraints are applied when the setters are used to set * As said above no constraints are applied when the setters are used to set
* new states for the view. Applying constraints is done explicitly through * new states for the view. Applying constraints is done explicitly through
* the use of the `constrain*` functions (`constrainResolution` and * the use of the `constrain*` functions (`constrainResolution` and
* `constrainRotation`). * `constrainRotation` and `constrainCenter`).
* *
* The main users of the constraints are the interactions and the * The main users of the constraints are the interactions and the
* controls. For example, double-clicking on the map changes the view to * controls. For example, double-clicking on the map changes the view to
@@ -195,7 +194,7 @@ ol.View2D.prototype.constrainCenter = function(center) {
/** /**
* Get the constrained the resolution of this view. * Get the constrained resolution of this view.
* @param {number|undefined} resolution Resolution. * @param {number|undefined} resolution Resolution.
* @param {number=} opt_delta Delta. Default is `0`. * @param {number=} opt_delta Delta. Default is `0`.
* @param {number=} opt_direction Direction. Default is `0`. * @param {number=} opt_direction Direction. Default is `0`.