package label

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

Dependency Relation
	imports 2 packages, and imported by 12 packages

Involved Source Files

	    label.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Position int8 (basic type)

		Methods (total 10)
			( Position) GetPointOnBox(box *geo.Box, padding, width, height float64) *geo.Point
			( Position) GetPointOnRoute(route geo.Route, strokeWidth, labelPercentage, width, height float64) (point *geo.Point, index int)
				return the top left point of a width x height label at the given label position on the route
				also return the index of the route segment that point is on

			( Position) IsBorder() bool
			( Position) IsEdgePosition() bool
			( Position) IsOnEdge() bool
			( Position) IsOutside() bool
			( Position) IsShapePosition() bool
			( Position) IsUnlocked() bool
			( Position) Mirrored() Position
			( Position) String() string
		Implements (at least 2)
			 Position : expvar.Var
			 Position : fmt.Stringer
		As Outputs Of (at least 2)
			func FromString(s string) Position
			func Position.Mirrored() Position
		As Types Of (total 37)
			const BorderBottomCenter
			const BorderBottomLeft
			const BorderBottomRight
			const BorderLeftBottom
			const BorderLeftMiddle
			const BorderLeftTop
			const BorderRightBottom
			const BorderRightMiddle
			const BorderRightTop
			const BorderTopCenter
			const BorderTopLeft
			const BorderTopRight
			const InsideBottomCenter
			const InsideBottomLeft
			const InsideBottomRight
			const InsideMiddleCenter
			const InsideMiddleLeft
			const InsideMiddleRight
			const InsideTopCenter
			const InsideTopLeft
			const InsideTopRight
			const OutsideBottomCenter
			const OutsideBottomLeft
			const OutsideBottomRight
			const OutsideLeftBottom
			const OutsideLeftMiddle
			const OutsideLeftTop
			const OutsideRightBottom
			const OutsideRightMiddle
			const OutsideRightTop
			const OutsideTopCenter
			const OutsideTopLeft
			const OutsideTopRight
			const UnlockedBottom
			const UnlockedMiddle
			const UnlockedTop
			const Unset


Package-Level Functions (only one)

	 func FromString(s string) Position
Package-Level Constants (total 41)

	const BorderBottomCenter Position = 32
	const BorderBottomLeft Position = 31
	const BorderBottomRight Position = 33
	const BorderLeftBottom Position = 27
	const BorderLeftMiddle Position = 26
	const BorderLeftTop Position = 25
	const BorderRightBottom Position = 30
	const BorderRightMiddle Position = 29
	const BorderRightTop Position = 28
	const BorderTopCenter Position = 23
	const BorderTopLeft Position = 22
	const BorderTopRight Position = 24
	const CENTER_LABEL_POSITION = 0.5
	const InsideBottomCenter Position = 20
	const InsideBottomLeft Position = 19
	const InsideBottomRight Position = 21
	const InsideMiddleCenter Position = 17
	const InsideMiddleLeft Position = 16
	const InsideMiddleRight Position = 18
	const InsideTopCenter Position = 14
	const InsideTopLeft Position = 13
	const InsideTopRight Position = 15
	const LEFT_LABEL_POSITION = 0.25
		These are % locations where labels will be placed along the connection

	const OutsideBottomCenter Position = 11
	const OutsideBottomLeft Position = 10
	const OutsideBottomRight Position = 12
	const OutsideLeftBottom Position = 6
	const OutsideLeftMiddle Position = 5
	const OutsideLeftTop Position = 4
	const OutsideRightBottom Position = 9
	const OutsideRightMiddle Position = 8
	const OutsideRightTop Position = 7
	const OutsideTopCenter Position = 2
	const OutsideTopLeft Position = 1
	const OutsideTopRight Position = 3
	const PADDING = 5
		This is the space between a node border and its outside label

	const RIGHT_LABEL_POSITION = 0.75
	const UnlockedBottom Position = 36
	const UnlockedMiddle Position = 35
	const UnlockedTop Position = 34
	const Unset Position = 0

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