TextMarkupBase

class Communicator.Markup.Shape.TextMarkupBase()

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


Methods

getFillColor

TextMarkupBase.getFillColor()

Gets the fill color for this shape

Return type

Color()

Returns

the fill color

getFillOpacity

TextMarkupBase.getFillOpacity()

Gets the fill opacity for this shape

Return type

number

Returns

the fill opacity

getFontFamily

TextMarkupBase.getFontFamily()

Gets the font family for this text

Return type

string | null

Returns

the font family

getFontSize

TextMarkupBase.getFontSize()

Gets the font size for this text

Return type

number

Returns

the font size

getStrokeColor

TextMarkupBase.getStrokeColor()

Gets the stroke color for this shape

Return type

Color()

Returns

the stroke color

getStrokeWidth

TextMarkupBase.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Pixels

Returns

the stroke width in pixels

setFillColor

TextMarkupBase.setFillColor(color)

Sets the fill color for this shape

Arguments
  • color (Color()) – the fill color

Return type

void

setFillOpacity

TextMarkupBase.setFillOpacity(fillOpacity)

Sets the fill opacity for this shape

Arguments
  • fillOpacity (number()) – the fill opacity

Return type

void

setFontFamily

TextMarkupBase.setFontFamily(fontFamily)

Sets the font family this shape

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

Return type

void

setFontSize

TextMarkupBase.setFontSize(fontSize)

Sets the font size for this text

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

Return type

void

setStrokeColor

TextMarkupBase.setStrokeColor(color)

Sets the stroke color for this shape

Arguments
  • color (Color()) – the stroke color

Return type

void

setStrokeWidth

TextMarkupBase.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments
  • strokeWidth (Pixels) – the stroke width in pixels

Return type

void