Class ClefInstruction

A [[ClefInstruction]] is the clef placed at the beginning of the stave, which indicates the pitch of the notes.

Hierarchy (View Summary)

AbstractNotationInstruction
- ClefInstruction

Index

Constructors

Properties

Accessors

ClefPitch ClefType Line OctaveOffset Parent PrintObject ReferenceCyPosition

Methods

Equals NotEqual ToString getAllPossibleClefs getDefaultClefFromMidiInstrument isSupportedClef

Constructors

constructor

new ClefInstruction(
    clefType?: ClefEnum,
    octaveOffset?: number,
    line?: number,
): ClefInstruction
Parameters
- clefType: ClefEnum = ClefEnum.G
- octaveOffset: number = 0
- line: number = 2
Returns ClefInstruction
Overrides AbstractNotationInstruction.constructor
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:11

Properties

`Protected`parent

parent: SourceStaffEntry

Accessors

ClefPitch

get ClefPitch(): Pitch
Returns Pitch
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:100
set ClefPitch(value: Pitch): void
Parameters
- value: Pitch
Returns void
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:104

ClefType

get ClefType(): ClefEnum
Returns ClefEnum
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:76
set ClefType(value: ClefEnum): void
Parameters
- value: ClefEnum
Returns void
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:80

Line

get Line(): number
Returns number
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:84
set Line(value: number): void
Parameters
- value: number
Returns void
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:88

OctaveOffset

get OctaveOffset(): number
Returns number
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:92
set OctaveOffset(value: number): void
Parameters
- value: number
Returns void
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:96

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

ReferenceCyPosition

get ReferenceCyPosition(): number
Returns number
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:108
set ReferenceCyPosition(value: number): void
Parameters
- value: number
Returns void
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:112

Methods

Equals

Equals(other: ClefInstruction): boolean
Parameters
- other: ClefInstruction
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:116

NotEqual

NotEqual(clef2: ClefInstruction): boolean
Parameters
- clef2: ClefInstruction
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:126

ToString

ToString(): string
Returns string
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:130

`Static`getAllPossibleClefs

getAllPossibleClefs(): ClefInstruction[]
Returns ClefInstruction[]
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:50

`Static`getDefaultClefFromMidiInstrument

getDefaultClefFromMidiInstrument(instrument: MidiInstrument): ClefInstruction
Parameters
- instrument: MidiInstrument
Returns ClefInstruction
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:25

`Static`isSupportedClef

isSupportedClef(clef: ClefEnum): boolean
Parameters
- clef: ClefEnum
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/ClefInstruction.ts:63