RectangleCollection

class Communicator.Markup.Shape.RectangleCollection(): This is useful for drawing a number of rectangles which share the same visual appearance.

Methods

`addRectangle()`
`clear()`
`getBorderRadius()`
`getFillColor()`
`getFillOpacity()`
`getRectangles()`
`getStrokeColor()`
`getStrokeWidth()`
`setBorderRadius()`
`setFillColor()`
`setFillOpacity()`
`setStrokeColor()`
`setStrokeWidth()`

Methods

addRectangle

Communicator.Markup.Shape.RectangleCollection.addRectangle(position, size)

Adds a rectangle to the collection

Arguments

position (Communicator.Point2()) – the top left corner of the rectangle
size (Communicator.Point2()) – indicating the rectangle width and height

Return type

void

clear

Communicator.Markup.Shape.RectangleCollection.clear()

Removes all rectangles from this collection

Return type: void

getBorderRadius

Communicator.Markup.Shape.RectangleCollection.getBorderRadius()

Gets the border radius for this shape

Return type: number
Returns: the border radius

getFillColor

Communicator.Markup.Shape.RectangleCollection.getFillColor()

Gets the fill color for this shape

Return type: Communicator.Color
Returns: the fill color

getFillOpacity

Communicator.Markup.Shape.RectangleCollection.getFillOpacity()

Gets the fill opacity for this shape

Return type: number
Returns: the fill opacity

getRectangles

Communicator.Markup.Shape.RectangleCollection.getRectangles()

Gets the rectangles in the collection

Return type: [_MarkupRectangleData]

getStrokeColor

Communicator.Markup.Shape.RectangleCollection.getStrokeColor()

Gets the stroke color for this shape

Return type: Communicator.Color
Returns: the stroke color

getStrokeWidth

Communicator.Markup.Shape.RectangleCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type: Communicator.Pixels
Returns: the stroke width in pixels

setBorderRadius

Communicator.Markup.Shape.RectangleCollection.setBorderRadius(borderRadius)

Sets the border radius for this shape

Arguments

borderRadius (number()) – the border radius in pixels

Return type

void

setFillColor

Communicator.Markup.Shape.RectangleCollection.setFillColor(color)

Sets the fill color for this shape

Arguments

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

Return type

void

setFillOpacity

Communicator.Markup.Shape.RectangleCollection.setFillOpacity(fillOpacity)

Sets the fill opacity for this shape

Arguments

fillOpacity (number()) – the fill opacity

Return type

void

setStrokeColor

Communicator.Markup.Shape.RectangleCollection.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

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

Return type

void

setStrokeWidth

Communicator.Markup.Shape.RectangleCollection.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments

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

Return type

void