TextCollection

class Communicator.Markup.Shape.TextCollection()

Methods

`addString()`
`clear()`
`getFillColor()`
`getFillOpacity()`
`getFontFamily()`
`getFontSize()`
`getStrings()`
`getStrokeColor()`
`getStrokeWidth()`
`setFillColor()`
`setFillOpacity()`
`setFontFamily()`
`setFontSize()`
`setStrokeColor()`
`setStrokeWidth()`

Methods

addString

Communicator.Markup.Shape.TextCollection.addString(text, position)

Adds a string to the collection

Arguments

text (string()) – the text to render
position (Communicator.Point2()) – the top left position of the text

Return type

void

clear

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

Removes all text strings from this collection

Return type: void

getFillColor

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

Gets the fill color for this shape

Return type: Communicator.Color
Returns: the fill color

getFillOpacity

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

Gets the fill opacity for this shape

Return type: number
Returns: the fill opacity

getFontFamily

Communicator.Markup.Shape.TextCollection.getFontFamily()

Gets the font family for this text

Return type: { }
Returns: the font family

getFontSize

Communicator.Markup.Shape.TextCollection.getFontSize()

Gets the font size for this text

Return type: number
Returns: the font size

getStrings

Communicator.Markup.Shape.TextCollection.getStrings()

Gets the strings in the collection

Return type: [_MarkupTextData]

getStrokeColor

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

Gets the stroke color for this shape

Return type: Communicator.Color
Returns: the stroke color

getStrokeWidth

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

Gets the stroke width for this shape in pixels

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

setFillColor

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

Sets the fill color for this shape

Arguments

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

Return type

void

setFillOpacity

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

Sets the fill opacity for this shape

Arguments

fillOpacity (number()) – the fill opacity

Return type

void

setFontFamily

Communicator.Markup.Shape.TextCollection.setFontFamily(fontFamily)

Sets the font family this shape

Arguments

fontFamily (string()) – font family to use for this text

Return type

void

setFontSize

Communicator.Markup.Shape.TextCollection.setFontSize(fontSize)

Sets the font size for this text

Arguments

fontSize (number()) – size to use for this text

Return type

void

setStrokeColor

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

Sets the stroke color for this shape

Arguments

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

Return type

void

setStrokeWidth

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

Sets the stroke width for this shape in pixels

Arguments

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

Return type

void