OpenLayers 3 API Documentation

Namespace: source

olx. source

Type Definitions

experimental olx.source.BingMapsOptionsObject

Properties:

Name	Type	Description
`culture`	string \| undefined	Culture code. Default is `en-us`.
`key`	string	Bing Maps API key. Get yours at http://bingmapsportal.com/.
`imagerySet`	string	Type of imagery.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.

experimental olx.source.FormatVectorOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`extent`	ol.Extent \| undefined	Extent.
`format`	ol.format.Feature	Format.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection.

experimental olx.source.GeoJSONOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`defaultProjection`	ol.proj.ProjectionLike	Default projection.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`object`	GeoJSONObject \| undefined	Object.
`projection`	ol.proj.ProjectionLike	Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.
`urls`	Array.<string> \| undefined	URLs.

experimental olx.source.GPXOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`doc`	Document \| undefined	Document.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`node`	Node \| undefined	Node.
`projection`	ol.proj.ProjectionLike	Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.
`urls`	Array.<string> \| undefined	URLs.

experimental olx.source.IGCOptionsObject

Properties:

Name	Type	Description
`altitudeMode`	ol.format.IGCZ \| undefined	Altitude mode. Possible values are `barometric`, `gps`, and `none`. Default is `none`.
`projection`	ol.proj.ProjectionLike	Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.
`urls`	Array.<string> \| undefined	URLs.

experimental olx.source.ImageCanvasOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`canvasFunction`	ol.CanvasFunctionType	Canvas function. The function returning the canvas element used by the source as an image. The arguments passed to the function are: `{ol.Extent}` the image extent, `{number}` the image resolution, `{number}` the device pixel ratio, `{ol.Size}` the image size, and `{ol.proj.Projection}` the image projection. The canvas returned by this function is cached by the source. If the value returned by the function is later changed then `dispatchChangeEvent` should be called on the source for the source to invalidate the current cached image.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection.
`ratio`	number \| undefined	Ratio. 1 means canvases are the size of the map viewport, 2 means twice the size of the map viewport, and so on. Default is `1.5`.
`resolutions`	Array.<number> \| undefined	Resolutions. If specified, new canvases will be created for these resolutions only.
`state`	ol.source.State \| string \| undefined	Source state.

experimental olx.source.ImageStaticOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	crossOrigin setting for image requests.
`extent`	ol.Extent \| undefined	Extent.
`imageExtent`	ol.Extent \| undefined	Extent of the image.
`imageSize`	ol.Size \| undefined	Size of the image.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection.
`url`	string	Url.

experimental olx.source.ImageVectorOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection.
`ratio`	number \| undefined	Ratio. 1 means canvases are the size of the map viewport, 2 means twice the size of the map viewport, and so on. Default is `1.5`.
`resolutions`	Array.<number> \| undefined	Resolutions. If specified, new canvases will be created for these resolutions only.
`source`	ol.source.Vector	The vector source from which the vector features drawn in canvas elements are read.
`style`	ol.style.Style \| Array.<ol.style.Style> \| ol.feature.StyleFunction \| undefined	Style to use when rendering features to the canvas.

