render

Documentation

Overview

Package render provides rendering utilities for Aha canvases.

Package render provides rendering utilities for Aha canvases.

Index

• func RenderCanvasD2(sm *aha.StrategicModel, opts *D2Options) string
• func RenderCanvasMermaid(sm *aha.StrategicModel, opts *MermaidOptions) string
• func RenderCanvasSVG(sm *aha.StrategicModel, opts *SVGOptions) string
• type D2Options
  • func DefaultD2Options() *D2Options
• type Format
  • func SupportedFormats() []Format
  • func (f Format) FileExtension() string
  • func (f Format) MimeType() string
• type MermaidOptions
  • func DefaultMermaidOptions() *MermaidOptions
• type SVGOptions
  • func DefaultSVGOptions() *SVGOptions

Functions

func RenderCanvasD2

func RenderCanvasD2(sm *aha.StrategicModel, opts *D2Options) string

RenderCanvasD2 renders a strategic model to D2 diagram language.

func RenderCanvasMermaid

func RenderCanvasMermaid(sm *aha.StrategicModel, opts *MermaidOptions) string

RenderCanvasMermaid renders a strategic model to Mermaid diagram language.

func RenderCanvasSVG

func RenderCanvasSVG(sm *aha.StrategicModel, opts *SVGOptions) string

RenderCanvasSVG renders a strategic model to SVG.

Types

type D2Options

type D2Options struct {
	Theme     int    // D2 theme number (0-8)
	Layout    string // "dagre", "elk", "tala"
	Direction string // "right", "down", "left", "up"
}

D2Options configures D2 rendering.

func DefaultD2Options

func DefaultD2Options() *D2Options

DefaultD2Options returns default D2 rendering options.

type Format

type Format string

Format identifies the output format for canvas rendering.

const (
	FormatSVG     Format = "svg"
	FormatD2      Format = "d2"
	FormatMermaid Format = "mermaid"
)

func SupportedFormats

func SupportedFormats() []Format

SupportedFormats returns all supported render formats.

func (Format) FileExtension

func (f Format) FileExtension() string

FileExtension returns the file extension for a format.

func (Format) MimeType

func (f Format) MimeType() string

MimeType returns the MIME type for a format.

type MermaidOptions

type MermaidOptions struct {
	Theme     string // "default", "dark", "forest", "neutral"
	Direction string // "TB", "BT", "LR", "RL"
}

MermaidOptions configures Mermaid rendering.

func DefaultMermaidOptions

func DefaultMermaidOptions() *MermaidOptions

DefaultMermaidOptions returns default Mermaid rendering options.

type SVGOptions

type SVGOptions struct {
	Width      int
	Height     int
	FontFamily string
	Theme      string // "dark" or "light"
}

SVGOptions configures SVG rendering.

func DefaultSVGOptions

func DefaultSVGOptions() *SVGOptions

DefaultSVGOptions returns default SVG options.