Class RhythmInstruction

A [[RhythmInstruction]] is the time signature which specifies the number of beats in each bar, and the value of one beat.

Hierarchy (View Summary)

AbstractNotationInstruction
- RhythmInstruction

Index

Constructors

constructor

new RhythmInstruction(
rhythm: Fraction,
rhythmSymbolEnum: RhythmSymbolEnum,
): RhythmInstruction
Parameters
- rhythm: Fraction
- rhythmSymbolEnum: RhythmSymbolEnum
Returns RhythmInstruction
Overrides AbstractNotationInstruction.constructor
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:8

Properties

`Protected`parent

parent: SourceStaffEntry

SynthesizedFromNoTimeSignature

SynthesizedFromNoTimeSignature: boolean = false

Whether this time signature was not given in the source (e.g. MusicXML), but synthesized by default, e.g. a default 4/4 for a sample without a time signature like Satie's Gnossiennes. Such a time signature is not rendered by default (see EngravingRules.RenderTimeSignaturesForSamplesWithoutTimeSignature).

Accessors

Parent

get Parent(): SourceStaffEntry
Returns SourceStaffEntry
Inherited from AbstractNotationInstruction.Parent
- Defined in MusicalScore/VoiceData/Instructions/AbstractNotationInstruction.ts:13
set Parent(value: SourceStaffEntry): void
Parameters
- value: SourceStaffEntry
Returns void
Inherited from AbstractNotationInstruction.Parent
- Defined in MusicalScore/VoiceData/Instructions/AbstractNotationInstruction.ts:16

PrintObject

get PrintObject(): boolean
Returns boolean
Inherited from AbstractNotationInstruction.PrintObject
- Defined in MusicalScore/VoiceData/Instructions/AbstractNotationInstruction.ts:20
set PrintObject(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractNotationInstruction.PrintObject
- Defined in MusicalScore/VoiceData/Instructions/AbstractNotationInstruction.ts:24

Rhythm

get Rhythm(): Fraction
Returns Fraction
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:25
set Rhythm(value: Fraction): void
Parameters
- value: Fraction
Returns void
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:29

SymbolEnum

get SymbolEnum(): RhythmSymbolEnum
Returns RhythmSymbolEnum
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:33
set SymbolEnum(value: RhythmSymbolEnum): void
Parameters
- value: RhythmSymbolEnum
Returns void
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:37

Methods

clone

clone(): RhythmInstruction
Returns RhythmInstruction
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:41

OperatorEquals

OperatorEquals(rhythm2: RhythmInstruction): boolean
Parameters
- rhythm2: RhythmInstruction
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:47

OperatorNotEqual

OperatorNotEqual(rhythm2: RhythmInstruction): boolean
Parameters
- rhythm2: RhythmInstruction
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:58

ToString

ToString(): string
Returns string
- Defined in MusicalScore/VoiceData/Instructions/RhythmInstruction.ts:63

Class RhythmInstruction

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RhythmInstruction

Properties

Protectedparent

SynthesizedFromNoTimeSignature

Accessors

Parent

Returns SourceStaffEntry

Parameters

Returns void

PrintObject

Returns boolean

Parameters

Returns void

Rhythm

Returns Fraction

Parameters

Returns void

SymbolEnum

Returns RhythmSymbolEnum

Parameters

Returns void

Methods

clone

Returns RhythmInstruction

OperatorEquals

Parameters

Returns boolean

OperatorNotEqual

Parameters

Returns boolean

ToString

Returns string

Settings

On This Page

`Protected`parent