d2svg

Documentation

Overview

d2svg implements an SVG renderer for d2 diagrams. The input is d2exporter's output

Index

• Constants
• Variables
• func EmbedFonts(buf *bytes.Buffer, diagramHash, source string, fontFamily *d2fonts.FontFamily, ...)
• func Render(diagram *d2target.Diagram, opts *RenderOpts) ([]byte, error)
• func RenderMultiboard(diagram *d2target.Diagram, opts *RenderOpts) ([][]byte, error)
• func RenderText(text string, x, height float64) string
• func ThemeCSS(diagramHash string, themeID int64, darkThemeID *int64) (stylesheet string, err error)
• type DiagramObject
• type RenderOpts

Constants

const (
	DEFAULT_PADDING = 100
)

const DEFAULT_THEME int64 = 0

Variables

var BaseStylesheet string

var DEFAULT_DARK_THEME *int64 = nil // no theme selected

var LinkIcon string

var MarkdownCSS string

var TooltipIcon string

Functions

func EmbedFonts

func EmbedFonts(buf *bytes.Buffer, diagramHash, source string, fontFamily *d2fonts.FontFamily, corpus string)

func Render

func Render(diagram *d2target.Diagram, opts *RenderOpts) ([]byte, error)

func RenderMultiboard

func RenderMultiboard(diagram *d2target.Diagram, opts *RenderOpts) ([][]byte, error)

func RenderText

func RenderText(text string, x, height float64) string

func ThemeCSS

func ThemeCSS(diagramHash string, themeID int64, darkThemeID *int64) (stylesheet string, err error)

TODO include only colors that are being used to reduce size

Types

type DiagramObject

type DiagramObject interface {
	GetID() string
	GetZIndex() int
}

type RenderOpts

type RenderOpts struct {
	Pad         int
	Sketch      bool
	Center      bool
	ThemeID     int64
	DarkThemeID *int64
	Font        string
	// disables the fit to screen behavior and ensures the exported svg has the exact dimensions
	SetDimensions bool

	// MasterID is passed when the diagram should use something other than its own hash for unique targeting
	// Currently, that's when multi-boards are collapsed
	MasterID string
}