package d2themes

Import Path
	github.com/pancsta/d2/d2themes (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 9 packages

Involved Source Files

	    common.go
	  d d2themes.go
		d2themes defines themes to make d2 diagrams pretty
		Color codes: darkest (N1) -> lightest (N7)

	    element.go
	    pattern_overlay.go
	    sketch_overlay.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type ColorPalette (struct)

		Fields (total 12)
			AA2 string
				Alternative colors A

			AA4 string
			AA5 string
			AB4 string
				Alternative colors B

			AB5 string
			B1 string
				Base Colors: used for containers

			B2 string
			B3 string
			B4 string
			B5 string
			B6 string
			Neutrals Neutral

	 type Neutral (struct)

		Fields (total 7)
			N1 string
			N2 string
			N3 string
			N4 string
			N5 string
			N6 string
			N7 string
		As Types Of (total 7)
			  var CoolNeutral
			  var DarkMauveNeutral
			  var DarkNeutral
			  var WarmNeutral
			  var github.com/pancsta/d2/d2themes/d2themescatalog.OrigamiNeutral
			  var github.com/pancsta/d2/d2themes/d2themescatalog.TerminalGrayscaleNeutral
			  var github.com/pancsta/d2/d2themes/d2themescatalog.TerminalNeutral

	 type PatternOverlay (struct)
		PatternOverlay renders a legacy pattern overlay for a themable element.
		
		Deprecated: PatternOverlay is no longer used by D2 and will be removed after
		one compatibility release. There is no replacement.

		Methods (only one)
			(*PatternOverlay) Render() (string, error)
				Render renders the legacy pattern overlay.
				
				Deprecated: PatternOverlay is no longer used by D2 and will be removed after
				one compatibility release. There is no replacement.

		As Outputs Of (at least one exported)
			func NewPatternOverlay(el *ThemableElement, pattern string) *PatternOverlay

	 type SpecialRules (struct)

		Fields (total 7)
			AllPaper bool
			C4 bool
			CapsLock bool
			ContainerDots bool
			Mono bool
			NoCornerRadius bool
			OuterContainerDoubleBorder bool

	 type ThemableElement (struct)
		ThemableElement is a helper class for creating new XML elements.
		This should be preferred over formatting and must be used
		whenever Fill, Stroke, BackgroundColor or Color contains a color from a theme.
		i.e. N[1-7] | B[1-6] | AA[245] | AB[45]

		Fields (total 30)
			Attributes string
				Attributes is retained for source compatibility. Values are parsed and
				re-serialized through lib/svg; malformed or event attributes panic.
				Deprecated: use AddAttributes.

			BackgroundColor string
			ClassName string
			ClipPath string
				ClipPath is retained for source compatibility and must contain a local
				identifier. Deprecated: use SetClipPathID.

			Color string
			Content string
				Content is retained as a trusted-markup compatibility escape hatch.
				Deprecated: use SetText or SetInnerSVG.

			Cx float64
			Cy float64
			D string
			Fill string
			FillPattern string
			Height float64
			Href string
			Mask string
				Mask is retained for source compatibility and must be a local IRI in the
				form url(#id). Deprecated: use SetMaskID.

			Points string
			R float64
			Rx float64
			Ry float64
			Stroke string
			StrokeDashArray string
			Style string
			Transform string
			Width float64
			X float64
			X1 float64
			X2 float64
			Xmlns string
			Y float64
			Y1 float64
			Y2 float64
		Methods (total 9)
			(*ThemableElement) AddAttributes(attributes ...svg.Attribute)
			(*ThemableElement) Copy() *ThemableElement
			(*ThemableElement) Render() string
			(*ThemableElement) SetClipPathID(id svg.ID)
			(*ThemableElement) SetInnerSVG(content svg.Fragment)
			(*ThemableElement) SetMaskID(id svg.ID)
			(*ThemableElement) SetMaskUrl(id string)
				SetMaskUrl is retained for source compatibility.
				Deprecated: use SetMaskID.

			(*ThemableElement) SetText(text string)
			(*ThemableElement) SetTranslate(x, y float64)
		As Outputs Of (at least 2)
			func NewThemableElement(tag string, inlineTheme *Theme) *ThemableElement
			func (*ThemableElement).Copy() *ThemableElement
		As Inputs Of (at least 2)
			func NewPatternOverlay(el *ThemableElement, pattern string) *PatternOverlay
			func NewThemableSketchOverlay(el *ThemableElement, fill string) *ThemableSketchOverlay

	 type ThemableSketchOverlay (struct)

		Methods (only one)
			(*ThemableSketchOverlay) Render() (string, error)
				TODO we can just call el.Copy() to prevent that
				WARNING: Do not reuse the element afterwards as this function changes the Class property

		As Outputs Of (at least one exported)
			func NewThemableSketchOverlay(el *ThemableElement, fill string) *ThemableSketchOverlay

	 type Theme (struct)

		Fields (total 4)
			Colors ColorPalette
			ID int64
			Name string
			SpecialRules SpecialRules
		Methods (total 2)
			(*Theme) ApplyOverrides(overrides *d2target.ThemeOverrides)
			(*Theme) IsDark() bool
		As Outputs Of (at least one exported)
			func github.com/pancsta/d2/d2themes/d2themescatalog.Find(id int64) Theme
		As Inputs Of (at least 3)
			func NewThemableElement(tag string, inlineTheme *Theme) *ThemableElement
			func ResolveThemeColor(theme Theme, code string) string
			func github.com/pancsta/d2/d2renderers/d2svg.RenderLegend(buf *bytes.Buffer, diagram *d2target.Diagram, diagramHash string, theme *Theme) error
		As Types Of (total 20)
			  var github.com/pancsta/d2/d2themes/d2themescatalog.Aubergine
			  var github.com/pancsta/d2/d2themes/d2themescatalog.ButteredToast
			  var github.com/pancsta/d2/d2themes/d2themescatalog.C4
			  var github.com/pancsta/d2/d2themes/d2themescatalog.ColorblindClear
			  var github.com/pancsta/d2/d2themes/d2themescatalog.CoolClassics
			  var github.com/pancsta/d2/d2themes/d2themescatalog.DarkFlagshipTerrastruct
			  var github.com/pancsta/d2/d2themes/d2themescatalog.DarkMauve
			  var github.com/pancsta/d2/d2themes/d2themescatalog.EarthTones
			  var github.com/pancsta/d2/d2themes/d2themescatalog.EvergladeGreen
			  var github.com/pancsta/d2/d2themes/d2themescatalog.FlagshipTerrastruct
			  var github.com/pancsta/d2/d2themes/d2themescatalog.GrapeSoda
			  var github.com/pancsta/d2/d2themes/d2themescatalog.MixedBerryBlue
			  var github.com/pancsta/d2/d2themes/d2themescatalog.NeutralDefault
			  var github.com/pancsta/d2/d2themes/d2themescatalog.NeutralGrey
			  var github.com/pancsta/d2/d2themes/d2themescatalog.OrangeCreamsicle
			  var github.com/pancsta/d2/d2themes/d2themescatalog.Origami
			  var github.com/pancsta/d2/d2themes/d2themescatalog.ShirleyTemple
			  var github.com/pancsta/d2/d2themes/d2themescatalog.Terminal
			  var github.com/pancsta/d2/d2themes/d2themescatalog.TerminalGrayscale
			  var github.com/pancsta/d2/d2themes/d2themescatalog.VanillaNitroCola


Package-Level Functions (total 5)

	 func NewPatternOverlay(el *ThemableElement, pattern string) *PatternOverlay
		NewPatternOverlay returns a legacy pattern overlay.
		
		Deprecated: PatternOverlay is no longer used by D2 and will be removed after
		one compatibility release. There is no replacement.

	 func NewThemableElement(tag string, inlineTheme *Theme) *ThemableElement
	 func NewThemableSketchOverlay(el *ThemableElement, fill string) *ThemableSketchOverlay
	 func ResolveThemeColor(theme Theme, code string) string
	 func ShapeTheme(shape d2target.Shape) (fill, stroke string)
Package-Level Variables (total 4)

	  var CoolNeutral Neutral
	  var DarkMauveNeutral Neutral
	  var DarkNeutral Neutral
	  var WarmNeutral Neutral

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.