Hide Table of Contents
esri
arcgis
dijit
geometry
layers
renderer
symbols
tasks
Class: OpenStreetMapLayer
[ AMD Module Require | Legacy Module Require ]
Module Require
require(["esri/layers/OpenStreetMapLayer", ... ], function(OpenStreetMapLayer, ... ){ ... });
Description
Class added 2.0
Allows you to use basemaps from OpenStreetMap . Set the tileservers property to change which OpenStreetMap tiles you want to use.
Allows you to use basemaps from OpenStreetMap . Set the tileservers property to change which OpenStreetMap tiles you want to use.
Samples
Search for samples that use this class.Class hierarchy
esri.layers.OpenStreetMapLayer
Constructors
| Constructor | Description |
|---|---|
| new OpenStreetMapLayer(options?) | Creates a new OpenStreetMapLayer object. |
Properties
| Property | Type | Description |
|---|---|---|
| copyright | String | The copyright text. |
Constructor Details
Creates a new OpenStreetMapLayer object.
Parameters:
| <Object> options | Optional | Optional parameters. See options list. |
Options:
| <Number[]> displayLevels | An array of levels at which to draw. |
| <String> id | Id to assign to the layer. If not assigned, esri.Map assigns value. |
| <Number> opacity | Initial opacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency. The default value is 1.0. |
| <Boolean> resampling | When true, tile resampling is enabled. Default value is false. |
| <Number> resamplingTolerance | Number of levels beyond the last level where tiles are available. If not specified, resampling is enabled at all levels where tiles are not available. |
| <String[]> tileServers | An array of tile servers |
| <Boolean> visible | Initial visibility of the layer. Default is true. |
Code Snippet:
Create a default OpenStreetMapLayer
require([
"esri/map", "esri/layers/OpenStreetMapLayer", ...
], function(Map, OpenStreetMapLayer, ... ) {
var map = new Map( ... );
var osmLayer = new OpenStreetMapLayer();
map.addLayer(osmLayer);
...
});
Specify optional parameters when creating a new OpenStreetMapLayer
require([
"esri/map", "esri/layers/OpenStreetMapLayer", ...
], function(Map, OpenStreetMapLayer, ... ) {
var map = new Map( ... );
var osmLayer = new OpenStreetMapLayer({
id: "myOSMLayer",
visible: true,
opacity: .75,
displayLevels: [0,1,2]
});
...
});
Property Details