Class OpenString

constructor

• new OpenString(opts?): OpenString

• Parameters

  • Optional opts: {
        attributes?: Partial<OpenStringAttributes>;
        contents?: [];
    }

    • Optional attributes?: Partial<OpenStringAttributes>

    • Optional contents?: []

  Returns OpenString

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

setColor

• setColor(color): OpenString

• Sets

  Parameters

  • color: null | string

  Returns OpenString

setDefaultX

• setDefaultX(defaultX): OpenString

• Sets

  Parameters

  • defaultX: null | number

  Returns OpenString

setDefaultY

• setDefaultY(defaultY): OpenString

• Sets

  Parameters

  • defaultY: null | number

  Returns OpenString

setFontFamily

• setFontFamily(fontFamily): OpenString

• Sets

  Parameters

  • fontFamily: null | string

  Returns OpenString

setFontSize

• setFontSize(fontSize): OpenString

• Sets

  Parameters

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

  Returns OpenString

setFontStyle

• setFontStyle(fontStyle): OpenString

• Sets

  Parameters

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

  Returns OpenString

setFontWeight

• setFontWeight(fontWeight): OpenString

• Sets

  Parameters

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

  Returns OpenString

setPlacement

• setPlacement(placement): OpenString

• Sets

  Parameters

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

  Returns OpenString

setRelativeX

• setRelativeX(relativeX): OpenString

• Sets

  Parameters

  • relativeX: null | number

  Returns OpenString

setRelativeY

• setRelativeY(relativeY): OpenString

• Sets

  Parameters

  • relativeY: null | number

  Returns OpenString