| Safe Haskell | None |
|---|
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.
- data Renderable a = Renderable {
- minsize :: ChartBackend RectSize
- render :: RectSize -> ChartBackend (PickFn a)
- class ToRenderable a where
- toRenderable :: a -> Renderable ()
- type PickFn a = Point -> Maybe a
- data Rectangle = Rectangle {}
- data RectCornerStyle
- rectangleToRenderable :: Rectangle -> Renderable a
- fillBackground :: FillStyle -> Renderable a -> Renderable a
- addMargins :: (Double, Double, Double, Double) -> Renderable a -> Renderable a
- emptyRenderable :: Renderable a
- embedRenderable :: ChartBackend (Renderable a) -> Renderable a
- label :: FontStyle -> HTextAnchor -> VTextAnchor -> String -> Renderable String
- rlabel :: FontStyle -> HTextAnchor -> VTextAnchor -> Double -> String -> Renderable String
- spacer :: RectSize -> Renderable a
- spacer1 :: Renderable a -> Renderable b
- setPickFn :: PickFn b -> Renderable a -> Renderable b
- mapMaybePickFn :: (a -> Maybe b) -> Renderable a -> Renderable b
- mapPickFn :: (a -> b) -> Renderable a -> Renderable b
- nullPickFn :: PickFn a
- rect_minsize :: Lens' Rectangle RectSize
- rect_fillStyle :: Lens' Rectangle (Maybe FillStyle)
- rect_lineStyle :: Lens' Rectangle (Maybe LineStyle)
- rect_cornerStyle :: Lens' Rectangle RectCornerStyle
Documentation
data Renderable a Source
A Renderable is a record of functions required to layout a graphic element.
Constructors
| Renderable | |
Fields
| |
class ToRenderable a whereSource
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) | |
| ToRenderable (Legend x y) | |
| (Ord x, Ord y) => ToRenderable (Layout x y) | |
| (Ord x, Ord yl, Ord yr) => ToRenderable (LayoutLR x yl yr) |
type PickFn a = Point -> Maybe aSource
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.
Constructors
| Rectangle | |
Instances
data RectCornerStyle Source
Constructors
| RCornerSquare | |
| RCornerBevel Double | |
| RCornerRounded Double |
fillBackground :: FillStyle -> Renderable a -> Renderable aSource
Overlay a renderable over a solid background fill.
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.
embedRenderable :: ChartBackend (Renderable a) -> Renderable aSource
Helper function for using a renderable, when we generate it in the CRender monad.
label :: FontStyle -> HTextAnchor -> VTextAnchor -> String -> Renderable StringSource
Construct a renderable from a text string, aligned with the axes.
rlabel :: FontStyle -> HTextAnchor -> VTextAnchor -> Double -> String -> Renderable StringSource
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 aSource
Create a blank renderable with a specified minimum size.
spacer1 :: Renderable a -> Renderable bSource
Create a blank renderable with a minimum size the same as some other renderable.
setPickFn :: PickFn b -> Renderable a -> Renderable bSource
Replace the pick function of a renderable with another.
mapMaybePickFn :: (a -> Maybe b) -> Renderable a -> Renderable bSource
Map a function over the result of a renderable's pickfunction, keeping only Just results.
mapPickFn :: (a -> b) -> Renderable a -> Renderable bSource
Map a function over result of a renderable's pickfunction.
nullPickFn :: PickFn aSource