tiling

Documentation

Index

• Constants
• Variables
• func Render(paper TiledPaper, labelGroups []Renderable, options DocumentRenderOptions) ([]*xmlquery.Node, error)
• type DocumentRenderOptions
• type DocumentRenderer
  • func NewDocumentRenderer(paper TiledPaper, options DocumentRenderOptions) *DocumentRenderer
  • func (builder *DocumentRenderer) IsSpaceLeftOnCurrentPage() bool
  • func (builder *DocumentRenderer) Pages() []*xmlquery.Node
  • func (builder *DocumentRenderer) PlaceLabel(node *xmlquery.Node)
  • func (builder *DocumentRenderer) StartNewPage()
• type Renderable
• type Size64
• type Template
• type TemplateInstancesGroup
  • func (group TemplateInstancesGroup) RenderTo(renderer *DocumentRenderer) error
• type TemplateInstancesGroupInstance
• type TiledPaper
• type Vector64

Constants

const SvgNamespaceURI = "http://www.w3.org/2000/svg"

Variables

var UnitSuffixRegex = regexp.MustCompile("[^.0-9]*$")

Functions

func Render

func Render(
	paper TiledPaper,
	labelGroups []Renderable,
	options DocumentRenderOptions,
) ([]*xmlquery.Node, error)

Types

type DocumentRenderOptions

type DocumentRenderOptions struct {
	RenderPageBorders  bool
	RenderTileBorders  bool
	RenderLabelBorders bool
}

type DocumentRenderer

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

func NewDocumentRenderer

func NewDocumentRenderer(
	paper TiledPaper,
	options DocumentRenderOptions,
) *DocumentRenderer

func (*DocumentRenderer) IsSpaceLeftOnCurrentPage

func (builder *DocumentRenderer) IsSpaceLeftOnCurrentPage() bool

func (*DocumentRenderer) Pages

func (builder *DocumentRenderer) Pages() []*xmlquery.Node

func (*DocumentRenderer) PlaceLabel

func (builder *DocumentRenderer) PlaceLabel(node *xmlquery.Node)

func (*DocumentRenderer) StartNewPage

func (builder *DocumentRenderer) StartNewPage()

type Renderable

type Renderable interface {
	RenderTo(renderer *DocumentRenderer) error
}

type Size64

type Size64 struct {
	Width, Height float64
}

type Template

type Template interface {
	Render(content map[string]any) (*xmlquery.Node, error)
}

type TemplateInstancesGroup

type TemplateInstancesGroup struct {
	Template Template

	Instances []TemplateInstancesGroupInstance
}

func (TemplateInstancesGroup) RenderTo

func (group TemplateInstancesGroup) RenderTo(renderer *DocumentRenderer) error

type TemplateInstancesGroupInstance

type TemplateInstancesGroupInstance struct {
	Count    int
	FillPage bool
	Content  map[string]any
}

type TiledPaper

type TiledPaper struct {
	Width, Height float64

	TileOffset  Vector64
	TileSize    Size64
	TileSpacing Vector64
}

type Vector64

type Vector64 struct {
	X, Y float64
}