Class RhythmProps

Rhythm props class.

Index

Properties

dotCount flagCount hasStem isSolidNoteHead noteLength noteSize ticks tupletRatio?

Methods

toString cmp equals get

Properties

`Readonly`dotCount

dotCount: number

Dot count.

`Readonly`flagCount

flagCount: number

Flag count.

`Readonly`hasStem

hasStem: boolean

Has note stem.

`Readonly`isSolidNoteHead

isSolidNoteHead: boolean

Is note head solid (black)?

`Readonly`noteLength

noteLength: NoteLength

Note length.

`Readonly`noteSize

noteSize: number

Note size (whole=1, half=2, quarter=4, ...).

`Readonly`ticks

ticks: number

Number of ticks.

`Optional` `Readonly`tupletRatio

tupletRatio?: TupletRatio

Tuplet ratio.

Methods

toString

toString(): string
Get string presentation of rhythm props.

Returns string
- String presentation.

`Static`cmp

cmp(a: RhythmProps, b: RhythmProps): -1 | 0 | 1
Compare duration of rhythm props.
Parameters
- a: RhythmProps
  RhythmProps
- b: RhythmProps
  RhythmProps
Returns -1 | 0 | 1
- -1: a < b, 0: a === b, +1: a > b (duration comparisons)

`Static`equals

equals(a: RhythmProps, b: RhythmProps): boolean
Compare duration equality of rhythm props.
Parameters
- a: RhythmProps
  RhythmProps
- b: RhythmProps
  RhythmProps
Returns boolean
- true: a === b, false: a !== b (duration comparisons)

`Static`get

get(
    noteLength:
        | "1n"
        | "1t"
        | "1."
        | "1.."
        | "1..."
        | "1...."
        | "1....."
        | "1......"
        | "2n"
        | "2t"
        | "2."
        | "2.."
        | "2..."
        | "2...."
        | "2....."
        | "4n"
        | "4t"
        | "4."
        | "4.."
        | "4..."
        | "4...."
        | "8n"
        | "8t"
        | "8."
        | "8.."
        | "8..."
        | "16n"
        | "16t"
        | "16."
        | "16.."
        | "32n"
        | "32t"
        | "32."
        | "64n"
        | "64t"
        | NoteLength,
    dotCount?: number,
    tupletRatio?: TupletRatio,
): RhythmProps
Get rhythm props with given arguments.
Parameters
- noteLength:
      | "1n"
      | "1t"
      | "1."
      | "1.."
      | "1..."
      | "1...."
      | "1....."
      | "1......"
      | "2n"
      | "2t"
      | "2."
      | "2.."
      | "2..."
      | "2...."
      | "2....."
      | "4n"
      | "4t"
      | "4."
      | "4.."
      | "4..."
      | "4...."
      | "8n"
      | "8t"
      | "8."
      | "8.."
      | "8..."
      | "16n"
      | "16t"
      | "16."
      | "16.."
      | "32n"
      | "32t"
      | "32."
      | "64n"
      | "64t"
      | NoteLength
  Note length.
- OptionaldotCount: number
  Dot count.
- OptionaltupletRatio: TupletRatio
  Tuplet ratio.
Returns RhythmProps
- Rhythm props.