Class StaffDetails

constructor

• new StaffDetails(opts?): StaffDetails

• Parameters

  • Optional opts: {
        attributes?: Partial<StaffDetailsAttributes>;
        contents?: StaffDetailsContents;
    }

    • Optional attributes?: Partial<StaffDetailsAttributes>

    • Optional contents?: StaffDetailsContents

  Returns StaffDetails

attributes

contents

Readonly schema

Static Readonly schema

getCapo

• getCapo(): null | Capo

• Gets

  Returns null | Capo

getLines

• getLines(): null | [StaffLines, LineDetail[]]

• Gets

  Returns null | [StaffLines, LineDetail[]]

getNumber

• getNumber(): null | number

• Gets

  Returns null | number

getPrintObject

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

• Gets

  Returns null | "yes" | "no"

getPrintSpacing

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

• Gets

  Returns null | "yes" | "no"

getShowFrets

• getShowFrets(): null | "letters" | "numbers"

• Gets

  Returns null | "letters" | "numbers"

getStaffSize

• getStaffSize(): null | StaffSize

• Gets

  Returns null | StaffSize

getStaffTunings

• getStaffTunings(): StaffTuning[]

• Gets

  Returns StaffTuning[]

getStaffType

• getStaffType(): null | StaffType

• Gets

  Returns null | StaffType

setCapo

• setCapo(capo): StaffDetails

• Sets

  Parameters

  • capo: null | Capo

  Returns StaffDetails

setLines

• setLines(lines): StaffDetails

• Sets

  Parameters

  • lines: null | [StaffLines, LineDetail[]]

  Returns StaffDetails

setNumber

• setNumber(number): StaffDetails

• Sets

  Parameters

  • number: null | number

  Returns StaffDetails

setPrintObject

• setPrintObject(printObject): StaffDetails

• Sets

  Parameters

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

  Returns StaffDetails

setPrintSpacing

• setPrintSpacing(printSpacing): StaffDetails

• Sets

  Parameters

  • printSpacing: null | "yes" | "no"

  Returns StaffDetails

setShowFrets

• setShowFrets(showFrets): StaffDetails

• Sets

  Parameters

  • showFrets: null | "letters" | "numbers"

  Returns StaffDetails

setStaffSize

• setStaffSize(staffSize): StaffDetails

• Sets

  Parameters

  • staffSize: null | StaffSize

  Returns StaffDetails

setStaffTunings

• setStaffTunings(staffTunings): StaffDetails

• Sets

  Parameters

  • staffTunings: StaffTuning[]

  Returns StaffDetails

setStaffType

• setStaffType(staffType): StaffDetails

• Sets

  Parameters

  • staffType: null | StaffType

  Returns StaffDetails