Class KeyInstruction

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

Hierarchy

AbstractNotationInstruction
- KeyInstruction

Index

Constructors

constructor

new KeyInstruction(sourceStaffEntry?: SourceStaffEntry, key?: number, mode?: KeyEnum): KeyInstruction

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

Properties

Private alteratedNotes

alteratedNotes: NoteEnum[]

isTransposedBy

isTransposedBy: number = 0

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

Private keyType

keyType: number

keyTypeOriginal

keyTypeOriginal: number

Private mode

Protected parent

parent: SourceStaffEntry

Static Private flatPositionList

flatPositionList: NoteEnum[] = ...

Static Private sharpPositionList

sharpPositionList: NoteEnum[] = ...

Accessors

AlteratedNotes

get AlteratedNotes(): NoteEnum[]

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

Key

get Key(): number
set Key(value: number): void

- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:45
Returns number
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:49
Parameters
- value: number
Returns void

Mode

get Mode(): KeyEnum
set Mode(value: KeyEnum): void

- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:54
Returns KeyEnum
- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:58
Parameters
- value: KeyEnum
Returns void

Parent

get Parent(): SourceStaffEntry
set Parent(value: SourceStaffEntry): void

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

PrintObject

get PrintObject(): boolean
set PrintObject(value: boolean): void

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

Methods

OperatorEquals

OperatorEquals(key2: KeyInstruction): boolean

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

OperatorNotEqual

OperatorNotEqual(key2: KeyInstruction): boolean

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

ToString

ToString(): string

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

Private calcAlteratedNotes

calcAlteratedNotes(): NoteEnum[]

- Defined in MusicalScore/VoiceData/Instructions/KeyInstruction.ts:66
Returns NoteEnum[]

getAlterationForPitch

getAlterationForPitch(pitch: Pitch): AccidentalEnum

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

willAlterateNote

willAlterateNote(note: NoteEnum): boolean

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

Static copy

copy(keyInstruction: KeyInstruction): KeyInstruction

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

Static getAllPossibleMajorKeyInstructions

getAllPossibleMajorKeyInstructions(): KeyInstruction[]

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

Generated using TypeDoc