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

Add basic docs for attributioncontrol

Browse Source
This commit is contained in:
Marc Jansen
2015-04-23 20:26:37 +02:00
parent cbc0ae730a
commit a433f1abbe
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ol/control/attributioncontrol.js
View File

@@ -210,6 +210,7 @@ ol.control.Attribution.prototype.getSourceAttributions = function(frameState) {
/** /**
* Update the attribution element.
* @param {ol.MapEvent} mapEvent Map event. * @param {ol.MapEvent} mapEvent Map event.
* @this {ol.control.Attribution} * @this {ol.control.Attribution}
* @api * @api
@@ -365,6 +366,7 @@ ol.control.Attribution.prototype.handleToggle_ = function() {
/** /**
* Return `true` if the attribution is collapsible, `false` otherwise.
* @return {boolean} True if the widget is collapsible. * @return {boolean} True if the widget is collapsible.
* @api stable * @api stable
*/ */
@@ -374,6 +376,7 @@ ol.control.Attribution.prototype.getCollapsible = function() {
/** /**
* Set whether the attribution should be collapsible.
* @param {boolean} collapsible True if the widget is collapsible. * @param {boolean} collapsible True if the widget is collapsible.
* @api stable * @api stable
*/ */
@@ -390,6 +393,9 @@ ol.control.Attribution.prototype.setCollapsible = function(collapsible) {
/** /**
* Collapse or expand the attribution according to the passed parameter. Will
* not do anything if the attribution isn't collapsible or if the current
* collapsed state is already the one requested.
* @param {boolean} collapsed True if the widget is collapsed. * @param {boolean} collapsed True if the widget is collapsed.
* @api stable * @api stable
*/ */
@@ -402,6 +408,8 @@ ol.control.Attribution.prototype.setCollapsed = function(collapsed) {
/** /**
* Return `true` when the attribution is currently collapsed or `false`
* otherwise.
* @return {boolean} True if the widget is collapsed. * @return {boolean} True if the widget is collapsed.
* @api stable * @api stable
*/ */