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

Communicator.Markup.Shape.CircleCollection.addCircle(center, radius)

Adds a circle to the collection

Arguments
  • center (Communicator.Point2()) – circle center

  • radius (number()) – the circle radius

Return type

void

clear

Communicator.Markup.Shape.CircleCollection.clear()

Removes all circles from this collection

Return type

void

getCircles

Communicator.Markup.Shape.CircleCollection.getCircles()

Gets the circles in the collection

Return type

[_MarkupCircleData]

getFillColor

Communicator.Markup.Shape.CircleCollection.getFillColor()

Gets the fill color for this shape

Return type

Communicator.Color

Returns

the fill color

getFillOpacity

Communicator.Markup.Shape.CircleCollection.getFillOpacity()

Gets the fill opacity for this shape

Return type

number

Returns

the fill opacity

getStrokeColor

Communicator.Markup.Shape.CircleCollection.getStrokeColor()

Gets the stroke color for this shape

Return type

Communicator.Color

Returns

the stroke color

getStrokeWidth

Communicator.Markup.Shape.CircleCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Communicator.Pixels

Returns

the stroke width in pixels

setCircle

Communicator.Markup.Shape.CircleCollection.setCircle(index, center, radius)

Updates a circle in the collection

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

  • center (Communicator.Point2()) – circle center

  • radius (number()) – the circle radius

Return type

void

setFillColor

Communicator.Markup.Shape.CircleCollection.setFillColor(color)

Sets the fill color for this shape

Arguments
  • color (Communicator.Color()) – the fill color

Return type

void

setFillOpacity

Communicator.Markup.Shape.CircleCollection.setFillOpacity(fillOpacity)

Sets the fill opacity for this shape

Arguments
  • fillOpacity (number()) – the fill opacity

Return type

void

setStrokeColor

Communicator.Markup.Shape.CircleCollection.setStrokeColor(color)

Sets the stroke color for this shape

Arguments
  • color (Communicator.Color()) – the stroke color

Return type

void

setStrokeWidth

Communicator.Markup.Shape.CircleCollection.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments
  • strokeWidth (Communicator.Pixels()) – the stroke width in pixels

Return type

void