svgmap

Documentation

Overview

Example (CustomMarshaler)

package main

import (
	"encoding/xml"
	"image"
	"image/color"
	"os"

	"github.com/owulveryck/wardleyToGo/internal/svg"
)

type component struct{}

func (c *component) MarshalSVG(e *xml.Encoder, bounds image.Rectangle) error {
	e.Encode(&svg.Transform{
		Translate: image.Point{50, 100},
		Components: []interface{}{
			&svg.Circle{
				Fill: svg.Color{color.Black},
			},
		},
	})
	return nil
}
func main() {
	c := &component{}
	enc := xml.NewEncoder(os.Stdout)
	c.MarshalSVG(enc, image.Rectangle{})
}

Example (Style)

package main

import (
	"image"
	"log"
	"os"

	svgmap "github.com/owulveryck/wardleyToGo/encoding/svg"
)

func main() {
	f, _ := os.Create("/tmp/test.svg")
	defer f.Close()
	e, err := svgmap.NewEncoder(f, image.Rect(0, 0, 1100, 900), image.Rect(30, 50, 1070, 850))
	if err != nil {
		log.Fatal(err)
	}
	defer e.Close()
	style := svgmap.NewWardleyStyle(svgmap.DefaultEvolution)
	e.Init(style)
}

Index

• Variables
• type Annotator
  • func AllEvolutionIndications() []Annotator
• type Encoder
  • func NewEncoder(w io.Writer, box image.Rectangle, canvas image.Rectangle) (*Encoder, error)
  • func (e *Encoder) Close()
  • func (e *Encoder) Encode(m *wardleyToGo.Map) error
  • func (e *Encoder) Init(s SVGStyleMarshaler)
• type Evolution
• type EvolutionIndication
  • func (e *EvolutionIndication) MarshalSVG(enc *xml.Encoder, box image.Rectangle, canvas image.Rectangle)
• type OctoStyle
  • func NewOctoStyle(evolutionSteps []Evolution, annotators ...Annotator) *OctoStyle
  • func (w *OctoStyle) MarshalStyleSVG(enc *xml.Encoder, box, canvas image.Rectangle)
• type SVGMarshaler
• type SVGStyleMarshaler
• type WardleyStyle
  • func NewWardleyStyle(evolutionSteps []Evolution) *WardleyStyle
  • func (w *WardleyStyle) MarshalStyleSVG(enc *xml.Encoder, box, canvas image.Rectangle)

Examples

• Package (CustomMarshaler)
• Package (Style)

Variables

var DataEvolution = []Evolution{
	{
		Position: 0,
		Label:    "Unmodeled",
	},
	{
		Position: stage12,
		Label:    "Divergent",
	},
	{
		Position: stage23,
		Label:    "Convergent",
	},
	{
		Position: stage34,
		Label:    "Modeled",
	},
}

DataEvolution

https://learnwardleymapping.com/2020/01/22/visualizing-the-interaction-of-evolution-and-data-measurement/

var DefaultEvolution = []Evolution{
	{
		Position: 0,
		Label:    "🧪 Genesis",
	},
	{
		Position: stage12,
		Label:    "⚒️  Custom-Built",
	},
	{
		Position: stage23,
		Label:    "🛒 Product\n(+rental)",
	},
	{
		Position: stage34,
		Label:    "⛽ Commodity\n(+utility)",
	},
}

Types

type Annotator

type Annotator interface {
	MarshalSVG(enc *xml.Encoder, box, canvas image.Rectangle)
}

func AllEvolutionIndications

func AllEvolutionIndications() []Annotator

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(w io.Writer, box image.Rectangle, canvas image.Rectangle) (*Encoder, error)

func (*Encoder) Close

func (e *Encoder) Close()

func (*Encoder) Encode

func (e *Encoder) Encode(m *wardleyToGo.Map) error

func (*Encoder) Init

func (e *Encoder) Init(s SVGStyleMarshaler)

type Evolution

type Evolution struct {
	Position float64
	Label    string
}

type EvolutionIndication

type EvolutionIndication struct {
	Y      int
	Labels []string
}

func (*EvolutionIndication) MarshalSVG

func (e *EvolutionIndication) MarshalSVG(enc *xml.Encoder, box image.Rectangle, canvas image.Rectangle)

type OctoStyle

type OctoStyle struct {
	WithValueChain bool
	WithSpace      bool
	WithControls   bool
	Annotators     []Annotator
	// contains filtered or unexported fields
}

func NewOctoStyle

func NewOctoStyle(evolutionSteps []Evolution, annotators ...Annotator) *OctoStyle

func (*OctoStyle) MarshalStyleSVG

func (w *OctoStyle) MarshalStyleSVG(enc *xml.Encoder, box, canvas image.Rectangle)

type SVGMarshaler

type SVGMarshaler interface {
	MarshalSVG(e *xml.Encoder, bounds image.Rectangle) error
}

type SVGStyleMarshaler

type SVGStyleMarshaler interface {
	MarshalStyleSVG(e *xml.Encoder, box, canvas image.Rectangle)
}

type WardleyStyle

type WardleyStyle struct {
	// contains filtered or unexported fields
}

func NewWardleyStyle

func NewWardleyStyle(evolutionSteps []Evolution) *WardleyStyle

func (*WardleyStyle) MarshalStyleSVG

func (w *WardleyStyle) MarshalStyleSVG(enc *xml.Encoder, box, canvas image.Rectangle)