Optional backgroundOptional barreBarre chord rectangle border radius relative to the fingerSize (eg. 1 means completely round edges, 0 means not rounded at all)
Optional barrestroke color of a barre chord. Defaults to the finger color if not set
Optional barrestroke width of a barre chord
Optional colorGlobal color of the whole diagram. Can be overridden with more specifig color settings such as
titleColor or
stringColor etc.
Optional emptySize of the Xs and Os above empty strings relative to the space between two strings
Optional fingerColor of a finger
Optional fingerSize of a finger relative to the string spacing
Optional fingerstroke color of a finger. Defaults to the finger color if not set
Optional fingerstroke width of a finger or barre
Optional fingerThe color of text inside fingers or barres
Optional fingerThe size of text inside fingers or barres
Optional fixedWhen set to true the distance between the chord diagram and the top of the SVG stayes the same, no matter if a title is defined or not.
Optional fontThe font family used for all letters and numbers. Please not that when using the 'handdrawn' chord diagram style setting the font family has no effect.
Optional fretThe color of the frets (overrides color)
Optional fretThe color of the fret position (overrides color)
Optional fretThe font size of the fret label
Optional fretThe position of the fret label (eg. "3fr")
Optional fretHeight of a fret, relative to the space between two strings
Optional fretsThe number of frets
Optional noIf this is set to true, the fret (eg. 3fr) will not be shown. If the position is 1 the nut will have the same width as all other frets.
Optional nutThe width of the nut (only used if position is 1)
Optional orientationOrientation of the chord diagram. Chose between "vertical" or "horizontal". Defaults to "vertical".
Optional positionThe starting fret (first fret is 1). The position can also be provided with the Chord. If the position is provided via the chord, this value will be ignored.
Optional sideThe minimum side padding (from the guitar to the edge of the SVG) relative to the whole width. This is only applied if it's larger than the letters inside of the padding (eg the starting fret)
Optional stringThe color of the strings (overrides color)
Optional stringsThe number of strings
Optional strokeGlobal stroke width
Optional styleStyle of the chord diagram. Currently you can chose between "normal" and "handdrawn".
Optional svgThe title of the SVG. This is not visible in the SVG, but can be used for accessibility.
Optional titleThe title of the diagram. The title can also be provided with the Chord. If the title is provided in the chord, this value will be ignored.
Optional titleSpace between the title and the chord diagram
Optional titleThe color of the title (overrides color)
Optional titleFont size of the title. This is only the initial font size. If the title doesn't fit, the title is automatically scaled so that it fits.
Optional topThe width of the nut (only used if position is 1). If nutWidth is set, this value will be ignored.
Use nutWidth instead. This will be removed in the next major version.
Optional tuningThese are the labels under the strings. Can be any string.
Optional tuningsThe color of the tunings (overrides color)
Optional tuningsThe font size of the string labels
Optional watermarkText of the watermark
Optional watermarkColor of the watermark (overrides color)
Optional watermarkFont-family of the watermark (overrides fontFamily)
Optional watermarkFont size of the watermark
Generated using TypeDoc
The background color of the chord diagram. By default the background is transparent. To set the background to transparent either set this to 'none' or undefined