Class Caesura

constructor

• new Caesura(opts?): Caesura

• Parameters

  • Optional opts: {
        attributes?: Partial<CaesuraAttributes>;
        contents?: CaesuraContents;
    }

    • Optional attributes?: Partial<CaesuraAttributes>

    • Optional contents?: CaesuraContents

  Returns Caesura

attributes

contents

Readonly schema

Static Readonly schema

getCaesuraValue

• getCaesuraValue(): null | "" | "normal" | "single" | "curved" | "short" | "thick"

• Gets

  Returns null | "" | "normal" | "single" | "curved" | "short" | "thick"

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

setCaesuraValue

• setCaesuraValue(caesuraValue): Caesura

• Sets

  Parameters

  • caesuraValue: null | "" | "normal" | "single" | "curved" | "short" | "thick"

  Returns Caesura

setColor

• setColor(color): Caesura

• Sets

  Parameters

  • color: null | string

  Returns Caesura

setDefaultX

• setDefaultX(defaultX): Caesura

• Sets

  Parameters

  • defaultX: null | number

  Returns Caesura

setDefaultY

• setDefaultY(defaultY): Caesura

• Sets

  Parameters

  • defaultY: null | number

  Returns Caesura

setFontFamily

• setFontFamily(fontFamily): Caesura

• Sets

  Parameters

  • fontFamily: null | string

  Returns Caesura

setFontSize

• setFontSize(fontSize): Caesura

• Sets

  Parameters

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

  Returns Caesura

setFontStyle

• setFontStyle(fontStyle): Caesura

• Sets

  Parameters

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

  Returns Caesura

setFontWeight

• setFontWeight(fontWeight): Caesura

• Sets

  Parameters

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

  Returns Caesura

setPlacement

• setPlacement(placement): Caesura

• Sets

  Parameters

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

  Returns Caesura

setRelativeX

• setRelativeX(relativeX): Caesura

• Sets

  Parameters

  • relativeX: null | number

  Returns Caesura

setRelativeY

• setRelativeY(relativeY): Caesura

• Sets

  Parameters

  • relativeY: null | number

  Returns Caesura