CircleCollection

class Markup.Shapes.CircleCollection()

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

Index

Constructors

• constructor

Methods

• addCircle
• clear
• getCircles
• getFillColor
• getFillOpacity
• getStrokeColor
• getStrokeWidth
• setCircle
• setFillColor
• setFillOpacity
• setStrokeColor
• setStrokeWidth

Constructors

Markup.Shapes.CircleCollection.constructor()

CircleCollection(): CircleCollection

Returns: CircleCollection

Methods

Markup.Shapes.CircleCollection.addCircle()

addCircle(center: Point2, radius: number): void

Adds a circle to the collection

Parameters

center: Point2

circle center

radius: number

the circle radius

Returns: void

Markup.Shapes.CircleCollection.clear()

clear(): void

Removes all circles from this collection

Returns: void

Markup.Shapes.CircleCollection.getCircles()

getCircles(): _MarkupCircleData[]

Gets the circles in the collection

Returns: _MarkupCircleData[]

Markup.Shapes.CircleCollection.getFillColor()

inherited

getFillColor(): Color

Gets the fill color for this shape

Returns: Color

the fill color

Markup.Shapes.CircleCollection.getFillOpacity()

inherited

getFillOpacity(): number

Gets the fill opacity for this shape

Returns: number

the fill opacity

Markup.Shapes.CircleCollection.getStrokeColor()

inherited

getStrokeColor(): Color

Gets the stroke color for this shape

Returns: Color

the stroke color

Markup.Shapes.CircleCollection.getStrokeWidth()

inherited

getStrokeWidth(): number

Gets the stroke width for this shape in pixels

Returns: number

the stroke width in pixels

Markup.Shapes.CircleCollection.setCircle()

setCircle(index: number, center: Point2, radius: number): void

Updates a circle in the collection

Parameters

index: number

the index of the circle to update

center: Point2

circle center

radius: number

the circle radius

Returns: void

Markup.Shapes.CircleCollection.setFillColor()

inherited

setFillColor(color: Color): void

Sets the fill color for this shape

Parameters

color: Color

the fill color

Returns: void

Markup.Shapes.CircleCollection.setFillOpacity()

inherited

setFillOpacity(fillOpacity: number): void

Sets the fill opacity for this shape

Parameters

fillOpacity: number

the fill opacity

Returns: void

Markup.Shapes.CircleCollection.setStrokeColor()

inherited

setStrokeColor(color: Color): void

Sets the stroke color for this shape

Parameters

color: Color

the stroke color

Returns: void

Markup.Shapes.CircleCollection.setStrokeWidth()

inherited

setStrokeWidth(strokeWidth: number): void

Sets the stroke width for this shape in pixels

Parameters

strokeWidth: number

the stroke width in pixels

Returns: void