Class KeyInstruction

A [[KeyInstruction]] is a key signature denoting which notes are to be sharpened or flattened.

Hierarchy (View Summary)

AbstractNotationInstruction
- KeyInstruction

Index

Constructors

Properties

isTransposedBy keyTypeOriginal parent

Accessors

AlteratedNotes Key Mode Parent PrintObject

Methods

getAlterationForPitch OperatorEquals OperatorNotEqual ToString willAlterateNote copy getAllPossibleMajorKeyInstructions

Constructors

constructor

new KeyInstruction(
    sourceStaffEntry?: SourceStaffEntry,
    key?: number,
    mode?: KeyEnum,
): KeyInstruction
Parameters
- sourceStaffEntry: SourceStaffEntry = undefined
- key: number = 0
- mode: KeyEnum = KeyEnum.major
Returns KeyInstruction
Overrides AbstractNotationInstruction.constructor
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:11

Properties

isTransposedBy

isTransposedBy: number = 0

The halftones this instruction was transposed by, compared to the original.

keyTypeOriginal

keyTypeOriginal: number

`Protected`parent

parent: SourceStaffEntry

Accessors

AlteratedNotes

get AlteratedNotes(): NoteEnum[]
Returns NoteEnum[]
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:62

Key

get Key(): number
Returns number
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:45
set Key(value: number): void
Parameters
- value: number
Returns void
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:49

Mode

get Mode(): KeyEnum
Returns KeyEnum
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:54
set Mode(value: KeyEnum): void
Parameters
- value: KeyEnum
Returns void
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:58

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

Methods

getAlterationForPitch

getAlterationForPitch(pitch: Pitch): AccidentalEnum
Parameters
- pitch: Pitch
Returns AccidentalEnum
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:87

OperatorEquals

OperatorEquals(key2: KeyInstruction): boolean
Parameters
- key2: KeyInstruction
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:102

OperatorNotEqual

OperatorNotEqual(key2: KeyInstruction): boolean
Parameters
- key2: KeyInstruction
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:113

ToString

ToString(): string
Returns string
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:98

willAlterateNote

willAlterateNote(note: NoteEnum): boolean
Parameters
- note: NoteEnum
Returns boolean
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:80

`Static`copy

copy(keyInstruction: KeyInstruction): KeyInstruction
Parameters
- keyInstruction: KeyInstruction
Returns KeyInstruction
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:29

`Static`getAllPossibleMajorKeyInstructions

getAllPossibleMajorKeyInstructions(): KeyInstruction[]
Returns KeyInstruction[]
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:36