Graphics.Rendering.Plot.Figure

Creation and manipulation of Figures

The same problem of leaked instances as at http://hackage.haskell.org/packages/archive/graphviz/2999.10.0.1/doc/html/Data-GraphViz-Commands.html#t%3AGraphvizCanvas occurs here.

with, set, clear, new, and add are the operations that can be performed on various elements of a figure.

glib/data-accessor abstractions (verbs/modifiers) are planned for future implementations

Documentation

module Data.Colour.Names

Top level operation

data Figure a

Instances

Monad Figure

Simple Figure

MonadState FigureState Figure

data FigureState

Instances

MonadState FigureState Figure

Default options

withTextDefaults :: Text () -> Figure ()

perform some actions on the text defaults, must be run before other text element modifications

withLineDefaults :: Line () -> Figure ()

perform some actions on the line defaults, must be run before other line element modifications

withPointDefaults :: Point () -> Figure ()

perform some actions on the point defaults, must be run before other point modifications

withBarDefaults :: Bar () -> Figure ()

perform some actions on the bar defaults, must be run before other point modifications

Figures

newFigure :: Figure ()

create a new blank Figure

Formatting

setFigurePadding :: Double -> Double -> Double -> Double -> Figure ()

set the padding of the figure

withTitle :: Text () -> Figure ()

operate on the title

withSubTitle :: Text () -> Figure ()

operate on the sub-title

setPlots

Arguments

:: Int

rows

-> Int

columns

-> Figure ()

set the shape of the plots, losing all current plots

withPlot :: (Int, Int) -> Plot () -> Figure ()

perform some actions on the specified subplot

withPlots :: Plot () -> Figure ()

perform some actions all subplots

Sub-plots

data Plot a

Instances

Monad Plot

Simple Plot

MonadReader Options Plot

MonadState PlotData Plot

MonadSupply SupplyData Plot

Plot elements

type Border = Bool

setBorder :: Border -> Plot ()

whether to draw a boundary around the plot area

setPlotPadding :: Double -> Double -> Double -> Double -> Plot ()

set the padding of the subplot

withHeading :: Text () -> Plot ()

set the heading of the subplot

Series data

type Function = Double -> Double

type Series = Vector Double

type MinMaxSeries = (Series, Series)

type ErrorSeries = Series

type Surface = Matrix Double

type SeriesLabel = String

class Abscissa a

Instances

Abscissa Series

class Ordinate a

Instances

Ordinate Function

Ordinate Series

Ordinate (Function, SeriesLabel)

Ordinate (Function, AxisSide)

Ordinate (MinMaxSeries, (ErrorSeries, ErrorSeries))

Ordinate (Series, (ErrorSeries, ErrorSeries))

Ordinate (Series, SeriesLabel)

Ordinate (Series, ErrorSeries)

Ordinate (Series, AxisSide)

Ordinate (Function, AxisSide, SeriesLabel)

Ordinate (MinMaxSeries, (ErrorSeries, ErrorSeries), AxisSide)

Ordinate (Series, (ErrorSeries, ErrorSeries), SeriesLabel)

Ordinate (Series, (ErrorSeries, ErrorSeries), AxisSide)

Ordinate (Series, ErrorSeries, SeriesLabel)

Ordinate (Series, ErrorSeries, AxisSide)

Ordinate (Series, AxisSide, SeriesLabel)

Ordinate (MinMaxSeries, (ErrorSeries, ErrorSeries), AxisSide, SeriesLabel)

Ordinate (Series, (ErrorSeries, ErrorSeries), AxisSide, SeriesLabel)

Ordinate (Series, ErrorSeries, AxisSide, SeriesLabel)

class Dataset a

Instances

Dataset Surface

Abscissa a => Dataset [(a, FormattedSeries)]

(Abscissa a, Ordinate b) => Dataset [(SeriesType, a, b)]

Dataset [FormattedSeries]

Abscissa a => Dataset (a, [FormattedSeries])

Ordinate a => Dataset (SeriesType, [a])

(Abscissa a, Ordinate b) => Dataset (SeriesType, a, [b])

type FormattedSeries = Data DecoratedSeries

data SeriesType

Constructors

Line

Point

LinePoint

Impulse

Step

Area

Bar

Hist

Candle

Whisker

Instances

(Abscissa a, Ordinate b) => Dataset [(SeriesType, a, b)]

Ordinate a => Dataset (SeriesType, [a])

(Abscissa a, Ordinate b) => Dataset (SeriesType, a, [b])

line :: (Ordinate a, LineFormat b) => a -> b -> FormattedSeries

point :: (Ordinate a, PointFormat b) => a -> b -> FormattedSeries

linepoint :: (Ordinate a, LineFormat b, PointFormat c) => a -> b -> c -> FormattedSeries

impulse :: (Ordinate a, LineFormat b) => a -> b -> FormattedSeries

step :: (Ordinate a, LineFormat b) => a -> b -> FormattedSeries

