package font

Import Path
	gonum.org/v1/plot/font (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 2 packages

Involved Source Files

	  d doc.go
		Package font provides types to describe and select text font faces.

	    font.go
	    len.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Cache (struct)
		Cache collects font faces.

		Methods (total 5)
			(*Cache) Add(coll Collection)
				Add adds a whole collection of font Faces to the font cache.
				If the cache is empty, the first font Face in the collection is set
				to be the default one.

			(*Cache) GobDecode([]byte) error
			(*Cache) GobEncode() ([]byte, error)
			(*Cache) Has(fnt Font) bool
				Has returns whether the cache contains the exact font descriptor.

			(*Cache) Lookup(fnt Font, size Length) Face
				Lookup returns the font Face corresponding to the provided Font descriptor,
				with the provided font size set.
				
				If no matching font Face could be found, the one corresponding to
				the default typeface is selected and returned.

		Implements (at least 2)
			*Cache : encoding/gob.GobDecoder
			*Cache : encoding/gob.GobEncoder
		As Outputs Of (at least one exported)
			func NewCache(coll Collection) *Cache
		As Types Of (only one)
			  var DefaultCache *Cache

	 type Collection ([])
		Collection is a collection of fonts, regrouped under a common typeface.

		As Inputs Of (at least 2)
			func NewCache(coll Collection) *Cache
			func (*Cache).Add(coll Collection)

	 type Extents (struct)
		Extents contains font metric information.

		Fields (total 3)
			Ascent Length
				Ascent is the distance that the text
				extends above the baseline.

			Descent Length
				Descent is the distance that the text
				extends below the baseline. The descent
				is given as a positive value.

			Height Length
				Height is the distance from the lowest
				descending point to the highest ascending
				point.

		As Outputs Of (at least one exported)
			func (*Face).Extents() Extents

	 type Face (struct)
		Face holds a font descriptor and the associated font face.

		Fields (total 2)
			Face *opentype.Font
			Font Font
		Methods (total 4)
			(*Face) Extents() Extents
				Extents returns the FontExtents for a font.

			(*Face) FontFace(dpi float64) font.Face
				FontFace returns the opentype font face for the requested
				dots-per-inch resolution.

			(*Face) Name() string
				Name returns a fully qualified name for the given font.

			(*Face) Width(s string) Length
				Width returns width of a string when drawn using the font.

		Implements (at least one exported)
			*Face : github.com/polarsignals/frostdb/query/logicalplan.Named
		As Outputs Of (at least one exported)
			func (*Cache).Lookup(fnt Font, size Length) Face
		As Inputs Of (at least 3)
			func gonum.org/v1/plot/vg.Canvas.FillString(f Face, pt vg.Point, text string)
			func gonum.org/v1/plot/vg.CanvasSizer.FillString(f Face, pt vg.Point, text string)
			func gonum.org/v1/plot/vg.CanvasWriterTo.FillString(f Face, pt vg.Point, text string)

	 type Font (struct)
		Font represents a font face.

		Fields (total 5)
			Size Length
				Size is the size of the font.

			Style font.Style
				Style is the style of a font, such as Regular or Italic.

			Typeface Typeface
				Typeface identifies the Font.

			Variant Variant
				Variant is the variant of a font, such as "Mono" or "Smallcaps".

			Weight font.Weight
				Weight is the weight of a font, such as Normal or Bold.

		Methods (only one)
			(*Font) Name() string
				Name returns a fully qualified name for the given font.

		Implements (at least one exported)
			*Font : github.com/polarsignals/frostdb/query/logicalplan.Named
		As Outputs Of (at least one exported)
			func From(fnt Font, size Length) Font
		As Inputs Of (at least 3)
			func From(fnt Font, size Length) Font
			func (*Cache).Has(fnt Font) bool
			func (*Cache).Lookup(fnt Font, size Length) Face

	 type Length float64 (basic type)
		Length is a unit-independent representation of length.
		Internally, the length is stored in postscript points.

		Methods (total 2)
			( Length) Dots(dpi float64) float64
				Dots returns the length in dots for the given resolution.

			( Length) Points() float64
				Points returns the length in postscript points.

		As Outputs Of (at least 3)
			func ParseLength(value string) (Length, error)
			func Points(pt float64) Length
			func (*Face).Width(s string) Length
		As Inputs Of (at least 2)
			func From(fnt Font, size Length) Font
			func (*Cache).Lookup(fnt Font, size Length) Face
		As Types Of (total 6)
			const Centimeter
			const Inch
			const Millimeter
			const gonum.org/v1/plot/vg.Centimeter
			const gonum.org/v1/plot/vg.Inch
			const gonum.org/v1/plot/vg.Millimeter

	 type Typeface string (basic type)
		Typeface identifies a particular typeface design.
		The empty string denotes the default typeface.

	 type Variant string (basic type)
		Variant denotes a typeface variant, such as "Mono", "Smallcaps" or "Math".


Package-Level Functions (total 4)

	 func From(fnt Font, size Length) Font
		From returns a copy of the provided font with its size set.

	 func NewCache(coll Collection) *Cache
		NewCache creates a new cache of fonts from the provided collection of
		font Faces.
		The first font Face in the collection is set to be the default one.

	 func ParseLength(value string) (Length, error)
		ParseLength parses a Length string.
		A Length string is a possible signed floating number with a unit.
		e.g. "42cm" "2.4in" "66pt"
		If no unit was given, ParseLength assumes it was (postscript) points.
		Currently valid units are:
		
		  - mm (millimeter)
		  - cm (centimeter)
		  - in (inch)
		  - pt (point)

	 func Points(pt float64) Length
		Points returns a length for the given number of points.


Package-Level Variables (only one)

	  var DefaultCache *Cache
		DefaultCache is the global cache for fonts.


Package-Level Constants (total 3)

	const Centimeter Length = 28.3465
		Common lengths.

	const Inch Length = 72
		Common lengths.

	const Millimeter Length = 2.83465
		Common lengths.

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.