Class Formatter<T>

Whether to preserve directive names, prefer long directive names, or prefer short aliases. May be set globally or per directive name, with an optional default fallback.

Whether or not to evaluate meta expressions. For more info about meta expressions, see: https://bit.ly/2SC9c2u

The separator to be used when rendering a metadata value that has multiple values. See: https://bit.ly/2SC9c2u

The key to use for rendering. The chord sheet will be transposed from the song's original key (as indicated by the {key} directive) to the specified key. Note that transposing will only work if the original song key is set.

Whether or not to expand {chorus} directives by rendering the last defined chorus inline after the directive. Note that for the measurement-based formatters (PdfFormatter, MeasuredHtmlFormatter) expandChorusDirective runs before the repeatedSections display rule: an expanded chorus counts as a repeated section, so a collapsing repeatedSections mode (the PDF default is title_only) can hide part or all of the recalled chorus. Use repeatedSections: "full" to render the full chorus.

Whether or not to use unicode flat and sharp symbols.

Whether to eliminate the capo by transposing the chords up by the capo amount. The {key} directive is updated to the sounding key and the {capo} directive is dropped. When false (the default), the chords are rendered as written, because a capo tells the player which shapes to play, not which chords sound.

Whether or not to automatically normalize chords

Whether to normalize chord suffixes (e.g. sus2 to 2, maj7 to ma7). Only takes effect when normalizeChords is true. Defaults to false for ChordProFormatter so ChordPro round-trips preserve the user's suffix variant.

Styling for semantic chord parts.

Chord-quality font and size/baseline ratios.

Chord-extension font and size/baseline ratios.