Interactive.Plot.Run

Run plots interactively in the terminal.

Simple

runPlot

Arguments

:: PlotOpts

options (can be defaultPlotOpts)

-> Maybe String

title

-> [Series]

series data

-> IO ()

Display fixed plot and title interactively.

See runPlotDynamic for more control.

runPlotAuto

Arguments

:: PlotOpts

options (can be defaultPlotOpts)

-> Maybe String

title

-> [AutoSeries]

uninitialized series data

-> IO ()

Display fixed plot and title interactively, filling in default values.

See runPlotDynamic for more control.

Animated

animatePlot

Arguments

:: PlotOpts

options (can be defaultPlotOpts)

-> Double

update rate (frames per second)

-> Maybe String

title

-> [[Series]]

list of series data (potentially infinite)

-> IO ()

Display a series of plots ([SeriesF]) with a time delay between each one. Will quit when the last plot is displayed. Use lastForever on the input list to repeat the last item indefinitely, or cycle to cycle through the list forever.

Note that this behavior is pretty simple; more advanced functionality can be achieved with runPlotDynamic directly.

lastForever :: [a] -> [a]

Handy function to use with animatePlot to extend the last frame into eternity.

animatePlotFunc

Arguments

:: PlotOpts

options (can be defaultPlotOpts, but remember to set a framerate)

-> Maybe String

title

-> (Double -> Maybe [Series])

function from time to plot. will quit as soon as Nothing is returned.

-> IO ()

Animate (according to the framerate in the PlotOpts) a function Double -> Maybe [Series], where the input is the current time in seconds and the output is the plot to display at that time. Will quit as soon as Nothing is given.

Remember to give a PlotOpts with a Just framerate.

This is a simple wrapper over animatePlotMoore with a stateless function. For more advanced functionality, use animatePlotMoore or runPlotDynamic directly.

animatePlotMoore

Arguments

:: PlotOpts

options (can be defaultPlotOpts, but remember to set a framerate)

-> Maybe String

title

-> Moore [Series]

moore machine representing progression of plot from an initial state

-> IO ()

Animate (according to the framerate in the PlotOpts) a "Moore machine" description of a plot evolving over time with some initial state.

Remember to give a PlotOpts with a Just framerate.

For a simplified version of a stateless function, see animatePlotFunc. This is implemented in terms of runPlotDynamic, but the representation of an animation in terms of a moore machine is powerful enough to represent a very general class of animations.

data Moore a

Used for animatePlotMoore to specify how a plot evolves over time with some initial state.

Constructors

Moore

Fields

• moInitVal :: Maybe a

  initial value of plot. Nothing for a non-starter.

• moInitState :: s

  initial state of plot

• moUpdate :: Double -> s -> IO (Maybe (a, s))

  Given change in time since last render and old state, return new plot and state. Return Nothing to quit.

Instances

Functor Moore

Defined in Interactive.Plot.Run

Methods

fmap :: (a -> b) -> Moore a -> Moore b

(<$) :: a -> Moore b -> Moore a

Custom

runPlotDynamic

Arguments

:: PlotOpts

-> (Event -> IO Bool)

process VTY events (return False to trigger quit)

-> IO (Maybe PlotData)

action to "get" the plot data every frame. if Nothing, quit.

-> IO ()

Version of runPlot that allows you to vary the plotted data and the title. It will execute the IO PlotData to get the current plot data; you can use this with i.e. an IORef to adjust the data in real-time.

data PlotData

Dynamically adjustable plot data.

Constructors

PlotData

Fields

• _pdTitle :: Maybe String
• _pdDesc :: Maybe Image
• _pdSerieses :: [Series]

pdTitle :: Lens' PlotData (Maybe String)

Getter/setter lens to the title field of a PlotData

pdSerieses :: Lens' PlotData [Series]

Getter/setter lens to the serieses field of a PlotData

pdDesc :: Lens' PlotData (Maybe Image)

Getter/setter lens to the description box field of a PlotData