Copyright	(c) Tim Docker 2006, 2014
License	BSD-style (see chart/COPYRIGHT)
Safe Haskell	None
Language	Haskell98

Graphics.Rendering.Chart.Renderable

Description

This module contains the definition of the Renderable type, which is a composable drawing element, along with assorted functions to them.

Synopsis

Documentation

data Renderable a Source

A Renderable is a record of functions required to layout a graphic element.

Constructors

Renderable
Fields minsize :: ChartBackend RectSize Calculate the minimum size of the renderable. render :: RectSize -> ChartBackend (PickFn a) Draw the renderable with a rectangle, which covers the origin to a given point. The resulting "pick" function maps a point in the image to a value.

class ToRenderable a where Source

A type class abtracting the conversion of a value to a Renderable.

Methods

toRenderable :: a -> Renderable () Source

Instances

ToRenderable Rectangle
ToRenderable PieChart
ToRenderable PieLayout
ToRenderable SparkLine
ToRenderable a => ToRenderable (Grid a)
Ord x => ToRenderable (StackedLayouts x)
ToRenderable (Legend x y)
(Ord x, Ord y) => ToRenderable (Layout x y)
(Default a, ToRenderable a) => ToRenderable (EC a b)
(Ord x, Ord yl, Ord yr) => ToRenderable (LayoutLR x yl yr)

type PickFn a = Point -> Maybe a Source

A function that maps a point in device coordinates to some value.

Perhaps it might be generalised from Maybe a to (MonadPlus m ) => m a in the future.

data Rectangle Source

Constructors

Rectangle
Fields _rect_minsize :: RectSize _rect_fillStyle :: Maybe FillStyle _rect_lineStyle :: Maybe LineStyle _rect_cornerStyle :: RectCornerStyle

Instances

Default Rectangle
ToRenderable Rectangle

data RectCornerStyle Source

Constructors

RCornerSquare
RCornerBevel Double
RCornerRounded Double

rectangleToRenderable :: Rectangle -> Renderable a Source

fillBackground :: FillStyle -> Renderable a -> Renderable a Source

Overlay a renderable over a solid background fill.

addMargins Source

Arguments

:: (Double, Double, Double, Double)	The spacing to be added.
-> Renderable a	The source renderable.
-> Renderable a

Add some spacing at the edges of a renderable.

emptyRenderable :: Renderable a Source

embedRenderable :: ChartBackend (Renderable a) -> Renderable a Source

Helper function for using a renderable, when we generate it in the ChartBackend monad.

label :: FontStyle -> HTextAnchor -> VTextAnchor -> String -> Renderable String Source

Construct a renderable from a text string, aligned with the axes.

rlabel :: FontStyle -> HTextAnchor -> VTextAnchor -> Double -> String -> Renderable String Source

Construct a renderable from a text string, rotated wrt to axes. The angle of rotation is in degrees, measured clockwise from the horizontal.

spacer :: RectSize -> Renderable a Source

Create a blank renderable with a specified minimum size.

spacer1 :: Renderable a -> Renderable b Source

Create a blank renderable with a minimum size the same as some other renderable.

setPickFn :: PickFn b -> Renderable a -> Renderable b Source

Replace the pick function of a renderable with another.

mapMaybePickFn :: (a -> Maybe b) -> Renderable a -> Renderable b Source

Map a function over the result of a renderable's pickfunction, keeping only Just results.

mapPickFn :: (a -> b) -> Renderable a -> Renderable b Source

Map a function over result of a renderable's pickfunction.

nullPickFn :: PickFn a Source

rect_minsize :: Lens' Rectangle RectSize Source

rect_fillStyle :: Lens' Rectangle (Maybe FillStyle) Source

rect_lineStyle :: Lens' Rectangle (Maybe LineStyle) Source

rect_cornerStyle :: Lens' Rectangle RectCornerStyle Source