cartodb/Leaflet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docstrings: Fix popup "autoClose" and "closeOnClick" options, fixes #5040 (#5304)

Browse Source 
* Fix popup "autoClose" and "closeOnClick" options documentation, fixes #5040

* Docstring for Popup `closeOnClick` option

* Backticks on docstrings
This commit is contained in:
Madis Allikmaa 2017-02-07 17:24:36 +02:00 committed by Iván Sánchez Ortega
parent fa458e7511
commit 59298a72d0
4 changed files with 30 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference-1.0.0.html
View File

@ -2916,13 +2916,19 @@ off of the screen while it is open.</td>
<td><code>true</code></td>
<td>Controls the presence of a close button in the popup.</td>
</tr>
<tr id='popup-closeonclick'>
<td><code><b>closeOnClick</b></code></td>
<td><code>Boolean</code>
<td><code>*</code></td>
<td>Set it if you want to override the default behavior of the popup closing when user clicks
on the map. Defaults to the Map&#39;s <a href="#map-closepopuponclick">closePopupOnClick</a> option.</td>
</tr>
<tr id='popup-autoclose'>
<td><code><b>autoClose</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to <code>false</code> if you want to override the default behavior of
the popup closing when user clicks the map (set globally by
the Map&#39;s <a href="#map-closepopuponclick">closePopupOnClick</a> option).</td>
the popup closing when another popup is opened.</td>
</tr>
<tr id='popup-classname'>
<td><code><b>className</b></code></td>

10
docs/reference-1.0.2.html
View File

@ -2958,13 +2958,19 @@ off of the screen while it is open.</td>
<td><code>true</code></td>
<td>Controls the presence of a close button in the popup.</td>
</tr>
<tr id='popup-closeonclick'>
<td><code><b>closeOnClick</b></code></td>
<td><code>Boolean</code>
<td><code>*</code></td>
<td>Set it if you want to override the default behavior of the popup closing when user clicks
on the map. Defaults to the Map&#39;s <a href="#map-closepopuponclick">closePopupOnClick</a> option.</td>
</tr>
<tr id='popup-autoclose'>
<td><code><b>autoClose</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to <code>false</code> if you want to override the default behavior of
the popup closing when user clicks the map (set globally by
the Map&#39;s <a href="#map-closepopuponclick">closePopupOnClick</a> option).</td>
the popup closing when another popup is opened.</td>
</tr>
<tr id='popup-classname'>
<td><code><b>className</b></code></td>

10
docs/reference-1.0.3.html
View File

@ -2967,13 +2967,19 @@ off of the screen while it is open.</td>
<td><code>true</code></td>
<td>Controls the presence of a close button in the popup.</td>
</tr>
<tr id='popup-closeonclick'>
<td><code><b>closeOnClick</b></code></td>
<td><code>Boolean</code>
<td><code>*</code></td>
<td>Set it if you want to override the default behavior of the popup closing when user clicks
on the map. Defaults to the Map&#39;s <a href="#map-closepopuponclick">closePopupOnClick</a> option.</td>
</tr>
<tr id='popup-autoclose'>
<td><code><b>autoClose</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to <code>false</code> if you want to override the default behavior of
the popup closing when user clicks the map (set globally by
the Map&#39;s <a href="#map-closepopuponclick">closePopupOnClick</a> option).</td>
the popup closing when another popup is opened.</td>
</tr>
<tr id='popup-classname'>
<td><code><b>className</b></code></td>

9
src/layer/Popup.js
View File

@ -84,10 +84,13 @@ export var Popup = DivOverlay.extend({
// @option autoClose: Boolean = true
// Set it to `false` if you want to override the default behavior of
// the popup closing when user clicks the map (set globally by
// the Map's [closePopupOnClick](#map-closepopuponclick) option).
// the popup closing when another popup is opened.
autoClose: true,
// @option closeOnClick: Boolean = *
// Set it if you want to override the default behavior of the popup closing when user clicks
// on the map. Defaults to the map's [`closePopupOnClick`](#map-closepopuponclick) option.
// @option className: String = ''
// A custom CSS class name to assign to the popup.
className: ''
@ -148,7 +151,7 @@ export var Popup = DivOverlay.extend({
getEvents: function () {
var events = DivOverlay.prototype.getEvents.call(this);
if ('closeOnClick' in this.options ? this.options.closeOnClick : this._map.options.closePopupOnClick) {
if (this.options.closeOnClick !== undefined ? this.options.closeOnClick : this._map.options.closePopupOnClick) {
events.preclick = this._close;
}