Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

ICanvasTile

Interface for tiles that can be displayed in the canvas object's 2d context.

Constructor | Fields | Events | Methods

Constructor

ICanvasTile(url)

Parameters:

ParameterDefault valueDescription
url *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: String

Tile URL.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Tile event manager.

Events

NameDescription
ready

Tile ready event.

Methods

NameReturnsDescription
destroy()

Destroys the tile.

isReady()

Boolean

Checks tile readiness.

renderAt(context, canvasSize, bounds[, animate])

Draws an image tile in the canvas object's 2d context.

Fields details

events

{IEventManager} events

Tile event manager.

Events details

ready

Tile ready event.

Methods details

destroy

{} destroy()

Destroys the tile.

isReady

{Boolean} isReady()

Checks tile readiness.

Returns true if the tile is ready, or false if it is not ready.

renderAt

{} renderAt(context, canvasSize, bounds[, animate])

Draws an image tile in the canvas object's 2d context.

Parameters:

ParameterDefault valueDescription
context*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

2D context of the canvas object.

canvasSize*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[]

Dimensions of the canvas HTML element.

bounds*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[][]

Area in client coordinates where the tile should be drawn.

animate false

Type: Boolean

If true, rendering is animated; if false, it is not.

* Mandatory parameter/option.