# new XYZLayer(opts)
Initialization object
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
opts |
object | Tile layer options. |
||
url |
string | URL template. Must include {x}, {y} or {-y}, and {z} placeholders. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option |
||
name |
string |
<optional> |
Layer name |
|
order |
number |
<optional> |
The order for layer rendering. At rendering time, the layers will be ordered, first by order and then by position. When undefined, a order of 0 is assumed for layers that are added to the map's layers collection. |
|
visible |
boolean |
<optional> |
true | Visibility |
opacity |
number |
<optional> |
1 | Opacity (0, 1). |
bbox |
string |
<optional> |
Layer bbox coverage |
|
minZoom |
number |
<optional> |
Mix zoom allowed. |
|
maxZoom |
number |
<optional> |
Max zoom allowed. |
|
attributions |
string |
<optional> |
Attributions. |
- Tutorials:
Example
Create empty layer
const options = { url :"https://www.sample-url.com/tiles/{z}/{y}/{x}" };
const layer = new Vexcel.Layers.XYZLayer(options);Extends
Classes
Methods
# getAttributions() → {string}
Gets the attributions of the layer.
Attributions of the layer.
# getMaxZoom() → {number}
Gets the maximum zoom level of the layer.
- Overrides:
The maximum zoom level of the layer.
# getMinZoom() → {number}
Gets the minimum zoom level of the layer.
- Overrides:
The minimum zoom level of the layer.
# getOpacity() → {number}
Gets the opacity of the layer (between 0 and 1).
- Overrides:
The opacity of the layer.
# getVisible() → {boolean}
Gets the visibility of the layer (true or false).
- Overrides:
The visibility of the layer.
# setAttributions(attributions)
Sets the attributions of the layer.
Parameters:
| Name | Type | Description |
|---|---|---|
attributions |
string | Attributions. Can be passed as string. |
# setMaxZoom(maxZoom)
Sets the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.
Parameters:
| Name | Type | Description |
|---|---|---|
maxZoom |
number | The maximum zoom of the layer. |
- Overrides:
# setMinZoom(minZoom)
Sets the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.
Parameters:
| Name | Type | Description |
|---|---|---|
minZoom |
number | The minimum zoom of the layer. |
- Overrides:
# setOpacity(opacity)
Sets the opacity of the layer, allowed values range from 0 to 1.
Parameters:
| Name | Type | Description |
|---|---|---|
opacity |
number | The opacity of the layer. |
- Overrides:
# setVisible(visible)
Sets the visibility of the layer (true or false).
Parameters:
| Name | Type | Description |
|---|---|---|
visible |
boolean | The visibility of the layer. |
- Overrides: