RectangleCollection

class Markup.Shapes.RectangleCollection()

This is useful for drawing a number of rectangles which share the same visual appearance.

Index

Constructors

• constructor

Methods

• addRectangle
• clear
• getBorderRadius
• getFillColor
• getFillOpacity
• getRectangles
• getStrokeColor
• getStrokeWidth
• setBorderRadius
• setFillColor
• setFillOpacity
• setStrokeColor
• setStrokeWidth

Constructors

Markup.Shapes.RectangleCollection.constructor()

RectangleCollection(): RectangleCollection

Returns: RectangleCollection

Methods

Markup.Shapes.RectangleCollection.addRectangle()

addRectangle(position: Point2, size: Point2): void

Adds a rectangle to the collection

Parameters

position: Point2

the top left corner of the rectangle

size: Point2

indicating the rectangle width and height

Returns: void

Markup.Shapes.RectangleCollection.clear()

clear(): void

Removes all rectangles from this collection

Returns: void

Markup.Shapes.RectangleCollection.getBorderRadius()

inherited

getBorderRadius(): number

Gets the border radius for this shape

Returns: number

the border radius

Markup.Shapes.RectangleCollection.getFillColor()

inherited

getFillColor(): Color

Gets the fill color for this shape

Returns: Color

the fill color

Markup.Shapes.RectangleCollection.getFillOpacity()

inherited

getFillOpacity(): number

Gets the fill opacity for this shape

Returns: number

the fill opacity

Markup.Shapes.RectangleCollection.getRectangles()

getRectangles(): _MarkupRectangleData[]

Gets the rectangles in the collection

Returns: _MarkupRectangleData[]

Markup.Shapes.RectangleCollection.getStrokeColor()

inherited

getStrokeColor(): Color

Gets the stroke color for this shape

Returns: Color

the stroke color

Markup.Shapes.RectangleCollection.getStrokeWidth()

inherited

getStrokeWidth(): number

Gets the stroke width for this shape in pixels

Returns: number

the stroke width in pixels

Markup.Shapes.RectangleCollection.setBorderRadius()

inherited

setBorderRadius(borderRadius: number): void

Sets the border radius for this shape

Parameters

borderRadius: number

the border radius in pixels

Returns: void

Markup.Shapes.RectangleCollection.setFillColor()

inherited

setFillColor(color: Color): void

Sets the fill color for this shape

Parameters

color: Color

the fill color

Returns: void

Markup.Shapes.RectangleCollection.setFillOpacity()

inherited

setFillOpacity(fillOpacity: number): void

Sets the fill opacity for this shape

Parameters

fillOpacity: number

the fill opacity

Returns: void

Markup.Shapes.RectangleCollection.setStrokeColor()

inherited

setStrokeColor(color: Color): void

Sets the stroke color for this shape

Parameters

color: Color

the stroke color

Returns: void

Markup.Shapes.RectangleCollection.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