ALK Maps v2.0.0 API

Class: BaseMapLayer

alk .layer.BaseMapLayer

An instance of this class is to be used for the base map (i.e. lowest) layer in an ol.Map. It uses a ol.source.Tile source that is specific to the ALK Map Tile Service.

new alk.layer.BaseMapLayer(opt_options)

This constructor creates an Openlayers compatible ol.Layer for an {ol.Map} based on the default {@alk.source.BaseMapSource}.

Option	Type	Description
`sourceOptions`	alkx.BaseMapSourceOptions \| undefined	This option provides the options to create the `alk.source.BaseMapSource` source and its `alk.service.MapTileService` service that will supply the URL to get the base map layer tiles.
`opacity`	number \| undefined	This option is an OpenLayer Vector Layer Option. Opacity (0, 1). Default is `1`.
`preload`	number \| undefined	This option is an OpenLayer Vector Layer Option. Preload. Load low-resolution tiles up to `preload` levels. By default `preload` is `0`, which means no preloading.
`map`	ol.PluggableMap \| undefined	This option is an OpenLayer Vector Layer Option. Sets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use `ol.Map#addLayer`.
`visible`	boolean \| undefined	This option is an OpenLayer Vector Layer Option. Visibility. Default is `true` (visible).
`extent`	ol.Extent \| undefined	This option is an OpenLayer Vector Layer Option. The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
`minResolution`	number \| undefined	This option is an OpenLayer Vector Layer Option. The minimum resolution (inclusive) at which this layer will be visible.
`maxResolution`	number \| undefined	This option is an OpenLayer Vector Layer Option. The maximum resolution (exclusive) below which this layer will be visible.
`useInterimTilesOnError`	boolean \| undefined	This option is an OpenLayer Vector Layer Option. Use interim tiles on error. Default is `true`.
`zIndex`	number \| undefined	This option is an OpenLayer Vector Layer Option. The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. The default Z-index is 0.

Example

var map = new ol.Map();
var baseLayer = new alk.layer.BaseMapLayer({
  sourceOptions: {
    serviceOptions: {
       style: alk.val.Style.Satellite
    }
  }
})
map.addLayer(baseLayer);

Extends

alk.layer.ImageTileLayer