CanvasTiles

Extends: Layer

Source: CanvasTiles.ts:56

Layer that renders each tile as a separate canvas object.

Fires

• event:load
• event:loadend

Constructor

Parameters

• name (string, optional, default: "\"noname\"") — Layer name.
• options (ICanvasTilesParams) — Layer options.
  • 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) — 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.animated (boolean, optional, default: false) — Re-draw ready tiles every frame.
  • options.minNativeZoom (number, optional, default: 0) — Minimal zoom level where native tile drawing is allowed.
  • options.maxNativeZoom (number, optional, default: 100) — Maximal zoom level where native tile drawing is allowed.
  • options.drawTile (DrawTileCallback) — Draw tile callback.

Instance Methods

abortLoading()

Abort loading tiles.

setVisibility(visibility: boolean)

Overrides: Layer#setVisibility

Sets layer visibility.

Parameters

• visibility (boolean) — Layer visibility.

loadMaterial(material: Material)

Start to load tile material.

Parameters

• material (Material)

_exec(material: Material)

Loads material image and apply it to the planet segment.

Parameters

• material (Material) — Loads material image.

abortMaterialLoading(material: Material)

Abort exact material loading.

Parameters

• material (Material) — Segment material.

hasImageryTiles(): boolean

Inherited from Layer#hasImageryTiles

Overrides: Layer#hasImageryTiles

Returns true if a layer has imagery tiles.

Returns

• boolean — Imagery tiles flag.

getID(): number

Inherited from Layer#getID

Overrides: Layer#getID

Gets layer identifier.

Returns

• number — Layer object id.

isEqual(layer: Layer): boolean

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)

Inherited from Layer#_assignPlanet

Overrides: Layer#_assignPlanet

Assign the planet.

Parameters

• planet (Planet) — Planet render node.

_bindPicking()

Inherited from Layer#_bindPicking

Overrides: Layer#_bindPicking

Assign picking color to the layer.

addTo(planet: Planet)

Inherited from Layer#addTo

Overrides: Layer#addTo

Adds layer to the planet.

Parameters

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

remove(): Layer

Inherited from Layer#remove

Overrides: Layer#remove

Removes from a planet.

Returns

• Layer — This layer.

clear()

Inherited from Layer#clear

Overrides: Layer#clear

Clears layer material.

setAttribution(html: string)

Inherited from Layer#setAttribution

Overrides: Layer#setAttribution

Sets layer attribution text.

Parameters

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

getAttribution(): string

Inherited from Layer#getAttribution

Overrides: Layer#getAttribution

Gets layer attribution.

Returns

• string — Layer attribution.

setHeight(height: number)

Inherited from Layer#setHeight

Overrides: Layer#setHeight

Sets height over the ground.

Parameters

• height (number) — Layer height.

getHeight(): number

Inherited from Layer#getHeight

Overrides: Layer#getHeight

Gets layer height.

Returns

• number

setZIndex(zIndex: number)

Inherited from Layer#setZIndex

Overrides: Layer#setZIndex

Sets z-index.

Parameters

• zIndex (number) — Layer z-index.

getZIndex(): number

Inherited from Layer#getZIndex

Overrides: Layer#getZIndex

Gets z-index.

Returns

• number

bringToFront()

Inherited from Layer#bringToFront

Overrides: Layer#bringToFront

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

isBaseLayer(): boolean

Inherited from Layer#isBaseLayer

Overrides: Layer#isBaseLayer

Returns true if the layer is a base.

Returns

• boolean — Base layer flag.

setBaseLayer(isBaseLayer: boolean)

Inherited from Layer#setBaseLayer

Overrides: Layer#setBaseLayer

Sets base layer type flag.

Parameters

• isBaseLayer (boolean)

getVisibility(): boolean

Inherited from Layer#getVisibility

Overrides: Layer#getVisibility

Gets layer visibility.

Returns

• boolean — Layer visibility.

setExtent(extent: Extent)

Inherited from Layer#setExtent

Overrides: Layer#setExtent

Sets visible geographical extent.

Parameters

• extent (Extent) — Layer visible geographical extent.

getExtent(): Extent

Inherited from Layer#getExtent

Overrides: Layer#getExtent

Gets layer extent.

Returns

• Extent — Layer geodetic extent.

getExtentMerc(): Extent

Inherited from Layer#getExtentMerc

Overrides: Layer#getExtentMerc

Gets layer web-mercator extent.

Returns

• Extent — Layer extent.

flyExtent()

Inherited from Layer#flyExtent

Overrides: Layer#flyExtent

Fly extent.

viewExtent()

Inherited from Layer#viewExtent

Overrides: Layer#viewExtent

View extent.

_correctFullExtent()

Inherited from Layer#_correctFullExtent

Overrides: Layer#_correctFullExtent

Special correction of the whole globe extent.

Instance Fields

_pickingColor: Vec3

Inherited from Layer#_pickingColor

Overrides: Layer#_pickingColor

Layer picking color. Assign when added to the planet.

nightTextureCoefficient: number

Inherited from Layer#nightTextureCoefficient

Overrides: Layer#nightTextureCoefficient

Night texture blending coefficient.

_id

Inherited from Layer#_id

Overrides: Layer#_id

planet

Inherited from Layer#planet

Overrides: Layer#planet

Returns planet instance.