$arc

Draws a circular arc in the current path.

Usage

$arc[canvas;x;y;radius;startAngle;endAngle;counterclockwise?]

Parameters

Field	Type	Description	Required
canvas	String	Name of the canvas.	True
x	Number	The X coordinate of the arc’s center.	True
y	Number	The Y coordinate of the arc’s center.	True
radius	Number	The arc’s radius	True
startAngle	Number	The angle at which the arc starts in radians, measured from the positive x-axis.	True
endAngle	Number	The angle at which the arc ends in radians, measured from the positive x-axis.	True
counterclockwise	Boolean	If true, draws the arc counter-clockwise between the start and end angles.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$arc",
 "description": "Draws a circular arc in the current path.",
 "params": [
  {
   "name": "canvas",
   "description": "Name of the canvas.",
   "type": "String",
   "required": true
  },
  {
   "name": "x",
   "description": "The X coordinate of the arc's center.",
   "type": "Number",
   "required": true
  },
  {
   "name": "y",
   "description": "The Y coordinate of the arc's center.",
   "type": "Number",
   "required": true
  },
  {
   "name": "radius",
   "description": "The arc's radius",
   "type": "Number",
   "required": true
  },
  {
   "name": "startAngle",
   "description": "The angle at which the arc starts in radians, measured from the positive x-axis.",
   "type": "Number",
   "required": true
  },
  {
   "name": "endAngle",
   "description": "The angle at which the arc ends in radians, measured from the positive x-axis.",
   "type": "Number",
   "required": true
  },
  {
   "name": "counterclockwise",
   "description": "If true, draws the arc counter-clockwise between the start and end angles.",
   "type": "Boolean",
   "required": false
  }
 ],
 "usage": "$arc[canvas;x;y;radius;startAngle;endAngle;counterclockwise?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/arc.ts",
 "docs": "https://aoicanvas.vercel.app/functions/arc"
}