TextBoxCollection

class Markup.Shapes.TextBoxCollection()

This class is useful for drawing a number of text boxes which share the same visual settings.

Methods

Markup.Shapes.TextBoxCollection.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.TextBoxCollection.clear()
clear(): void

Removes all text strings from this collection

Returns: void

Markup.Shapes.TextBoxCollection.getBoxPortion()

inherited

getBoxPortion(): RectangleBase

Gets the Box portion of the TextBox. Use the methods on this object to modify the appearance of the rectangle around the text string

Returns: RectangleBase

the rectangle markup object.
Markup.Shapes.TextBoxCollection.getPadding()

inherited

getPadding(): number

Gets the Pixel distance between the text and outer rectangle

Returns: number

the padding value.
Markup.Shapes.TextBoxCollection.getStrings()
getStrings(): _MarkupTextData[]

Gets the strings in the collection

Returns: _MarkupTextData[]

Markup.Shapes.TextBoxCollection.getTextPortion()

inherited

getTextPortion(): TextMarkupBase

Gets the Text portion of the TextBox. Use the methods on this object to modify the appearance of the text string

Returns: TextMarkupBase

the text markup object
Markup.Shapes.TextBoxCollection.setPadding()

inherited

setPadding(padding: number): void

Sets the Pixel distance between the text and outer rectangle

Parameters

padding: number

the padding value.

Returns: void