Skip to main content

alphaTab.json.EngravingSettingsJson

This class holds all all spacing, thickness and scaling metrics related to engraving the music notation. While general layout settings are configurable via the display settings, these settings go deeper into how the individual music symbols are scaled and aligned targeting specification compliance with the Standard Music Font Layout (SMuFL).

Unless specified differently the settings here are available since 1.7.0

If properties are marked with a SMuFl tag, it means that the values are part of the SMuFL specification and should be filled from the respective metadata files shipped with the fonts or aligned generally with the specification. Other properties are custom to alphaTab.

In SmuFL Sizes and coordinates are expressed in "staff space" units which is 1/4 of the configured font size. In this data structure the values are converted to pixels.

 interface EngravingSettingsJson

Properties​

accidentalPadding​

The horizontal padding between individual accidentals when multiple ones are applied.

accidentalPadding?: number;

alternateEndingsPadding​

The padding used for aligning the alternate ending brackets and texts.

alternateEndingsPadding?: number;

arrowShaftThickness​

The thickness of the line used for the shaft of an arrow

arrowShaftThickness?: number;

barlineContentPadding​

The minimum horizontal padding between the content of the last beat in a bar and the bar line. Additional space is only added where the content would come closer than this. Behind Bars: stems must never come closer to a barline than one stave-space.

barlineContentPadding?: number;

barlineSeparation​

The default distance between multiple thin barlines when locked together, e.g. between two thin barlines making a double barline, measured from the right-hand edge of the left barline to the left-hand edge of the right barline.

barlineSeparation?: number;

beamSpacing​

The distance between the inner edge of the primary and outer edge of subsequent secondary beams

beamSpacing?: number;

beamThickness​

The thickness of a beam

beamThickness?: number;

beatContentPadding​

The minimum horizontal padding between the content of two adjacent beats (e.g. a notehead and the accidental or grace notes of the following beat). Additional space is only added between beats where their content would come closer than this. Behind Bars: where space is limited, characters should not be closer than 1/2 stave-space and never collide.

beatContentPadding?: number;

beatTimerPadding​

The padding between the border and text of beat timers.

beatTimerPadding?: number;

bendNoteHeadElementPadding​

The additional padding applied to helper note heads shown on bends.

bendNoteHeadElementPadding?: number;

bracketThickness​

The thickness of the vertical line of a bracket grouping staves together

bracketThickness?: number;

brokenBeamWidth​

The width of broken beams e.g. when combining a 32nd and 16th note

brokenBeamWidth?: number;

chordDiagramFretHeight​

The height of the individual fret lines.

chordDiagramFretHeight?: number;

chordDiagramFretSpacing​

The spacing between frets on chord diagrams.

chordDiagramFretSpacing?: number;

chordDiagramLineWidth​

The width of all other lines drawn on chord diagrams.

chordDiagramLineWidth?: number;

chordDiagramNutHeight​

The height of the nut on chord diagrams..

chordDiagramNutHeight?: number;

chordDiagramPaddingX​

The horizontal padding applied to individual chord diagrams.

chordDiagramPaddingX?: number;

chordDiagramPaddingY​

The vertical padding applied to individual chord diagrams.

chordDiagramPaddingY?: number;

chordDiagramStringSpacing​

The spacing between strings on chord diagrams.

chordDiagramStringSpacing?: number;

dashedBarlineDashLength​

The length of the dashes to be used in a dashed barline

dashedBarlineDashLength?: number;

dashedBarlineGapLength​

The length of the gap between dashes in a dashed barline

dashedBarlineGapLength?: number;

dashedBarlineThickness​

The thickness of a dashed barline

dashedBarlineThickness?: number;

deadSlappedLineWidth​

The width of the lines drawn for dead slapped beats.

deadSlappedLineWidth?: number;

directionsScale​

The relative scale of any directions glyphs drawn like coda or segno.

directionsScale?: number;

ghostParenthesisPadding​

The padding between the parenthesis and wrapped elements on ghost notes and free time time signatures

ghostParenthesisPadding?: number;

ghostParenthesisWidth​

The width of the parenthesis shown on ghost notes and free time time signatures.

ghostParenthesisWidth?: number;

