Safe Haskell	None

Graphics.Rendering.Chart

Description

A framework for creating 2D charts in Haskell.

The basic model is that you define a value of type Renderable, typically by applying toRenderable to some other value. This Renderable is then actually displayed or output by calling either renderableToPNGFile, or renderableToWindow.

Currently, the only useful Renderable for displaying charts is created by applying toRenderable to a value of type Layout1

For a simpler though less flexible API, see Graphics.Rendering.Chart.Simple.

Synopsis

Documentation

data Renderable Source

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

Constructors

Renderable
Fields minsize :: CRender RectSize a Cairo action to calculate a minimum size, render :: Rect -> CRender () a Cairo action for drawing it within a specified rectangle.

class ToRenderable a whereSource

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

Methods

toRenderable :: a -> Renderable Source

Instances

ToRenderable Legend
ToRenderable AxisT
ToRenderable Layout1
ToRenderable PieChart
ToRenderable PieLayout

data Layout1 Source

A Layout1 value is a single plot area, with optional: axes on each of the 4 sides; title at the top; legend at the bottom.

Constructors

Layout1
Fields layout1_background :: CairoFillStyle layout1_title :: String layout1_title_style :: CairoFontStyle layout1_horizontal_axes :: AxesFn layout1_vertical_axes :: AxesFn layout1_margin :: Double layout1_plots :: [(String, HAxis, VAxis, Plot)] layout1_legend :: Maybe LegendStyle layout1_grid_last :: Bool

Instances

ToRenderable Layout1

data Axis Source

The concrete data type for an axis

Constructors

Axis

Fields

axis_viewport :: Range -> Double -> Double: The axis_viewport function maps values into device cordinates.
axis_title :: String: The title string to be displayed on the axis. An empty string means no title.
axis_ticks :: [(Double, Double)]: The tick marks on the axis as pairs. The first element is the position on the axis (in viewport units) and the second element is the length of the tick in output coordinates. The tick starts on the axis, and positive number are drawn towards the plot area.
axis_labels :: [(Double, String)]: The labels on an axis as pairs. The first element is the position on the axis (in viewport units) and the second is the label text string.
axis_grid :: [Double]: The positions on the axis (in viewport units) where we want to show grid lines.
axis_label_gap :: Double: How far the labels are to be drawn from the axis.
axis_title_style :: CairoFontStyle
axis_line_style :: CairoLineStyle
axis_label_style :: CairoFontStyle
axis_grid_style :: CairoLineStyle

data LinearAxisParams Source

Constructors

LinearAxisParams
Fields la_labelf :: Double -> String The function used to show the axes labels la_nLabels :: Int The target number of labels to be shown la_nTicks :: Int The target number of ticks to be shown la_gridAtMinor :: Bool If True, the grid is shown at the label values, otherwise the otherwise the grid is shown at the tick values

data Plot Source

Interface to control plotting on a 2D area.

Constructors

Plot

Fields

plot_render :: PointMapFn -> CRender (): Given the mapping between model space coordinates and device coordinates, render this plot into a chart.
plot_render_legend :: Rect -> CRender (): Render a small sample of this plot into the given rectangle. This is for used to generate a the legend a chart.
plot_all_points :: [Point]: All of the model space coordinates to be plotted. These are used to autoscale the axes where necessary.

class ToPlot a whereSource

a type class abstracting the conversion of a value to a Plot.

Methods

toPlot :: a -> Plot Source

Instances

ToPlot PlotErrBars
ToPlot PlotFillBetween
ToPlot PlotPoints
ToPlot PlotLines

data PlotPoints Source

Value defining a series of datapoints, and a style in which to render them

Constructors

PlotPoints
Fields plot_points_style :: CairoPointStyle plot_points_values :: [Point]

Instances

ToPlot PlotPoints

data PlotErrBars Source

Value defining a series of error intervals, and a style in which to render them

