Class BreathMark

constructor

• new BreathMark(opts?): BreathMark

• Parameters

  • Optional opts: {
        attributes?: Partial<BreathMarkAttributes>;
        contents?: BreathMarkContents;
    }

    • Optional attributes?: Partial<BreathMarkAttributes>

    • Optional contents?: BreathMarkContents

  Returns BreathMark

attributes

contents

Readonly schema

Static Readonly schema

getBreathMarkValue

• getBreathMarkValue(): null | "" | "comma" | "tick" | "upbow" | "salzedo"

• Gets

  Returns null | "" | "comma" | "tick" | "upbow" | "salzedo"

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

setBreathMarkValue

• setBreathMarkValue(breathMarkValue): BreathMark

• Sets

  Parameters

  • breathMarkValue: null | "" | "comma" | "tick" | "upbow" | "salzedo"

  Returns BreathMark

setColor

• setColor(color): BreathMark

• Sets

  Parameters

  • color: null | string

  Returns BreathMark

setDefaultX

• setDefaultX(defaultX): BreathMark

• Sets

  Parameters

  • defaultX: null | number

  Returns BreathMark

setDefaultY

• setDefaultY(defaultY): BreathMark

• Sets

  Parameters

  • defaultY: null | number

  Returns BreathMark

setFontFamily

• setFontFamily(fontFamily): BreathMark

• Sets

  Parameters

  • fontFamily: null | string

  Returns BreathMark

setFontSize

• setFontSize(fontSize): BreathMark

• Sets

  Parameters

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

  Returns BreathMark

setFontStyle

• setFontStyle(fontStyle): BreathMark

• Sets

  Parameters

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

  Returns BreathMark

setFontWeight

• setFontWeight(fontWeight): BreathMark

• Sets

  Parameters

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

  Returns BreathMark

setPlacement

• setPlacement(placement): BreathMark

• Sets

  Parameters

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

  Returns BreathMark

setRelativeX

• setRelativeX(relativeX): BreathMark

• Sets

  Parameters

  • relativeX: null | number

  Returns BreathMark

setRelativeY

• setRelativeY(relativeY): BreathMark

• Sets

  Parameters

  • relativeY: null | number

  Returns BreathMark