experimental olx.source.ImageWMSOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	crossOrigin setting for image requests.
`extent`	ol.Extent \| undefined	Extent.
`hidpi`	boolean \| undefined	Use the `ol.Map#pixelRatio` value when requesting the image from the remote server. Default is `true`.
`serverType`	ol.source.wms.ServerType \| string \| undefined	The type of the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only needed if `hidpi` is `true`. Default is `undefined`.
`logo`	string \| undefined	Logo.
`params`	Object.<string, *>	WMS request parameters. At least a `LAYERS` param is required. `STYLES` is `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically.
`projection`	ol.proj.ProjectionLike	Projection.
`ratio`	number \| undefined	Ratio. `1` means image requests are the size of the map viewport, `2` means twice the size of the map viewport, and so on. Default is `1.5`.
`resolutions`	Array.<number> \| undefined	Resolutions. If specified, requests will be made for these resolutions only.
`url`	string \| undefined	WMS service URL.

experimental olx.source.KMLOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`defaultStyle`	Array.<ol.style.Style> \| undefined	Default style.
`doc`	Document \| undefined	Document.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`node`	Node \| undefined	Node.
`projection`	ol.proj.ProjectionLike	Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.
`urls`	Array.<string> \| undefined	URLs.

experimental olx.source.MapGuideOptionsObject

Properties:

Name	Type	Description
`url`	string \| undefined	The mapagent url.
`displayDpi`	number \| undefined	The display resolution. Default is `96`.
`metersPerUnit`	number \| undefined	The meters-per-unit value. Default is `1`.
`extent`	ol.Extent \| undefined	Extent.
`hidpi`	boolean \| undefined	Use the `ol.Map#pixelRatio` value when requesting the image from the remote server. Default is `true`.
`useOverlay`	boolean \| undefined	If `true`, will use `GETDYNAMICMAPOVERLAYIMAGE`.
`projection`	ol.proj.ProjectionLike	Projection.
`ratio`	number \| undefined	Ratio. `1` means image requests are the size of the map viewport, `2` means twice the size of the map viewport, and so on. Default is `1`.
`resolutions`	Array.<number> \| undefined	Resolutions. If specified, requests will be made for these resolutions only.
`params`	Object \| undefined	Additional parameters.

experimental olx.source.MapQuestOptionsObject

Properties:

Name	Type	Description
`layer`	string	Layer. Possible values are `osm`, `sat`, and `hyb`.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.

experimental olx.source.OSMOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	crossOrigin setting for image requests. Default is `anonymous`.
`maxZoom`	number \| undefined	Max zoom.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`url`	string \| undefined	URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders. Default is `//{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png`.

experimental olx.source.OSMXMLOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`defaultStyle`	Array.<ol.style.Style> \| undefined	Default style.
`doc`	Document \| undefined	Document.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`node`	Node \| undefined	Node.
`projection`	ol.proj.ProjectionLike	Projection.
`reprojectTo`	ol.proj.ProjectionLike	Re-project to.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.
`urls`	Array.<string> \| undefined	URLs.

experimental olx.source.ServerVectorOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`extent`	ol.Extent \| undefined	Extent.
`format`	ol.format.Feature	Format.
`loader`	function	Loading function.
`strategy`	function	Loading strategy. Default is `ol.loadingstrategy.bbox`.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection.

experimental olx.source.StamenOptionsObject

Properties:

Name	Type	Description
`layer`	string	Layer.
`minZoom`	number \| undefined	Minimum zoom.
`maxZoom`	number \| undefined	Maximum zoom.
`opaque`	boolean \| undefined	Whether the layer is opaque.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`url`	string \| undefined	URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.

experimental olx.source.StaticVectorOptionsObject

Properties:

Name	Type	Description
`arrayBuffer`	ArrayBuffer \| undefined	Array buffer.
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`doc`	Document \| undefined	Document.
`extent`	ol.Extent \| undefined	Extent.
`format`	ol.format.Feature	Format.
`logo`	string \| undefined	Logo.
`node`	Node \| undefined	Node.
`object`	Object \| undefined	Object.
`projection`	ol.proj.ProjectionLike	Projection.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.
`urls`	Array.<string> \| undefined	URLs.

experimental olx.source.TileDebugOptionsObject

Properties:

Name	Type	Description
`extent`	ol.Extent \| undefined	Extent.
`projection`	ol.proj.ProjectionLike	Projection.
`tileGrid`	ol.tilegrid.TileGrid \| undefined	Tile grid.

experimental olx.source.TileImageOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	crossOrigin setting for image requests. Default is `null`.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`opaque`	boolean \| undefined	Whether the layer is opaque.
`projection`	ol.proj.ProjectionLike	Projection.
`tileClass`	function \| undefined	tile class
`tileGrid`	ol.tilegrid.TileGrid \| undefined	Tile grid.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`tileUrlFunction`	ol.TileUrlFunctionType \| undefined	Optional function to get tile URL given a tile coordinate and the projection.

experimental olx.source.TileJSONOptionsObject

Properties:

Name	Type	Description
`crossOrigin`	null \| string \| undefined	crossOrigin setting for image requests.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`url`	string	URL to the TileJSON file.

