TextCollection

class Markup.Shapes.TextCollection()

This is a base class for text markup objects. It should not be created directly.

Index

Methods

• addString
• clear
• getFillColor
• getFillOpacity
• getFontFamily
• getFontSize
• getStrings
• getStrokeColor
• getStrokeWidth
• setFillColor
• setFillOpacity
• setFontFamily
• setFontSize
• setStrokeColor
• setStrokeWidth

Methods

Markup.Shapes.TextCollection.addString()

addString(text: string, position: Point2): void

Adds a string to the collection

Parameters

text: string

the text to render

position: Point2

the top left position of the text

Returns: void

Markup.Shapes.TextCollection.clear()

clear(): void

Removes all text strings from this collection

Returns: void

Markup.Shapes.TextCollection.getFillColor()

inherited

getFillColor(): Color

Gets the fill color for this shape

Returns: Color

the fill color

Markup.Shapes.TextCollection.getFillOpacity()

inherited

getFillOpacity(): number

Gets the fill opacity for this shape

Returns: number

the fill opacity

Markup.Shapes.TextCollection.getFontFamily()

inherited

getFontFamily(): (None | string)

Gets the font family for this text

Returns: (None | string)

the font family

Markup.Shapes.TextCollection.getFontSize()

inherited

getFontSize(): number

Gets the font size for this text

Returns: number

the font size

Markup.Shapes.TextCollection.getStrings()

getStrings(): _MarkupTextData[]

Gets the strings in the collection

Returns: _MarkupTextData[]

Markup.Shapes.TextCollection.getStrokeColor()

inherited

getStrokeColor(): Color

Gets the stroke color for this shape

Returns: Color

the stroke color

Markup.Shapes.TextCollection.getStrokeWidth()

inherited

getStrokeWidth(): number

Gets the stroke width for this shape in pixels

Returns: number

the stroke width in pixels

Markup.Shapes.TextCollection.setFillColor()

inherited

setFillColor(color: Color): void

Sets the fill color for this shape

Parameters

color: Color

the fill color

Returns: void

Markup.Shapes.TextCollection.setFillOpacity()

inherited

setFillOpacity(fillOpacity: number): void

Sets the fill opacity for this shape

Parameters

fillOpacity: number

the fill opacity

Returns: void

Markup.Shapes.TextCollection.setFontFamily()

inherited

setFontFamily(fontFamily: string): void

Sets the font family this shape

Parameters

fontFamily: string

font family to use for this text

Returns: void

Markup.Shapes.TextCollection.setFontSize()

inherited

setFontSize(fontSize: number): void

Sets the font size for this text

Parameters

fontSize: number

size to use for this text

Returns: void

Markup.Shapes.TextCollection.setStrokeColor()

inherited

setStrokeColor(color: Color): void

Sets the stroke color for this shape

Parameters

color: Color

the stroke color

Returns: void

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