CircleCollection

class Communicator.Markup.Shape.CircleCollection()

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

Methods

• addCircle()

• clear()

• getCircles()

• getFillColor()

• getFillOpacity()

• getStrokeColor()

• getStrokeWidth()

• setCircle()

• setFillColor()

• setFillOpacity()

• setStrokeColor()

• setStrokeWidth()

---

Methods

addCircle

CircleCollection.addCircle(center, radius)

Adds a circle to the collection

Arguments

• center (Point2()) – circle center

• radius (number()) – the circle radius

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

Return type

Color()

Returns

the fill color

getFillOpacity

CircleCollection.getFillOpacity()

Gets the fill opacity for this shape

Return type

number

Returns

the fill opacity

getStrokeColor

CircleCollection.getStrokeColor()

Gets the stroke color for this shape

Return type

Color()

Returns

the stroke color

getStrokeWidth

CircleCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Pixels

Returns

the stroke width in pixels

setCircle

CircleCollection.setCircle(index, center, radius)

Updates a circle in the collection

Arguments

• index (number()) – the index of the circle to update

• center (Point2()) – circle center

• radius (number()) – the circle radius

Return type

void

setFillColor

CircleCollection.setFillColor(color)

Sets the fill color for this shape

Arguments

• color (Color()) – the fill color

Return type

void

setFillOpacity

CircleCollection.setFillOpacity(fillOpacity)

Sets the fill opacity for this shape

Arguments

• fillOpacity (number()) – the fill opacity

Return type

void

setStrokeColor

CircleCollection.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

• color (Color()) – the stroke color

Return type

void

setStrokeWidth

CircleCollection.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments

• strokeWidth (Pixels) – the stroke width in pixels

Return type

void