Skip to content

$canvasSize

Returns the canvas size.

Usage

$canvasSize[canvas;property?]

Parameters

FieldTypeDescriptionRequired
canvasStringName of the canvas.True
property”width” | “height” | 0 | 1The size property to return.False

Example(s)

No examples for this function.

meow

Raw Info

{
"name": "$canvasSize",
"description": "Returns the canvas size.",
"params": [
{
"name": "canvas",
"description": "Name of the canvas.",
"type": "String",
"required": true
},
{
"name": "property",
"description": "The size property to return.",
"type": "\"width\" | \"height\" | 0 | 1",
"required": false,
"enum": {
"0": "width",
"1": "height",
"width": 0,
"height": 1
}
}
],
"usage": "$canvasSize[canvas;property?]",
"category": "canvas",
"src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/canvasSize.ts",
"docs": "https://aoicanvas.vercel.app/functions/canvassize"
}