minimap

README

minimap

Go package for creating a minimap of a file, using text.

• Version: 1.3.0
• License: BSD-3

Documentation

Index

• func Block(contents string, targetLineLength, targetOutputLines int) string
• func ColorMinimap(data string, width, height int, m mode.Mode, highlightIndex int) (string, error)
• func DrawBackgroundMinimap(c *vt100.Canvas, data string, x, y, width, height int, highlightIndex int, ...) error
• func Simple(contents string, targetLineLength, targetOutputLines int) string

Functions

func Block

func Block(contents string, targetLineLength, targetOutputLines int) string

Block creates a minimap of the given text, using block characters

func ColorMinimap

func ColorMinimap(data string, width, height int, m mode.Mode, highlightIndex int) (string, error)

ColorMinimap returns a colored text representation of the given text. width and height are the number of characters and lines for the minimap. highlightIndex is the line index to be highlighted in the minimap. Use -1 for no highlight.

func DrawBackgroundMinimap

func DrawBackgroundMinimap(c *vt100.Canvas, data string, x, y, width, height int, highlightIndex int, contentColor, spaceColor, highlightColor vt100.AttributeColor) error

DrawBackgroundMinimap draws a colored representation of the given text onto a vt100.Canvas.

func Simple

func Simple(contents string, targetLineLength, targetOutputLines int) string

Simple function creates a basic minimap of the contents.