TextMarkupBase

class Communicator.Markup.Shape.TextMarkupBase(): This is a base class for text markup objects. It should not be created directly.

Methods

getFillColor()
getFillOpacity()
getFontFamily()
getFontSize()
getStrokeColor()
getStrokeWidth()
setFillColor()
setFillOpacity()
setFontFamily()
setFontSize()
setStrokeColor()
setStrokeWidth()

Methods

getFillColor

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

Gets the fill color for this shape

Return type: Communicator.Color
Returns: the fill color

getFillOpacity

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

Gets the fill opacity for this shape

Return type: number
Returns: the fill opacity

getFontFamily

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

Gets the font family for this text

Return type: { }
Returns: the font family

getFontSize

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

Gets the font size for this text

Return type: number
Returns: the font size

getStrokeColor

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

Gets the stroke color for this shape

Return type: Communicator.Color
Returns: the stroke color

getStrokeWidth

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

Gets the stroke width for this shape in pixels

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

setFillColor

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

Sets the fill color for this shape

Arguments

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

Return type

void

setFillOpacity

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

Sets the fill opacity for this shape

Arguments

fillOpacity (number()) – the fill opacity

Return type

void

setFontFamily

Communicator.Markup.Shape.TextMarkupBase.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.TextMarkupBase.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.TextMarkupBase.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

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

Return type

void

setStrokeWidth

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

Sets the stroke width for this shape in pixels

Arguments

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

Return type

void