Class: WMS

Constructor

new WMS(name, options, extra)

Parameters:

Name Type Description

name

string

Layer name.

options

Object

Options:

Properties

Name	Type	Attributes	Default	Description
`opacity`	number	<optional>	1.0	Layer opacity.
`minZoom`	number	<optional>	0	Minimal visibility zoom level.
`maxZoom`	number	<optional>	0	Maximal visibility zoom level.
`attribution`	string	<optional>		Layer attribution that displayed in the attribution area on the screen.
`isBaseLayer`	boolean	<optional>	false	Base layer flag.
`visibility`	boolean	<optional>	true	Layer visibility.
`url`	string			WMS url source.
`width`	number	<optional>	256	Tile width.
`height`	number	<optional>	256	Tile height.
`layers`	string			WMS layers string.
`version`	string	<optional>	"1.1.1"	WMS version.

extra

Object

Extra parameters (by WMS reference or by WMS service vendors) to pass to WMS service.

Source: layer/WMS.ts, line 15

Extends

Members

_id

Overrides: XYZ#_id
Source: layer/Layer.ts, line 452

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

Overrides: XYZ#_pickingColor
Source: layer/Layer.ts, line 304

imageHeight :number

WMS tile height.

Type:

number

Source: layer/WMS.ts, line 94

imageWidth :number

WMS tile width.

Type:

number

Source: layer/WMS.ts, line 87

isIdle

Overrides: XYZ#isIdle
Source: layer/XYZ.ts, line 121

planet

Returns planet instance.

Overrides: XYZ#planet
Source: layer/Layer.ts, line 568

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

Overrides: XYZ#_assignPlanet
Source: layer/Layer.ts, line 469

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Overrides: XYZ#_bindPicking
Source: layer/Layer.ts, line 511

(protected) _correctFullExtent()

Overrides: XYZ#_correctFullExtent
Source: layer/XYZ.ts, line 353

(abstract, protected) _createUrl(segment) → {string}

Creates query url.

Parameters:

Name	Type	Description
`segment`	Segment	Creates specific url for current segment.

Overrides: XYZ#_createUrl
Source: layer/XYZ.ts, line 236

Returns:

Returns url string.

Type:: string

(protected) _getHTTPRequestString(segment) → {string}

Returns actual url query string.

Parameters:

Name	Type	Description
`segment`	Segment	Segment that loads image data.

Overrides: XYZ#_getHTTPRequestString
Source: layer/XYZ.ts, line 257

Returns:

Url string.

Type:: string

abortLoading()

Abort loading tiles.

Overrides: XYZ#abortLoading
Source: layer/XYZ.ts, line 132

addTo(planet)

Adds layer to the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Adds layer to the planet.

Overrides: XYZ#addTo
Source: layer/Layer.ts, line 520

bringToFront()

Set zIndex to the maximal value depend on other layers on the planet.

Overrides: XYZ#bringToFront
Source: layer/Layer.ts, line 634

(abstract) clear()

Clears layer material.

Overrides: XYZ#clear
Source: layer/Layer.ts, line 558

flyExtent()

Fly extent.

Overrides: XYZ#flyExtent
Source: layer/Layer.ts, line 801

getAttribution() → {string}

Gets layer attribution.

Overrides: XYZ#getAttribution
Source: layer/Layer.ts, line 587

Returns:

Layer attribution

Type:: string

getExtent() → {Extent}

Gets layer extent.

Overrides: XYZ#getExtent
Source: layer/Layer.ts, line 782

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Overrides: XYZ#getExtentMerc
Source: layer/Layer.ts, line 791

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

Overrides: XYZ#getHeight
Source: layer/Layer.ts, line 606

Returns:

Type:: number

getID() → {string}

Gets layer identifier.

Overrides: XYZ#getID
Source: layer/Layer.ts, line 439

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}

Gets layer visibility.

Overrides: XYZ#getVisibility
Source: layer/Layer.ts, line 750

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

Overrides: XYZ#getZIndex
Source: layer/Layer.ts, line 625

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Overrides: XYZ#hasImageryTiles
Source: layer/Layer.ts, line 429

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Overrides: XYZ#isBaseLayer
Source: layer/Layer.ts, line 648

Returns:

Base layer flag.

Type:: boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:

Name	Type	Description
`layer`	Layer	Layer instance to compare.

Overrides: XYZ#isEqual
Source: layer/Layer.ts, line 459

Returns:

Returns true if the layers is the same instance of the input.

Type:: boolean

(abstract) loadMaterial(material, forceLoadingopt)

Start to load tile material.

Parameters:

Name	Type	Attributes	Default	Description
`material`	Material			Loads current material.
`forceLoading`	boolean	<optional>	false

Overrides: XYZ#loadMaterial
Source: layer/XYZ.ts, line 178

remove() → {Layer}

Removes from planet.

Overrides: XYZ#remove
Source: layer/Layer.ts, line 531

Returns:

-This layer.

Type:: Layer

setAttribution(html)

Sets layer attribution text.

Parameters:

Name	Type	Description
`html`	string	HTML code that represents layer attribution, it could be just a text.

Overrides: XYZ#setAttribution
Source: layer/Layer.ts, line 575

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

Overrides: XYZ#setBaseLayer
Source: layer/Layer.ts, line 657

setExtent(extent)

Sets visible geographical extent.

Parameters:

Name	Type	Description
`extent`	Extent	Layer visible geographical extent.

Overrides: XYZ#setExtent
Source: layer/Layer.ts, line 759

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

Overrides: XYZ#setHeight
Source: layer/Layer.ts, line 596

setUrl(url)

Sets imagery tiles url source template.

Parameters:

Name	Type	Description
`url`	string	Url template.

Overrides: XYZ#setUrl
Source: layer/XYZ.ts, line 162

Example

http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
where {z}, {x} and {y} - replaces by current tile values, {s} - random domain.

setUrlRewriteCallback(ur)

Sets url rewrite callback, used for custom url rewriting for every tile loading.

Parameters:

Name	Type	Description
`ur`	function	The callback that returns tile custom created url.

Overrides: XYZ#setUrlRewriteCallback
Source: layer/XYZ.ts, line 267

setVisibility(visibility)

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

Overrides: XYZ#setVisibility
Source: layer/XYZ.ts, line 142

setZIndex(zIndex)

Sets z-index.

Parameters:

Name	Type	Description
`zIndex`	number	Layer z-index.

Overrides: XYZ#setZIndex
Source: layer/Layer.ts, line 615

viewExtent()

View extent.

Overrides: XYZ#viewExtent
Source: layer/Layer.ts, line 809