Class AccidentalText

constructor

• new AccidentalText(opts?): AccidentalText

• Parameters

  • Optional opts: {
        attributes?: Partial<AccidentalTextAttributes>;
        contents?: AccidentalTextContents;
    }

    • Optional attributes?: Partial<AccidentalTextAttributes>

    • Optional contents?: AccidentalTextContents

  Returns AccidentalText

attributes

contents

Readonly schema

Static Readonly schema

getAccidentalValue

• getAccidentalValue(): "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"

• Gets

  Returns "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"

getColor

• getColor(): null | string

• Gets

  Returns null | string

getDefaultX

• getDefaultX(): null | number

• Gets

  Returns null | number

getDefaultY

• getDefaultY(): null | number

• Gets

  Returns null | number

getDir

• getDir(): null | "ltr" | "rtl" | "lro" | "rlo"

• Gets

  Returns null | "ltr" | "rtl" | "lro" | "rlo"

getEnclosure

• getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

• Gets

  Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

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"

getJustify

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

• Gets

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

getLetterSpacing

• getLetterSpacing(): null | number | "normal"

• Gets

  Returns null | number | "normal"

getLineHeight

• getLineHeight(): null | number | "normal"

• Gets

  Returns null | number | "normal"

getLineThrough

• getLineThrough(): null | number

• Gets

  Returns null | number

getOverline

• getOverline(): null | number

• Gets

  Returns null | number

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getRotation

• getRotation(): null | number

• Gets

  Returns null | number

getSmufl

• getSmufl(): null | string

• Gets

  Returns null | string

getUnderline

• getUnderline(): null | number

• Gets

  Returns null | number

getValign

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

• Gets

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

getXmlLang

• getXmlLang(): null | string

• Gets

  Returns null | string

getXmlSpace

• getXmlSpace(): null | "default" | "preserve"

• Gets

  Returns null | "default" | "preserve"

setAccidentalValue

• setAccidentalValue(accidentalValue): AccidentalText

• Sets

  Parameters

  • accidentalValue: "other" | "sharp" | "natural" | "flat" | "double-sharp" | "sharp-sharp" | "flat-flat" | "natural-sharp" | "natural-flat" | "quarter-flat" | "quarter-sharp" | "three-quarters-flat" | "three-quarters-sharp" | "sharp-down" | "sharp-up" | "natural-down" | "natural-up" | "flat-down" | "flat-up" | "double-sharp-down" | "double-sharp-up" | "flat-flat-down" | "flat-flat-up" | "arrow-down" | "arrow-up" | "triple-sharp" | "triple-flat" | "slash-quarter-sharp" | "slash-sharp" | "slash-flat" | "double-slash-flat" | "sharp-1" | "sharp-2" | "sharp-3" | "sharp-5" | "flat-1" | "flat-2" | "flat-3" | "flat-4" | "sori" | "koron"

  Returns AccidentalText

setColor

• setColor(color): AccidentalText

• Sets

  Parameters

  • color: null | string

  Returns AccidentalText

setDefaultX

• setDefaultX(defaultX): AccidentalText

• Sets

  Parameters

  • defaultX: null | number

  Returns AccidentalText

setDefaultY

• setDefaultY(defaultY): AccidentalText

• Sets

  Parameters

  • defaultY: null | number

  Returns AccidentalText

setDir

• setDir(dir): AccidentalText

• Sets

  Parameters

  • dir: null | "ltr" | "rtl" | "lro" | "rlo"

  Returns AccidentalText

setEnclosure

• setEnclosure(enclosure): AccidentalText

• Sets

  Parameters

  • enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

  Returns AccidentalText

setFontFamily

• setFontFamily(fontFamily): AccidentalText

• Sets

  Parameters

  • fontFamily: null | string

  Returns AccidentalText

setFontSize

• setFontSize(fontSize): AccidentalText

• Sets

  Parameters

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

  Returns AccidentalText

setFontStyle

• setFontStyle(fontStyle): AccidentalText

• Sets

  Parameters

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

  Returns AccidentalText

setFontWeight

• setFontWeight(fontWeight): AccidentalText

• Sets

  Parameters

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

  Returns AccidentalText

setHalign

• setHalign(halign): AccidentalText

• Sets

  Parameters

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

  Returns AccidentalText

setJustify

• setJustify(justify): AccidentalText

• Sets

  Parameters

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

  Returns AccidentalText

setLetterSpacing

• setLetterSpacing(letterSpacing): AccidentalText

• Sets

  Parameters

  • letterSpacing: null | number | "normal"

  Returns AccidentalText

setLineHeight

• setLineHeight(lineHeight): AccidentalText

• Sets

  Parameters

  • lineHeight: null | number | "normal"

  Returns AccidentalText

setLineThrough

• setLineThrough(lineThrough): AccidentalText

• Sets

  Parameters

  • lineThrough: null | number

  Returns AccidentalText

setOverline

• setOverline(overline): AccidentalText

• Sets

  Parameters

  • overline: null | number

  Returns AccidentalText

setRelativeX

• setRelativeX(relativeX): AccidentalText

• Sets

  Parameters

  • relativeX: null | number

  Returns AccidentalText

setRelativeY

• setRelativeY(relativeY): AccidentalText

• Sets

  Parameters

  • relativeY: null | number

  Returns AccidentalText

setRotation

• setRotation(rotation): AccidentalText

• Sets

  Parameters

  • rotation: null | number

  Returns AccidentalText

setSmufl

• setSmufl(smufl): AccidentalText

• Sets

  Parameters

  • smufl: null | string

  Returns AccidentalText

setUnderline

• setUnderline(underline): AccidentalText

• Sets

  Parameters

  • underline: null | number

  Returns AccidentalText

setValign

• setValign(valign): AccidentalText

• Sets

  Parameters

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

  Returns AccidentalText

setXmlLang

• setXmlLang(xmlLang): AccidentalText

• Sets

  Parameters

  • xmlLang: null | string

  Returns AccidentalText

setXmlSpace

• setXmlSpace(xmlSpace): AccidentalText

• Sets

  Parameters

  • xmlSpace: null | "default" | "preserve"

  Returns AccidentalText