ALK Maps v2.0.0 API

Class: DriveTimeLayer

alk .layer.DriveTimeLayer

An instance of this class is a layer that displays the drive time polygons from a alk.source.DriveTimePolygon source.

new alk.layer.DriveTimeLayer(opt_options)

This constructor creates a layer that displays the drive time polygons.

If no 'source' is provided in the options, then a new alk.source.DriveTimePolygon source is created with a new alk.service.DriveTimePolygonService service created with the provided 'driveTimePolygonServiceOptions' in the options.

All visual representation is handled by the 'style' option. As a default, the alk.style.QueuedStyleLayerStyle is used, which round robins between its styles for each polygon added to the layer.

Option	Type	Description
`source`	alk.source.DriveTimePolygon \| undefined	This option contains the `alk.source.DriveTimePolygon`.
`driveTimePolygonServiceOptions`	alkx.DriveTimePolygonServiceOptions \| undefined	This option contains the options that are given to the underlying `alk.service.DriveTimePolygonService` to create the polygons.
`frameRoute`	boolean \| undefined	This option specifies when the to the underlying `alk.service.DriveTimePolygonService` completes successfully, the map will zoom and center to fit the extent of its features.
`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.
`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.
`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.
`opacity`	number \| undefined	This option is an OpenLayer Vector Layer Option. Opacity (0, 1). Default is `1`.
`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.DriveTimeLayerStyle \| alk.style.StyleQueue \| Array.<ol.style.Style> \| ol.style.Style \| Array.<ol.style.Style> \| ol.StyleFunction \| undefined	This option specifies the style or style function to be used in drawing the polygons. The default is to use a `alk.style.QueuedStyleLayerStyle` object that cycles through a set of default corresponding fill and stroke colors. If the style is a `alk.style.DriveTimeLayerStyle` it is used directly. All others result in creating a `alk.style.DriveTimeLayerStyle` with the given style. If the style is a `alk.style.StyleQueue` it creates a DriveTimePolygonLayerStyle with this StyleQueue. This approach allows you to direct which colors are drawn for polygons on different drive time layers. If the style is a single style, it sets up a StyleQueue containing that stroke. If it is an array of Styles, it sets up a StyleQueue containing those styles. 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.
`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.
`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 = ol.Map({
  layers: [
    new alk.layer.BaseMapLayer(),
    new alk.layer.DriveTimeLayer()
  ]);

Extends

ol.layer.Vector

Methods

addDriveTimePolygon(opt_options, success, failure)

This method calls directly to the associated source's alk.source.MultiRoute#addRoute method.

Name	Type	Description
`options`	Object
`success`	function
`failure`	function