CircleCollection

class Markup.Shapes.CircleCollection()

This class is useful for specifying multiple circles that all share the same visual appearance.

Constructors

Methods

Constructors

CircleCollection.constructor()
Return type:CircleCollection

Methods

addCircle

CircleCollection.addCircle(center, radius)
Arguments:
  • center (Point2()) – circle center
  • radius (number()) – the circle radius

Adds a circle to the collection

Return type:void

clear

CircleCollection.clear()

Removes all circles from this collection

Return type:void

getCircles

CircleCollection.getCircles()

Gets the circles in the collection

Return type:[_MarkupCircleData]

getFillColor

CircleCollection.getFillColor()

Gets the fill color for this shape

Returns:the fill color
Return type:Color

getFillOpacity

CircleCollection.getFillOpacity()

Gets the fill opacity for this shape

Returns:the fill opacity
Return type:number

getStrokeColor

CircleCollection.getStrokeColor()

Gets the stroke color for this shape

Returns:the stroke color
Return type:Color

getStrokeWidth

CircleCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Returns:the stroke width in pixels
Return type:number

setCircle

CircleCollection.setCircle(index, center, radius)
Arguments:
  • index (number()) – the index of the circle to update
  • center (Point2()) – circle center
  • radius (number()) – the circle radius

Updates a circle in the collection

Return type:void

setFillColor

CircleCollection.setFillColor(color)
Arguments:
  • color (Color()) – the fill color

Sets the fill color for this shape

Return type:void

setFillOpacity

CircleCollection.setFillOpacity(fillOpacity)
Arguments:
  • fillOpacity (number()) – the fill opacity

Sets the fill opacity for this shape

Return type:void

setStrokeColor

CircleCollection.setStrokeColor(color)
Arguments:
  • color (Color()) – the stroke color

Sets the stroke color for this shape

Return type:void

setStrokeWidth

CircleCollection.setStrokeWidth(strokeWidth)
Arguments:
  • strokeWidth (number()) – the stroke width in pixels

Sets the stroke width for this shape in pixels

Return type:void