glyphBottom​

A lookup containing the offset from the glyph center to the visual bottom of the glyph. The glyph center is the origin coordinate at which the glyph paths start when drawn on the alphabetic baseline.

glyphBottom?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, number>;

glyphHeights​

A lookup for the heights of the visual bounding box for the glyphs.

glyphHeights?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, number>;

glyphTop​

A lookup containing the offset from the visual top to the glyph center. The glyph center is the origin coordinate at which the glyph paths start when drawn on the alphabetic baseline.

glyphTop?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, number>;

glyphWidths​

A lookup for the widths of the visual bounding box for the glyphs.

glyphWidths?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, number>;

hairpinThickness​

The thickness of a crescendo/diminuendo hairpin

hairpinThickness?: number;

leftHandTabTieWidth​

The width of ties drawn for left-hand-tapped notes.

leftHandTabTieWidth?: number;

legerLineExtension​

The amount by which a leger line should extend either side of a notehead, scaled proportionally with the notehead's size, e.g. when scaled down as a grace note

legerLineExtension?: number;

legerLineThickness​

The thickness of a leger line (normally somewhat thicker than a staff line)

legerLineThickness?: number;

lineRangedGlyphDashGap​

The gap between dashes on line ranged glyphs (like let-ring)

lineRangedGlyphDashGap?: number;

lineRangedGlyphDashSize​

The size between dashes on line ranged glyphs (like let-ring)

lineRangedGlyphDashSize?: number;

multiVoiceDisplacedNoteHeadSpacing​

The spacing between displaced displaced note heads in case of multi-voice note head overlaps.

multiVoiceDisplacedNoteHeadSpacing?: number;

musicFontSize​

The font size of the music font in pixel.

musicFontSize?: number;

numberedBarRendererBarSize​

The size of the bars drawn in numbered notation to indicate the durations.

numberedBarRendererBarSize?: number;

numberedBarRendererBarSpacing​

The spacing between the bars drawn in numbered notation to indicate the durations.

numberedBarRendererBarSpacing?: number;

numberedDashGlyphPadding​

The padding minimum between the duration dashes.

numberedDashGlyphPadding?: number;

numberedDashGlyphWidth​

The width of the dashed drawn in numbered notation to indicate the durations.

numberedDashGlyphWidth?: number;

octaveLineThickness​

The thickness of the dashed line used for an octave line

octaveLineThickness?: number;

oneStaffSpace​

The staff space in pixel

oneStaffSpace?: number;

onNoteEffectPadding​

The padding between effects and glyphs placed above/blow the note heads e.g. staccato

onNoteEffectPadding?: number;

pedalLineThickness​

The thickness of the line used for piano pedaling

pedalLineThickness?: number;

postNoteEffectPadding​

The padding between effects and glyphs placed after the note heads, e.g. slides or bends

postNoteEffectPadding?: number;

preBeatGlyphSpacing​

The padding between glyphs shown before any beats e.g. clefs and time signatures

preBeatGlyphSpacing?: number;

preNoteEffectPadding​

The padding between effects and glyphs placed before the note heads, e.g. accidentals or brushes

preNoteEffectPadding?: number;

repeatBarlineDotSeparation​

The default horizontal distance between the dots and the inner barline of a repeat barline, measured from the edge of the dots to the edge of the barline.

repeatBarlineDotSeparation?: number;

repeatEndingLineThickness​

The thickness of the brackets drawn to indicate repeat endings

repeatEndingLineThickness?: number;

repeatOffsetX​

Holds the x-coordinate offsets for glyphs which are drawn repeatedly (like vibrato waves).

repeatOffsetX?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, number>;

rowContainerGap​

The innter gap for glyphs arranged in a grid like fashion, like the tunings and chord diagrams.

rowContainerGap?: number;

rowContainerPadding​

The outer padding for glyphs arranged in a grid like fashion, like the tunings and chord diagrams.

rowContainerPadding?: number;

simpleSlideHeight​

The height of simple slides like slide out down which do slide to a defined target note.

simpleSlideHeight?: number;

simpleSlideWidth​

The width of simple slides like slide out down which do slide to a defined target note.

