OpenGlobus v1.0.0-rc27

XYZ

Extends: Layer

Source: XYZ.ts:61

Represents an imagery tiles source provider.

Fires

  • event:load
  • event:loadend

Example

Creates OpenStreetMap base tile layer

CODE
new og.layer.XYZ("OpenStreetMap", {
    isBaseLayer: true,
    url: "http://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
    visibility: true,
    attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>'
});

Constructor

new XYZ(name: string, options:: IXYZParams): XYZ

Parameters

  • name (string) — Layer name.
  • options: (IXYZParams)
  • options.opacity (number, optional, default: "1.0") — Layer opacity.
  • options.subdomains (Array.<string>, optional, default: "['a','b','c']") — Subdomains of the tile service.
  • options.minZoom (number, optional, default: 0) — Minimal visibility zoom level.
  • options.maxZoom (number, optional, default: 0) — Maximal visibility zoom level.
  • options.minNativeZoom (number, optional, default: 0) — Minimal available zoom level.
  • options.maxNativeZoom (number, optional, default: 19) — Maximal available zoom level.
  • options.attribution (string, optional) — Layer attribution shown in the attribution area.
  • options.isBaseLayer (boolean, optional, default: false) — Base layer flag.
  • options.visibility (boolean, optional, default: true) — Layer visibility.
  • options.crossOrigin (string, optional, default: true) — If true, all tiles will have their crossOrigin attribute set to ''.
  • options.url (string) — Tile url source template(see example below).
  • options.textureFilter (string) — Texture WebGL filter: NEAREST, LINEAR, MIPMAP, ANISOTROPIC.
  • options.urlRewrite (function) — URL rewrite function.

Instance Methods

abortLoading()

XYZ.ts:129

Abort loading tiles.

setVisibility(visibility: boolean)

XYZ.ts:140

Overrides: Layer#setVisibility

Sets layer visibility.

Parameters

  • visibility (boolean) — Layer visibility.

setUrl(url: string)

XYZ.ts:163

Sets imagery tiles url source template.

Parameters

  • url (string) — Url template.

Example

CODE
http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
where {z}, {x} and {y} - replaces by current tile values, {s} - random domain.

loadMaterial(material: Material, forceLoading?: boolean)

abstract
XYZ.ts:178

Start to load tile material.

Parameters

  • material (Material) — Loads current material.
  • forceLoading (boolean, optional, default: false)

_createUrl(segment: Segment): string

protectedabstract
XYZ.ts:237

Creates query url.

Parameters

  • segment (Segment) — Creates specific url for current segment.

Returns

  • string — URL string.

_getHTTPRequestString(segment: Segment): string

protected
XYZ.ts:261

Returns actual url query string.

Parameters

  • segment (Segment) — Segment that loads image data.

Returns

  • string — URL string.

setUrlRewriteCallback(ur: function)

XYZ.ts:270

Sets url rewrite callback, used for custom url rewriting for every tile loading.

Parameters

  • ur (function) — The callback that returns tile custom created url.

_correctFullExtent()

protected
XYZ.ts:423

Overrides: Layer#_correctFullExtent

hasImageryTiles(): boolean

abstract
Layer.ts:471

Inherited from Layer#hasImageryTiles

Overrides: Layer#hasImageryTiles

Returns true if a layer has imagery tiles.

Returns

  • boolean — Imagery tiles flag.

getID(): number

Layer.ts:480

Inherited from Layer#getID

Overrides: Layer#getID

Gets layer identifier.

Returns

  • number — Layer object id.

isEqual(layer: Layer): boolean

Layer.ts:501

Inherited from Layer#isEqual

Overrides: Layer#isEqual

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)

protectedabstract
Layer.ts:511

Inherited from Layer#_assignPlanet

Overrides: Layer#_assignPlanet

Assign the planet.

Parameters

  • planet (Planet) — Planet render node.

_bindPicking()

