On this page

CanvasTiles

Layer used to rendering each tile as a separate canvas object.

Constructor

new CanvasTiles(nameopt, options:)

Parameters:

Name	Type	Attributes	Default	Description
`name`	String	<optional>	"noname"	Layer name.
`options:`	ICanvasTilesParams
`options.opacity`	number	<optional>	1.0	Layer opacity.
`options.minZoom`	number	<optional>	0	Minimal visibility zoom level.
`options.maxZoom`	number	<optional>	0	Maximal visibility zoom level.
`options.attribution`	string	<optional>		Layer attribution that displayed in the attribution area on the screen.
`options.isBaseLayer`	boolean	<optional>	false	Base layer flag.
`options.visibility`	boolean	<optional>	true	Layer visibility.
`options.drawTile`	DrawTileCallback			Draw tile callback.

Source: layer/CanvasTiles.ts, line 40

Fires:

EventsHandler#event:load
EventsHandler#event:loadend

Extends

Layer

Members

_id

Overrides: Layer#_id
Source: layer/Layer.ts, line 454

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

Overrides: Layer#_pickingColor
Source: layer/Layer.ts, line 306

planet

Returns planet instance.

Overrides: Layer#planet
Source: layer/Layer.ts, line 570

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

Overrides: Layer#_assignPlanet
Source: layer/Layer.ts, line 471

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Overrides: Layer#_bindPicking
Source: layer/Layer.ts, line 513

(protected) _correctFullExtent()

Special correction of the whole globe extent.

Overrides: Layer#_correctFullExtent
Source: layer/Layer.ts, line 819

(protected) _exec(material)

Loads material image and apply it to the planet segment.

Parameters:

Name	Type	Description
`material`	Material	Loads material image.

Source: layer/CanvasTiles.ts, line 190

abortLoading()

Abort loading tiles.

Source: layer/CanvasTiles.ts, line 138

abortMaterialLoading(material)

Abort exact material loading.

Parameters:

Name	Type	Description
`material`	Material	Segment material.

Source: layer/CanvasTiles.ts, line 220

addTo(planet)

Adds layer to the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Adds layer to the planet.

Overrides: Layer#addTo
Source: layer/Layer.ts, line 522

bringToFront()

Set zIndex to the maximal value depend on other layers on the planet.

Overrides: Layer#bringToFront
Source: layer/Layer.ts, line 636

(abstract) clear()

Clears layer material.

Overrides: Layer#clear
Source: layer/Layer.ts, line 560

flyExtent()

Fly extent.

Overrides: Layer#flyExtent
Source: layer/Layer.ts, line 803

getAttribution() → {string}

Gets layer attribution.

Overrides: Layer#getAttribution
Source: layer/Layer.ts, line 589

Returns:

Layer attribution

Type:: string

getExtent() → {Extent}

Gets layer extent.

Overrides: Layer#getExtent
Source: layer/Layer.ts, line 784

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Overrides: Layer#getExtentMerc
Source: layer/Layer.ts, line 793

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

Overrides: Layer#getHeight
Source: layer/Layer.ts, line 608

Returns:

Type:: number

getID() → {string}

Gets layer identifier.

Overrides: Layer#getID
Source: layer/Layer.ts, line 441

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}

Gets layer visibility.

Overrides: Layer#getVisibility
Source: layer/Layer.ts, line 752

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

Overrides: Layer#getZIndex
Source: layer/Layer.ts, line 627

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Overrides: Layer#hasImageryTiles
Source: layer/Layer.ts, line 431

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Overrides: Layer#isBaseLayer
Source: layer/Layer.ts, line 650

Returns:

Base layer flag.

Type:: boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:

Name	Type	Description
`layer`	Layer	Layer instance to compare.

Overrides: Layer#isEqual
Source: layer/Layer.ts, line 461

Returns:

Returns true if the layers is the same instance of the input.

Type:: boolean

(abstract) loadMaterial(material)

Start to load tile material.

Parameters:

Name	Type	Description
`material`	Material

Source: layer/CanvasTiles.ts, line 164

remove() → {Layer}

Removes from planet.

Overrides: Layer#remove
Source: layer/Layer.ts, line 533

Returns:

-This layer.

Type:: Layer

setAttribution(html)

Sets layer attribution text.

Parameters:

Name	Type	Description
`html`	string	HTML code that represents layer attribution, it could be just a text.

Overrides: Layer#setAttribution
Source: layer/Layer.ts, line 577

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

Overrides: Layer#setBaseLayer
Source: layer/Layer.ts, line 659

setExtent(extent)

Sets visible geographical extent.

Parameters:

Name	Type	Description
`extent`	Extent	Layer visible geographical extent.

Overrides: Layer#setExtent
Source: layer/Layer.ts, line 761

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

Overrides: Layer#setHeight
Source: layer/Layer.ts, line 598

setVisibility(visibility)

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

Overrides: Layer#setVisibility
Source: layer/CanvasTiles.ts, line 149

setZIndex(zIndex)

Sets z-index.

Parameters:

Name	Type	Description
`zIndex`	number	Layer z-index.

Overrides: Layer#setZIndex
Source: layer/Layer.ts, line 617

viewExtent()

View extent.

Overrides: Layer#viewExtent
Source: layer/Layer.ts, line 811