area :: (Ordinate a, LineFormat b) => a -> b -> FormattedSeries

bar :: (Ordinate a, BarFormat b) => a -> b -> FormattedSeries

hist :: (Ordinate a, BarFormat b) => a -> b -> FormattedSeries

candle :: (Ordinate a, BarFormat b) => a -> b -> FormattedSeries

whisker :: (Ordinate a, BarFormat b) => a -> b -> FormattedSeries

setDataset :: Dataset a => a -> Plot ()

set the data series of the subplot

The data series are either FormattedSeries or plain data series. A plain data series must carry a SeriesType.

A dataset may or may not have an abscissa series, and if so, it is paired with either a list of ordinate series or a single ordinate series.

The abscissa series (if present) is of type 'Vector Double'.

An ordinate series be a function (Double -> Double) or a series of points, a 'Vector Double' with optional error series, y axis preference, and labels.

To specify decoration options for an ordinate series, use the appropriate function, such as linespoints, with the ordinate series and decoration formatting (LineFormat, PointFormat, and BarFormat) as arguments.

 setDataset (ts,[linespoints (xs,(le,ue),Upper,"data") (([Dash,Dash],3,blue),(Diamond,green))])

has abscissa ts paired with a list of ordinate series, the single element of which is a FormattedSeries, linespoints where the ordinate is xs with error series le and ue, to be graphed against the upper y-range with label "data". The line element is formatted to be dashed, of width 3, and blue and the point element is to be a green diamond.

Annotations

type Location = (Double, Double)

type Head = Bool

type Fill = Bool

data Annote a

Instances

Monad Annote

MonadReader Options Annote

MonadState Annotations Annote

arrow :: Head -> Location -> Location -> Line () -> Annote ()

add an arrow

oval :: Fill -> Location -> Location -> Bar () -> Annote ()

add an oval

rect :: Fill -> Location -> Location -> Bar () -> Annote ()

add a rectangle

glyph :: Location -> Point () -> Annote ()

add a rectangle

text :: Location -> Text () -> Annote ()

add text

cairo :: (Double -> Double -> Double -> Double -> Render ()) -> Annote ()

add a cairo render that takes the bounding box (in user coordinates) as an argument

withAnnotations :: Annote () -> Plot ()

Plot type

setSeriesType :: Int -> SeriesType -> Plot ()

set the plot type of a given data series

setAllSeriesTypes :: SeriesType -> Plot ()

change the plot type of all data series

Formatting

class PlotFormats m

Instances

PlotFormats Bar

PlotFormats Line

PlotFormats Point

withSeriesFormat :: PlotFormats m => Int -> m () -> Plot ()

format the plot elements of a given series

withAllSeriesFormats :: PlotFormats m => (Int -> m ()) -> Plot ()

format the plot elements of all series

the operation to modify the formats is passed the series index. This allows, for example, colours to be selected from a list that gets indexed by the argument

 setColour = withAllSeriesFormats (\i -> do
                                         setLineColour $ [black,blue,red,green,yellow] !! i
                                         setLineWidth 1.0)

Range

data Scale

Constructors

Linear

Log

Instances

Eq Scale

setRange :: AxisType -> AxisSide -> Scale -> Double -> Double -> Plot ()

set the axis range

setRangeFromData :: AxisType -> AxisSide -> Scale -> Plot ()

set the axis ranges to values based on dataset

Axes

data Axis a

Instances

Monad Axis

MonadReader Options Axis

MonadState AxisData Axis

data AxisType

Constructors

XAxis

YAxis

Instances

Eq AxisType

data AxisSide

Constructors

Lower

Upper

Instances

Eq AxisSide

Ordinate (Function, AxisSide)

Ordinate (Series, AxisSide)

Ordinate (Function, AxisSide, SeriesLabel)

Ordinate (MinMaxSeries, (ErrorSeries, ErrorSeries), AxisSide)

Ordinate (Series, (ErrorSeries, ErrorSeries), AxisSide)

Ordinate (Series, ErrorSeries, AxisSide)

Ordinate (Series, AxisSide, SeriesLabel)

Ordinate (MinMaxSeries, (ErrorSeries, ErrorSeries), AxisSide, SeriesLabel)

Ordinate (Series, (ErrorSeries, ErrorSeries), AxisSide, SeriesLabel)

Ordinate (Series, ErrorSeries, AxisSide, SeriesLabel)

data AxisPosn

Constructors

Side AxisSide

Value Double

Instances

Eq AxisPosn

clearAxes :: Plot ()

clear the axes of a subplot

clearAxis :: AxisType -> AxisPosn -> Plot ()

clear an axis of a subplot

addAxis :: AxisType -> AxisPosn -> Axis () -> Plot ()

add an axis to the subplot

withAxis :: AxisType -> AxisPosn -> Axis () -> Plot ()

operate on the given axis

Legend

data Legend a

Instances

Monad Legend

MonadReader TextOptions Legend

