Class StringMute

constructor

• new StringMute(opts?): StringMute

• Parameters

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

    • Optional attributes?: Partial<StringMuteAttributes>

    • Optional contents?: []

  Returns StringMute

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"

getHalign

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

• Gets

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

getId

• getId(): null | string

• Gets

  Returns null | string

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getType

• getType(): "on" | "off"

• Gets

  Returns "on" | "off"

getValign

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

• Gets

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

setColor

• setColor(color): StringMute

• Sets

  Parameters

  • color: null | string

  Returns StringMute

setDefaultX

• setDefaultX(defaultX): StringMute

• Sets

  Parameters

  • defaultX: null | number

  Returns StringMute

setDefaultY

• setDefaultY(defaultY): StringMute

• Sets

  Parameters

  • defaultY: null | number

  Returns StringMute

setFontFamily

• setFontFamily(fontFamily): StringMute

• Sets

  Parameters

  • fontFamily: null | string

  Returns StringMute

setFontSize

• setFontSize(fontSize): StringMute

• Sets

  Parameters

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

  Returns StringMute

setFontStyle

• setFontStyle(fontStyle): StringMute

• Sets

  Parameters

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

  Returns StringMute

setFontWeight

• setFontWeight(fontWeight): StringMute

• Sets

  Parameters

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

  Returns StringMute

setHalign

• setHalign(halign): StringMute

• Sets

  Parameters

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

  Returns StringMute

setId

• setId(id): StringMute

• Sets

  Parameters

  • id: null | string

  Returns StringMute

setRelativeX

• setRelativeX(relativeX): StringMute

• Sets

  Parameters

  • relativeX: null | number

  Returns StringMute

setRelativeY

• setRelativeY(relativeY): StringMute

• Sets

  Parameters

  • relativeY: null | number

  Returns StringMute

setType

• setType(type): StringMute

• Sets

  Parameters

  • type: "on" | "off"

  Returns StringMute

setValign

• setValign(valign): StringMute

• Sets

  Parameters

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

  Returns StringMute