Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

layer.tileContainer.DomContainer

Extends IChildOnMap.

Container for tiles of the IDomTile type.

Constructor | Fields | Events | Methods

Constructor

layer.tileContainer.DomContainer(layer[, options])

Creates a container for DOM tiles. Accessible in the storage for tile container classes by the key "default#dom".

Parameters:

ParameterDefault valueDescription
layer *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: ILayer

Layer.

options

Type: Object

Container options.

options.notFoundTile null

Type: String|null

Option that specifies the URL for downloading an image if the tile image didn't load. If the value is null, a standard tile is displayed with a text message. For transparent tiles, the notFoundTile option is not applied, and nothing is shown in place of tiles that didn't load.

options.tileClass 'default#dom'

Type: IDomTile

Class of tiles used by the container. Must implement the interface IDomTile.

options.tileTransparent false

Type: Boolean

Flag showing whether container tiles are transparent.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
parentchange

The parent object reference changed.

Data fields:

  • oldParent - Old parent.
  • newParent - New parent.

Inherited from IChild.

ready

Ready event for all tiles.

Methods

NameReturnsDescription
getMap()

Map

Returns reference to the map.

getParent()

IControlParent|null

Returns link to the parent object, or null if the parent element was not set.

Inherited from IChildOnMap.

getTile(tileNumber, tileZoom, priority)

IDomTile

Factory function for creating tiles.

setParent(parent)

IChildOnMap

Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object.

Inherited from IChildOnMap.

Events details

ready

Ready event for all tiles.

Methods details

getMap

{Map} getMap()

Returns reference to the map.

getTile

Factory function for creating tiles.

Returns tile instance.

Parameters:

ParameterDefault valueDescription
tileNumber*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[]

Tile number.

tileZoom*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number

Tile scale.

priority*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number

Loading priority.

* Mandatory parameter/option.