MonadState (Maybe LegendData) Legend

type LegendBorder = Bool

data LegendLocation

Constructors

North

NorthEast

East

SouthEast

South

SouthWest

West

NorthWest

Instances

Eq LegendLocation

data LegendOrientation

Constructors

Inside

Outside

clearLegend :: Plot ()

clear the legend

setLegend :: LegendBorder -> LegendLocation -> LegendOrientation -> Plot ()

set the legend location and orientation

withLegendFormat :: Text () -> Plot ()

format the legend text

Formatting

data Tick

Constructors

Minor

Major

Instances

Eq Tick

type TickValues

Arguments

 = Either Int (Vector Double)

Either (number of ticks) (tick values)

type GridLines = Bool

setTicks :: Tick -> TickValues -> Axis ()

format the axis ticks

setGridlines :: Tick -> GridLines -> Axis ()

should gridlines be displayed?

setTickLabelFormat :: String -> Axis ()

printf format that takes one argument, the tick value

withAxisLabel :: Text () -> Axis ()

operate on the axis label

withAxisLine :: Line () -> Axis ()

format the axis line

withGridLine :: Tick -> Line () -> Axis ()

format the grid lines

Lines

data Line a

Instances

Monad Line

PlotFormats Line

MonadReader LineOptions Line

MonadState LineType Line

class LineFormat a

Instances

LineFormat LineWidth

LineFormat DashStyle

Real a => LineFormat (Colour a)

Real a => LineFormat (LineWidth, Colour a)

Real a => LineFormat (DashStyle, Colour a)

LineFormat (DashStyle, LineWidth)

Real a => LineFormat (DashStyle, LineWidth, Colour a)

type DashStyle = [Dash]

data Dash

Constructors

Dot

Dash

Instances

Eq Dash

LineFormat DashStyle

Real a => LineFormat (DashStyle, Colour a)

LineFormat (DashStyle, LineWidth)

Real a => LineFormat (DashStyle, LineWidth, Colour a)

type LineWidth = Double

clearLineFormat :: Line ()

clear the formatting of a line

setDashStyle :: DashStyle -> Line ()

change the dash style of a line

setLineWidth :: LineWidth -> Line ()

change the line width of a line

setLineColour :: Color -> Line ()

change the line colour of a line

Points

data Point a

Instances

Monad Point

PlotFormats Point

MonadReader PointOptions Point

MonadState PointType Point

class PointFormat a

Instances

PointFormat Glyph

Real a => PointFormat (Colour a)

Real a => PointFormat (Glyph, Colour a)

PointFormat (Glyph, PointSize)

Real a => PointFormat (Glyph, PointSize, Colour a)

data Glyph

Constructors

Box

Cross

Diamond

Asterisk

Triangle

Circle

Bullet

Top

Bot

Instances

PointFormat Glyph

Supply SupplyData Glyph

Real a => PointFormat (Glyph, Colour a)

PointFormat (Glyph, PointSize)

Real a => PointFormat (Glyph, PointSize, Colour a)

type PointSize = Double

setGlyph :: Glyph -> Point ()

change the glyph of a point

setPointSize :: PointSize -> Point ()

change the size of a point

setPointColour :: Color -> Point ()

change the colour of a point

Bars

data Bar a

Instances

Monad Bar

PlotFormats Bar

MonadReader BarOptions Bar

MonadState BarType Bar

class BarFormat a

Instances

BarFormat Width

Real a => BarFormat (Colour a)

Real a => BarFormat (Width, Colour a)

(Real a, Real b) => BarFormat (Width, Colour a, Colour b)

Real a => BarFormat (Width, Colour a, LineWidth)

(Real a, Real b) => BarFormat (Width, Colour a, LineWidth, Colour b)

clearBarFormat :: Bar ()

clear the formatting of a line

setBarWidth :: Width -> Bar ()

set the width of the bar

setBarColour :: Color -> Bar ()

set the colour of the bar

setBarBorderWidth :: LineWidth -> Bar ()

set the width of the bar border

setBarBorderColour :: Color -> Bar ()

set the colour of the bar border

Text labels

data Text a

Instances

Monad Text

MonadReader TextOptions Text

MonadState TextEntry Text

type FontFamily = String

type FontSize = Double

type Color = Colour Double

A text element must exist for formatting to work

clearText :: Text ()

clear the text entry

clearTextFormat :: Text ()

set the text formatting to the default

setText :: String -> Text ()

set the value of a text entry

setFontFamily :: FontFamily -> Text ()

set the font style of a text entry

setFontStyle :: FontStyle -> Text ()

set the font style of a text entry

setFontVariant :: Variant -> Text ()

set the font variant of a text entry

setFontWeight :: Weight -> Text ()

set the font weight of a text entry

setFontStretch :: Stretch -> Text ()

set the font stretch of a text entry

setFontSize :: FontSize -> Text ()

set the font size of a text entry

setFontColour :: Color -> Text ()

set the colour of a text entry