Graphics.Rendering.Chart.Types

This module contains basic types and functions used for drawing.

Note that template haskell is used to derive accessor functions (see Data.Accessor) for each field of the following data types:

• CairoLineStyle
• CairoFontStyle

These accessors are not shown in this API documentation. They have the same name as the field, but with the trailing underscore dropped. Hence for data field f_::F in type D, they have type

   f :: Data.Accessor.Accessor D F

Documentation

data Rect

A rectangle is defined by two points

Constructors

Rect Point Point

Instances

Show Rect

data Point

A point in two dimensions

Constructors

Point

Fields

p_x :: Double

p_y :: Double

Instances

Show Point

data Vector

Constructors

Vector

Fields

v_x :: Double

v_y :: Double

Instances

Show Vector

type RectSize = (Double, Double)

type Range = (Double, Double)

mkrect :: Point -> Point -> Point -> Point -> Rect

Create a rectangle based upon the coordinates of 4 points

pvadd :: Point -> Vector -> Point

add a point and a vector

pvsub :: Point -> Vector -> Point

subtract a vector from a point

psub :: Point -> Point -> Vector

subtract two points

vscale :: Double -> Vector -> Vector

scale a vector by a constant

within :: Point -> Rect -> Bool

Test if a point is within a rectangle

data RectEdge

Constructors

E_Top

E_Bottom

E_Left

E_Right

type PointMapFn x y = (x, y) -> Point

a function mapping between points

preserveCState :: CRender a -> CRender a

Execute a rendering action in a saved context (ie bracketed between C.save and C.restore)

setClipRegion :: Point -> Point -> CRender ()

strokeLines :: [Point] -> CRender ()

stroke the lines between successive points

moveTo :: Point -> CRender ()

lineTo :: Point -> CRender ()

rectPath :: Rect -> CRender ()

make a path from a rectable

isValidNumber :: RealFloat a => a -> Bool

maybeM :: Monad m => a -> (a1 -> m a) -> Maybe a1 -> m a

black :: Color

grey8 :: Color

white :: Color

red :: Color

green :: Color

blue :: Color

defaultColorSeq :: [Color]

data Color

Constructors

Color

Fields

c_r :: Double

c_g :: Double

c_b :: Double

setSourceColor :: Color -> Render ()

data CairoLineStyle

Data type for the style of a line

Constructors

CairoLineStyle

Fields

line_width_ :: Double

line_color_ :: Color

line_dashes_ :: [Double]

line_cap_ :: LineCap

line_join_ :: LineJoin

solidLine

Arguments

:: Double

width of line

-> Color

-> CairoLineStyle

dashedLine

Arguments

:: Double

width of line

-> [Double]

the dash pattern in device coordinates

-> Color

-> CairoLineStyle

setLineStyle :: CairoLineStyle -> CRender ()

newtype CairoFillStyle

Abstract data type for a fill style

The contained Cairo action sets the required fill style in the Cairo rendering state.

Constructors

CairoFillStyle (CRender ())

defaultPointStyle :: CairoPointStyle

solidFillStyle :: Color -> CairoFillStyle

setFillStyle :: CairoFillStyle -> CRender ()

data CairoFontStyle

Data type for a font

Constructors

CairoFontStyle

Fields

font_name_ :: String

font_size_ :: Double

font_slant_ :: FontSlant

font_weight_ :: FontWeight

font_color_ :: Color

defaultFontStyle :: CairoFontStyle

setFontStyle :: CairoFontStyle -> CRender ()

newtype CairoPointStyle

Abstract data type for the style of a plotted point

The contained Cairo action draws a point in the desired style, at the supplied device coordinates.

Constructors

CairoPointStyle (Point -> CRender ())

filledPolygon

Arguments

:: Double

radius of circle

-> Int

Number of vertices

-> Bool

Is right-side-up?

-> Color

-> CairoPointStyle

hollowPolygon

Arguments

:: Double

radius of circle

-> Double

thickness of line

-> Int

Number of vertices

-> Bool

Is right-side-up?

-> Color

-> CairoPointStyle

filledCircles

Arguments

:: Double

radius of circle

-> Color

colour

-> CairoPointStyle

hollowCircles

Arguments

:: Double

radius of circle

-> Double

thickness of line

-> Color

-> CairoPointStyle

plusses

Arguments

:: Double

radius of circle

-> Double

thickness of line

-> Color

-> CairoPointStyle

exes

Arguments

:: Double

radius of circle

-> Double

thickness of line

-> Color

-> CairoPointStyle

stars

Arguments

:: Double

radius of circle

-> Double

thickness of line

-> Color

-> CairoPointStyle

data HTextAnchor

Constructors

HTA_Left

HTA_Centre

HTA_Right

data VTextAnchor

Constructors

VTA_Top

VTA_Centre

VTA_Bottom

VTA_BaseLine

drawText :: HTextAnchor -> VTextAnchor -> Point -> String -> CRender ()

Function to draw a textual label anchored by one of it's corners or edges.

textSize :: String -> CRender RectSize

Return the bounding rectancgle for a text string rendered in the current context.

newtype CRender a

The reader monad containing context information to control the rendering process.

Constructors

DR (ReaderT CEnv Render a)

Instances

Monad CRender

Functor CRender

MonadReader CEnv CRender

data CEnv

The environment present in the CRender Monad.

Constructors

CEnv

Fields

cenv_point_alignfn :: Point -> Point

A transform applied immediately prior to values being displayed in device coordinates

When device coordinates correspond to pixels, a cleaner image is created if this transform rounds to the nearest pixel. With higher-resolution output, this transform can just be the identity function.

Instances

MonadReader CEnv CRender

runCRender :: CRender a -> CEnv -> Render a

c :: Render a -> CRender a

line_width :: T CairoLineStyle Double

line_color :: T CairoLineStyle Color

line_dashes :: T CairoLineStyle ([] Double)

line_cap :: T CairoLineStyle LineCap

line_join :: T CairoLineStyle LineJoin

font_name :: T CairoFontStyle String

font_size :: T CairoFontStyle Double

font_slant :: T CairoFontStyle FontSlant

font_weight :: T CairoFontStyle FontWeight

font_color :: T CairoFontStyle Color