Class TextBlock

boundingBox

• get boundingBox(): DOMRect

  Returns the bounding box where text should fit and/or be anchored.

  Returns DOMRect
• set boundingBox(value: DOMRect): void

  Sets the bounding box where text should fit and/or be anchored.

  Parameters

  • value: DOMRect

  Returns void

color

• get color(): string

  Returns the text color.

  Returns string
• set color(value: string): void

  Sets the text color.

  Parameters

  • value: string

  Returns void

fontFamily

• get fontFamily(): string

  Returns the text's font family.

  Returns string
• set fontFamily(value: string): void

  Sets the text's font family.

  Parameters

  • value: string

  Returns void

fontSize

• get fontSize(): FontSize

  Returns the text's font size.

  Returns FontSize
• set fontSize(value: FontSize): void

  Sets the text's font size.

  Parameters

  • value: FontSize

  Returns void

labelBackground

• get labelBackground(): SVGRectElement

  Returns the background rectangle (behind the text).

  Returns SVGRectElement

text

• get text(): string

  Returns the text block's text.

  Returns string
• set text(value: string): void

  Sets the text block's text.

  Parameters

  • value: string

  Returns void

textElement

• get textElement(): SVGTextElement

  Returns the text block's text element.

  Returns SVGTextElement

textSize

• get textSize(): undefined | DOMRect

  Returns the size of the rectangle containing the text block's text.

  Returns undefined | DOMRect

constructor

• new TextBlock(text?: string): TextBlock

  Creates a text block

  Parameters

  • Optionaltext: string

    initial text

  Returns TextBlock

OptionalonTextSizeChanged

hide

• hide(): void

  Hides the text block content.

  Returns void

hideControlBox

• hideControlBox(): void

  Hides the text block's dashed outline.

  Returns void

ownsTarget

• ownsTarget(el: EventTarget): boolean

  Returns true if the text block contains the supplied element.

  Parameters

  • el: EventTarget

    element to test.

  Returns boolean

  true if the element belongs to the text block, false otherwise.

positionText

• positionText(textBlock?: TextBlock): void

  Positions the text within the text block.

  Parameters

  • OptionaltextBlock: TextBlock

  Returns void

renderText

• renderText(): Promise<void>

  Renders text within the text block according to its settings.

  Returns Promise<void>

show

• show(): void

  Makes the text block content visible.

  Returns void

showControlBox

• showControlBox(): void

  Shows the text block's dashed outline.

  Returns void

offsetX

offsetY

wordWrap