Docstrings(Map/Grid+TileLayer): improve minZoom and maxZoom explanations (#5573)
* Docs(Map/Grid+TileLayer): improve minZoom and maxZoom explanations so that it is more explicit how Map's options may get automatically computed from its Grid/Tile layers, and what is the exact effect of these options on Grid/Tile layers. * Docs(Map/Grid+TileLayer): use "inclusive" instead of "included". https://en.wiktionary.org/wiki/inclusive
This commit is contained in:
parent
90a8d88460
commit
6bfa764cb0
@ -106,11 +106,11 @@ export var GridLayer = Layer.extend({
|
||||
bounds: null,
|
||||
|
||||
// @option minZoom: Number = 0
|
||||
// The minimum zoom level that tiles will be loaded at. By default the entire map.
|
||||
// The minimum zoom level down to which this layer will be displayed (inclusive).
|
||||
minZoom: 0,
|
||||
|
||||
// @option maxZoom: Number = undefined
|
||||
// The maximum zoom level that tiles will be loaded at.
|
||||
// The maximum zoom level up to which this layer will be displayed (inclusive).
|
||||
maxZoom: undefined,
|
||||
|
||||
// @option maxNativeZoom: Number = undefined
|
||||
|
@ -42,11 +42,11 @@ export var TileLayer = GridLayer.extend({
|
||||
// @aka TileLayer options
|
||||
options: {
|
||||
// @option minZoom: Number = 0
|
||||
// Minimum zoom number.
|
||||
// The minimum zoom level down to which this layer will be displayed (inclusive).
|
||||
minZoom: 0,
|
||||
|
||||
// @option maxZoom: Number = 18
|
||||
// Maximum zoom number.
|
||||
// The maximum zoom level up to which this layer will be displayed (inclusive).
|
||||
maxZoom: 18,
|
||||
|
||||
// @option subdomains: String|String[] = 'abc'
|
||||
|
@ -46,12 +46,16 @@ export var Map = Evented.extend({
|
||||
// Initial map zoom level
|
||||
zoom: undefined,
|
||||
|
||||
// @option minZoom: Number = undefined
|
||||
// Minimum zoom level of the map. Overrides any `minZoom` option set on map layers.
|
||||
// @option minZoom: Number = *
|
||||
// Minimum zoom level of the map.
|
||||
// If not specified and at least one `GridLayer` or `TileLayer` is in the map,
|
||||
// the lowest of their `minZoom` options will be used instead.
|
||||
minZoom: undefined,
|
||||
|
||||
// @option maxZoom: Number = undefined
|
||||
// Maximum zoom level of the map. Overrides any `maxZoom` option set on map layers.
|
||||
// @option maxZoom: Number = *
|
||||
// Maximum zoom level of the map.
|
||||
// If not specified and at least one `GridLayer` or `TileLayer` is in the map,
|
||||
// the highest of their `maxZoom` options will be used instead.
|
||||
maxZoom: undefined,
|
||||
|
||||
// @option layers: Layer[] = []
|
||||
|
Loading…
Reference in New Issue
Block a user