package textmeasure

Import Path
	oss.terrastruct.com/d2/lib/textmeasure (on go.dev)

Dependency Relation
	imports 22 packages, and imported by 6 packages

Involved Source Files

	    atlas.go
	    links.go
	    markdown.go
	    rect.go
	    substitutions.go
	    textmeasure.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Ruler (struct)
		Ruler allows for effiecient and convenient text drawing.
		
		To create a Ruler object, use the New constructor:
		
			txt := text.New(pixel.ZV, text.NewAtlas(face, text.ASCII))
		
		As suggested by the constructor, a Ruler object is always associated with one font face and a
		fixed set of runes. For example, the Ruler we created above can draw text using the font face
		contained in the face variable and is capable of drawing ASCII characters.
		
		Here we create a Ruler object which can draw ASCII and Katakana characters:
		
			txt := text.New(0, text.NewAtlas(face, text.ASCII, text.RangeTable(unicode.Katakana)))
		
		Similarly to IMDraw, Ruler functions as a buffer. It implements io.Writer interface, so writing
		text to it is really simple:
		
			fmt.Print(txt, "Hello, world!")
		
		Newlines, tabs and carriage returns are supported.
		
		Finally, if we want the written text to show up on some other Target, we can draw it:
		
			txt.Draw(target)
		
		Ruler exports two important fields: Orig and Dot. Dot is the position where the next character
		will be written. Dot is automatically moved when writing to a Ruler object, but you can also
		manipulate it manually. Orig specifies the text origin, usually the top-left dot position. Dot is
		always aligned to Orig when writing newlines. The Clear method resets the Dot to Orig.

		Fields (total 3)
			Dot *geo.Point
				Dot is the position where the next character will be written. Dot is automatically moved
				when writing to a Ruler object, but you can also manipulate it manually

			LineHeightFactor float64
				lineHeight is the vertical distance between two lines of text.
				
				Example:
				  txt.lineHeight = 1.5 * txt.atlas.lineHeight

			Orig *geo.Point
				Orig specifies the text origin, usually the top-left dot position. Dot is always aligned
				to Orig when writing newlines.

		Methods (total 4)
			(*Ruler) HasFontFamilyLoaded(fontFamily *d2fonts.FontFamily) bool
			(*Ruler) Measure(font d2fonts.Font, s string) (width, height int)
			(*Ruler) MeasureMono(font d2fonts.Font, s string) (width, height int)
			(*Ruler) MeasurePrecise(font d2fonts.Font, s string) (width, height float64)
		As Outputs Of (at least one exported)
			func NewRuler() (*Ruler, error)
		As Inputs Of (at least 5)
			func MeasureMarkdown(mdText string, ruler *Ruler, fontFamily *d2fonts.FontFamily, fontSize int) (width, height int, err error)
			func oss.terrastruct.com/d2/d2graph.GetTextDimensions(mtexts []*d2target.MText, ruler *Ruler, t *d2target.MText, fontFamily *d2fonts.FontFamily) *d2target.TextDimensions
			func oss.terrastruct.com/d2/d2graph.(*Graph).SetDimensions(mtexts []*d2target.MText, ruler *Ruler, fontFamily *d2fonts.FontFamily) error
			func oss.terrastruct.com/d2/d2graph.(*Object).GetDefaultSize(mtexts []*d2target.MText, ruler *Ruler, fontFamily *d2fonts.FontFamily, labelDims d2target.TextDimensions, withLabelPadding bool) (*d2target.TextDimensions, error)
			func oss.terrastruct.com/d2/d2graph.(*Object).GetLabelSize(mtexts []*d2target.MText, ruler *Ruler, fontFamily *d2fonts.FontFamily) (*d2target.TextDimensions, error)


Package-Level Functions (total 6)

	 func HeaderToFontSize(baseFontSize int, header string) int
	 func MeasureMarkdown(mdText string, ruler *Ruler, fontFamily *d2fonts.FontFamily, fontSize int) (width, height int, err error)
	 func NewAtlas(face font.Face, runeSets ...[]rune) *atlas
		NewAtlas creates a new atlas containing glyphs of the union of the given sets of runes (plus
		unicode.ReplacementChar) from the given font face.
		
		Creating an atlas is rather expensive, do not create a new atlas each frame.
		
		Do not destroy or close the font.Face after creating the atlas. atlas still uses it.

	 func NewRuler() (*Ruler, error)
		New creates a new Ruler capable of drawing runes contained in the provided atlas. Orig and Dot
		will be initially set to orig.
		
		Here we create a Ruler capable of drawing ASCII characters using the Go Regular font.
		
			ttf, err := truetype.Parse(goregular.TTF)
			if err != nil {
			    panic(err)
			}
			face := truetype.NewFace(ttf, &truetype.Options{
			    Size: 14,
			})
			txt := text.New(orig, text.NewAtlas(face, text.ASCII))

	 func RenderMarkdown(m string) (string, error)
	 func ReplaceSubstitutionsMarkdown(mdText string, variables map[string]string) string
Package-Level Variables (only one)

	  var Runes []rune
		Runes encompasses ASCII, Latin-1, and geometric shapes like black square


Package-Level Constants (total 26)

	const BorderBottom_h1_h2 = 1
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const BorderLeft_blockquote_em = 0.25
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const CODE_LINE_HEIGHT = 1.3
	const FontSize_pre_code_em = 0.85
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const Height_hr_em = 0.25
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const LineHeight_h = 1.25
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const LineHeight_pre = 1.45
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginBottom_blockquote = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginBottom_h = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginBottom_p = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginBottom_pre = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginBottom_ul = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginTop_h = 24
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginTop_li_em = 0.25
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginTop_li_p = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarginTopBottom_hr = 24
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarkdownFontSize = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const MarkdownLineHeight = 1.5
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const Padding_pre = 16
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const PaddingBottom_h1_h2_em = 0.3
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const PaddingLeft_ul_ol_em = 2
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const PaddingLeftRight_code_em = 0.4
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const PaddingLR_blockquote_em = 1
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const PaddingTopBottom_code_em = 0.2
		these are css values from github-markdown.css so we can accurately compute the rendered dimensions

	const SIZELESS_FONT_SIZE = 0
	const TAB_SIZE = 4

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.