$strokeRect

Draws a stroked (outlined) rectangle.

Usage

$strokeRect[canvas;style;x;y;width;height;strokeWidth?;...radius?]

Parameters

Field	Type	Description	Required
canvas	String	The canvas name to draw rect on.	True
style	Color | Gradient | Pattern	The rect style.	True
x	Number	The rect start X coordinate.	True
y	Number	The rect start Y coordinate.	True
width	Number	The rect width.	True
height	Number	The rect height.	True
strokeWidth	Number	The stroke (outline) width.	False
radius	Number	The rect corners radius.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$strokeRect",
 "description": "Draws a stroked (outlined) rectangle.",
 "params": [
  {
   "name": "canvas",
   "description": "The canvas name to draw rect on.",
   "type": "String",
   "required": true
  },
  {
   "name": "style",
   "description": "The rect style.",
   "type": "Color | Gradient | Pattern",
   "required": true
  },
  {
   "name": "x",
   "description": "The rect start X coordinate.",
   "type": "Number",
   "required": true
  },
  {
   "name": "y",
   "description": "The rect start Y coordinate.",
   "type": "Number",
   "required": true
  },
  {
   "name": "width",
   "description": "The rect width.",
   "type": "Number",
   "required": true
  },
  {
   "name": "height",
   "description": "The rect height.",
   "type": "Number",
   "required": true
  },
  {
   "name": "strokeWidth",
   "description": "The stroke (outline) width.",
   "type": "Number",
   "required": false
  },
  {
   "name": "radius",
   "description": "The rect corners radius.",
   "type": "Number",
   "required": false
  }
 ],
 "usage": "$strokeRect[canvas;style;x;y;width;height;strokeWidth?;...radius?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/strokeRect.ts",
 "docs": "https://aoicanvas.vercel.app/functions/strokerect"
}