Graphics.Rendering.Chart.Layout

This module glues together axes and plots to actually create a renderable for a chart.

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

• Layout1
• StackedLayouts
• LayoutAxis

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 Layout1 x y

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. It's parameterised by the types of values to be plotted on the horizonal and vertical axes.

Constructors

Layout1

Fields

layout1_background_ :: CairoFillStyle

layout1_plot_background_ :: Maybe CairoFillStyle

layout1_title_ :: String

layout1_title_style_ :: CairoFontStyle

layout1_bottom_axis_ :: LayoutAxis x

layout1_top_axis_ :: LayoutAxis x

layout1_left_axis_ :: LayoutAxis y

layout1_right_axis_ :: LayoutAxis y

layout1_yaxes_control_ :: ([y], [y]) -> ([y], [y])

Function to map points from the left/right plot to the left/right axes. The default value is id.

layout1_margin_ :: Double

layout1_plots_ :: [Either (Plot x y) (Plot x y)]

layout1_legend_ :: Maybe LegendStyle

layout1_grid_last_ :: Bool

True if the grid is to be rendered on top of the Plots.

Instances

(Ord x, Ord y) => ToRenderable (Layout1 x y)

data LayoutAxis x

Constructors

LayoutAxis

Fields

laxis_title_style_ :: CairoFontStyle

laxis_title_ :: String

laxis_style_ :: AxisStyle

laxis_visible_ :: [x] -> Bool

Function that determines whether an axis should be visible, based upon the points plotted on this axis. The default value is 'not.null'.

laxis_generate_ :: AxisFn x

Function that generates the axis data, based upon the points plotted. The default value is autoAxis.

laxis_override_ :: AxisData x -> AxisData x

Function that can be used to override the generated axis data. The default value is id.

laxis_reverse_ :: Bool

True if left to right (bottom to top) is to show descending values.

data Layout1Pick x y

Constructors

L1P_Legend String

L1P_Title String

L1P_BottomAxisTitle String

L1P_TopAxisTitle String

L1P_LeftAxisTitle String

L1P_RightAxisTitle String

L1P_PlotArea x y y

L1P_BottomAxis x

L1P_TopAxis x

L1P_LeftAxis y

L1P_RightAxis y

Instances

(Show x, Show y) => Show (Layout1Pick x y)

data StackedLayouts x

A holder for a set of vertically stacked layouts

Constructors

StackedLayouts

Fields

slayouts_layouts_ :: [StackedLayout x]

slayouts_compress_xlabels_ :: Bool

slayouts_compress_legend_ :: Bool

data StackedLayout x

A layout with it's y type hidded, so that it can be stacked with other layouts (with differing y types)

Constructors

forall y . Ord y => StackedLayout (Layout1 x y)

type MAxisFn t = [t] -> Maybe (AxisData t)

A MAxisFn is a function that generates an (optional) axis given the points plotted against that axis.

defaultLayout1 :: (PlotValue x, PlotValue y) => Layout1 x y

layout1ToRenderable :: (Ord x, Ord y) => Layout1 x y -> Renderable (Layout1Pick x y)

linkAxes :: ([a], [a]) -> ([a], [a])

independentAxes :: (a, b) -> (a, b)

updateAllAxesStyles :: (AxisStyle -> AxisStyle) -> Layout1 x y -> Layout1 x y

Helper to update all axis styles on a Layout1 simultaneously.

setLayout1Foreground :: AlphaColour Double -> Layout1 x y -> Layout1 x y

Helper to set the forground color uniformly on a Layout1.

defaultLayoutAxis :: PlotValue t => LayoutAxis t

laxis_title_style :: forall x. T (LayoutAxis x) CairoFontStyle

laxis_title :: forall x. T (LayoutAxis x) String

laxis_style :: forall x. T (LayoutAxis x) AxisStyle

laxis_visible :: forall x. T (LayoutAxis x) ([x] -> Bool)

laxis_generate :: forall x. T (LayoutAxis x) (AxisFn x)

laxis_override :: forall x. T (LayoutAxis x) (AxisData x -> AxisData x)

laxis_reverse :: forall x. T (LayoutAxis x) Bool

layout1_background :: forall x y. T (Layout1 x y) CairoFillStyle

layout1_plot_background :: forall x y. T (Layout1 x y) (Maybe CairoFillStyle)

layout1_title :: forall x y. T (Layout1 x y) String

layout1_title_style :: forall x y. T (Layout1 x y) CairoFontStyle

layout1_left_axis :: forall x y. T (Layout1 x y) (LayoutAxis y)

layout1_right_axis :: forall x y. T (Layout1 x y) (LayoutAxis y)

layout1_top_axis :: forall x y. T (Layout1 x y) (LayoutAxis x)

layout1_bottom_axis :: forall x y. T (Layout1 x y) (LayoutAxis x)

layout1_yaxes_control :: forall x y. T (Layout1 x y) (([y], [y]) -> ([y], [y]))

layout1_margin :: forall x y. T (Layout1 x y) Double

layout1_plots :: forall x y. T (Layout1 x y) [Either (Plot x y) (Plot x y)]

layout1_legend :: forall x y. T (Layout1 x y) (Maybe LegendStyle)

layout1_grid_last :: forall x y. T (Layout1 x y) Bool

defaultStackedLayouts :: StackedLayouts x

slayouts_layouts :: forall x. T (StackedLayouts x) [StackedLayout x]

slayouts_compress_xlabels :: forall x. T (StackedLayouts x) Bool

slayouts_compress_legend :: forall x. T (StackedLayouts x) Bool

renderStackedLayouts :: Ord x => StackedLayouts x -> Renderable ()

Render several layouts with the same x-axis type and range, vertically stacked so that their origins and x-values are aligned.

The legends from all the charts may be optionally combined, and shown once on the bottom chart. The x labels may be optionally removed so that they are only shown once.