simpleSlideWidth?: number;

slurMidpointThickness​

The thickness of the mid-point of a slur (i.e. its thickest point)

slurMidpointThickness?: number;

songBookWhammyDipHeight​

The height of simple dip whammys when using the songbook mode.

songBookWhammyDipHeight?: number;

staffContentPadding​

The minimum vertical padding between the content of two adjacent staves (e.g. a stem below one staff and a fret number above the next one). Additional space is only added between staves where their content would come closer than this. Behind Bars: characters should not be closer than 1/2 stave-space and never collide.

staffContentPadding?: number;

staffLineThickness​

The thickness of each staff line

staffLineThickness?: number;

standardStemLength​

The standard stem length of a quarter note.

standardStemLength?: number;

stemDown​

Holds information about where to place downwards pointing stems on glyphs.

stemDown?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, EngravingStemInfoJson>;

stemFlagHeight​

The space needed by flags on the stem-side from top to bottom to place.

stemFlagHeight?: Map<Duration | keyof typeof Duration | Lowercase<keyof typeof Duration>, number>;

stemFlagOffsets​

The additional offsets stems need to have enough space for flags.

stemFlagOffsets?: Map<Duration | keyof typeof Duration | Lowercase<keyof typeof Duration>, number>;

stemThickness​

The thickness of a stem

stemThickness?: number;

stemUp​

Holds information about where to place upwards pointing stems on glyphs.

stemUp?: Map<MusicFontSymbol | keyof typeof MusicFontSymbol | Lowercase<keyof typeof MusicFontSymbol>, EngravingStemInfoJson>;

stringNumberCirclePadding​

The padding between the circles around string numbers.

stringNumberCirclePadding?: number;

sustainPedalLinePadding​

The padding between the sustain pedal glyphs and lines.

sustainPedalLinePadding?: number;

tabBendDashSize​

The size of the dashes on bends (e.g. on holds)

tabBendDashSize?: number;

tabBendLabelPadding​

The padding applied between the line and text of bends.

tabBendLabelPadding?: number;

tabBendPerValueHeight​

The height applied per quarter-note.

tabBendPerValueHeight?: number;

tabBendStaffPadding​

The additional padding between the staff and the point where bend values are calculated from.

tabBendStaffPadding?: number;

tabLineSpacing​

The staff space in pixel for tablature fonts. This is typically 1.5 of the standard staff space.

tabLineSpacing?: number;

tabWhammyDashSize​

The size of the dashes on whammys (e.g. on holds)

tabWhammyDashSize?: number;

tabWhammyPerHalfHeight​

The height applied per half-note whammy.

tabWhammyPerHalfHeight?: number;

tabWhammyTextPadding​

The padding between the text and whammy lines.

tabWhammyTextPadding?: number;

tempoNoteScale​

The relative scale of the note drawn on tempo markers

tempoNoteScale?: number;

thickBarlineThickness​

The thickness of a thick barline, e.g. in a final barline or a repeat barline

thickBarlineThickness?: number;

thinBarlineThickness​

The thickness of a dashed barline

thinBarlineThickness?: number;

thinThickBarlineSeparation​

The default distance between a pair of thin and thick barlines when locked together, e.g. between the thin and thick barlines making a final barline, or between the thick and thin barlines making a start repeat barline.

thinThickBarlineSeparation?: number;

tieHeight​

The height of ties.

tieHeight?: number;

tieMidpointThickness​

The thickness of the mid-point of a tie

tieMidpointThickness?: number;

tripletFeelBracketPadding​

The padding between the bracket lines and numbers of tuplets

tripletFeelBracketPadding?: number;

tuningGlyphCircleNumberScale​

The scale of string numbers shown on tuning glyphs.

tuningGlyphCircleNumberScale?: number;

tuningGlyphStringColumnScale​

The scale factor applied to the width of the columns of string on tuning glyphs.

tuningGlyphStringColumnScale?: number;

tuningGlyphStringRowPadding​

The padding between rows of strings on tuning glyphs.

tuningGlyphStringRowPadding?: number;

tupletBracketThickness​

The thickness of the brackets drawn either side of tuplet numbers

tupletBracketThickness?: number;