package
0.20.0
Repository: https://github.com/mum4k/termdash.git
Documentation: pkg.go.dev

# Packages

Package testdraw provides helpers for tests that use the draw package.

# Functions

Border draws a border on the canvas.
BorderCellOpts sets options on the cells that create the border.
BorderLineStyle sets the style of the line used to draw the border.
BorderTitle sets a title for the border.
BorderTitleAlign configures the horizontal alignment for the title.
BrailleCircle draws an approximated circle with the specified mid point and radius.
BrailleCircleArcOnly indicates that only a portion of the circle should be drawn.
BrailleCircleCellOpts sets options on the cells that contain the circle.
BrailleCircleClearPixels changes the behavior of BrailleCircle, so that it clears the pixels belonging to the circle instead of setting them.
BrailleCircleFilled indicates that the drawn circle should be filled.
BrailleFill fills the braille canvas starting at the specified point.
BrailleFillCellOpts sets options on the cells that are set as part of filling shapes.
BrailleFillClearPixels changes the behavior of BrailleFill, so that it clears the pixels instead of setting them.
BrailleLine draws an approximated line segment on the braille canvas between the two provided points.
BrailleLineCellOpts sets options on the cells that contain the line.
BrailleLineClearPixels changes the behavior of BrailleLine, so that it clears the pixels belonging to the line instead of setting them.
HVLineCellOpts sets options on the cells that contain the line.
HVLines draws horizontal or vertical lines.
HVLineStyle sets the style of the line.
Rectangle draws a filled rectangle on the canvas.
RectCellOpts sets options on the cells that create the rectangle.
RectChar sets the character used in each of the cells of the rectangle.
ResizeNeeded draws an unicode character indicating that the canvas size is too small to draw meaningful content.
Text prints the provided text on the canvas starting at the provided point.
TextCellOpts sets options on the cells that contain the text.
TextMaxX sets a limit on the X coordinate (column) of the drawn text.
TextOverrunMode indicates what to do with text that overruns the TextMaxX() or the width of the canvas if TextMaxX() isn't specified.
TrimText trims the provided text so that it fits the specified amount of cells.
VerticalText prints the provided text on the canvas starting at the provided point.
VerticalTextCellOpts sets options on the cells that contain the text.
VerticalTextMaxY sets a limit on the Y coordinate (row) of the drawn text.
VerticalTextOverrunMode indicates what to do with text that overruns the VerticalTextMaxY() or the width of the canvas if VerticalTextMaxY() isn't specified.

# Constants

DefaultBorderLineStyle is the default value for the BorderLineStyle option.
DefaultLineStyle is the default value for the HVLineStyle option.
DefaultRectChar is the default value for the RectChar option.
OverrunModeStrict verifies that the drawn value fits the canvas and returns an error if it doesn't.
OverrunModeThreeDot trims the text and places the horizontal ellipsis '…' character at the end.
OverrunModeTrim trims the part of the text that doesn't fit.

# Structs

HVLine represents one horizontal or vertical line.

# Interfaces

BorderOption is used to provide options to Border().
BrailleCircleOption is used to provide options to BrailleCircle.
BrailleFillOption is used to provide options to BrailleFill.
BrailleLineOption is used to provide options to BrailleLine().
HVLineOption is used to provide options to HVLine().
RectangleOption is used to provide options to the Rectangle function.
TextOption is used to provide options to Text().
VerticalTextOption is used to provide options to Text().

# Type aliases

OverrunMode represents.