Skip to main content
Represents a Rive artboard instance, providing drawing, advancing, interaction handling, and access to named nodes and data.

​
Fields

​
frameOrigin

If true, the artboard’s origin is treated as the frame origin.

​
data

The typed data associated with the artboard.

​
width

The width of the artboard. 
self.artboardInstance = self.myArtboard:instance()
if self.artboardInstance then
   self.artboardInstance.width = 20
end

​
height

The height of the artboard. 
self.artboardInstance = self.myArtboard:instance()
if self.artboardInstance then
   self.artboardInstance.height = 20
end

​
Methods

​
draw

draw(renderer: Renderer) -> ()
Draws the artboard using the provided renderer.

​
advance

advance(seconds: number) -> boolean
Advances the artboard by the given time in seconds. Returns true if the artboard should continue receiving advance calls.

​
instance

instance(viewModel: ViewModel?) -> Artboard<T>
Creates a new instance of the artboard with independent state.

​
animation

animation(name: string) -> Animation?
Creates an animation instance linked to the artboard instance

​
bounds

bounds() -> (Vector, Vector)
Returns the bounding box of the artboard as two Vector values: the minimum point and the maximum point. 
local minPt, maxPt = self.myArtboard:bounds()
print("Bounds width", maxPt.x - minPt.x)
print("Bounds height", maxPt.y - minPt.y)

​
node

node(name: string) -> NodeData?
Returns the node with the given name, or nil if no such node exists.

​
pointerDown

pointerDown(event: PointerEvent) -> number
Pointer event down handler. Each returns a hit-test result, where 0 indicates no hit and non-zero values indicate a hit.

​
pointerUp

pointerUp(event: PointerEvent) -> number
Pointer event up handler. Each returns a hit-test result, where 0 indicates no hit and non-zero values indicate a hit.

​
pointerMove

pointerMove(event: PointerEvent) -> number
Pointer event move handler. Each returns a hit-test result, where 0 indicates no hit and non-zero values indicate a hit.

​
pointerExit

pointerExit(event: PointerEvent) -> number
Pointer event exit handler. Each returns a hit-test result, where 0 indicates no hit and non-zero values indicate a hit.

​
addToPath

addToPath(path: Path, transform: Mat2D?) -> ()
Adds the artboard’s geometry to the given path, optionally transformed by the provided matrix.