Class MapLayer

This class represent a background map

Source : file data/MapLayer.js at line 33

Constructor

new MapLayer ( jsonLayer )

The constructor

Source : file data/MapLayer.js at line 285

Parameters

Name Type Description
jsonLayer JsonObject

A json object from TravelNotesLayers.json

Public getters and setters

readonly get attribution : String

The map attributions. For maps based on OpenStreetMap, it is not necessary to add the attributions of OpenStreetMap because they are always present in Travel & Notes.

Source : file data/MapLayer.js at line 378

readonly get bounds : Array of Number

The lower left and upper right corner of the mapLayer

Source : file data/MapLayer.js at line 335

readonly get maxZoom : Number

The largest possible zoom for this mapLayer

Source : file data/MapLayer.js at line 349

readonly get minZoom : Number

The smallest possible zoom for this mapLayer

Source : file data/MapLayer.js at line 342

readonly get name : String

The name of the map

Source : file data/MapLayer.js at line 306

readonly get providerKeyNeeded : Boolean

When true, an access key is required to get the map.

Source : file data/MapLayer.js at line 370

readonly get providerName : String

The name of the service provider. This name will be used to find the access key to the service.

Source : file data/MapLayer.js at line 363

readonly get service : String

The type of service: wms or wmts

Source : file data/MapLayer.js at line 313

readonly get toolbarButtonData : LayerToolbarButtonData

An object with text, color and backgroundColor properties used to create the button in the toolbar

Source : file data/MapLayer.js at line 356

readonly get url : String

The url to use to get the map

Source : file data/MapLayer.js at line 320

readonly get wmsOptions : LeafletObject

The wmsOptions for this mapLayer See the Leaflet TileLayer.WMS documentation

Source : file data/MapLayer.js at line 328

Private properties

#attribution : String

The map attributions.

Source : file data/MapLayer.js at line 111

#bounds : Array of Number

The lower left and upper right corner of the mapLayer

Source : file data/MapLayer.js at line 69

#jsonLayer : JsonObject

A temporary variable to store the layer data

Source : file data/MapLayer.js at line 118

#maxZoom : Number

The largest possible zoom for this mapLayer

Source : file data/MapLayer.js at line 83

#minZoom : Number

The smallest possible zoom for this mapLayer

Source : file data/MapLayer.js at line 76

#name : String

The name of the map

Source : file data/MapLayer.js at line 40

#providerKeyNeeded : Boolean

When true, an access key is required to get the map.

Source : file data/MapLayer.js at line 104

#providerName : String

The name of the service provider.

Source : file data/MapLayer.js at line 97

#service : String

The type of service: wms or wmts

Source : file data/MapLayer.js at line 47

#toolbarButtonData : LayerToolbarButtonData

An object with text, color and backgroundColor properties used to create the button in the toolbar

Source : file data/MapLayer.js at line 90

#url : String

The url to use to get the map

Source : file data/MapLayer.js at line 54

#wmsOptions : LeafletObject

The wmsOptions for this mapLayer See the Leaflet TileLayer.WMS documentation

Source : file data/MapLayer.js at line 62

Private methods

#setAttributions ( )

Set the map attributions.

Source : file data/MapLayer.js at line 268

#setBounds ( )

Set the lower left and upper right corner of the mapLayer

Source : file data/MapLayer.js at line 186

#setLayerName ( )

Set the name of the map layer

Source : file data/MapLayer.js at line 124

#setMinMaxZoom ( )

Set the min and max zoom for the map

Source : file data/MapLayer.js at line 211

#setProviderKeyNeeded ( )

Set the providerKeyNeeded value

Source : file data/MapLayer.js at line 255

#setProviderName ( )

Set the name of the service provider

Source : file data/MapLayer.js at line 242

#setService ( )

Set the type of service: wms or wmts

Source : file data/MapLayer.js at line 137

#setToolbarButtonData ( )

Set the toolbar data

Source : file data/MapLayer.js at line 234

#setUrl ( )

Set the url to use to get the map

Source : file data/MapLayer.js at line 150

#setWmsOptions ( )

Set the wmsOptions for this mapLayer

Source : file data/MapLayer.js at line 163