Class String

constructor

• new String(opts?): String

• Parameters

  • Optional opts: {
        attributes?: Partial<StringAttributes>;
        contents?: StringContents;
    }

    • Optional attributes?: Partial<StringAttributes>

    • Optional contents?: StringContents

  Returns String

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

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"

getPlacement

• getPlacement(): null | "above" | "below"

• Gets

  Returns null | "above" | "below"

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getStringNumber

• getStringNumber(): number

• Gets

  Returns number

setColor

• setColor(color): String

• Sets

  Parameters

  • color: null | string

  Returns String

setDefaultX

• setDefaultX(defaultX): String

• Sets

  Parameters

  • defaultX: null | number

  Returns String

setDefaultY

• setDefaultY(defaultY): String

• Sets

  Parameters

  • defaultY: null | number

  Returns String

setFontFamily

• setFontFamily(fontFamily): String

• Sets

  Parameters

  • fontFamily: null | string

  Returns String

setFontSize

• setFontSize(fontSize): String

• Sets

  Parameters

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

  Returns String

setFontStyle

• setFontStyle(fontStyle): String

• Sets

  Parameters

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

  Returns String

setFontWeight

• setFontWeight(fontWeight): String

• Sets

  Parameters

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

  Returns String

setPlacement

• setPlacement(placement): String

• Sets

  Parameters

  • placement: null | "above" | "below"

  Returns String

setRelativeX

• setRelativeX(relativeX): String

• Sets

  Parameters

  • relativeX: null | number

  Returns String

setRelativeY

• setRelativeY(relativeY): String

• Sets

  Parameters

  • relativeY: null | number

  Returns String

setStringNumber

• setStringNumber(stringNumber): String

• Sets

  Parameters

  • stringNumber: number

  Returns String