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

data Limit a

Constructors

LMin

LValue a

LMax

Instances

Show a => Show (Limit a)

type PointMapFn x y = (Limit x, Limit 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 ()

moveTo, lineTo :: Point -> CRender ()

rectPath :: Rect -> [Point]

Make a path from a rectangle.

strokePath :: [Point] -> CRender ()

Draw lines between the specified points.

The points will be corrected by the cenv_point_alignfn, so that when drawing bitmaps, 1 pixel wide lines will be centred on the pixels.

fillPath :: [Point] -> CRender ()

Fill the region with the given corners.

The points will be corrected by the cenv_coord_alignfn, so that when drawing bitmaps, the edges of the region will fall between pixels.

isValidNumber :: RealFloat a => a -> Bool

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

defaultColorSeq :: [AlphaColour Double]

setSourceColor :: AlphaColour Double -> Render ()

data CairoLineStyle

Data type for the style of a line.

Constructors

CairoLineStyle

Fields

line_width_ :: Double

line_color_ :: AlphaColour Double

line_dashes_ :: [Double]

line_cap_ :: LineCap

line_join_ :: LineJoin

solidLine

Arguments

:: Double

Width of line.

-> AlphaColour Double

-> CairoLineStyle

dashedLine

Arguments

:: Double

Width of line.

-> [Double]

The dash pattern in device coordinates.

-> AlphaColour Double

-> 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 :: AlphaColour Double -> 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_ :: AlphaColour Double

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?

-> AlphaColour Double

-> CairoPointStyle

hollowPolygon

Arguments

:: Double

Radius of circle.

-> Double

Thickness of line.

-> Int

Number of vertices.

-> Bool

Is right-side-up?

-> AlphaColour Double

-> CairoPointStyle

filledCircles

Arguments

:: Double

Radius of circle.

-> AlphaColour Double

Colour.

-> CairoPointStyle

hollowCircles

Arguments

:: Double

Radius of circle.

-> Double

Thickness of line.

-> AlphaColour Double

-> CairoPointStyle

plusses

Arguments

:: Double

Radius of circle.

-> Double

Thickness of line.

-> AlphaColour Double

-> CairoPointStyle

exes

Arguments

:: Double

Radius of circle.

-> Double

Thickness of line.

-> AlphaColour Double

-> CairoPointStyle

stars

Arguments

:: Double

Radius of circle.

-> Double

Thickness of line.

-> AlphaColour Double

-> 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 its corners or edges.

drawTextR :: HTextAnchor -> VTextAnchor -> Double -> Point -> String -> CRender ()

Function to draw a textual label anchored by one of its corners or edges, with rotation. Rotation angle is given in degrees, rotation is performed around anchor point.

drawTextsR :: HTextAnchor -> VTextAnchor -> Double -> Point -> String -> CRender ()

Function to draw a multi-line textual label anchored by one of its corners or edges, with rotation. Rotation angle is given in degrees, rotation is performed around anchor point.

textSize :: String -> CRender RectSize

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

textDrawRect :: HTextAnchor -> VTextAnchor -> Point -> String -> CRender Rect

Recturn the bounding rectangle for a text string positioned where it would be drawn by drawText

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

An adjustment applied immediately prior to points 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.

cenv_coord_alignfn :: Point -> Point

A adjustment applied immediately prior to coordinates being transformed.

Instances

MonadReader CEnv CRender

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

c :: Render a -> CRender a

alignp :: Point -> CRender Point

alignc :: Point -> CRender Point

line_width :: T CairoLineStyle Double

line_color :: T CairoLineStyle (AlphaColour Double)

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 (AlphaColour Double)