TextBoxCollection

class Markup.Shapes.TextBoxCollection()

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

Methods

Methods

addString

TextBoxCollection.addString(text, position)
Arguments:
  • text (string()) – the text to render
  • position (Point2()) – the top left position of the text

Adds a string to the collection

Return type:void

clear

TextBoxCollection.clear()

Removes all text strings from this collection

Return type:void

getBoxPortion

TextBoxCollection.getBoxPortion()

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:the rectangle markup object.
Return type:RectangleBase

getPadding

TextBoxCollection.getPadding()

Gets the Pixel distance between the text and outer rectangle

Returns:the padding value.
Return type:number

getStrings

TextBoxCollection.getStrings()

Gets the strings in the collection

Return type:[_MarkupTextData]

getTextPortion

TextBoxCollection.getTextPortion()

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

Returns:the text markup object
Return type:TextMarkupBase

setPadding

TextBoxCollection.setPadding(padding)
Arguments:
  • padding (number()) – the padding value.

Sets the Pixel distance between the text and outer rectangle

Return type:void