The Tokens Layer

The Tokens Layer is the middle layer of the tabletop Canvas and it contains all the Sprites which represent actors within the game space. Tokens are placed onto the Tokens Layer by dragging actors from the Actors Directory (in the right sidebar) onto the canvas.

Tokens and Related Concepts

Token Layer API

All tokens which are rendered on the canvas are drawn as children of the TokenLayer(). The token layer may be accessed globally as canvas.tokens and provides the following API.

class TokenLayer()

The Token Layer


Conclude an area selection event


Draw the select rectangle given an event originated within the base canvas layer

  • event

Draw a new Token onto the canvas TokenLayer

  • tokenData (Object) – The data object from which to create a new Token

Token – The new Token container


Get a token by its tokenId


Release control of all tokens on the board


Select all the tokens within a provided set of rectangular coordinates. Control any tokens within the area which you are able to control based on token permissions.