ALK Maps v2.0.0 API

Class: POILayer

alk .layer.POILayer

An instance of this class provides a layer that may lookup a points of interest within the radius of a point, using the ALK POI Service, and display them.

new alk.layer.POILayer(opt_options)

This constructor creates an ALK Points of Interest layer. All visual representation is handled by the 'style' option. As a default, the alk.style.POILayerStyle is used, which as a default draws POIs according to their category.

Option	Type	Description
`source`	alk.source.POISource \| undefined	This option contains the vector source for the Points of Interest. This option is mutually exclusive with poiServiceOptions.
`poiServiceOptions`	alkx.POIServiceOptions \| undefined	This option contains the options that are given to the underlying `alk.service.POIService` to retrieve the Points Of Interest.
`renderOrder`	ol.RenderOrderFunction \| null \| undefined	This option is an OpenLayer Vector Layer Option. Render Order. Function to be used when sorting features before rendering. By default features are drawn in the order that they are created. Use null to avoid the sort, but get an undefined draw order. Required. The default order of creation is, route lines, then stops in order from origin to destination.
`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.
`opacity`	number \| undefined	This option is an OpenLayer Vector Layer Option. Opacity (0, 1). Default is `1`.
`declutter`	boolean \| undefined	This option is an OpenLayer Vector Layer Option. Declutter images and text. Decluttering is applied to all image and text styles, and the priority is defined by the z-index of the style. Lower z-index means higher priority. Default is false.
`renderBuffer`	number \| undefined	This option is an OpenLayer Vector Layer Option. The buffer around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. Recommended value: the size of the largest symbol, line width, or label. Default is 100 pixels.
`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`.
`style`	alk.style.POILayerStyle \| alk.style.StrokeQueue \| Array.<ol.style.Stroke> \| ol.style.Style \| Array.<ol.style.Style> \| ol.StyleFunction \| undefined	This option specifies the style or style function to be used in drawing the points of interest. The default is to use a `alk.style.IconPOILayerStyle` object that labels points of interest with their POI category. If it is anything else, the style is passed to the ol.layer.Vector for default styling.
`updateWhileAnimating`	boolean \| undefined	This option is an OpenLayer Vector Layer Option. When set to true, feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to false, batches will be recreated when no animation is active. Default is false.
`updateWhileInteracting`	boolean \| undefined	This option is an OpenLayer Vector Layer Option. When set to true, feature batches will be recreated during interactions. See also `updateWhileAnimating`.
`visible`	boolean \| undefined	This option is an OpenLayer Vector Layer Option. Visibility. Default is `true` (visible).
`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.

Fires:

change:updating: This event is fired when the request is being made and when it returns.
change:updating: This event is fired when the request is being made and when it returns.

Extends

ol.layer.Vector

Methods

getPOILayerStyle(){alk.style.POILayerStyle|undefined}

This function returns the POILayerStyle that was either assigned or created for this POILayer.

setStyle(optStyle)

This function sets the Style for this layer.

Name	Type	Description
`optStyle`	alk.style.POILayerStyle \| ol.style.Style \| Array.<ol.style.Style> \| ol.StyleFunction \| string \| undefined