Class TimeSignature

Time signature class.

Index

Constructors

Properties

beamGroupSizes beatCount beatLength beatSize measureTicks type

Methods

Constructors

constructor

new TimeSignature(timeSignature: "C" | "C|"): TimeSignature
Create new time signature instance.
Parameters
- timeSignature: "C" | "C|"
  Commmon time signature "C".
Returns TimeSignature
new TimeSignature(
timeSignature: TimeSignaturesValue,
beamGrouping?: BeamGroupingValue,
): TimeSignature
Create new time signature instance.
Parameters
- timeSignature: TimeSignaturesValue
  For example "4/4".
- OptionalbeamGrouping: BeamGroupingValue
  Beam grouping (e.g. "3-2" for time signature "5/8").
Returns TimeSignature
new TimeSignature(
    beatCount: number,
    beatSize: number,
    beamGrouping?: BeamGroupingValue,
): TimeSignature
Create new time signature instance.
Parameters
- beatCount: number
  Measure beat count.
- beatSize: number
  Size value: whole-note=1, half-note=2, quarter-note=4, etc.
- OptionalbeamGrouping: BeamGroupingValue
  Beam grouping (e.g. "3-2" for time signature "5/8").
Returns TimeSignature

Properties

`Readonly`beamGroupSizes

beamGroupSizes: number[][] = []

Beam groups (e.g. [[2], [2]] or [[2, 2], [2, 2]] (first try as [[4], [4]])).

`Readonly`beatCount

beatCount: number

Number of beats in measure, upper value (e.g. "3" in "3/4").

`Readonly`beatLength

beatLength: NoteLength

Beat length.

`Readonly`beatSize

beatSize: number

Beat size of time signature, lower value (e.g. "4" in "3/4").

`Readonly`measureTicks

measureTicks: number

Number of ticks in measure.

`Readonly`type

type: "n/d" | "common" | "cut" = "n/d"

Methods

is

is(beatCount: number, beatSize: number): boolean
Test whether this time signature has given beat count and size.
Parameters
- beatCount: number
  Beat count.
- beatSize: number
  Beat size.
Returns boolean
- Boolean whether this time signature match given beat count and size.

toString

toString(): string
Get string representation of this time signature (e.g. "3/4").

Returns string
- String representation.