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:
NameTypeAttributesDefaultDescription
nameString<optional>
"noname"

Layer name.

optionsObject<optional>

Layer options:

Properties
NameTypeAttributesDefaultDescription
opacitynumber<optional>
1.0

Layer opacity.

minZoomnumber<optional>
0

Minimal visibility zoom level.

maxZoomnumber<optional>
0

Maximal visibility zoom level.

attributionstring<optional>

Layer attribution shown in the attribution area.

isBaseLayerboolean<optional>
false

This is a base layer.

visibilityboolean<optional>
true

Layer visibility.

hideInLayerSwitcherboolean<optional>
false

Presence of layer in dialog window of LayerSwitcher control.

isSRGBboolean<optional>
false

Layer image WebGL internal format.

extentExtent<optional>
[[-180.0, -90.0], [180.0, 90.0]]

Visible extent.

textureFilterstring<optional>
"anisotropic"

Image texture filter. Available values: "nearest", "linear", "mipmap" and "anisotropic".

iconstring<optional>

Icon for LayerSwitcher

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

Members

_id

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

planet

Returns planet instance.

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:
NameTypeDescription
planetPlanet

Planet render node.

(abstract, protected) _bindPicking()

Assign picking color to the layer.

(protected) _correctFullExtent()

Special correction of the whole globe extent.

addTo(planet)

Adds layer to the planet.

Parameters:
NameTypeDescription
planetPlanet

Adds layer to the planet.

bringToFront()

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

(abstract) clear()

Clears layer material.

flyExtent()

Fly extent.

getAttribution() → {string}

Gets layer attribution.

Returns:

Layer attribution.

Type: 
string

getExtent() → {Extent}

Gets layer extent.

Returns:

Layer geodetic extent.

Type: 
Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Returns:

Layer extent.

Type: 
Extent

getHeight() → {number}

Gets layer height.

Returns:
Type: 
number

getID() → {number}

Gets layer identifier.

Returns:

Layer object id.

Type: 
number

getVisibility() → {boolean}

Gets layer visibility.

Returns:

Layer visibility.

Type: 
boolean

getZIndex() → {number}

Gets z-index.

Returns:
Type: 
number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Returns:

Imagery tiles flag.

Type: 
boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Returns:

Base layer flag.

Type: 
boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:
NameTypeDescription
layerLayer

Layer instance to compare.

Returns:

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

Type: 
boolean

remove() → {Layer}

Removes from planet.

Returns:

This layer.

Type: 
Layer

setAttribution(html)

Sets layer attribution text.

Parameters:
NameTypeDescription
htmlstring

HTML string that represents layer attribution.

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:
NameTypeDescription
isBaseLayerboolean

setExtent(extent)

Sets visible geographical extent.

Parameters:
NameTypeDescription
extentExtent

Layer visible geographical extent.

setHeight(height)

Sets height over the ground.

Parameters:
NameTypeDescription
heightnumber

Layer height.

(abstract) setVisibility(visibility)

Sets layer visibility.

Parameters:
NameTypeDescription
visibilityboolean

Layer visibility.

setZIndex(zIndex)

Sets z-index.

Parameters:
NameTypeDescription
zIndexnumber

Layer z-index.

viewExtent()

View extent.