On this page

Layer

Base class; normally only used for creating subclasses and not instantiated in apps. A visual representation of raster or vector map data well known as a layer.

Constructor

new Layer(nameopt, optionsopt)

Parameters:

Name Type Attributes Default Description

name

string | null

<optional>

"noname"

Layer name.

options

ILayerParams

<optional>

{}

Layer options.

Properties

Name	Type	Attributes	Default	Description
`properties`	*	<optional>	{}	Custom user properties.
`labelMaxLetters`	number	<optional>		Label max letters (reserved for specific layer implementations).
`hideInLayerSwitcher`	boolean	<optional>	false	Presence in LayerSwitcher control.
`opacity`	number	<optional>	1.0	Layer opacity.
`minZoom`	number	<optional>	0	Minimal visibility zoom level.
`maxZoom`	number	<optional>	50	Maximal visibility zoom level.
`attribution`	string	<optional>	""	Layer attribution shown in the attribution area.
`zIndex`	number	<optional>	0	Layer z-index.
`isBaseLayer`	boolean	<optional>	false	Base layer flag.
`defaultTextures`	Array.<IDefaultTextureParams>	<optional>	[null, null]	Default textures.
`visibility`	boolean	<optional>	true	Layer visibility.
`fading`	boolean	<optional>	false	Enables fade-in/fade-out opacity transitions.
`height`	number	<optional>	0	Height over the ground.
`textureFilter`	string	<optional>	"mipmap"	Image texture filter. Available values: "nearest", "linear", "mipmap" and "anisotropic".
`colorSpace`	string \| number	<optional>	"srgb"	Layer color space. Available values: "linear", "srgb", 0, 1.
`pickingEnabled`	boolean	<optional>	true	Enables layer picking.
`preLoadZoomLevels`	Array.<number>	<optional>	[0, 1]	Zoom levels to preload when layer becomes visible.
`extent`	Extent \| Array.<Array.<number>>	<optional>	[[-180.0, -90.0], [180.0, 90.0]]	Visible extent.
`ambient`	string \| NumberArray3 \| Vec3	<optional>		Ambient color.
`diffuse`	string \| NumberArray3 \| Vec3	<optional>		Diffuse color.
`specular`	string \| NumberArray3 \| Vec3	<optional>		Specular color.
`shininess`	number	<optional>	20.0	Specular shininess coefficient.
`nightTextureCoefficient`	number	<optional>	1.0	Night texture blending coefficient.
`iconSrc`	string \| null	<optional>	null	Icon for LayerSwitcher.
`waitForParentMaterial`	boolean	<optional>	true	Wait for parent material while loading current tile material.

Source: layer/Layer.ts, line 48

Fires:

Members

_id

Source: layer/Layer.ts, line 471

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

Source: layer/Layer.ts, line 317

planet

Returns planet instance.

Source: layer/Layer.ts, line 586

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

Source: layer/Layer.ts, line 488

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Source: layer/Layer.ts, line 529

(protected) _correctFullExtent()

Special correction of the whole globe extent.

Source: layer/Layer.ts, line 837

addTo(planet)

Adds layer to the planet.

Parameters:

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

Source: layer/Layer.ts, line 538

bringToFront()

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

Source: layer/Layer.ts, line 652

(abstract) clear()

Clears layer material.

Source: layer/Layer.ts, line 576

flyExtent()

Fly extent.

Source: layer/Layer.ts, line 821

getAttribution() → {string}

Gets layer attribution.

Source: layer/Layer.ts, line 605

Returns:

Layer attribution.

Type:: string

getExtent() → {Extent}

Gets layer extent.

Source: layer/Layer.ts, line 803

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Source: layer/Layer.ts, line 812

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

Source: layer/Layer.ts, line 624

Returns:

Type:: number

getID() → {number}

Gets layer identifier.

Source: layer/Layer.ts, line 458

Returns:

Layer object id.

Type:: number

getVisibility() → {boolean}

Gets layer visibility.

Source: layer/Layer.ts, line 771

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

Source: layer/Layer.ts, line 643

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Source: layer/Layer.ts, line 448

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Source: layer/Layer.ts, line 666

Returns:

Base layer flag.

Type:: boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:

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

Source: layer/Layer.ts, line 478

Returns:

Returns true if the layer is the same instance as the input.

Type:: boolean

remove() → {Layer}

Removes from a planet.

Source: layer/Layer.ts, line 549

Returns:

This layer.

Type:: Layer

setAttribution(html)

Sets layer attribution text.

Parameters:

Name	Type	Description
`html`	string	HTML string that represents layer attribution.

Source: layer/Layer.ts, line 593

setBaseLayer(isBaseLayer)

Sets base layer type flag.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

Source: layer/Layer.ts, line 675

setExtent(extent)

Sets visible geographical extent.

Parameters:

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

Source: layer/Layer.ts, line 780

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

Source: layer/Layer.ts, line 614

(abstract) setVisibility(visibility)

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

Source: layer/Layer.ts, line 694

setZIndex(zIndex)

Sets z-index.

Parameters:

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

Source: layer/Layer.ts, line 633

viewExtent()

View extent.

Source: layer/Layer.ts, line 829