Class: RoadSurfaceRouteLayer

alk.layer.RoadSurfaceRouteLayer

An instance of this class provides a display layer for a alk.source.RoadSurfaceRoute source, in which depending its type will display routes according to the associated style. If no source is supplied, the default is the alk.source.RoadSurfaceRoute source with the given 'roadSurfaceRouteServiceOptions' option, if supplied.

This class may be sub-classed to provide for different functionality.

new alk.layer.RoadSurfaceRouteLayer(opt_options)

This constructor creates an layer that gets ALK Road Surface tiles for particular routes.

If no 'source' is provided in the options, then a new alk.source.RoadSurfaceRoute source is created with a new alk.service.RoadSurfaceRouteService service created with the provided 'roadSurfaceRouteServiceOptions' in the options.

All visual representation is handled by the 'style' option. As a default, the alk.style.RoadSurfaceStyle is used.

Should you need a specific styling, please see alk.style.RoadSurfaceStyle as a base object from which to implement.

Option Type Description
source alk.source.Route | undefined

This option contains the alk.source.Route for the layer. alk.service.RoadSurfaceRouteService to create the route.
routeServiceOptions alkx.RoadSurfaceRouteServiceOptions | undefined

This option contains the options that are given to the underlying alk.service.RoadSurfaceRouteService to create the route.
frameRoute boolean | undefined

This option specifies when the to the underlying alk.service.RoadSurfaceRouteService 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.
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.RoadSurfaceStyle | ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | undefined

This option specifies the style or style function to be used in drawing the road surface along the route. The default is to use a alk.style.RoadSurfaceStyle..

If the style is a alk.style.RoadSurfaceStyle it is used directly. All others result in creating a alk.style.RoadSurfaceStyle with the given style.

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).

Extends

  • ol.layer.Vector

Methods

getRoadSurfaceStyle(){alk.style.RoadSurfaceStyle|undefined}

This function returns the RoadSurfaceStyle that was either assigned or created for this RoadSurfaceRouteLayer.

setStyle(optStyle)

This function sets the Style for this layer.

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