Constructor
new Circles()
- Description:
- Create Circles object
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
point |
Point | X & Y axis coordinates |
stroke |
StrokeCollection | Stroke collection properties |
shadow |
ShadowCollection | Shadow collection properties |
aspect |
Aspect | Aspect properties |
canvas |
HTMLCanvasElement | 2D canvas context |
template |
Template | Canvas Lab Template object |
anchor |
Anchor | Anchor properties |
options |
Options | Options for this object |
Methods
anchor(value)
- Description:
- Set anchor type
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Anchor type |
anchor() → {Anchor}
- Description:
- Get anchor
- Source:
- See:
Returns:
Anchor properties
- Type
- Anchor
area() → {number}
- Description:
- Get area of this object
- Source:
- See:
Returns:
Area of rectangle
- Type
- number
aspect() → {Aspect}
- Description:
- Get aspect properties
- Source:
- See:
Returns:
Aspect properties
- Type
- Aspect
canvas(value)
- Description:
- Set canvas value
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Canvas id |
canvas() → {string}
- Description:
- Get canvas value
- Source:
- See:
Returns:
Canvas id
- Type
- string
center() → {Point}
- Description:
- Get center of this object
- Source:
- See:
Returns:
Center point coordinates
- Type
- Point
draw(canvas)
- Description:
- Draw function for collections
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
canvas |
string | Canvas Id |
endPoint() → {Point}
- Description:
- Returns the last Point within this Array
- Source:
- See:
Returns:
Last Array element's X & Y Coordinates
- Type
- Point
getPoints(indexes, color)
- Description:
- Get all or specific points throughout this collection
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
indexes |
Array.<number> | Indexes of points |
color |
Rgb | Color to colorize objects selected points |
height() → {number}
- Description:
- Get aspect height
- Source:
- See:
Returns:
Height value
- Type
- number
options() → {Object}
- Description:
- Get options
- Source:
Returns:
Options object
- Type
- Object
perimeter() → {number}
- Description:
- Get perimeter of this object
- Source:
- See:
Returns:
Perimeter of rectangle
- Type
- number
point(value)
- Description:
- Set point
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Point | X & Y coordinates |
point() → {Point}
- Description:
- Get point
- Source:
- See:
Returns:
X & Y coordinates
- Type
- Point
push()
- Description:
- Pushes child object(s) into this collection
- Source:
- See:
shadow() → {Shadow}
- Description:
- Get shadow properties
- Source:
Returns:
Shadow properties
- Type
- Shadow
storageType() → {clObject}
- Description:
- Returns this collection's storage type
- Source:
Returns:
Canvas Lab object
- Type
- clObject
stroke() → {Stroke}
- Description:
- Get stroke properties
- Source:
Returns:
Stroke properties
- Type
- Stroke
template(value)
- Description:
- Set template
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Template | Template object |
template() → {Template}
- Description:
- Get template
- Source:
- See:
Returns:
Template object
- Type
- Template
width() → {number}
- Description:
- Get aspect with
- Source:
- See:
Returns:
Width value
- Type
- number
x(value)
- Description:
- Set x-axis value
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number | X coordinate value |
x() → {number}
- Description:
- Get x-axis value
- Source:
- See:
Returns:
X coordinate value
- Type
- number
y(value)
- Description:
- Set the y-axis value
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number | Y coordinate value |
y() → {number}
- Description:
- Get y-axis value
- Source:
- See:
Returns:
Y coordinate value
- Type
- number