Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tuplet

Tuplets create irregular rhythms; e.g. triplets, quadruplets, quintuplets, etc.

Hierarchy

  • Tuplet

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Tuplet(tupletLabelNumber: number, bracket?: boolean): Tuplet

Properties

BracketedXmlValue

BracketedXmlValue: boolean

Boolean if 'bracket="no"' or "yes" was explicitly requested in the XML, otherwise undefined.

PlacementFromXml

PlacementFromXml: boolean = false

RenderTupletNumber

RenderTupletNumber: boolean = true

ShowNumberNoneGivenInXml

ShowNumberNoneGivenInXml: boolean

Whether was given in the XML, indicating the tuplet number should not be rendered.

Private bracket

bracket: boolean

Whether this tuplet has a bracket. (e.g. showing |--3--| or just 3 for a triplet)

Private fractions

fractions: Fraction[] = []

Private notes

notes: Note[][] = []

Notes contained in the tuplet, per VoiceEntry (list of VoiceEntries, which has a list of notes).

Private tupletLabelNumber

tupletLabelNumber: number

tupletLabelNumberPlacement

tupletLabelNumberPlacement: PlacementEnum

Accessors

Bracket

  • get Bracket(): boolean
  • set Bracket(value: boolean): void

Fractions

Notes

  • get Notes(): Note[][]
  • set Notes(value: Note[][]): void

TupletLabelNumber

  • get TupletLabelNumber(): number
  • set TupletLabelNumber(value: number): void

Methods

getNoteIndex

  • getNoteIndex(note: Note): number

shouldBeBracketed

  • shouldBeBracketed(useXmlValue: boolean, tupletsBracketed: boolean, tripletsBracketed: boolean, isTabMeasure?: boolean, tabTupletsBracketed?: boolean): boolean

  • Determines whether the tuplet should be bracketed (arguments are EngravingRules).

    Parameters

    • useXmlValue: boolean
    • tupletsBracketed: boolean
    • tripletsBracketed: boolean
    • isTabMeasure: boolean = false
    • tabTupletsBracketed: boolean = false

    Returns boolean

Generated using TypeDoc