WMS

Extends: XYZ

Source: WMS.ts:48

Used to display WMS services as tile layers on the globe.

Constructor

Parameters

• name (string) — Layer name.
• options (Object) — Options:
  • options.opacity (number, optional, default: "1.0") — Layer opacity.
  • options.minZoom (number, optional, default: 0) — Minimal visibility zoom level.
  • options.maxZoom (number, optional, default: 0) — Maximal visibility zoom level.
  • options.attribution (string, optional) — Layer attribution shown in the attribution area.
  • options.isBaseLayer (boolean, optional, default: false) — Base layer flag.
  • options.visibility (boolean, optional, default: true) — Layer visibility.
  • options.url (string) — WMS url source.
  • options.width (number, optional, default: 256) — Tile width.
  • options.height (number, optional, default: 256) — Tile height.
  • options.layers (string) — WMS layers string.
  • options.version (string, optional, default: "\"1.1.1\"") — WMS version.
• extra (Object) — Extra parameters (by WMS reference or by WMS service vendors) to pass to WMS service.

Instance Methods

abortLoading()

Inherited from XYZ#abortLoading

Overrides: XYZ#abortLoading

Abort loading tiles.

setVisibility(visibility: boolean)

Inherited from XYZ#setVisibility

Overrides: XYZ#setVisibility

Sets layer visibility.

Parameters

• visibility (boolean) — Layer visibility.

setUrl(url: string)

Inherited from XYZ#setUrl

Overrides: XYZ#setUrl

Sets imagery tiles url source template.

Parameters

• url (string) — Url template.

Example

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

loadMaterial(material: Material, forceLoading?: boolean)

Inherited from XYZ#loadMaterial

Overrides: XYZ#loadMaterial

Start to load tile material.

Parameters

• material (Material) — Loads current material.
• forceLoading (boolean, optional, default: false)

_createUrl(segment: Segment): string

Inherited from XYZ#_createUrl

Overrides: XYZ#_createUrl

Creates query url.

Parameters

• segment (Segment) — Creates specific url for current segment.

Returns

• string — URL string.

_getHTTPRequestString(segment: Segment): string

Inherited from XYZ#_getHTTPRequestString

Overrides: XYZ#_getHTTPRequestString

Returns actual url query string.

Parameters

• segment (Segment) — Segment that loads image data.

Returns

• string — URL string.

setUrlRewriteCallback(ur: function)

Inherited from XYZ#setUrlRewriteCallback

Overrides: XYZ#setUrlRewriteCallback

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

Parameters

• ur (function) — The callback that returns tile custom created url.

_correctFullExtent()

Inherited from XYZ#_correctFullExtent

Overrides: XYZ#_correctFullExtent

hasImageryTiles(): boolean

Inherited from Layer#hasImageryTiles

Overrides: XYZ#hasImageryTiles

Returns true if a layer has imagery tiles.

Returns

• boolean — Imagery tiles flag.

getID(): number

Inherited from Layer#getID

Overrides: XYZ#getID

Gets layer identifier.

Returns

• number — Layer object id.

isEqual(layer: Layer): boolean

Inherited from Layer#isEqual

Overrides: XYZ#isEqual

Compares layers instances.

Parameters

• layer (Layer) — Layer instance to compare.

Returns

• boolean — Returns true if the layer is the same instance as the input.

_assignPlanet(planet: Planet)

Inherited from Layer#_assignPlanet

Overrides: XYZ#_assignPlanet

Assign the planet.

Parameters

• planet (Planet) — Planet render node.

_bindPicking()

Inherited from Layer#_bindPicking

Overrides: XYZ#_bindPicking

Assign picking color to the layer.

addTo(planet: Planet)

Inherited from Layer#addTo

Overrides: XYZ#addTo

Adds layer to the planet.

Parameters

• planet (Planet) — Adds layer to the planet.

remove(): Layer

Inherited from Layer#remove

Overrides: XYZ#remove

Removes from a planet.

Returns

• Layer — This layer.

clear()

Inherited from Layer#clear

Overrides: XYZ#clear

Clears layer material.

setAttribution(html: string)

Inherited from Layer#setAttribution

Overrides: XYZ#setAttribution

Sets layer attribution text.

Parameters

• html (string) — HTML string that represents layer attribution.

getAttribution(): string

Inherited from Layer#getAttribution

Overrides: XYZ#getAttribution

Gets layer attribution.

Returns

• string — Layer attribution.

setHeight(height: number)

Inherited from Layer#setHeight

Overrides: XYZ#setHeight

Sets height over the ground.

Parameters

• height (number) — Layer height.

getHeight(): number

Inherited from Layer#getHeight

Overrides: XYZ#getHeight

Gets layer height.

Returns

• number

setZIndex(zIndex: number)

Inherited from Layer#setZIndex

Overrides: XYZ#setZIndex

Sets z-index.

Parameters

• zIndex (number) — Layer z-index.

getZIndex(): number

Inherited from Layer#getZIndex

Overrides: XYZ#getZIndex

Gets z-index.

Returns

• number

bringToFront()

Inherited from Layer#bringToFront

Overrides: XYZ#bringToFront

Sets z-index to the maximum value relative to other layers on the planet.

isBaseLayer(): boolean

Inherited from Layer#isBaseLayer

Overrides: XYZ#isBaseLayer

Returns true if the layer is a base.

Returns

• boolean — Base layer flag.

setBaseLayer(isBaseLayer: boolean)

Inherited from Layer#setBaseLayer

Overrides: XYZ#setBaseLayer

Sets base layer type flag.

Parameters

• isBaseLayer (boolean)

getVisibility(): boolean

Inherited from Layer#getVisibility

Overrides: XYZ#getVisibility

Gets layer visibility.

Returns

• boolean — Layer visibility.

setExtent(extent: Extent)

Inherited from Layer#setExtent

Overrides: XYZ#setExtent

Sets visible geographical extent.

Parameters

• extent (Extent) — Layer visible geographical extent.

getExtent(): Extent

Inherited from Layer#getExtent

Overrides: XYZ#getExtent

Gets layer extent.

Returns

• Extent — Layer geodetic extent.

getExtentMerc(): Extent

Inherited from Layer#getExtentMerc

Overrides: XYZ#getExtentMerc

Gets layer web-mercator extent.

Returns

• Extent — Layer extent.

flyExtent()

Inherited from Layer#flyExtent

Overrides: XYZ#flyExtent

Fly extent.

viewExtent()

Inherited from Layer#viewExtent

Overrides: XYZ#viewExtent

View extent.

Instance Fields

imageWidth: number

WMS tile width.

imageHeight: number

WMS tile height.

isIdle

Inherited from XYZ#isIdle

Overrides: XYZ#isIdle

_pickingColor: Vec3

Inherited from Layer#_pickingColor

Overrides: XYZ#_pickingColor

Layer picking color. Assign when added to the planet.

nightTextureCoefficient: number

Inherited from Layer#nightTextureCoefficient

Overrides: XYZ#nightTextureCoefficient

Night texture blending coefficient.

_id

Inherited from Layer#_id

Overrides: XYZ#_id

planet

Inherited from Layer#planet

Overrides: XYZ#planet

Returns planet instance.