layer.tileContainer.CanvasContainer
Extends IChildOnMap.
Container for tiles on canvas.
Constructor | Fields | Events | Methods
Constructor
layer.tileContainer.CanvasContainer(layer[, options])
Creates a container for tiles on canvas. Accessible in the storage for tile container classes by the key "default#canvas".
Parameters:
Parameter |
Default value |
Description |
— |
Type: ILayer Layer. |
|
— |
Type: Object Container options. |
|
null |
Type: String|null 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. |
|
'default#canvas' |
Type: ICanvasTile Class of tiles used by the container. Must implement the interface ICanvasTile. |
|
false |
Type: Boolean Indicates whether container tiles are transparent. |
* Mandatory parameter/option.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
Events
Name |
Description |
The parent object reference changed. Data fields:
Inherited from IChild. |
Methods
Name |
Returns |
Description |
getMap() |
Returns reference to the map. |
|
IParentOnMap|null |
Returns link to the parent object, or null if the parent element was not set. Inherited from IChildOnMap. |
|
Factory function for creating tiles. |
||
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. |
Methods details
getMap
{Map} getMap()
Returns reference to the map.
getTile
{ICanvasTile} getTile(tileNumber, tileZoom, priority)
Factory function for creating tiles.
Returns tile instance.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Number[] Tile number. |
|
— |
Type: Number Tile scale. |
|
— |
Type: Number Loading priority. |
* Mandatory parameter/option.
Mandatory parameter/option.