Class: XYZ

Constructor#

new XYZ(name, options:)#

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Layer name.
`options:`	IXYZParams
`options.opacity`	number	<optional>	1.0	Layer opacity.
`options.subdomains`	Array.<string>	<optional>	['a','b','c']	Subdomains of the tile service.
`options.minZoom`	number	<optional>	0	Minimal visibility zoom level.
`options.maxZoom`	number	<optional>	0	Maximal visibility zoom level.
`options.minNativeZoom`	number	<optional>	0	Minimal available zoom level.
`options.maxNativeZoom`	number	<optional>	19	Maximal available zoom level.
`options.attribution`	string	<optional>		Layer attribution that displayed in the attribution area on the screen.
`options.isBaseLayer`	boolean	<optional>	false	Base layer flag.
`options.visibility`	boolean	<optional>	true	Layer visibility.
`options.crossOrigin`	string	<optional>	true	If true, all tiles will have their crossOrigin attribute set to ''.
`options.url`	string			Tile url source template(see example below).
`options.textureFilter`	string			texture gl filter. NEAREST, LINEAR, MIPMAP, ANISOTROPIC.
`options.urlRewrite`	function			Url rewrite function.

Source: layer/XYZ.ts, line 26

Fires:

EventsHandler#event:load
EventsHandler#event:loadend

Example

Creates OpenStreetMap base tile layer

CODE

 new og.layer.XYZ("OpenStreetMap", {
    isBaseLayer: true,
    url: "http://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
    visibility: true,
    attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>'
});

Extends#

Layer

Members#

_id#

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

(protected) _pickingColor :Vec3#

Layer picking color. Assign when added to the planet.

Type:

Vec3

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

isIdle#

Source: layer/XYZ.ts, line 121

planet#

Returns planet instance.

Overrides: Layer#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: Layer#_assignPlanet
Source: layer/Layer.ts, line 469

(abstract, protected) _bindPicking()#

Assign picking color to the layer.

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

(protected) _correctFullExtent()#

Overrides: Layer#_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.

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.

Source: layer/XYZ.ts, line 257

Returns:

Url string.

Type:: string

abortLoading()#

Abort loading tiles.

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: Layer#addTo
Source: layer/Layer.ts, line 520

bringToFront()#

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

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

(abstract) clear()#

Clears layer material.

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

flyExtent()#

Fly extent.

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

getAttribution() → {string}#

Gets layer attribution.

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

Returns:

Layer attribution

Type:: string

getExtent() → {Extent}#

Gets layer extent.

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

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}#

Gets layer web-mercator extent.

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

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}#

Gets layer height.

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

Returns:

Type:: number

getID() → {string}#

Gets layer identifier.

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

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}#

Gets layer visibility.

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

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}#

Gets z-index.

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

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}#

Returns true if a layer has imagery tiles.

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

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}#

Returns true if the layer is a base.

Overrides: Layer#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: Layer#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

Source: layer/XYZ.ts, line 178

remove() → {Layer}#

Removes from planet.

Overrides: Layer#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: Layer#setAttribution
Source: layer/Layer.ts, line 575

setBaseLayer(isBaseLayer)#

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

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

setExtent(extent)#

Sets visible geographical extent.

Parameters:

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

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

setHeight(height)#

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

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

setUrl(url)#

Sets imagery tiles url source template.

Parameters:

Name	Type	Description
`url`	string	Url template.

Source: layer/XYZ.ts, line 162

Example

CODE

 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.

Source: layer/XYZ.ts, line 267

setVisibility(visibility)#

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

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

setZIndex(zIndex)#

Sets z-index.

Parameters:

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

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

viewExtent()#

View extent.

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

	new og.layer.XYZ("OpenStreetMap", {
	isBaseLayer: true,
	url: "http://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
	visibility: true,
	attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>'
	});

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