alphaTab.model.Note

Description

A note is a single played sound on a fretted instrument. It consists of a fret offset and a string on which the note is played on. It also can be modified by a lot of different effects.

 class Note

Properties

`accentuated`	Gets or sets the accentuation of this note.
`accidentalMode`	Gets or sets how accidetnals for this note should be handled.
`beat`	Gets or sets the reference to the parent beat to which this note belongs to.
`bendOrigin`	Gets or sets the note from which this note continues the bend.
`bendPoints`	Gets or sets a list of the points defining the bend behavior.
`bendStyle`	Gets or sets the bend style for this note.
`bendType`	Gets or sets the bend type for this note.
`displayValue`
`displayValueWithoutBend`
`durationPercent`	Gets or sets the percentual duration of the note relative to the overall beat duration.
`dynamics`	Gets or sets the dynamics for this note.
`effectSlurDestination`
`effectSlurOrigin`
`element`	Gets or sets the percusson element.
`fret`	Gets or sets the fret on which this note is played on the instrument.
`GlobalNoteId`
`hammerPullDestination`	Gets the destination for the hammeron/pullof started by this note.
`hammerPullOrigin`	Gets the origin of the hammeron/pulloff of this note.
`harmonicPitch`
`harmonicType`	Gets or sets the harmonic type applied to this note.
`harmonicValue`	Gets or sets the value defining the harmonic pitch.
`hasBend`
`hasEffectSlur`
`hasQuarterToneOffset`
`id`	Gets or sets the unique id of this note.
`index`	Gets or sets the zero-based index of this note within the beat.
`initialBendValue`
`isContinuedBend`	Gets or sets whether this note continues a bend from a previous note.
`isDead`	Gets or sets whether the note is shown and played as dead note.
`isEffectSlurDestination`
`isEffectSlurOrigin`
`isFingering`	Gets or sets whether this note has fingering defined.
`isGhost`	Gets or sets whether the note is a ghost note and shown in parenthesis. Also this will make the note a bit more silent.
`isHammerPullDestination`
`isHammerPullOrigin`	Gets or sets whether this note starts a hammeron or pulloff.
`isHarmonic`
`isLeftHandTapped`	Gets a value indicating whether the note is left hand tapped.
`isLetRing`	Gets or sets whether this note has a let-ring effect.
`isPalmMute`	Gets or sets whether this note has a palm-mute effect.
`isPercussion`
`isPiano`
`isSlurDestination`	Gets or sets whether this note finishes a slur.
`isSlurOrigin`
`isStaccato`	Gets or sets whether the note is played as staccato.
`isStringed`
`isTieDestination`	Gets or sets whether this note is ends a tied note.
`isTieOrigin`
`isTrill`
`isVisible`	Gets or sets whether this note is visible on the music sheet.
`leftHandFinger`	Gets or sets the fingers used for this note on the left hand.
`letRingDestination`	Gets or sets the destination note for the let-ring effect.
`maxBendPoint`	Gets or sets the bend point with the highest bend value.
`octave`	Gets or sets the octave on which this note is played.
`ornament`	The ornament applied on the note.
`palmMuteDestination`	Gets or sets the destination note for the palm-mute effect.
`percussionArticulation`	Gets or sets the index of percussion articulation in the related `track.percussionArticulations`.
`realValue`
`realValueWithoutHarmonic`
`rightHandFinger`	Gets or sets the fingers used for this note on the right hand.
`showStringNumber`	Gets or sets whether the string number for this note should be shown.
`slideInType`	Gets or sets the slide-in type this note is played with.
`slideOrigin`	Gets or sets the source note for several slide types.
`slideOutType`	Gets or sets the slide-out type this note is played with.
`slideTarget`	Gets or sets the target note for several slide types.
`slurDestination`	Gets or sets the note where the slur of this note ends.
`slurOrigin`	Gets or sets the note where the slur of this note starts.
`string`	Gets or sets the string number where the note is placed.
`stringTuning`
`style`	The style customizations for this item.
`tieDestination`	Gets the desination of the tie.
`tieOrigin`	Gets the origin of the tied if this note is tied.
`tone`	Gets or sets the tone of this note within the octave.
`trillFret`
`trillSpeed`	Gets or sets the speed of the trill effect.
`trillValue`	Gets or sets the target note value for the trill effect.
`variation`	Gets or sets the variation of this note.
`vibrato`	Gets or sets whether a vibrato is played on the note.

Methods

`addBendPoint(BendPoint)`
`calculateRealValue(boolean, boolean)`	Calculates the real note value of this note as midi key respecting the given options.
`chain(Map<string, unknown> \| null)`
`findHammerPullDestination(Note)`
`findTieOrigin(Note)`
`finish(Settings, Map<string, unknown> \| null)`
`getStringTuning(Staff, number)`
`nextNoteOnSameLine(Note)`