protectedabstract
Layer.ts:551

Inherited from Layer#_bindPicking

Overrides: Layer#_bindPicking

Assign picking color to the layer.

addTo(planet: Planet)

Layer.ts:560

Inherited from Layer#addTo

Overrides: Layer#addTo

Adds layer to the planet.

Parameters

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

remove(): Layer

Layer.ts:571

Inherited from Layer#remove

Overrides: Layer#remove

Removes from a planet.

Returns

clear()

abstract
Layer.ts:597

Inherited from Layer#clear

Overrides: Layer#clear

Clears layer material.

setAttribution(html: string)

Layer.ts:616

Inherited from Layer#setAttribution

Overrides: Layer#setAttribution

Sets layer attribution text.

Parameters

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

getAttribution(): string

Layer.ts:628

Inherited from Layer#getAttribution

Overrides: Layer#getAttribution

Gets layer attribution.

Returns

  • string — Layer attribution.

setHeight(height: number)

Layer.ts:637

Inherited from Layer#setHeight

Overrides: Layer#setHeight

Sets height over the ground.

Parameters

  • height (number) — Layer height.

getHeight(): number

Layer.ts:647

Inherited from Layer#getHeight

Overrides: Layer#getHeight

Gets layer height.

Returns

  • number

setZIndex(zIndex: number)

Layer.ts:656

Inherited from Layer#setZIndex

Overrides: Layer#setZIndex

Sets z-index.

Parameters

  • zIndex (number) — Layer z-index.

getZIndex(): number

Layer.ts:666

Inherited from Layer#getZIndex

Overrides: Layer#getZIndex

Gets z-index.

Returns

  • number

bringToFront()

Layer.ts:674

Inherited from Layer#bringToFront

Overrides: Layer#bringToFront

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

isBaseLayer(): boolean

Layer.ts:689

Inherited from Layer#isBaseLayer

Overrides: Layer#isBaseLayer

Returns true if the layer is a base.

Returns

  • boolean — Base layer flag.

setBaseLayer(isBaseLayer: boolean)

Layer.ts:698

Inherited from Layer#setBaseLayer

Overrides: Layer#setBaseLayer

Sets base layer type flag.

Parameters

  • isBaseLayer (boolean)

getVisibility(): boolean

Layer.ts:794

Inherited from Layer#getVisibility

Overrides: Layer#getVisibility

Gets layer visibility.

Returns

  • boolean — Layer visibility.

setExtent(extent: Extent)

Layer.ts:803

Inherited from Layer#setExtent

Overrides: Layer#setExtent

Sets visible geographical extent.

Parameters

  • extent (Extent) — Layer visible geographical extent.

getExtent(): Extent

Layer.ts:828

Inherited from Layer#getExtent

Overrides: Layer#getExtent

Gets layer extent.

Returns

  • Extent — Layer geodetic extent.

getExtentMerc(): Extent

Layer.ts:837

Inherited from Layer#getExtentMerc

Overrides: Layer#getExtentMerc

Gets layer web-mercator extent.

Returns

flyExtent()

Layer.ts:845

Inherited from Layer#flyExtent

Overrides: Layer#flyExtent

Fly extent.

viewExtent()

Layer.ts:853

Inherited from Layer#viewExtent

Overrides: Layer#viewExtent

View extent.

Instance Fields

isIdle

XYZ.ts:117

_pickingColor: Vec3

protected
Layer.ts:322

Inherited from Layer#_pickingColor

Overrides: Layer#_pickingColor

Layer picking color. Assign when added to the planet.

nightTextureCoefficient: number

Layer.ts:446

Inherited from Layer#nightTextureCoefficient

Overrides: Layer#nightTextureCoefficient

Night texture blending coefficient.

_id

Layer.ts:491

Inherited from Layer#_id

Overrides: Layer#_id

planet

Layer.ts:607

Inherited from Layer#planet

Overrides: Layer#planet

Returns planet instance.