Class: Toybox.WatchUi.AnimationLayer

Inherits:

Toybox.WatchUi.Layer

Overview

The class that represents an Animation layer

Since:

API Level 3.1.0

App Types and Runtime Contexts:

Supported Devices:

getDc() as Graphics.Dc or Null

getDc will always return null, as the dc buffer of animations can not be updated by user.
getResource() as WatchUi.AnimationResource

Get the animation resource.
initialize(rez as Lang.ResourceId or WatchUi.AnimationResource, options as { :locX as Lang.Numeric, :locY as Lang.Numeric, :identifier as Lang.Object, :visibility as Lang.Boolean } or Null)

Constructor.
play(options as { :delegate as WatchUi.AnimationDelegate } or Null) as Lang.Boolean

Play animation, animation must be added to and not abandoned by the view before it can be played.
stop() as Void

Stop a playing animation.

getDc will always return null, as the dc buffer of animations can not be updated by user.

Since:

API Level 3.1.0

Get the animation resource

Returns:

Since:

API Level 3.1.0

Constructor

Parameters:

rez — (Lang.ResourceId, WatchUi.AnimationResource) —

either an animation ResourceId or a WatchUi.AnimationResource
options — (Lang.Dictionary) —

A Dictionary of options, can be null
- :locX — (Lang.Number) —
  
  The initial absolute, on-screen x-coordinate for the Animation object (optional defaults to 0)
- :locY — (Lang.Number) —
  
  The initial absolute, on-screen y-coordinate for the Animation object (optional defaults to 0)
- :identifier — (Lang.Object) —
  
  unique object for identification (optional)
- :visibility — (Lang.Boolean) —
  
  true if the layer is visible, otherwise false (optional, default to +true+)

Since:

API Level 3.1.0

Throws:

(Lang.UnexpectedTypeException) —

Thrown if the rez is not an animation resource or ResourceId

Play animation, animation must be added to and not abandoned by the view before it can be played.

This will stop the existing playback first.

Parameters:

Returns:

Since:

API Level 3.1.0

Stop a playing animation.

  The last frame of the animation will be persisted in the frame buffer.

Since:

API Level 3.1.0

Generated Oct 22, 2025, 5:10:05 PM