experimental olx.source.TileVectorOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`defaultProjection`	ol.proj.ProjectionLike	Default projection.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`object`	GeoJSONObject \| undefined	Object.
`projection`	ol.proj.ProjectionLike	Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
`tileGrid`	ol.tilegrid.TileGrid	Tile grid.
`tileUrlFunction`	ol.TileUrlFunctionType \| undefined	Optional function to get tile URL given a tile coordinate and the projection. Required if url or urls are not provided.
`url`	string \| undefined	URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
`urls`	Array.<string> \| undefined	An array of URL templates.

experimental olx.source.TileWMSOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`params`	Object.<string, *>	WMS request parameters. At least a `LAYERS` param is required. `STYLES` is `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically.
`crossOrigin`	null \| string \| undefined	crossOrigin setting for image requests.
`extent`	ol.Extent \| undefined	Extent.
`gutter`	number \| undefined	The size in pixels of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of `2 x gutter`. Defaults to zero. Using a non-zero value allows artifacts of rendering at tile edges to be ignored. If you control the WMS service it is recommended to address "artifacts at tile edges" issues by properly configuring the WMS service. For example, MapServer has a `tile_map_edge_buffer` configuration parameter for this. See http://mapserver.org/output/tile_mode.html.
`hidpi`	boolean \| undefined	Use the `ol.Map#pixelRatio` value when requesting the image from the remote server. Default is `true`.
`logo`	string \| undefined	Logo.
`tileGrid`	ol.tilegrid.TileGrid \| undefined	Tile grid.
`maxZoom`	number \| undefined	Maximum zoom.
`projection`	ol.proj.ProjectionLike	Projection.
`serverType`	ol.source.wms.ServerType \| string \| undefined	The type of the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only needed if `hidpi` is `true`. Default is `undefined`.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`url`	string \| undefined	WMS service URL.
`urls`	Array.<string> \| undefined	WMS service urls. Use this instead of `url` when the WMS supports multiple urls for GetMap requests.

experimental olx.source.TopoJSONOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`defaultProjection`	ol.proj.ProjectionLike	Default projection.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`object`	GeoJSONObject \| undefined	Object.
`projection`	ol.proj.ProjectionLike	Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
`text`	string \| undefined	Text.
`url`	string \| undefined	URL.

experimental olx.source.VectorOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`extent`	ol.Extent \| undefined	Extent.
`features`	Array.<ol.Feature> \| undefined	Features.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection.
`state`	ol.source.State \| string \| undefined	State.

experimental olx.source.WMTSOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	string \| null \| undefined	crossOrigin setting for image requests.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`tileGrid`	ol.tilegrid.WMTS	Tile grid.
`projection`	ol.proj.ProjectionLike	Projection.
`requestEncoding`	ol.source.WMTSRequestEncoding \| undefined	Request encoding.
`layer`	string	Layer.
`style`	string	Style.
`version`	string \| undefined	WMTS version. Default to `1.0.0`.
`format`	string \| undefined	Format.
`matrixSet`	string	Matrix set.
`dimensions`	Object \| undefined	Dimensions.
`url`	string \| undefined	URL.
`maxZoom`	number \| undefined	Maximum zoom.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`urls`	Array.<string> \| undefined	Urls.

experimental olx.source.XYZOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	Cross origin setting for image requests.
`extent`	ol.Extent \| undefined	Extent.
`logo`	string \| undefined	Logo.
`projection`	ol.proj.ProjectionLike	Projection. Default is `EPSG:3857`.
`maxZoom`	number \| undefined	Optional max zoom level. Default is `18`.
`minZoom`	number \| undefined	Unsupported (TODO: remove this).
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	Optional function to load a tile given a URL.
`tileUrlFunction`	ol.TileUrlFunctionType \| undefined	Optional function to get tile URL given a tile coordinate and the projection. Required if url or urls are not provided.
`url`	string \| undefined	URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
`urls`	Array.<string> \| undefined	An array of URL templates.
`wrapX`	boolean \| undefined	Whether to wrap the world horizontally. Default is `true`.

experimental olx.source.ZoomifyOptionsObject

Properties:

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	Cross origin setting for image requests.
`logo`	string \| undefined	Logo.
`url`	string	Prefix of URL template.
`tierSizeCalculation`	string \| undefined	Tier size calculation method: `default` or `truncated`.
`size`	ol.Size	Size of the image.