Add more content for the API doc

Involves additions to (there will be subsequent pull requests for other
classes):
- ol.Attribution
- ol.Collection
- ol.Expression
- ol.Feature
- ol.Geolocation
- ol.Map
- ol.Object
- ol.Overlay
- ol.Projection
- ol.View2D
- ol.control.Attribution
- ol.control.Control
- ol.control.FullScreen
- ol.control.Logo
- ol.control.MousePosition
- ol.control.ScaleLine
- ol.control.Zoom
- ol.control.ZoomSlider
- ol.dom.Input
- ol.filter.Filter
- ol.filter.Geometry
- ol.filter.Logical
This commit is contained in:
Bart van den Eijnden
2013-06-11 11:09:39 +02:00
parent 9647567704
commit 8dc97790bc
23 changed files with 264 additions and 14 deletions

View File

@@ -18,6 +18,10 @@ goog.require('ol.source.Source');
/**
* Create a new attribution control to show all the attributions associated
* with the layer sources in the map. A default map has this control included.
* By default it will show in the bottom right portion of the map, but it can
* be changed by using a css selector for .ol-attribution.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.AttributionOptions=} opt_options Attribution options.

View File

@@ -9,8 +9,8 @@ goog.require('ol.MapEventType');
/**
* A thing which is painted over the map to provide a means for interaction
* (buttons) of show annotations (status bars).
* Something to be painted over the map to provide a means for interaction
* (buttons) or to show annotations (status bars).
*
* @constructor
* @extends {goog.Disposable}
@@ -63,6 +63,7 @@ ol.control.Control.prototype.disposeInternal = function() {
/**
* Get the map associated with this control.
* @return {ol.Map} Map.
*/
ol.control.Control.prototype.getMap = function() {

View File

@@ -14,6 +14,17 @@ goog.require('ol.css');
/**
* Provides a button that when clicked fills up the full screen with the map.
* When in full screen mode, a close button is shown to exit full screen mode.
*
* Example:
*
* var map = new ol.Map({
* controls: ol.control.defaults({}, [
* new ol.control.FullScreen()
* ]),
* ...
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.FullScreenOptions=} opt_options Options.

View File

@@ -11,6 +11,10 @@ goog.require('ol.css');
/**
* Shows a logo for all the layer sources in the map that have a logo
* associated with them, such as Bing. This control is part of a default map.
* By default it will show in the bottom-left portion of the map, but it can
* be styled by using a css selector for .ol-logo.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.LogoOptions=} opt_options Logo options.

View File

@@ -19,6 +19,19 @@ goog.require('ol.proj');
/**
* Create a new control to show the position of the mouse in the map's
* projection (or any other supplied projection). By default the control is
* shown in the top right corner of the map but this can be changed by using
* a css selector .ol-mouse-position.
*
* Example:
*
* var map = new ol.Map({
* controls: ol.control.defaults({}, [
* new ol.control.MousePosition({projection: ol.proj.get('EPSG:4326')})
* ]),
* ...
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.MousePositionOptions=} opt_options Mouse position options.

View File

@@ -30,6 +30,18 @@ ol.control.ScaleLineUnits = {
/**
* Create a control to help users estimate distances on a map.
*
* Example:
*
* var map = new ol.Map({
* controls: ol.control.defaults({}, [
* new ol.control.ScaleLine({
* units: ol.control.ScaleLineUnits.IMPERIAL
* })
* ]),
* ...
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.

View File

@@ -20,6 +20,9 @@ ol.control.ZOOM_DURATION = 250;
/**
* Create a new control with 2 buttons, one for zoom in and one for zoom out.
* This control is part of the default controls of a map. To style this control
* use css selectors .ol-zoom-in and .ol-zoom-out.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomOptions=} opt_options Zoom options.

View File

@@ -29,6 +29,14 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
/**
* A slider type of control for zooming.
*
* Example:
*
* var zoomslider = new ol.control.ZoomSlider({
* map: map
* });
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options.