Layer

Source: Layer.ts:108

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.

Fires

• event:visibilitychange
• event:baselayerchange
• 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

Constructor

Parameters

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

Instance Methods

hasImageryTiles(): boolean

Returns true if a layer has imagery tiles.

Returns

• boolean — Imagery tiles flag.

getID(): number

Gets layer identifier.

Returns

• number — Layer object id.

isEqual(layer: Layer): boolean

Compares layers instances.

Parameters

• layer (Layer) — Layer instance to compare.

Returns

• boolean — Returns true if the layer is the same instance as the input.

_assignPlanet(planet: Planet)

Assign the planet.

Parameters

• planet (Planet) — Planet render node.

_bindPicking()

Assign picking color to the layer.

addTo(planet: Planet)

Adds layer to the planet.

Parameters

• planet (Planet) — Adds layer to the planet.

remove(): Layer

Removes from a planet.

Returns

• Layer — This layer.

clear()

Clears layer material.

setAttribution(html: string)

Sets layer attribution text.

Parameters

• html (string) — HTML string that represents layer attribution.

getAttribution(): string

Gets layer attribution.

Returns

• string — Layer attribution.

setHeight(height: number)

Sets height over the ground.

Parameters

• height (number) — Layer height.

getHeight(): number

Gets layer height.

Returns

• number

setZIndex(zIndex: number)

Sets z-index.

Parameters

• zIndex (number) — Layer z-index.

getZIndex(): number

Gets z-index.

Returns

• number

bringToFront()

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

isBaseLayer(): boolean

Returns true if the layer is a base.

Returns

• boolean — Base layer flag.

setBaseLayer(isBaseLayer: boolean)

Sets base layer type flag.

Parameters

• isBaseLayer (boolean)

setVisibility(visibility: boolean)

Sets layer visibility.

Parameters

• visibility (boolean) — Layer visibility.

getVisibility(): boolean

Gets layer visibility.

Returns

• boolean — Layer visibility.

setExtent(extent: Extent)

Sets visible geographical extent.

Parameters

• extent (Extent) — Layer visible geographical extent.

getExtent(): Extent

Gets layer extent.

Returns

• Extent — Layer geodetic extent.

getExtentMerc(): Extent

Gets layer web-mercator extent.

Returns

• Extent — Layer extent.

flyExtent()

Fly extent.

viewExtent()

View extent.

_correctFullExtent()

Special correction of the whole globe extent.

Instance Fields

_pickingColor: Vec3

Layer picking color. Assign when added to the planet.

nightTextureCoefficient: number

Night texture blending coefficient.

_id

planet

Returns planet instance.