ol. ol.source

Source:
  • source.jsdoc, line 1

Classes

ol.source.BingMaps
ol.source.DebugTileSource
ol.source.MapQuestOpenAerial
ol.source.MapQuestOSM
ol.source.OSM
ol.source.SingleImageWMS
ol.source.Stamen
ol.source.StaticImage
ol.source.TiledWMS
ol.source.TileJSON
ol.source.TileSource
ol.source.Vector
ol.source.VectorSource2
ol.source.WMTS

Members

<static> WMSGetFeatureInfoMethod :string

Method to use to get WMS feature info.

Properties:
Name Type Default Description
IFRAME string iframe

Load the info in an IFRAME. Only works with 'text/html and 'text/plain' as INFO_FORMAT.

XHR_GET string xhr_get

Use an asynchronous GET request. Requires CORS headers or a server at the same origin as the application script.

Source:
  • wmssource.js, line 13

TypeDefs

BingMapsOptions

Properties:
Name Type Description
culture string | undefined

Culture.

key string

Bing Maps API key. Get yours at http://bingmapsportal.com/.

style string

Style.

Source:
  • objectliterals.jsdoc, line 85

DebugTileSourceOptions

Properties:
Name Type Description
extent ol.Extent | undefined

Extent.

projection ol.ProjectionLike

Projection.

tileGrid ol.tilegrid.TileGrid | undefined

Tile grid.

Source:
  • objectliterals.jsdoc, line 87

OSMOptions

Properties:
Name Type Description
attribution ol.Attribution | undefined

Attribution.

attributions Array.<ol.Attribution> | undefined

Attributions.

maxZoom number | undefined

Max zoom.

url string | undefined

URL.

Source:
  • objectliterals.jsdoc, line 89

SingleImageWMSOptions

Properties:
Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.

crossOrigin null | string | undefined

crossOrigin setting for image requests.

extent ol.Extent | undefined

Extent.

getFeatureInfoOptions ol.source.WMSGetFeatureInfoOptions | undefined

Options for GetFeatureInfo.

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

resolutions Array.<number> | undefined

Resolutions. If specified, requests will be made for these resolutions only.

url string | undefined

WMS service url.

Source:
  • objectliterals.jsdoc, line 91

SourceOptions

Properties:
Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.

extent ol.Extent | undefined

Extent.

logo string | undefined

Logo.

projection ol.ProjectionLike

Projection.

Source:
  • objectliterals.jsdoc, line 93

StamenOptions

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.

url string | undefined

Url.

Source:
  • objectliterals.jsdoc, line 95

StaticImageOptions

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.

projection ol.ProjectionLike

Projection.

url string | undefined

Url.

Source:
  • objectliterals.jsdoc, line 97

TiledWMSOptions

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.

getFeatureInfoOptions ol.source.WMSGetFeatureInfoOptions | undefined

Options for GetFeatureInfo.

tileGrid ol.tilegrid.TileGrid | undefined

Tile grid.

maxZoom number | undefined

Maximum zoom.

projection ol.ProjectionLike

Projection.

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.

Source:
  • objectliterals.jsdoc, line 101

TileJSONOptions

Properties:
Name Type Description
crossOrigin null | string | undefined

crossOriin setting for image requests.

url string

Url.

Source:
  • objectliterals.jsdoc, line 99

VectorOptions

Properties:
Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.

data Object | string | undefined

Data to parse.

extent ol.Extent | undefined

Extent.

logo string | undefined

Logo.

parser ol.parser.Parser

Parser instance to parse data provided as data or fetched from url.

projection ol.ProjectionLike | undefined

Projection. Usually the projection is provided by the parser, so this only needs to be set if the parser does not know the SRS (e.g. in some GML flavors), or if the projection determined by the parser needs to be overridden.

url string | undefined

Server url providing the vector data.

Source:
  • objectliterals.jsdoc, line 103

VectorSource2Options

Properties:
Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.

extent ol.Extent | undefined

Extent.

lineStringCollections Array.<ol.geom2.LineStringCollection> | undefined

Line string collections.

pointCollections Array.<ol.geom2.PointCollection> | undefined

Point collections.

projection ol.ProjectionLike

Projection.

Source:
  • objectliterals.jsdoc, line 105

WMSGetFeatureInfoOptions

Properties:
Name Type Description
method ol.source.WMSGetFeatureInfoMethod

Method for requesting GetFeatureInfo. Default is ol.source.WMSGetFeatureInfoMethod.IFRAME.

params Object

Params for the GetFeatureInfo request. Default is {'INFO_FORMAT': 'text/html'}.

Source:
  • objectliterals.jsdoc, line 108

WMTSOptions

Properties:
Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.

crossOrigin string | null | undefined

crossOrigin setting for image requeests.

extent ol.Extent | undefined

Extent.

tileGrid ol.tilegrid.WMTS

Tile grid.

projection ol.ProjectionLike

Projection.

requestEncoding ol.source.WMTSRequestEncoding | undefined

Request encoding.

layer string

Layer.

style string

Style.

format string | undefined

Format.

matrixSet string

Matrix set.

dimensions Object | undefined

Dimensions.

url string | undefined

Url.

maxZoom number | undefined

Maximum zoom.

urls Array.<string> | undefined

Urls.

Source:
  • objectliterals.jsdoc, line 111