Class Clef

constructor

• new Clef(opts?): Clef

• Parameters

  • Optional opts: {
        attributes?: Partial<ClefAttributes>;
        contents?: ClefContents;
    }

    • Optional attributes?: Partial<ClefAttributes>

    • Optional contents?: ClefContents

  Returns Clef

attributes

contents

Readonly schema

Static Readonly schema

getAdditional

• getAdditional(): null | "yes" | "no"

• Gets

  Returns null | "yes" | "no"

getAfterBarline

• getAfterBarline(): null | "yes" | "no"

• Gets

  Returns null | "yes" | "no"

getClefOctaveChange

• getClefOctaveChange(): null | ClefOctaveChange

• Gets

  Returns null | ClefOctaveChange

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"

getId

• getId(): null | string

• Gets

  Returns null | string

getLine

• getLine(): null | Line

• Gets

  Returns null | Line

getNumber

• getNumber(): null | number

• Gets

  Returns null | number

getPrintObject

• getPrintObject(): null | "yes" | "no"

• Gets

  Returns null | "yes" | "no"

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getSign

• getSign(): Sign

• Gets

  Returns Sign

getSize

• getSize(): null | "large" | "cue" | "grace-cue" | "full"

• Gets

  Returns null | "large" | "cue" | "grace-cue" | "full"

setAdditional

• setAdditional(additional): Clef

• Sets

  Parameters

  • additional: null | "yes" | "no"

  Returns Clef

setAfterBarline

• setAfterBarline(afterBarline): Clef

• Sets

  Parameters

  • afterBarline: null | "yes" | "no"

  Returns Clef

setClefOctaveChange

• setClefOctaveChange(clefOctaveChange): Clef

• Sets

  Parameters

  • clefOctaveChange: null | ClefOctaveChange

  Returns Clef

setColor

• setColor(color): Clef

• Sets

  Parameters

  • color: null | string

  Returns Clef

setDefaultX

• setDefaultX(defaultX): Clef

• Sets

  Parameters

  • defaultX: null | number

  Returns Clef

setDefaultY

• setDefaultY(defaultY): Clef

• Sets

  Parameters

  • defaultY: null | number

  Returns Clef

setFontFamily

• setFontFamily(fontFamily): Clef

• Sets

  Parameters

  • fontFamily: null | string

  Returns Clef

setFontSize

• setFontSize(fontSize): Clef

• Sets

  Parameters

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

  Returns Clef

setFontStyle

• setFontStyle(fontStyle): Clef

• Sets

  Parameters

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

  Returns Clef

setFontWeight

• setFontWeight(fontWeight): Clef

• Sets

  Parameters

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

  Returns Clef

setId

• setId(id): Clef

• Sets

  Parameters

  • id: null | string

  Returns Clef

setLine

• setLine(line): Clef

• Sets

  Parameters

  • line: null | Line

  Returns Clef

setNumber

• setNumber(number): Clef

• Sets

  Parameters

  • number: null | number

  Returns Clef

setPrintObject

• setPrintObject(printObject): Clef

• Sets

  Parameters

  • printObject: null | "yes" | "no"

  Returns Clef

setRelativeX

• setRelativeX(relativeX): Clef

• Sets

  Parameters

  • relativeX: null | number

  Returns Clef

setRelativeY

• setRelativeY(relativeY): Clef

• Sets

  Parameters

  • relativeY: null | number

  Returns Clef

setSign

• setSign(sign): Clef

• Sets

  Parameters

  • sign: Sign

  Returns Clef

setSize

• setSize(size): Clef

• Sets

  Parameters

  • size: null | "large" | "cue" | "grace-cue" | "full"

  Returns Clef