Class PartSymbol

constructor

• new PartSymbol(opts?): PartSymbol

• Parameters

  • Optional opts: {
        attributes?: Partial<PartSymbolAttributes>;
        contents?: PartSymbolContents;
    }

    • Optional attributes?: Partial<PartSymbolAttributes>

    • Optional contents?: PartSymbolContents

  Returns PartSymbol

attributes

contents

Readonly schema

Static Readonly schema

getBottomStaff

• getBottomStaff(): null | number

• Gets

  Returns null | number

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"

getGroupSymbolValue

• getGroupSymbolValue(): "none" | "bracket" | "square" | "brace" | "line"

• Gets

  Returns "none" | "bracket" | "square" | "brace" | "line"

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getTopStaff

• getTopStaff(): null | number

• Gets

  Returns null | number

setBottomStaff

• setBottomStaff(bottomStaff): PartSymbol

• Sets

  Parameters

  • bottomStaff: null | number

  Returns PartSymbol

setColor

• setColor(color): PartSymbol

• Sets

  Parameters

  • color: null | string

  Returns PartSymbol

setDefaultX

• setDefaultX(defaultX): PartSymbol

• Sets

  Parameters

  • defaultX: null | number

  Returns PartSymbol

setDefaultY

• setDefaultY(defaultY): PartSymbol

• Sets

  Parameters

  • defaultY: null | number

  Returns PartSymbol

setFontFamily

• setFontFamily(fontFamily): PartSymbol

• Sets

  Parameters

  • fontFamily: null | string

  Returns PartSymbol

setFontSize

• setFontSize(fontSize): PartSymbol

• Sets

  Parameters

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

  Returns PartSymbol

setFontStyle

• setFontStyle(fontStyle): PartSymbol

• Sets

  Parameters

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

  Returns PartSymbol

setFontWeight

• setFontWeight(fontWeight): PartSymbol

• Sets

  Parameters

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

  Returns PartSymbol

setGroupSymbolValue

• setGroupSymbolValue(groupSymbolValue): PartSymbol

• Sets

  Parameters

  • groupSymbolValue: "none" | "bracket" | "square" | "brace" | "line"

  Returns PartSymbol

setRelativeX

• setRelativeX(relativeX): PartSymbol

• Sets

  Parameters

  • relativeX: null | number

  Returns PartSymbol

setRelativeY

• setRelativeY(relativeY): PartSymbol

• Sets

  Parameters

  • relativeY: null | number

  Returns PartSymbol

setTopStaff

• setTopStaff(topStaff): PartSymbol

• Sets

  Parameters

  • topStaff: null | number

  Returns PartSymbol