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

<optional>

"noname"

Layer name.

options

Object

<optional>

Layer 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	This is a base layer.
`visibility`	boolean	<optional>	true	Layer visibility.
`hideInLayerSwitcher`	boolean	<optional>	false	Presence of layer in dialog window of LayerSwitcher control.
`isSRGB`	boolean	<optional>	false	Layer image webgl internal format.
`extent`	Extent	<optional>	[[-180.0, -90.0], [180.0, 90.0]]	Visible extent.
`textureFilter`	string	<optional>	"anisotropic"	Image texture filter. Available values: "nearest", "linear", "mipmap" and "anisotropic".
`icon`	string	<optional>		Icon for LayerSwitcher

Source: layer/Layer.ts, line 44

Fires:

EventsHandler#event:visibilitychange
EventsHandler#event:add
EventsHandler#event:remove
EventsHandler#event:mousemove
EventsHandler#event:mouseenter
EventsHandler#event:mouseleave
EventsHandler#event:lclick
EventsHandler#event:rclick
EventsHandler#event:mclick
EventsHandler#event:ldblclick
EventsHandler#event:rdblclick
EventsHandler#event:mdblclick
EventsHandler#event:lup
EventsHandler#event:rup
EventsHandler#event:mup
EventsHandler#event:ldown
EventsHandler#event:rdown
EventsHandler#event:mdown
EventsHandler#event:lhold
EventsHandler#event:rhold
EventsHandler#event:mhold
EventsHandler#event:mousewheel
EventsHandler#event:touchmove
EventsHandler#event:touchstart
EventsHandler#event:touchend
EventsHandler#event:doubletouch

Members

_id

Source: layer/Layer.ts, line 452

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

Source: layer/Layer.ts, line 304

planet

Returns planet instance.

Source: layer/Layer.ts, line 568

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

Source: layer/Layer.ts, line 469

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Source: layer/Layer.ts, line 511

(protected) _correctFullExtent()

Special correction of the whole globe extent.

Source: layer/Layer.ts, line 817

addTo(planet)

Adds layer to the planet.

Parameters:

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

Source: layer/Layer.ts, line 520

bringToFront()

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

Source: layer/Layer.ts, line 634

(abstract) clear()

Clears layer material.

Source: layer/Layer.ts, line 558

flyExtent()

Fly extent.

Source: layer/Layer.ts, line 801

getAttribution() → {string}

Gets layer attribution.

Source: layer/Layer.ts, line 587

Returns:

Layer attribution

Type:: string

getExtent() → {Extent}

Gets layer extent.

Source: layer/Layer.ts, line 782

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Source: layer/Layer.ts, line 791

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

Source: layer/Layer.ts, line 606

Returns:

Type:: number

getID() → {string}

Gets layer identifier.

Source: layer/Layer.ts, line 439

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}

Gets layer visibility.

Source: layer/Layer.ts, line 750

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

Source: layer/Layer.ts, line 625

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Source: layer/Layer.ts, line 429

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

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.

Source: layer/Layer.ts, line 459

Returns:

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

Type:: boolean

remove() → {Layer}

Removes from planet.

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.

Source: layer/Layer.ts, line 575

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

Source: layer/Layer.ts, line 657

setExtent(extent)

Sets visible geographical extent.

Parameters:

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

Source: layer/Layer.ts, line 759

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

Source: layer/Layer.ts, line 596

(abstract) setVisibility(visibility)

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

Source: layer/Layer.ts, line 672

setZIndex(zIndex)

Sets z-index.

Parameters:

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

Source: layer/Layer.ts, line 615

viewExtent()

View extent.

Source: layer/Layer.ts, line 809