Skip to main content

alphaTab.json.RenderingResourcesJson

This public class contains central definitions for controlling the visual appearance.

 interface RenderingResourcesJson

Propertiesโ€‹

barNumberColorโ€‹

The color to use for displaying the bar numbers above the music sheet.

barNumberColor?: ColorJson;

barNumberFontโ€‹

Deprecated

The font to use for displaying the bar numbers above the music sheet.

barNumberFont?: FontJson;

barSeparatorColorโ€‹

The color to use for rendering bar separators, the accolade and repeat signs.

barSeparatorColor?: ColorJson;

copyrightFontโ€‹

Deprecated

The font to use for displaying the songs copyright information in the header of the music sheet.

copyrightFont?: FontJson;

directionsFontโ€‹

Deprecated

The font to use for displaying the directions texts.

directionsFont?: FontJson;

effectFontโ€‹

Deprecated

use elementFonts with the respective

Ununsed, see deprecation note.

effectFont?: FontJson;

elementFontsโ€‹

The fonts used by individual elements. Check defaultFonts for the elements which have custom fonts. Removing fonts from this map can lead to unexpected side effects and errors. Only update it with new values.

elementFonts?: Map<NotationElement | keyof typeof NotationElement | Lowercase<keyof typeof NotationElement>, FontJson>;

engravingSettingsโ€‹

The SMuFL Metrics to use for rendering music symbols.

engravingSettings?: EngravingSettingsJson;

fingeringFontโ€‹

Deprecated

Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font

Unused, see deprecation note.

fingeringFont?: FontJson;

fretboardNumberFontโ€‹

The font to use for displaying the fretboard numbers in chord diagrams.

fretboardNumberFont?: FontJson;

graceFontโ€‹

The font to use for grace notation related texts in the music sheet.

graceFont?: FontJson;

inlineFingeringFontโ€‹

Deprecated

Since 1.7.0 alphaTab uses the glyphs contained in the SMuFL font

Unused, see deprecation note.

inlineFingeringFont?: FontJson;

mainGlyphColorโ€‹

The color to use for music notation elements of the primary voice.

mainGlyphColor?: ColorJson;

markerFontโ€‹

Deprecated

The font to use for section marker labels shown above the music sheet.

markerFont?: FontJson;

numberedNotationFontโ€‹

The font to use for displaying the numbered music notation in the music sheet.

numberedNotationFont?: FontJson;

numberedNotationGraceFontโ€‹

The font to use for displaying the grace notes in numbered music notation in the music sheet.

numberedNotationGraceFont?: FontJson;

scoreInfoColorโ€‹

The color to use for displaying the song information above the music sheets.

scoreInfoColor?: ColorJson;

secondaryGlyphColorโ€‹

The color to use for music notation elements of the secondary voices.

secondaryGlyphColor?: ColorJson;

staffLineColorโ€‹

The color to use for rendering the lines of staves.

staffLineColor?: ColorJson;

subTitleFontโ€‹

Deprecated

The font to use for displaying the songs subtitle in the header of the music sheet.

subTitleFont?: FontJson;

tablatureFontโ€‹

The font to use for displaying the guitar tablature numbers in the music sheet.

tablatureFont?: FontJson;

timerFontโ€‹

Deprecated

The font to use for displaying beat time information in the music sheet.

timerFont?: FontJson;

titleFontโ€‹

Deprecated

The font to use for displaying the songs title in the header of the music sheet.

titleFont?: FontJson;

wordsFontโ€‹

Deprecated

The font to use for displaying the lyrics information in the header of the music sheet.

wordsFont?: FontJson;