Diagrams.Backend.PGF.Render

This is an internal module exposeing internals for rendering a diagram. This is for advanced use only. PGF has enought for general use.

Documentation

data PGF

This data declaration is simply used as a token to distinguish this rendering engine.

Constructors

PGF

Instances

Show PGF

TypeableFloat n => Backend PGF V2 n

TypeableFloat n => Renderable (Text n) PGF

Does not support full alignment. Text is not escaped.

TypeableFloat n => Renderable (Hbox n) PGF

RealFloat n => Renderable (DImage n Embedded) PGF

Supported: ImageRGB8. (Other types from DynamicImage will error)

RealFloat n => Renderable (DImage n External) PGF

Supported: .pdf, .jpg, .png.

TypeableFloat n => Renderable (Path V2 n) PGF

Monoid (Render PGF V2 n)

Fractional n => Default (Options PGF V2 n)

Hashable n => Hashable (Options PGF V2 n)

type V PGF = V2

type N PGF = Double

data Options PGF V2 = PGFOptions {

• _surface :: Surface
• _sizeSpec :: SizeSpec V2 n
• _readable :: Bool
• _standalone :: Bool

}

data Render PGF V2 = R (Render n)

type Result PGF V2 n = Builder

type MainOpts [(String, QDiagram PGF V2 n Any)] = (MainOpts (QDiagram PGF V2 n Any), DiagramMultiOpts)

type MainOpts (OnlineTex (QDiagram PGF V2 n Any))

type MainOpts (Surface, QDiagram PGF V2 n Any)

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any))

type MainOpts (QDiagram PGF V2 n Any)

data family Options b v n

Backend-specific rendering options.

Instances

Fractional n => Default (Options PGF V2 n)

Hashable n => Hashable (Options PGF V2 n)

data Options NullBackend

data Options PGF V2 = PGFOptions {

• _surface :: Surface
• _sizeSpec :: SizeSpec V2 n
• _readable :: Bool
• _standalone :: Bool

}

data family Render b v n

An intermediate representation used for rendering primitives. (Typically, this will be some sort of monad, but it need not be.) The Renderable class guarantees that a backend will be able to convert primitives into this type; how these rendered primitives are combined into an ultimate Result is completely up to the backend.

Instances

Monoid (Render NullBackend v n)

Monoid (Render PGF V2 n)

data Render NullBackend = NullBackendRender

data Render PGF V2 = R (Render n)

Lenses

surface :: Lens' (Options PGF V2 n) Surface

Lens onto the surface used to render.

sizeSpec :: Lens' (Options PGF V2 n) (SizeSpec V2 n)

Lens onto the SizeSpec2D.

readable :: Lens' (Options PGF V2 n) Bool

Lens onto whether the lines of the TeX output are indented.

standalone :: Lens' (Options PGF V2 n) Bool

Lens onto whether a standalone TeX document should be produced.

Utilities

escapeString :: String -> String

Escapes some common characters in a string. Note that this does not mean the string can't create an error, it mearly escapes common characters.