Constructors

PlotErrBars
Fields plot_errbars_line_style :: CairoLineStyle plot_errbars_tick_length :: Double plot_errbars_overhang :: Double plot_errbars_values :: [ErrPoint]

Instances

ToPlot PlotErrBars

data PlotLines Source

Value defining a series of (possibly disjointed) lines, and a style in which to render them

Constructors

PlotLines
Fields plot_lines_style :: CairoLineStyle plot_lines_values :: [[Point]]

Instances

ToPlot PlotLines

data PlotFillBetween Source

Value specifying a plot filling the area between two sets of Y coordinates, given common X coordinates.

Constructors

PlotFillBetween
Fields plot_fillbetween_style :: CairoFillStyle plot_fillbetween_values :: [(Double, (Double, Double))]

Instances

ToPlot PlotFillBetween

data HAxis Source

The side of an horizontal axis

Constructors

HA_Top
HA_Bottom

Instances

Eq HAxis

data VAxis Source

The side of a vertical axis

Constructors

VA_Left
VA_Right

Instances

Eq VAxis

data LegendStyle Source

Constructors

LegendStyle
Fields legend_label_style :: CairoFontStyle legend_margin :: Double legend_plot_size :: Double

data Rect Source

A rectangle is defined by two points

Constructors

Rect Point Point

Instances

Show Rect

data Point Source

A point in two dimensions

Constructors

Point
Fields p_x :: Double p_y :: Double

Instances

Show Point

data Color Source

Constructors

Color
Fields c_r :: Double c_g :: Double c_b :: Double

data ErrPoint Source

Value for holding a point with associated error bounds for each axis.

Constructors

ErrPoint
Fields ep_x :: Double ep_y :: Double ep_dx :: Double ep_dy :: Double

Instances

Show ErrPoint

data PieChart Source

Constructors

PieChart
Fields pie_data :: [PieItem] pie_colors :: [Color] pie_label_style :: CairoFontStyle pie_label_line_style :: CairoLineStyle pie_start_angle :: Double

Instances

ToRenderable PieChart

data PieLayout Source

Constructors

PieLayout
Fields pie_title :: String pie_title_style :: CairoFontStyle pie_plot :: PieChart pie_background :: CairoFillStyle pie_margin :: Double

Instances

ToRenderable PieLayout

data PieItem Source

Constructors

PieItem
Fields pitem_label :: String pitem_offset :: Double pitem_value :: Double

defaultAxisLineStyle :: CairoLineStyle Source

defaultPlotLineStyle :: CairoLineStyle Source

defaultAxis :: Axis Source

defaultPlotPoints :: PlotPoints Source

defaultPlotErrBars :: PlotErrBars Source

defaultPlotLines :: PlotLines Source

defaultPlotFillBetween :: PlotFillBetween Source

defaultLayout1 :: Layout1 Source

defaultLinearAxis :: LinearAxisParams Source

defaultPieLayout :: PieLayout Source

defaultPieChart :: PieChart Source

defaultPieItem :: PieItem Source

defaultLegendStyle :: LegendStyle Source

filledCircles Source

Arguments

:: Double	radius of circle
-> Color	colour
-> CairoPointStyle

hollowCircles Source

Arguments

:: Double	radius of circle
-> Double	thickness of line
-> Color
-> CairoPointStyle

exes Source

Arguments

:: Double	radius of circle
-> Double	thickness of line
-> Color
-> CairoPointStyle

plusses Source

Arguments

:: Double	radius of circle
-> Double	thickness of line
-> Color
-> CairoPointStyle

stars Source

Arguments

:: Double	radius of circle
-> Double	thickness of line
-> Color
-> CairoPointStyle

filledPolygon Source

Arguments

:: Double	radius of circle
-> Int	Number of vertices
-> Bool	Is right-side-up?
-> Color
-> CairoPointStyle

hollowPolygon Source

Arguments

