Class: RoadSurfaceTileSource

alk.source.RoadSurfaceTileSource

An instance of this class holds the source for an ALK RoadSurface Source that is used in the alk.layer.RoadSurfaceTileLayer.

new alk.source.RoadSurfaceTileSource(opt_options)

This constructor creates a Source object to retrieve Road Surface Tiles from the ALK Road Surface Tile Service.

It is an ol.source.Tile source that uses the ALK RoadSurface Service.

Option Type Description
serviceOptions alkx.RoadSurfaceTileServiceOptions | undefined
attributions ol.AttributionLike | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Attributions.
cacheSize number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Cache size. Default is 2048.
extent ol.Extent | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

It contains the map extent in which the source is relevant.
crossOrigin null | string | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See [https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image] for more detail.
opaque boolean | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Whether the layer is opaque.
projection ol.ProjectionLike | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

This options contains the projection with which to interpret other options, such as the extent.
maxZoom number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Optional maximum zoom level. Default is 20 (ALK specific).
minZoom number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Optional minimum zoom level. Default is 0.
tileGrid ol.tilegrid.TileGrid | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Tile Grid.
tileLoadFunction ol.TileLoadFunctionType | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Optional function to load a tile given a URL. The default is function(imageTile, src) { imageTile.getImage().src = src; };
tilePixelRatio number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

The pixel ratio used by the tile service. For example, if the tile service advertises 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.
tileSize number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

The tile size used by the tile service. Default is [256, 256] pixels.
tileUrlFunction ol.TileUrlFunctionType | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Optional function to get tile URL given a tile coordinate and the projection. Required if url or urls are not provided.
reprojectionErrorThreshold number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Maximum allowed reprojection error (in pixels). Default is 0.5. Higher values may increase reprojection performance, but decrease precision.
wrapX boolean | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Whether to wrap the world horizontally. The default, undefined, is to request out-of-bounds tiles from the server. When set to false, only one world will be rendered. When set to true, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds.
transition number | undefined

This option is an OpenLayers option passed to the ol.source.XYZ super class of the alk.source.XYZSource object from its subclasses.

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.

Extends

Members

service{alk.service.Service}

This is the service that was used to create the URL. It is not used internally, and just serves as a reference.

Methods

changeRoadSurfaceTileService(options)

This method causes an entire refresh of this source. It does this by creating a new RoadSurfaceTileService from the old one with the extended options.

Option Type Description
apiKey string

This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers.
dataset alk.val.Dataset | number | string

The option contains the Dataset parameter for the Service. This option specifies an area dataset that may be pertinent to the request.
format alk.val.Format | number

This option tells the Service in which format to deliver its image data.
height number | string

This option tells the service the height in which to return image data or tiles. The value is in pixels.
imgOption alk.val.ImgOption | number | string

This option tells the service which way to deliver the image data. Available values are 'Background', 'Foreground', and 'Both'.
imgSrc alk.val.ImgSrc | number | string

This option tells the service from where to get its image data. The available names, such as 'Sat1' and 'Sat2', have specific designations with ALK. Please see {TODO: Need Reference Here} for a current description.
region alk.val.Region | number | string

This option tells the service in which region the retrieved data is to pertain. Some ALK Services switch underlying services due to this option. For instance, traffic data for North America and Europe may come from different underlying services.
srs alk.val.SRS | number | string

This option tells the service the particular projection that is used any GIS data given to the service.
style alk.val.Style | number | string

This option tells the service the style of map that is requested. ALK has a number of different map styles, such as alk.val.Style.Night, and alk.val.Style.Terrain.
hostURL string

This option contains the the host and port URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used.
path string

This option is the path part of the URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used.
width number | string

This option tells the service the width in which to return image data or tiles. The value is in pixels.
hourOffset number | string

This option tells the service the hour offset in which to return image data or tiles. TODO: Better description.
provider alk.val.Provider | number | string

This option tells the service the provider in which to return image data or tiles. The options are Default or RC1.

getRoadSurfaceTileService(){alk.service.RoadSurfaceTileService}

setRoadSurfaceTileService(service)

Name Type Description
service alk.service.RoadSurfaceTileService

setService(service) inherited

This method sets the Service for this source. It generates a new URL.

Name Type Description
service alk.service.Service