kandinsky

README

kandinsky -- Data (structure) visualization

kandinsky is a Go package for visualizing data and data structures using Scalable Vector Graphics.

Get started by running go get github.com/gosvg/kandinsky.

API documentation is available at https://godoc.org/github.com/gosvg/kandinsky.

Documentation

Overview

Package kandinsky contains functions and data for marshaling data and data structures to valid SVG documents.

Supported types: all int types, float32, float64, bool, structs, slices

Marshal objects by calling Marshal with the object and a nominal SVG document size.

Index

• func Marshal(i interface{}, size float64) ([]byte, error)
• type InvalidValueError
  • func (e InvalidValueError) Error() string
• type UnsupportedTypeError
  • func (e UnsupportedTypeError) Error() string

Functions

func Marshal

func Marshal(i interface{}, size float64) ([]byte, error)

Marshal marshals a value into a valid SVG document represented as a byte slice. Users should note that size here represents a nominal document size; SVG documents are vector graphics and as such do not have a notion of image size. This will simply provide a sensible default for web browsers or other viewers when displaying the output.

Types

type InvalidValueError

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

InvalidValueError represents an error condition where the given value for a type is not marshalable by kandinsky.

func (InvalidValueError) Error

func (e InvalidValueError) Error() string

type UnsupportedTypeError

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

UnsupportedTypeError represents an error condition where kandinsky does not support the provided type for marshaling.

func (UnsupportedTypeError) Error

func (e UnsupportedTypeError) Error() string