openglobus

Class: Layer

og/layer/Layer~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.

new Layer(name, options)

og/layer/Layer.js, line 61
Name Type Default Description
name String "noname" optional Layer name.
options Object optional Layer options:
Name Type Default Description
opacity number 1.0 optional Layer opacity.
minZoom number 0 optional Minimal visibility zoom level.
maxZoom number 0 optional Maximal visibility zoom level.
attribution string optional Layer attribution that displayed in the attribution area on the screen.
isBaseLayer boolean false optional This is a base layer.
visibility boolean true optional Layer visibility.
isSRGB boolean false optional Layer image webgl nternal format.
extent Extent [[-180.0, -90.0], [180.0, 90.0]] optional Visible extent.
textureFilter string "anisotropic" optional Image texture filter. Available values: "nearest", "linear", "mipmap" and "anisotropic".
Fires:
  • - Triggered when layer visibilty chanched.
  • - Triggered when layer has added to the planet.
  • - Triggered when layer has removed from the planet.

Members

static,constantmodule:og/layer/Layer~Layer.MAX_REQUESTSnumber

Maximum loading queries at one time.

protected_attributionstring

Layer attribution.

protected_extentExtent

Visible degrees extent.

protected_extentMercExtent

Visible mercator extent.

protected_heightnumber

Height over the ground.

protected_idnumber

Unic identifier.

protected_isBaseLayerboolean

Base layer type flag.

_opacitynumber

Layer global opacity.

protected_pickingColorVec3

Layer picking color. Assign when added to the planet.

protected_planetPlanet

Planet node.

protected_visibilityboolean

Layer visibility.

protected_zIndexnumber

Layer z-index.

eventsEvents

Events handler.

maxZoomnumber

Maximal zoom level when layer is visibile.

minZoomnumber

Minimal zoom level when layer is visibile.

namestring

Layer user name.

abstractplanet

Returns planet instance.

Methods

abstract,protected_assignPlanet(planet)

og/layer/Layer.js, line 316
Assign the planet.
Name Type Description
planet Planet Planet render node.

abstract,protected_bindPicking()

og/layer/Layer.js, line 343
Assign picking color to the layer.

protected_correctFullExtent()

og/layer/Layer.js, line 554
Special correction of the whole globe extent.

addTo(planet)

og/layer/Layer.js, line 352
Adds layer to the planet.
Name Type Description
planet Planet Adds layer to the planet.

bringToFront()

og/layer/Layer.js, line 455
Set zIndex to the maximal value depend on other layers on the planet.

abstractclear()

og/layer/Layer.js, line 387
Clears layer material.

getExtent(){Extent}

og/layer/Layer.js, line 546
Gets layer extent.
Returns:
Type Description
Extent - Layer geodetic extent.

getHeight(){number}

og/layer/Layer.js, line 428
Gets layer height.
Returns:
Type Description
number -

getID(){string}

og/layer/Layer.js, line 296
Gets layer identifier.
Returns:
Type Description
string - Layer object id.

getVisibility(){boolean}

og/layer/Layer.js, line 518
Gets layer visibility.
Returns:
Type Description
boolean - Layer visibility.

getZIndex(){number}

og/layer/Layer.js, line 447
Gets z-index.
Returns:
Type Description
number -

abstracthasImageryTiles(){boolean}

og/layer/Layer.js, line 287
Returns true if a layer has imagery tiles.
Returns:
Type Description
boolean - Imagery tiles flag.

isBaseLayer(){boolean}

og/layer/Layer.js, line 470
Returns true if the layer is a base.
Returns:
Type Description
boolean - Base layer flag.

isEqual(layer){boolean}

og/layer/Layer.js, line 306
Compares layers instances.
Name Type Description
layer Layer Layer instance to compare.
Returns:
Type Description
boolean - Returns true if the layers is the same instance of the input.

remove(){Layer}

og/layer/Layer.js, line 364
Removes from planet.
Returns:
Type Description
Layer -This layer.

setAttribution(html)

og/layer/Layer.js, line 408
Sets layer attribution text.
Name Type Description
html string HTML code that represents layer attribution, it could be just a text.

setBaseLayer(flag)

og/layer/Layer.js, line 479
Sets base layer type true.
Name Type Description
flag boolean Base layer flag.

setExtent(extent)

og/layer/Layer.js, line 527
Sets visible geographical extent.
Name Type Description
extent Extent Layer visible geographical extent.

setHeight(height)

og/layer/Layer.js, line 418
Sets height over the ground.
Name Type Description
height number Layer height.

abstractsetVisibility(visibility)

og/layer/Layer.js, line 495
Sets layer visibility.
Name Type Description
visibility boolean Layer visibility.

setZIndex(zIndex)

og/layer/Layer.js, line 437
Sets z-index.
Name Type Description
zIndex number Layer z-index.