Graphics.Rendering.Chart.Backend.Diagrams

The backend to render charts with the diagrams library.

Documentation

runBackend

Arguments

:: (Backend b R2, Renderable (Path R2) b)

=> DEnv

Environment to start rendering with.

-> ChartBackend a

Chart render code.

-> (Diagram b R2, a)

The diagram.

Run this backends renderer.

runBackendR

Arguments

:: (Backend b R2, Renderable (Path R2) b)

=> DEnv

Environment to start rendering with.

-> Renderable a

Chart render code.

-> (Diagram b R2, PickFn a)

The diagram.

Run this backends renderer.

defaultEnv

Arguments

:: AlignmentFns

Alignment functions to use.

-> Double

The output image width in backend coordinates.

-> Double

The output image height in backend coordinates.

-> IO DEnv

Produce a default environment with the default fonts.

customFontEnv

Arguments

:: AlignmentFns

Alignment functions to use.

-> Double

The output image width in backend coordinates.

-> Double

The output image height in backend coordinates.

-> Map (String, FontSlant, FontWeight) FilePath

-> IO DEnv

Produce an environment with a custom set of fonts. The defult fonts are still loaded as fall back.

data DEnv

The diagrams backend environement.

Constructors

DEnv

Fields

envAlignmentFns :: AlignmentFns

The used alignment functions.

envFontStyle :: FontStyle

The current/initial font style.

envSelectFont :: FontStyle -> DFont

The font selection function.

envOutputSize :: (Double, Double)

The size of the rendered output.

envUsedGlyphs :: Map (String, FontSlant, FontWeight) (Set String)

The map of all glyphs that are used from a specific font.

type DFont = (FontData, OutlineMap)

A font a delivered by SVGFonts.

File Output Functons

data FileFormat

The file output format: EPS -> Embedded Postscript SVG -> SVG with text rendered as stroked paths SVG -> SVG with embedded font information and text rendered as text operations

Constructors

EPS

SVG

SVG_EMBEDDED

data FileOptions

Constructors

FileOptions

Fields

_fo_size :: (Double, Double)

_fo_format :: FileFormat

_fo_customFonts :: Map (String, FontSlant, FontWeight) FilePath

fo_size :: Lens' FileOptions (Double, Double)

fo_format :: Lens' FileOptions FileFormat

fo_customFonts :: Lens' FileOptions (Map (String, FontSlant, FontWeight) FilePath)

renderableToFile :: FileOptions -> Renderable a -> FilePath -> IO (PickFn a)

Generate an image file for the given renderable, at the specified path. Size, format, and text rendering mode are all set through the FileOptions parameter.

cBackendToFile :: FileOptions -> ChartBackend a -> FilePath -> IO a

Generate an image file for the given drawing instructions, at the specified path. Size and format are set through the FileOptions parameter.

EPS Utility Functions

cBackendToEPSFile :: ChartBackend a -> DEnv -> FilePath -> IO a

renderableToEPSFile :: Renderable a -> Double -> Double -> FilePath -> IO (PickFn a)

Deprecated: use renderToFile

Output the given renderable to a EPS file using the default environment.

renderableToEPSFile' :: Renderable a -> DEnv -> FilePath -> IO (PickFn a)

Deprecated: use renderToFile

Output the given renderable to a EPS file using the given environment.

SVG Utility Functions

cBackendToSVG :: ChartBackend a -> DEnv -> (Svg, a)

cBackendToEmbeddedFontSVG :: ChartBackend a -> DEnv -> (Svg, a)

renderableToSVG :: Renderable a -> Double -> Double -> IO (Svg, PickFn a)

Output the given renderable as a SVG of the specifed size (in points) using the default environment.

renderableToSVG' :: Renderable a -> DEnv -> (Svg, PickFn a)

Output the given renderable as a SVG using the given environment.

renderableToSVGFile :: Renderable a -> Double -> Double -> FilePath -> IO (PickFn a)

Deprecated: use renderToFile

Output the given renderable to a SVG file of the specifed size (in points), to the specified file using the default environment.

renderableToSVGFile' :: Renderable a -> DEnv -> FilePath -> IO (PickFn a)

Deprecated: use renderToFile

Output the given renderable to a SVG file using the given environment.

renderableToSVGString :: Renderable a -> Double -> Double -> IO (ByteString, PickFn a)

Output the given renderable to a string containing a SVG of the specifed size (in points) using the default environment.

renderableToSVGString' :: Renderable a -> DEnv -> (ByteString, PickFn a)

Output the given renderable to a string containing a SVG using the given environment.

SVG Embedded Font Utility Functions

renderableToEmbeddedFontSVG :: Renderable a -> Double -> Double -> IO (Svg, PickFn a)

Output the given renderable as a SVG of the specifed size (in points) using the default environment. Font are embedded to save space.

renderableToEmbeddedFontSVG' :: Renderable a -> DEnv -> (Svg, PickFn a)

Output the given renderable as a SVG using the given environment. Font are embedded to save space.

renderableToEmbeddedFontSVGFile :: Renderable a -> Double -> Double -> FilePath -> IO (PickFn a)

Deprecated: use renderToFile

Output the given renderable to a SVG file of the specifed size (in points), to the specified file using the default environment. Font are embedded to save space.

renderableToEmbeddedFontSVGFile' :: Renderable a -> DEnv -> FilePath -> IO (PickFn a)

Deprecated: use renderToFile

Output the given renderable to a SVG file using the given environment. Font are embedded to save space.