Class DisplayText

constructor

• new DisplayText(opts?): DisplayText

• Parameters

  • Optional opts: {
        attributes?: Partial<DisplayTextAttributes>;
        contents?: DisplayTextContents;
    }

    • Optional attributes?: Partial<DisplayTextAttributes>

    • Optional contents?: DisplayTextContents

  Returns DisplayText

attributes

contents

Readonly schema

Static Readonly schema

getColor

• getColor(): null | string

• Gets

  Returns null | string

getDefaultX

• getDefaultX(): null | number

• Gets

  Returns null | number

getDefaultY

• getDefaultY(): null | number

• Gets

  Returns null | number

getDir

• getDir(): null | "ltr" | "rtl" | "lro" | "rlo"

• Gets

  Returns null | "ltr" | "rtl" | "lro" | "rlo"

getEnclosure

• getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

• Gets

  Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

getFontFamily

• getFontFamily(): null | string

• Gets

  Returns null | string

getFontSize

• getFontSize(): null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

• Gets

  Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

getFontStyle

• getFontStyle(): null | "normal" | "italic"

• Gets

  Returns null | "normal" | "italic"

getFontWeight

• getFontWeight(): null | "normal" | "bold"

• Gets

  Returns null | "normal" | "bold"

getHalign

• getHalign(): null | "left" | "center" | "right"

• Gets

  Returns null | "left" | "center" | "right"

getJustify

• getJustify(): null | "left" | "center" | "right"

• Gets

  Returns null | "left" | "center" | "right"

getLetterSpacing

• getLetterSpacing(): null | number | "normal"

• Gets

  Returns null | number | "normal"

getLineHeight

• getLineHeight(): null | number | "normal"

• Gets

  Returns null | number | "normal"

getLineThrough

• getLineThrough(): null | number

• Gets

  Returns null | number

getOverline

• getOverline(): null | number

• Gets

  Returns null | number

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getRotation

• getRotation(): null | number

• Gets

  Returns null | number

getText

• getText(): null | string

• Gets

  Returns null | string

getUnderline

• getUnderline(): null | number

• Gets

  Returns null | number

getValign

• getValign(): null | "top" | "middle" | "bottom" | "baseline"

• Gets

  Returns null | "top" | "middle" | "bottom" | "baseline"

getXmlLang

• getXmlLang(): null | string

• Gets

  Returns null | string

getXmlSpace

• getXmlSpace(): null | "default" | "preserve"

• Gets

  Returns null | "default" | "preserve"

setColor

• setColor(color): DisplayText

• Sets

  Parameters

  • color: null | string

  Returns DisplayText

setDefaultX

• setDefaultX(defaultX): DisplayText

• Sets

  Parameters

  • defaultX: null | number

  Returns DisplayText

setDefaultY

• setDefaultY(defaultY): DisplayText

• Sets

  Parameters

  • defaultY: null | number

  Returns DisplayText

setDir

• setDir(dir): DisplayText

• Sets

  Parameters

  • dir: null | "ltr" | "rtl" | "lro" | "rlo"

  Returns DisplayText

setEnclosure

• setEnclosure(enclosure): DisplayText

• Sets

  Parameters

  • enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

  Returns DisplayText

setFontFamily

• setFontFamily(fontFamily): DisplayText

• Sets

  Parameters

  • fontFamily: null | string

  Returns DisplayText

setFontSize

• setFontSize(fontSize): DisplayText

• Sets

  Parameters

  • fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

  Returns DisplayText

setFontStyle

• setFontStyle(fontStyle): DisplayText

• Sets

  Parameters

  • fontStyle: null | "normal" | "italic"

  Returns DisplayText

setFontWeight

• setFontWeight(fontWeight): DisplayText

• Sets

  Parameters

  • fontWeight: null | "normal" | "bold"

  Returns DisplayText

setHalign

• setHalign(halign): DisplayText

• Sets

  Parameters

  • halign: null | "left" | "center" | "right"

  Returns DisplayText

setJustify

• setJustify(justify): DisplayText

• Sets

  Parameters

  • justify: null | "left" | "center" | "right"

  Returns DisplayText

setLetterSpacing

• setLetterSpacing(letterSpacing): DisplayText

• Sets

  Parameters

  • letterSpacing: null | number | "normal"

  Returns DisplayText

setLineHeight

• setLineHeight(lineHeight): DisplayText

• Sets

  Parameters

  • lineHeight: null | number | "normal"

  Returns DisplayText

setLineThrough

• setLineThrough(lineThrough): DisplayText

• Sets

  Parameters

  • lineThrough: null | number

  Returns DisplayText

setOverline

• setOverline(overline): DisplayText

• Sets

  Parameters

  • overline: null | number

  Returns DisplayText

setRelativeX

• setRelativeX(relativeX): DisplayText

• Sets

  Parameters

  • relativeX: null | number

  Returns DisplayText

setRelativeY

• setRelativeY(relativeY): DisplayText

• Sets

  Parameters

  • relativeY: null | number

  Returns DisplayText

setRotation

• setRotation(rotation): DisplayText

• Sets

  Parameters

  • rotation: null | number

  Returns DisplayText

setText

• setText(text): DisplayText

• Sets

  Parameters

  • text: null | string

  Returns DisplayText

setUnderline

• setUnderline(underline): DisplayText

• Sets

  Parameters

  • underline: null | number

  Returns DisplayText

setValign

• setValign(valign): DisplayText

• Sets

  Parameters

  • valign: null | "top" | "middle" | "bottom" | "baseline"

  Returns DisplayText

setXmlLang

• setXmlLang(xmlLang): DisplayText

• Sets

  Parameters

  • xmlLang: null | string

  Returns DisplayText

setXmlSpace

• setXmlSpace(xmlSpace): DisplayText

• Sets

  Parameters

  • xmlSpace: null | "default" | "preserve"

  Returns DisplayText