:: Double	radius of circle
-> Double	thickness of line
-> Int	Number of vertices
-> Bool	Is right-side-up?
-> Color
-> CairoPointStyle

solidLine Source

Arguments

:: Double	width of line
-> Color
-> CairoLineStyle

dashedLine Source

Arguments

:: Double	width of line
-> [Double]	the dash pattern in device coordinates
-> Color
-> CairoLineStyle

solidFillStyle :: Color -> CairoFillStyle Source

independentAxes :: AxisFn -> AxisFn -> AxesFn Source

Show independent axes on each side of the layout

linkedAxes :: AxisFn -> AxesFn Source

Show the same axis on both sides of the layout

linkedAxes' :: AxisFn -> AxesFn Source

Show the same axis on both sides of the layout, but with labels only on the primary side

explicitAxis :: Maybe Axis -> AxisFn Source

Explicitly specify an axis

autoScaledAxis :: Axis -> AxisFn Source

Generate a linear axis automatically. Same as autoScaledAxis', but with labels generated with showD (showD is show for doubles, but with any trailing .0 removed)

autoScaledAxis' :: LinearAxisParams -> Axis -> AxisFn Source

Generate a linear axis automatically. The supplied axis is used as a template, with the viewport, ticks, labels and grid set appropriately for the data displayed against that axies. The resulting axis will only show a grid if the template has some grid values.

autoScaledLogAxis :: Axis -> AxisFn Source

Generate a log axis automatically. Same as autoScaledLogAxis', but with labels generated with showD (showD is show for doubles, but with any trailing .0 removed)

autoScaledLogAxis' :: (Double -> String) -> Axis -> AxisFn Source

Generate a log axis automatically. The supplied axis is used as a template, with the viewport, ticks, labels and grid set appropriately for the data displayed against that axies. The resulting axis will only show a grid if the template has some grid values.

timeAxis :: TimeSeq -> TimeSeq -> TimeLabelFn -> Axis -> AxisFn Source

Create an AxisFn to for a time axis. The first TimeSeq sets the minor ticks, and the ultimate range will aligned to it's elements. The second TimeSeq sets the labels and grid. The TimeLabelFn is used to format LocalTimes for labels. The values to be plotted against this axis can be created with doubleFromLocalTime

autoTimeAxis :: Axis -> AxisFn Source

Automatically choose a suitable time axis, based upon the time range of data. The values to be plotted against this axis can be created with doubleFromLocalTime

days :: TimeSeq Source

A TimeSeq for calendar days

months :: TimeSeq Source

A TimeSeq for calendar months

years :: TimeSeq Source

A TimeSeq for calendar years

renderableToPNGFile :: Renderable -> Int -> Int -> FilePath -> IO ()Source

Output the given renderable to a PNG file of the specifed size (in pixels), to the specified file.

renderableToPDFFile :: Renderable -> Int -> Int -> FilePath -> IO ()Source

Output the given renderable to a PDF file of the specifed size (in points), to the specified file.

renderableToPSFile :: Renderable -> Int -> Int -> FilePath -> IO ()Source

Output the given renderable to a postscript file of the specifed size (in points), to the specified file.

renderableToSVGFile :: Renderable -> Int -> Int -> FilePath -> IO ()Source

Output the given renderable to an SVG file of the specifed size (in points), to the specified file.

doubleFromLocalTime :: LocalTime -> Double Source

Map a LocalTime value to a plot cordinate

localTimeFromDouble :: Double -> LocalTime Source

Map a plot cordinate to a LocalTime

data CairoLineStyle Source

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

newtype CairoFillStyle Source

Abstract data type for a fill style

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

Constructors

CairoFillStyle (CRender ())

data CairoFontStyle Source

Data type for a font

Constructors

CairoFontStyle
Fields font_name :: String font_size :: Double font_slant :: FontSlant font_weight :: FontWeight font_color :: Color