aivika-experiment-chart-1.1: Simulation experiments with charting for the Aivika library

Stabilityexperimental
MaintainerDavid Sorokin <david.sorokin@gmail.com>
Safe HaskellNone

Simulation.Aivika.Experiment.Chart.FinalXYChartView

Description

Tested with: GHC 7.6.3

The module defines FinalXYChartView that saves the XY chart by final time points for all simulation runs sequentially.

Synopsis

Documentation

data FinalXYChartView Source

Defines the View that saves the XY chart in the PNG file by final time points for all simulation runs sequentially.

Constructors

FinalXYChartView 

Fields

finalXYChartTitle :: String

This is a title used HTML.

finalXYChartDescription :: String

This is a description used in HTML.

finalXYChartWidth :: Int

The width of the chart.

finalXYChartHeight :: Int

The height of the chart.

finalXYChartFileName :: FileName

It defines the file name for the PNG file. It may include special variable $TITLE.

An example is

   finalXYChartFileName = UniqueFileName "$TITLE" ".png"
finalXYChartPredicate :: Event Bool

It specifies the predicate that defines when we count data when plotting the chart.

finalXYChartXSeries :: Maybe String

It defines a label of the single X series.

You must define it, because it is Nothing by default.

finalXYChartYSeries :: [Either String String]

It contains the labels of Y series plotted on the chart.

finalXYChartPlotTitle :: String

This is a title used in the chart. It may include special variable $TITLE.

An example is

   finalXYChartPlotTitle = "$TITLE"
finalXYChartPlotLines :: [PlotLines Double Double -> PlotLines Double Double]

Probably, an infinite sequence of plot transformations based on which the plot is constructed for each series. Generally, it may not coincide with a sequence of labels as one label may denote a whole list or an array of data providers.

Here you can define a colour or style of the plot lines.

finalXYChartBottomAxis :: LayoutAxis Double -> LayoutAxis Double

A transformation of the bottom axis, after the X title is added.

finalXYChartLayout :: LayoutLR Double Double Double -> LayoutLR Double Double Double

A transformation of the plot layout, where you can redefine the axes, for example.

defaultFinalXYChartView :: FinalXYChartViewSource

The default XY chart view.