d2svg

package
v0.6.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2024 License: MPL-2.0 Imports: 30 Imported by: 27

Documentation

Overview

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

Index

Constants

View Source
const (
	DEFAULT_PADDING = 100
)

Variables

View Source
var BaseStylesheet string
View Source
var DEFAULT_DARK_THEME *int64 = nil // no theme selected
View Source
var LinkIcon string
View Source
var MarkdownCSS string
View Source
var TooltipIcon string

Functions

func EmbedFonts added in v0.3.0

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 added in v0.4.1

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

func RenderText added in v0.1.4

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

func ThemeCSS added in v0.3.0

func ThemeCSS(diagramHash string, themeID *int64, darkThemeID *int64, overrides, darkOverrides *d2target.ThemeOverrides) (stylesheet string, err error)

TODO include only colors that are being used to reduce size

Types

type DiagramObject added in v0.1.0

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

type RenderOpts added in v0.1.3

type RenderOpts struct {
	Pad                *int64
	Sketch             *bool
	Center             *bool
	ThemeID            *int64
	DarkThemeID        *int64
	ThemeOverrides     *d2target.ThemeOverrides
	DarkThemeOverrides *d2target.ThemeOverrides
	Font               string
	// the svg will be scaled by this factor, if unset the svg will fit to screen
	Scale *float64

	// 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
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL