alphaTab.json.EngravingSettingsJson

Description

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.
alternateEndingsPadding	The padding used for aligning the alternate ending brackets and texts.
arrowShaftThickness	The thickness of the line used for the shaft of an arrow
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.
beamSpacing	The distance between the inner edge of the primary and outer edge of subsequent secondary beams
beamThickness	The thickness of a beam
beatTimerPadding	The padding between the border and text of beat timers.
bendNoteHeadElementPadding	The additional padding applied to helper note heads shown on bends.
bracketThickness	The thickness of the vertical line of a bracket grouping staves together
brokenBeamWidth	The width of broken beams e.g. when combining a 32nd and 16th note
chordDiagramFretHeight	The height of the individual fret lines.
chordDiagramFretSpacing	The spacing between frets on chord diagrams.
chordDiagramLineWidth	The width of all other lines drawn on chord diagrams.
chordDiagramNutHeight	The height of the nut on chord diagrams..
chordDiagramPaddingX	The horizontal padding applied to individual chord diagrams.
chordDiagramPaddingY	The vertical padding applied to individual chord diagrams.
chordDiagramStringSpacing	The spacing between strings on chord diagrams.
dashedBarlineDashLength	The length of the dashes to be used in a dashed barline
dashedBarlineGapLength	The length of the gap between dashes in a dashed barline
dashedBarlineThickness	The thickness of a dashed barline
deadSlappedLineWidth	The width of the lines drawn for dead slapped beats.
directionsScale	The relative scale of any directions glyphs drawn like coda or segno.
ghostParenthesisPadding	The padding between the parenthesis and wrapped elements on ghost notes and free time time signatures
ghostParenthesisWidth	The width of the parenthesis shown on ghost notes and free time time signatures.
glyphBottom	A lookup containing the offset from the glyph center to the visual bottom of the glyph.
glyphHeights	A lookup for the heights of the visual bounding box for the glyphs.
glyphTop	A lookup containing the offset from the visual top to the glyph center.
glyphWidths	A lookup for the widths of the visual bounding box for the glyphs.
hairpinThickness	The thickness of a crescendo/diminuendo hairpin
leftHandTabTieWidth	The width of ties drawn for left-hand-tapped notes.
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
legerLineThickness	The thickness of a leger line (normally somewhat thicker than a staff line)
lineRangedGlyphDashGap	The gap between dashes on line ranged glyphs (like let-ring)
lineRangedGlyphDashSize	The size between dashes on line ranged glyphs (like let-ring)
musicFontSize	The font size of the music font in pixel.
numberedBarRendererBarSize	The size of the bars drawn in numbered notation to indicate the durations.
numberedBarRendererBarSpacing	The spacing between the bars drawn in numbered notation to indicate the durations.
numberedDashGlyphPadding	The size of the dashed drawn in numbered notation to indicate the durations.
numberedDashGlyphWidth	The width of the dashed drawn in numbered notation to indicate the durations.
octaveLineThickness	The thickness of the dashed line used for an octave line
oneStaffSpace	The staff space in pixel
onNoteEffectPadding	The padding between effects and glyphs placed above/blow the note heads e.g. staccato
pedalLineThickness	The thickness of the line used for piano pedaling
postNoteEffectPadding	The padding between effects and glyphs placed after the note heads, e.g. slides or bends
preBeatGlyphSpacing	The padding between glyphs shown before any beats e.g. clefs and time signatures
preNoteEffectPadding	The padding between effects and glyphs placed before the note heads, e.g. accidentals or brushes
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.
repeatEndingLineThickness	The thickness of the brackets drawn to indicate repeat endings
repeatOffsetX	Holds the x-coordinate offsets for glyphs which are drawn repeatedly (like vibrato waves).
rowContainerGap	The innter gap for glyphs arranged in a grid like fashion, like the tunings and chord diagrams.
rowContainerPadding	The outer padding for glyphs arranged in a grid like fashion, like the tunings and chord diagrams.
simpleSlideHeight	The height of simple slides like slide out down which do slide to a defined target note.
simpleSlideWidth	The width of simple slides like slide out down which do slide to a defined target note.
slurMidpointThickness	The thickness of the mid-point of a slur (i.e. its thickest point)
songBookWhammyDipHeight	The height of simple dip whammys when using the songbook mode.
staffLineThickness	The thickness of each staff line
standardStemLength	The standard stem length of a quarter note.
stemDown	Holds information about where to place downwards pointing stems on glyphs.
stemFlagOffsets	The additional offsets stems need to have enough space for flags.
stemThickness	The thickness of a stem
stemUp	Holds information about where to place upwards pointing stems on glyphs.
stringNumberCirclePadding	The padding between the circles around string numbers.
sustainPedalLinePadding	The padding between the sustain pedal glyphs and lines.
tabBendDashSize	The size of the dashes on bends (e.g. on holds)
tabBendLabelPadding	The padding applied between the line and text of bends.
tabBendPerValueHeight	The height applied per quarter-note.
tabLineSpacing	The staff space in pixel for tablature fonts. This is typically 1.5 of the standard staff space.
tabWhammyDashSize	The size of the dashes on whammys (e.g. on holds)
tabWhammyPerHalfHeight	The height applied per half-note whammy.
tabWhammyTextPadding	The padding between the text and whammy lines.
tempoNoteScale	The relative scale of the note drawn on tempo markers
thickBarlineThickness	The thickness of a thick barline, e.g. in a final barline or a repeat barline
thinBarlineThickness	The thickness of a dashed barline
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.
tieHeight	The height of ties.
tieMidpointThickness	The thickness of the mid-point of a tie
tripletFeelBracketPadding	The padding between the bracket lines and numbers of tuplets
tuningGlyphCircleNumberScale	The scale of string numbers shown on tuning glyphs.
tuningGlyphStringColumnScale	The scale factor applied to the width of the columns of string on tuning glyphs.
tuningGlyphStringRowPadding	The padding between rows of strings on tuning glyphs.
tupletBracketThickness	The thickness of the brackets drawn either side of tuplet numbers