package layout

Import Path
	github.com/d2lang/mathjax-go/internal/layout (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 2 packages

Involved Source Files

	  d bbox.go
		Package layout implements MathJax's common TeX layout rules.

	    lengths.go
	    parameters.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type BBox (struct)
		BBox is MathJax's common-output bounding box. Dimensions are in ems.
		L and R are space outside W, RScale is relative to the parent, IC is the
		italic correction, Skew is the accent skew, and DX is the combining-accent
		offset.

		Fields (total 11)
			D float64
			DX float64
			H float64
			IC float64
			L float64
			PWidth string
			R float64
			RScale float64
			Scale float64
			Skew float64
			W float64
		Methods (total 7)
			(*BBox) Append(child *BBox)
				Append places child after the current width and expands height and depth.

			(*BBox) Clean()
				Clean replaces unset dimensions with zero.

			(*BBox) Clone() *BBox
				Clone returns an independent copy.

			(*BBox) Combine(child *BBox, x, y float64)
				Combine expands b to include child at offset (x,y).

			(*BBox) Empty() *BBox
				Empty prepares b for Append and Combine operations.

			(*BBox) Rescale(scale float64)
				Rescale multiplies the three geometric dimensions. It intentionally does
				not modify spaces or scale metadata, matching MathJax 3.2.2.

			(*BBox) UpdateFrom(other *BBox)
				UpdateFrom overwrites b's geometric dimensions and copies a non-empty
				percentage width.

		As Outputs Of (at least 5)
			func EmptyBBox() *BBox
			func NewBBox(w, h, d float64) *BBox
			func ZeroBBox() *BBox
			func (*BBox).Clone() *BBox
			func (*BBox).Empty() *BBox
		As Inputs Of (at least 3)
			func (*BBox).Append(child *BBox)
			func (*BBox).Combine(child *BBox, x, y float64)
			func (*BBox).UpdateFrom(other *BBox)

	 type Parameters (struct)
		Parameters contains the TeX font parameters consumed by MathJax's common
		layout wrappers.

		Fields (total 31)
			Axis float64
			BigOp1 float64
			BigOp2 float64
			BigOp3 float64
			BigOp4 float64
			BigOp5 float64
			Delim1 float64
			Delim2 float64
			DelimiterFactor float64
			DelimiterShortfall float64
			Denom1 float64
			Denom2 float64
			ExtraIC float64
			MinRuleThickness float64
			NullDelimiterSpace float64
			Num1 float64
			Num2 float64
			Num3 float64
			Quad float64
			Rule float64
			ScriptSpace float64
			SeparationFactor float64
			Sub1 float64
			Sub2 float64
			SubDrop float64
			Sup1 float64
			Sup2 float64
			Sup3 float64
			SupDrop float64
			Surd float64
			XHeight float64
		As Types Of (only one)
			  var TeXParameters


Package-Level Functions (total 8)

	 func Em(m float64) string
		Em formats a dimension as ems.

	 func EmptyBBox() *BBox
		EmptyBBox returns a box whose height and depth have not been set.

	 func EmRounded(m, em float64) string
		EmRounded rounds a dimension to CSS pixel boundaries before formatting.

	 func Length2Em(length any, size, scale, em float64) float64
		Length2Em converts a MathML dimension into ems with MathJax 3.2.2's
		permissive prefix parsing.

	 func NewBBox(w, h, d float64) *BBox
		NewBBox returns the initialized zero-width box used by MathJax. An omitted
		height or depth is represented by -BigDimen.

	 func Percent(m float64) string
		Percent formats a multiplier as a CSS percentage.

	 func PX(m, minimum, em float64) string
		PX formats an em dimension as pixels with an optional minimum.

	 func ZeroBBox() *BBox
		ZeroBBox returns a fully specified zero box.


Package-Level Variables (total 2)

	  var MathSpace map[string]float64
		MathSpace contains MathJax's named math-space and size values.

	  var TeXParameters Parameters
		TeXParameters is SVG TeXFont.defaultParams in MathJax 3.2.2.


Package-Level Constants (total 2)

	const BigDimen = 1000000
		BigDimen is MathJax's sentinel for an unset or effectively infinite
		dimension.

	const FullWidth = "100%"
		FullWidth is the percentage-width marker used by MathJax tables.

The pages are generated with Golds v0.8.7. (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.