GraffitiDiffViewer

Preview #

About #

GraffitiDiffViewer is a simple component that allows the visualization of changed lines between two source texts.

Enumerations #

NameValues
ViewTypesSideBySide
Inline

Constants #

This class exposes no constants.

Events #

This class exposes no events.

Methods #

NameParametersReturn TypeDescription
ToHTMLincludeCSS as Boolean = TrueStringReturns an HTML string of the rendered output. Required Bootstrap 5.x also be loaded in the target document.

Properties #

NameTypeDefault ValueDescription
ContextSizeInteger0The number of lines around a changed line that are shown for context.
ShowAttributionBooleanTrueControls the display as the attribution footer to the Open Source library upon which GraffitiDiffViewer is built. The library is BSD licensed, so you should familiarize yourself with the requirements of the license before disabling the attribution.
TextBaseString“”Base text to compare against.
TextCompareString“”Changed text compare against TextBase.
TitleBaseString“Base Text”Text describing TextBase to the user.
TitleCompareString“Modified Text”Text describing TextCompare to the user.
ViewTypeGraffitiDiffViewer.ViewTypesGraffitiDiffViewer.ViewTypes.SideBySideDetermines how changes are presented to the user.