Plots.Types

This module defines the various types for holding plots:

PlotOptions b v n

Generic options all plots have.

PlotMods b v n

Includes PlotOptions along with modifications to the PlotStyle.

Plot p b

A rawPlot p grouped with a PlotMods.

DynamicPlot b v n

A wrapped up Plot so it can be stored in an Axis.

StyledPlot b v n

A DynamicPlot with a concrete PlotStyle, ready to be rendered.

As well as other things like the Plotable class, LegendEntries, HasOrientation and HasVisibility.

Plot options

data PlotOptions b v n

Data type for holding information all plots must contain.

Instances

HasPlotOptions f (PlotOptions b v n) b

Methods

plotOptions :: LensLike' f (PlotOptions b v n) (PlotOptions b (V (PlotOptions b v n)) (N (PlotOptions b v n)))

plotName :: LensLike' f (PlotOptions b v n) Name

clipPlot :: LensLike' f (PlotOptions b v n) Bool

legendEntries :: LensLike' f (PlotOptions b v n) [LegendEntry b (V (PlotOptions b v n)) (N (PlotOptions b v n))]

plotTransform :: LensLike' f (PlotOptions b v n) (Transformation (V (PlotOptions b v n)) (N (PlotOptions b v n)))

plotVisible :: LensLike' f (PlotOptions b v n) Bool

(Additive v, Num n) => Default (PlotOptions b v n)

Methods

def :: PlotOptions b v n

Qualifiable (PlotOptions b v n)

Methods

(.>>) :: IsName a => a -> PlotOptions b v n -> PlotOptions b v n

(HasLinearMap v, Num n) => Transformable (PlotOptions b v n)

Methods

transform :: Transformation (V (PlotOptions b v n)) (N (PlotOptions b v n)) -> PlotOptions b v n -> PlotOptions b v n

(Additive v, Num n) => HasOrigin (PlotOptions b v n)

Move origin by applying to plotTransform.

Methods

moveOriginTo :: Point (V (PlotOptions b v n)) (N (PlotOptions b v n)) -> PlotOptions b v n -> PlotOptions b v n

HasVisibility (PlotOptions b v n)

Methods

visible :: Lens' (PlotOptions b v n) Bool

hidden :: Lens' (PlotOptions b v n) Bool

type V (PlotOptions b v n)

type V (PlotOptions b v n) = v

type N (PlotOptions b v n)

type N (PlotOptions b v n) = n

class HasPlotOptions f a b | a -> b where

Class of things that have PlotOptions.

Minimal complete definition

plotOptions

Methods

plotOptions :: LensLike' f a (PlotOptions b (V a) (N a))

Lens onto the PlotOptions.

plotName :: Functor f => LensLike' f a Name

The Name applied to the plot. This gives a way to reference a specific plot in a rendered axis.

Default is mempty.

clipPlot :: Functor f => LensLike' f a Bool

Whether the plot should be clipped to the bounds of the axes.

Default is True.

legendEntries :: Functor f => LensLike' f a [LegendEntry b (V a) (N a)]

The legend entries to be used for the current plot.

Default is mempty.

plotTransform :: Functor f => LensLike' f a (Transformation (V a) (N a))

The transform applied to the plot once it's in the axis coordinates.

Default is mempty.

plotVisible :: Functor f => LensLike' f a Bool

Whether or not the plot should be shown. The BoundingBox of the plot will still affect the inferred axis bounds.

Default is True.

Instances

Functor f => HasPlotOptions f (Plot p b) b

Methods

plotOptions :: LensLike' f (Plot p b) (PlotOptions b (V (Plot p b)) (N (Plot p b)))

plotName :: LensLike' f (Plot p b) Name

clipPlot :: LensLike' f (Plot p b) Bool

legendEntries :: LensLike' f (Plot p b) [LegendEntry b (V (Plot p b)) (N (Plot p b))]

plotTransform :: LensLike' f (Plot p b) (Transformation (V (Plot p b)) (N (Plot p b)))

plotVisible :: LensLike' f (Plot p b) Bool

HasPlotOptions f (PlotOptions b v n) b

Methods

plotOptions :: LensLike' f (PlotOptions b v n) (PlotOptions b (V (PlotOptions b v n)) (N (PlotOptions b v n)))

plotName :: LensLike' f (PlotOptions b v n) Name

clipPlot :: LensLike' f (PlotOptions b v n) Bool

legendEntries :: LensLike' f (PlotOptions b v n) [LegendEntry b (V (PlotOptions b v n)) (N (PlotOptions b v n))]

plotTransform :: LensLike' f (PlotOptions b v n) (Transformation (V (PlotOptions b v n)) (N (PlotOptions b v n)))

plotVisible :: LensLike' f (PlotOptions b v n) Bool

Functor f => HasPlotOptions f (StyledPlot b v n) b

Methods

plotOptions :: LensLike' f (StyledPlot b v n) (PlotOptions b (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotName :: LensLike' f (StyledPlot b v n) Name

clipPlot :: LensLike' f (StyledPlot b v n) Bool

legendEntries :: LensLike' f (StyledPlot b v n) [LegendEntry b (V (StyledPlot b v n)) (N (StyledPlot b v n))]

plotTransform :: LensLike' f (StyledPlot b v n) (Transformation (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotVisible :: LensLike' f (StyledPlot b v n) Bool

Functor f => HasPlotOptions f (DynamicPlot b v n) b

Methods

plotOptions :: LensLike' f (DynamicPlot b v n) (PlotOptions b (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotName :: LensLike' f (DynamicPlot b v n) Name

clipPlot :: LensLike' f (DynamicPlot b v n) Bool

legendEntries :: LensLike' f (DynamicPlot b v n) [LegendEntry b (V (DynamicPlot b v n)) (N (DynamicPlot b v n))]

plotTransform :: LensLike' f (DynamicPlot b v n) (Transformation (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotVisible :: LensLike' f (DynamicPlot b v n) Bool

Functor f => HasPlotOptions f (PlotMods b v n) b

Methods

plotOptions :: LensLike' f (PlotMods b v n) (PlotOptions b (V (PlotMods b v n)) (N (PlotMods b v n)))

plotName :: LensLike' f (PlotMods b v n) Name

clipPlot :: LensLike' f (PlotMods b v n) Bool

legendEntries :: LensLike' f (PlotMods b v n) [LegendEntry b (V (PlotMods b v n)) (N (PlotMods b v n))]

plotTransform :: LensLike' f (PlotMods b v n) (Transformation (V (PlotMods b v n)) (N (PlotMods b v n)))

plotVisible :: LensLike' f (PlotMods b v n) Bool

Settable f => HasPlotOptions f (Axis b c n) b

Methods

plotOptions :: LensLike' f (Axis b c n) (PlotOptions b (V (Axis b c n)) (N (Axis b c n)))

plotName :: LensLike' f (Axis b c n) Name

clipPlot :: LensLike' f (Axis b c n) Bool

legendEntries :: LensLike' f (Axis b c n) [LegendEntry b (V (Axis b c n)) (N (Axis b c n))]

plotTransform :: LensLike' f (Axis b c n) (Transformation (V (Axis b c n)) (N (Axis b c n)))

plotVisible :: LensLike' f (Axis b c n) Bool

key :: (HasPlotOptions Identity a b, MonadState a m, Num (N a)) => String -> m ()

Add a LegendEntry to something with PlotOptions using the String as the legendText and a DefaultLegendPic. Here are some typical examples:

key :: String -> State (Plot (ScatterPlot v n) b) ()
key :: String -> State (DynamicPlot b v n) ()
key :: String -> State (PlotMods b v n) ()

If you only care about the name of the legend, use key.

addLegendEntry :: (HasPlotOptions Identity a b, MonadState a m) => LegendEntry b (V a) (N a) -> m ()

Add a LegendEntry to something with PlotOptions. Here are some typical examples:

addLegendEntry :: LegendEntry b v n -> State (Plot (ScatterPlot v n) b) ()
addLegendEntry :: LegendEntry b v n -> State (DynamicPlot b v n) ()

If you only care about the name of the legend, use key.

Plot modifications

data PlotMods b v n

A PlotOptions with modifications to a PlotStyle.

Instances

Settable f => HasPlotStyle f (PlotMods b v n) b

Methods

plotStyle :: LensLike' f (PlotMods b v n) (PlotStyle b (V (PlotMods b v n)) (N (PlotMods b v n)))

plotColour :: LensLike' f (PlotMods b v n) (Colour Double)

plotColor :: LensLike' f (PlotMods b v n) (Colour Double)

lineStyle :: LensLike' f (PlotMods b v n) (Style (V (PlotMods b v n)) (N (PlotMods b v n)))

lineStyleFunction :: LensLike' f (PlotMods b v n) (Colour Double -> Style (V (PlotMods b v n)) (N (PlotMods b v n)))

markerStyle :: LensLike' f (PlotMods b v n) (Style (V (PlotMods b v n)) (N (PlotMods b v n)))

markerStyleFunction :: LensLike' f (PlotMods b v n) (Colour Double -> Style (V (PlotMods b v n)) (N (PlotMods b v n)))

areaStyle :: LensLike' f (PlotMods b v n) (Style (V (PlotMods b v n)) (N (PlotMods b v n)))

areaStyleFunction :: LensLike' f (PlotMods b v n) (Colour Double -> Style (V (PlotMods b v n)) (N (PlotMods b v n)))

textStyle :: LensLike' f (PlotMods b v n) (Style (V (PlotMods b v n)) (N (PlotMods b v n)))

textStyleFunction :: LensLike' f (PlotMods b v n) (Colour Double -> Style (V (PlotMods b v n)) (N (PlotMods b v n)))

plotMarker :: LensLike' f (PlotMods b v n) (QDiagram b (V (PlotMods b v n)) (N (PlotMods b v n)) Any)

plotStyles :: LensLike' f (PlotMods b v n) (Style (V (PlotMods b v n)) (N (PlotMods b v n)))

plotStyleFunctions :: LensLike' f (PlotMods b v n) (Colour Double -> Style (V (PlotMods b v n)) (N (PlotMods b v n)))

Functor f => HasPlotOptions f (PlotMods b v n) b

Methods

plotOptions :: LensLike' f (PlotMods b v n) (PlotOptions b (V (PlotMods b v n)) (N (PlotMods b v n)))

plotName :: LensLike' f (PlotMods b v n) Name

clipPlot :: LensLike' f (PlotMods b v n) Bool

legendEntries :: LensLike' f (PlotMods b v n) [LegendEntry b (V (PlotMods b v n)) (N (PlotMods b v n))]

plotTransform :: LensLike' f (PlotMods b v n) (Transformation (V (PlotMods b v n)) (N (PlotMods b v n)))

plotVisible :: LensLike' f (PlotMods b v n) Bool

(Additive v, Num n) => Default (PlotMods b v n)

Methods

def :: PlotMods b v n

HasVisibility (PlotMods b v n)

Methods

visible :: Lens' (PlotMods b v n) Bool

hidden :: Lens' (PlotMods b v n) Bool

type V (PlotMods b v n)

type V (PlotMods b v n) = v

type N (PlotMods b v n)

type N (PlotMods b v n) = n

plotMods :: Lens' (Plot p b) (PlotMods b (V p) (N p))

The modifications to the PlotOptions and PlotStyle in a Plot.

Plotable class

class (Typeable p, Enveloped p) => Plotable p b where

Class defining how plots should be rendered.

Minimal complete definition

renderPlotable

Methods

renderPlotable :: InSpace v n p => AxisSpec v n -> PlotStyle b v n -> p -> QDiagram b v n Any

Render a plot according to the AxisSpec, using the PlotStyle.

defLegendPic :: InSpace v n p => PlotStyle b v n -> p -> QDiagram b v n Any

The default legend picture when the LegendPic is DefaultLegendPic.

Instances

(TypeableFloat n, Renderable (Path V2 n) b) => Plotable (BarPlot n) b

Methods

renderPlotable :: InSpace v n (BarPlot n) => AxisSpec v n -> PlotStyle b v n -> BarPlot n -> QDiagram b v n Any

defLegendPic :: InSpace v n (BarPlot n) => PlotStyle b v n -> BarPlot n -> QDiagram b v n Any

(TypeableFloat n, Renderable (Path V2 n) b) => Plotable (HistogramPlot n) b

Methods

renderPlotable :: InSpace v n (HistogramPlot n) => AxisSpec v n -> PlotStyle b v n -> HistogramPlot n -> QDiagram b v n Any

defLegendPic :: InSpace v n (HistogramPlot n) => PlotStyle b v n -> HistogramPlot n -> QDiagram b v n Any

(TypeableFloat n, Renderable (Path V2 n) b) => Plotable (Wedge n) b

Methods

renderPlotable :: InSpace v n (Wedge n) => AxisSpec v n -> PlotStyle b v n -> Wedge n -> QDiagram b v n Any

defLegendPic :: InSpace v n (Wedge n) => PlotStyle b v n -> Wedge n -> QDiagram b v n Any

(TypeableFloat n, Renderable (Path V2 n) b) => Plotable (Path V2 n) b

Methods

renderPlotable :: InSpace v n (Path V2 n) => AxisSpec v n -> PlotStyle b v n -> Path V2 n -> QDiagram b v n Any

defLegendPic :: InSpace v n (Path V2 n) => PlotStyle b v n -> Path V2 n -> QDiagram b v n Any

(Typeable * b, TypeableFloat n, Renderable (Path V2 n) b) => Plotable (HeatMap b n) b

Methods

renderPlotable :: InSpace v n (HeatMap b n) => AxisSpec v n -> PlotStyle b v n -> HeatMap b n -> QDiagram b v n Any

defLegendPic :: InSpace v n (HeatMap b n) => PlotStyle b v n -> HeatMap b n -> QDiagram b v n Any

(TypeableFloat n, Renderable (Path V2 n) b) => Plotable (ScatterPlot V2 n) b

Methods

renderPlotable :: InSpace v n (ScatterPlot V2 n) => AxisSpec v n -> PlotStyle b v n -> ScatterPlot V2 n -> QDiagram b v n Any

defLegendPic :: InSpace v n (ScatterPlot V2 n) => PlotStyle b v n -> ScatterPlot V2 n -> QDiagram b v n Any

(Typeable * b, Typeable (* -> *) v, Metric v, Typeable * n, OrderedField n) => Plotable (QDiagram b v n Any) b

Methods

renderPlotable :: InSpace v n (QDiagram b v n Any) => AxisSpec v n -> PlotStyle b v n -> QDiagram b v n Any -> QDiagram b v n Any

defLegendPic :: InSpace v n (QDiagram b v n Any) => PlotStyle b v n -> QDiagram b v n Any -> QDiagram b v n Any

Plot types

Parameterised plot

data Plot p b

A parameterised plot, together with a PlotMods. This type has an instance of many classes for modifying specific plots.

Instances

(Functor f, HasWedge f a) => HasWedge f (Plot a b)

Methods

pieWedge :: LensLike' f (Plot a b) (Wedge (N (Plot a b)))

wedgeOuterRadius :: LensLike' f (Plot a b) (N (Plot a b))

wedgeInnerRadius :: LensLike' f (Plot a b) (N (Plot a b))

wedgeOffset :: LensLike' f (Plot a b) (N (Plot a b))

wedgeWidth :: LensLike' f (Plot a b) (Angle (N (Plot a b)))

wedgeDirection :: LensLike' f (Plot a b) (Direction V2 (N (Plot a b)))

HasConnectingLine f p => HasConnectingLine f (Plot p b)

Methods

connectingLine :: LensLike' f (Plot p b) Bool

Settable f => HasPlotStyle f (Plot p b) b

Methods

plotStyle :: LensLike' f (Plot p b) (PlotStyle b (V (Plot p b)) (N (Plot p b)))

plotColour :: LensLike' f (Plot p b) (Colour Double)

plotColor :: LensLike' f (Plot p b) (Colour Double)

lineStyle :: LensLike' f (Plot p b) (Style (V (Plot p b)) (N (Plot p b)))

lineStyleFunction :: LensLike' f (Plot p b) (Colour Double -> Style (V (Plot p b)) (N (Plot p b)))

markerStyle :: LensLike' f (Plot p b) (Style (V (Plot p b)) (N (Plot p b)))

markerStyleFunction :: LensLike' f (Plot p b) (Colour Double -> Style (V (Plot p b)) (N (Plot p b)))

areaStyle :: LensLike' f (Plot p b) (Style (V (Plot p b)) (N (Plot p b)))

areaStyleFunction :: LensLike' f (Plot p b) (Colour Double -> Style (V (Plot p b)) (N (Plot p b)))

textStyle :: LensLike' f (Plot p b) (Style (V (Plot p b)) (N (Plot p b)))

textStyleFunction :: LensLike' f (Plot p b) (Colour Double -> Style (V (Plot p b)) (N (Plot p b)))

plotMarker :: LensLike' f (Plot p b) (QDiagram b (V (Plot p b)) (N (Plot p b)) Any)

plotStyles :: LensLike' f (Plot p b) (Style (V (Plot p b)) (N (Plot p b)))

plotStyleFunctions :: LensLike' f (Plot p b) (Colour Double -> Style (V (Plot p b)) (N (Plot p b)))

Functor f => HasPlotOptions f (Plot p b) b

Methods

plotOptions :: LensLike' f (Plot p b) (PlotOptions b (V (Plot p b)) (N (Plot p b)))

plotName :: LensLike' f (Plot p b) Name

clipPlot :: LensLike' f (Plot p b) Bool

legendEntries :: LensLike' f (Plot p b) [LegendEntry b (V (Plot p b)) (N (Plot p b))]

plotTransform :: LensLike' f (Plot p b) (Transformation (V (Plot p b)) (N (Plot p b)))

plotVisible :: LensLike' f (Plot p b) Bool

(Functor f, HasHeatMap f a b) => HasHeatMap f (Plot a b) b

Methods

heatMapOptions :: LensLike' f (Plot a b) (HeatMap b (N (Plot a b)))

heatMapGridVisible :: LensLike' f (Plot a b) Bool

heatMapGridStyle :: LensLike' f (Plot a b) (Style V2 (N (Plot a b)))

heatMapSize :: LensLike' f (Plot a b) (V2 (N (Plot a b)))

heatMapExtent :: LensLike' f (Plot a b) (V2 (N (Plot a b)))

heatMapStart :: LensLike' f (Plot a b) (P2 (N (Plot a b)))

heatMapCentre :: LensLike' f (Plot a b) (P2 (N (Plot a b)))

heatMapLimits :: LensLike' f (Plot a b) (Maybe (Double, Double))

heatMapRender :: LensLike' f (Plot a b) (HeatMatrix -> ColourMap -> QDiagram b V2 (N (Plot a b)) Any)

(Functor f, HasScatterOptions f p a) => HasScatterOptions f (Plot p b) a

Methods

gscatterOptions :: LensLike' f (Plot p b) (ScatterOptions (V (Plot p b)) (N (Plot p b)) a)

scatterTransform :: LensLike' f (Plot p b) (a -> Transformation (V (Plot p b)) (N (Plot p b)))

scatterStyle :: LensLike' f (Plot p b) (a -> Style (V (Plot p b)) (N (Plot p b)))

scatterPosition :: LensLike' f (Plot p b) (a -> Point (V (Plot p b)) (N (Plot p b)))

HasOrientation p => HasOrientation (Plot p b)

Methods

orientation :: Lens' (Plot p b) Orientation

HasVisibility (Plot p b)

Methods

visible :: Lens' (Plot p b) Bool

hidden :: Lens' (Plot p b) Bool

HasBarLayout a => HasBarLayout (Plot a b)

Methods

barLayout :: Lens' (Plot a b) (BarLayout (N (Plot a b)))

barWidth :: Lens' (Plot a b) (N (Plot a b))

barSpacing :: Lens' (Plot a b) (N (Plot a b))

barStart :: Lens' (Plot a b) (N (Plot a b))

HasHistogramOptions a => HasHistogramOptions (Plot a b)

Methods

histogramOptions :: Lens' (Plot a b) (HistogramOptions (N (Plot a b)))

numBins :: Lens' (Plot a b) Int

binRange :: Lens' (Plot a b) (Maybe (N (Plot a b), N (Plot a b)))

normaliseSample :: Lens' (Plot a b) NormalisationMethod

type V (Plot p b)

type V (Plot p b) = V p

type N (Plot p b)

type N (Plot p b) = N p

mkPlot :: (Additive (V p), Num (N p)) => p -> Plot p b

Make a Plot with Default PlotOptions.

rawPlot :: SameSpace p p' => Lens (Plot p b) (Plot p' b) p p'

Lens onto the raw Plotable inside a Plot.

Dynamic plot

data DynamicPlot b v n where

A wrapped up Plot, used to store plots in an Axis.

Constructors

DynamicPlot :: (InSpace v n p, Plotable p b) => Plot p b -> DynamicPlot b v n

Instances

(Applicative f, Typeable * b, (~) (* -> *) v V2, Typeable * n) => HasWedge f (DynamicPlot b v n)

Methods

pieWedge :: LensLike' f (DynamicPlot b v n) (Wedge (N (DynamicPlot b v n)))

wedgeOuterRadius :: LensLike' f (DynamicPlot b v n) (N (DynamicPlot b v n))

wedgeInnerRadius :: LensLike' f (DynamicPlot b v n) (N (DynamicPlot b v n))

wedgeOffset :: LensLike' f (DynamicPlot b v n) (N (DynamicPlot b v n))

wedgeWidth :: LensLike' f (DynamicPlot b v n) (Angle (N (DynamicPlot b v n)))

wedgeDirection :: LensLike' f (DynamicPlot b v n) (Direction V2 (N (DynamicPlot b v n)))

(Applicative f, Typeable * b, Typeable (* -> *) v, Typeable * n) => HasConnectingLine f (DynamicPlot b v n)

Methods

connectingLine :: LensLike' f (DynamicPlot b v n) Bool

Settable f => HasPlotStyle f (DynamicPlot b v n) b

Methods

plotStyle :: LensLike' f (DynamicPlot b v n) (PlotStyle b (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotColour :: LensLike' f (DynamicPlot b v n) (Colour Double)

plotColor :: LensLike' f (DynamicPlot b v n) (Colour Double)

lineStyle :: LensLike' f (DynamicPlot b v n) (Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

lineStyleFunction :: LensLike' f (DynamicPlot b v n) (Colour Double -> Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

markerStyle :: LensLike' f (DynamicPlot b v n) (Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

markerStyleFunction :: LensLike' f (DynamicPlot b v n) (Colour Double -> Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

areaStyle :: LensLike' f (DynamicPlot b v n) (Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

areaStyleFunction :: LensLike' f (DynamicPlot b v n) (Colour Double -> Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

textStyle :: LensLike' f (DynamicPlot b v n) (Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

textStyleFunction :: LensLike' f (DynamicPlot b v n) (Colour Double -> Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotMarker :: LensLike' f (DynamicPlot b v n) (QDiagram b (V (DynamicPlot b v n)) (N (DynamicPlot b v n)) Any)

plotStyles :: LensLike' f (DynamicPlot b v n) (Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotStyleFunctions :: LensLike' f (DynamicPlot b v n) (Colour Double -> Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

Functor f => HasPlotOptions f (DynamicPlot b v n) b

Methods

plotOptions :: LensLike' f (DynamicPlot b v n) (PlotOptions b (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotName :: LensLike' f (DynamicPlot b v n) Name

clipPlot :: LensLike' f (DynamicPlot b v n) Bool

legendEntries :: LensLike' f (DynamicPlot b v n) [LegendEntry b (V (DynamicPlot b v n)) (N (DynamicPlot b v n))]

plotTransform :: LensLike' f (DynamicPlot b v n) (Transformation (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

plotVisible :: LensLike' f (DynamicPlot b v n) Bool

(Applicative f, Typeable * b, Typeable (* -> *) v, Typeable * n, Typeable * a) => HasScatterOptions f (DynamicPlot b v n) a

Methods

gscatterOptions :: LensLike' f (DynamicPlot b v n) (ScatterOptions (V (DynamicPlot b v n)) (N (DynamicPlot b v n)) a)

scatterTransform :: LensLike' f (DynamicPlot b v n) (a -> Transformation (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

scatterStyle :: LensLike' f (DynamicPlot b v n) (a -> Style (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

scatterPosition :: LensLike' f (DynamicPlot b v n) (a -> Point (V (DynamicPlot b v n)) (N (DynamicPlot b v n)))

HasVisibility (DynamicPlot b v n)

Methods

visible :: Lens' (DynamicPlot b v n) Bool

hidden :: Lens' (DynamicPlot b v n) Bool

type V (DynamicPlot b v n)

type V (DynamicPlot b v n) = v

type N (DynamicPlot b v n)

type N (DynamicPlot b v n) = n

_DynamicPlot :: (Plotable p b, Typeable b) => Prism' (DynamicPlot b (V p) (N p)) (Plot p b)

Prism for a DynamicPlot.

dynamicPlot :: forall p b. (Typeable p, Typeable b) => Traversal' (DynamicPlot b (V p) (N p)) (Plot p b)

Traversal over the dynamic plot without the Plotable constraint _DynamicPlot has.

dynamicPlotMods :: Lens' (DynamicPlot b v n) (PlotMods b v n)

The modifications to the PlotOptions and PlotStyle in a DynamicPlot.

Styled plot

data StyledPlot b v n

A DynamicPlot with a concrete style. This is suitable for being rendered with renderStyledPlot and get extract the legend entries with styledPlotLegend.

You can make a StyledPlot with styleDynamic

Instances

((~) (* -> *) v V2, Applicative f, Typeable * n) => HasWedge f (StyledPlot b v n)

Methods

pieWedge :: LensLike' f (StyledPlot b v n) (Wedge (N (StyledPlot b v n)))

wedgeOuterRadius :: LensLike' f (StyledPlot b v n) (N (StyledPlot b v n))

wedgeInnerRadius :: LensLike' f (StyledPlot b v n) (N (StyledPlot b v n))

wedgeOffset :: LensLike' f (StyledPlot b v n) (N (StyledPlot b v n))

wedgeWidth :: LensLike' f (StyledPlot b v n) (Angle (N (StyledPlot b v n)))

wedgeDirection :: LensLike' f (StyledPlot b v n) (Direction V2 (N (StyledPlot b v n)))

(Applicative f, Typeable (* -> *) v, Typeable * n) => HasConnectingLine f (StyledPlot b v n)

Methods

connectingLine :: LensLike' f (StyledPlot b v n) Bool

Functor f => HasPlotStyle f (StyledPlot b v n) b

Methods

plotStyle :: LensLike' f (StyledPlot b v n) (PlotStyle b (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotColour :: LensLike' f (StyledPlot b v n) (Colour Double)

plotColor :: LensLike' f (StyledPlot b v n) (Colour Double)

lineStyle :: LensLike' f (StyledPlot b v n) (Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

lineStyleFunction :: LensLike' f (StyledPlot b v n) (Colour Double -> Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

markerStyle :: LensLike' f (StyledPlot b v n) (Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

markerStyleFunction :: LensLike' f (StyledPlot b v n) (Colour Double -> Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

areaStyle :: LensLike' f (StyledPlot b v n) (Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

areaStyleFunction :: LensLike' f (StyledPlot b v n) (Colour Double -> Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

textStyle :: LensLike' f (StyledPlot b v n) (Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

textStyleFunction :: LensLike' f (StyledPlot b v n) (Colour Double -> Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotMarker :: LensLike' f (StyledPlot b v n) (QDiagram b (V (StyledPlot b v n)) (N (StyledPlot b v n)) Any)

plotStyles :: LensLike' f (StyledPlot b v n) (Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotStyleFunctions :: LensLike' f (StyledPlot b v n) (Colour Double -> Style (V (StyledPlot b v n)) (N (StyledPlot b v n)))

Functor f => HasPlotOptions f (StyledPlot b v n) b

Methods

plotOptions :: LensLike' f (StyledPlot b v n) (PlotOptions b (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotName :: LensLike' f (StyledPlot b v n) Name

clipPlot :: LensLike' f (StyledPlot b v n) Bool

legendEntries :: LensLike' f (StyledPlot b v n) [LegendEntry b (V (StyledPlot b v n)) (N (StyledPlot b v n))]

plotTransform :: LensLike' f (StyledPlot b v n) (Transformation (V (StyledPlot b v n)) (N (StyledPlot b v n)))

plotVisible :: LensLike' f (StyledPlot b v n) Bool

(Metric v, OrderedField n) => Enveloped (StyledPlot b v n)

Methods

getEnvelope :: StyledPlot b v n -> Envelope (V (StyledPlot b v n)) (N (StyledPlot b v n))

HasVisibility (StyledPlot b v n)

Methods

visible :: Lens' (StyledPlot b v n) Bool

hidden :: Lens' (StyledPlot b v n) Bool

type V (StyledPlot b v n)

type V (StyledPlot b v n) = v

type N (StyledPlot b v n)

type N (StyledPlot b v n) = n

styledPlot :: forall p b. Typeable p => Traversal' (StyledPlot b (V p) (N p)) p

Traversal over a raw plot of a styled plot. The type of the plot must match for the traversal to be succesful.

styleDynamic :: PlotStyle b v n -> DynamicPlot b v n -> StyledPlot b v n

Give a DynamicPlot a concrete PlotStyle.

renderStyledPlot :: TypeableFloat n => AxisSpec V2 n -> StyledPlot b V2 n -> QDiagram b V2 n Any

Render a StyledPlot given an and AxisSpec.

singleStyledPlotLegend

Arguments

:: StyledPlot b v n

-> [(n, QDiagram b v n Any, String)]

(z-order, legend pic, legend text)

Get the legend rendered entries from a single styled plot. The resulting entries are in no particular order. See also styledPlotLegends.

styledPlotLegends

Arguments

:: Ord n

=> [StyledPlot b v n]

-> [(QDiagram b v n Any, String)]

[(legend pic, legend text)]

Render a list of legend entries, in order.

Miscellaneous

Visibility

class HasVisibility a where

Class of objects that can be hidden.

Minimal complete definition

visible

Methods

visible :: Lens' a Bool

Lens onto whether an object should be visible when rendered.

hidden :: Lens' a Bool

The opposite of visible.

Instances

HasVisibility (Plot p b)

Methods

visible :: Lens' (Plot p b) Bool

hidden :: Lens' (Plot p b) Bool

HasVisibility (Legend b n)

Methods

visible :: Lens' (Legend b n) Bool

hidden :: Lens' (Legend b n) Bool

HasVisibility (MinorTicks v n)

Methods

visible :: Lens' (MinorTicks v n) Bool

hidden :: Lens' (MinorTicks v n) Bool

HasVisibility (MajorTicks v n)

Methods

visible :: Lens' (MajorTicks v n) Bool

hidden :: Lens' (MajorTicks v n) Bool

HasVisibility (AxisLine v n)

Methods

visible :: Lens' (AxisLine v n) Bool

hidden :: Lens' (AxisLine v n) Bool

HasVisibility (MinorGridLines v n)

Hidden by default.

Methods

visible :: Lens' (MinorGridLines v n) Bool

hidden :: Lens' (MinorGridLines v n) Bool

HasVisibility (MajorGridLines v n)

Methods

visible :: Lens' (MajorGridLines v n) Bool

hidden :: Lens' (MajorGridLines v n) Bool

HasVisibility (ColourBar b n)

Methods

visible :: Lens' (ColourBar b n) Bool

hidden :: Lens' (ColourBar b n) Bool

HasVisibility (PlotOptions b v n)

Methods

visible :: Lens' (PlotOptions b v n) Bool

hidden :: Lens' (PlotOptions b v n) Bool

HasVisibility (StyledPlot b v n)

Methods

visible :: Lens' (StyledPlot b v n) Bool

hidden :: Lens' (StyledPlot b v n) Bool

HasVisibility (DynamicPlot b v n)

Methods

visible :: Lens' (DynamicPlot b v n) Bool

hidden :: Lens' (DynamicPlot b v n) Bool

HasVisibility (PlotMods b v n)

Methods

visible :: Lens' (PlotMods b v n) Bool

hidden :: Lens' (PlotMods b v n) Bool

HasVisibility (Title b v n)

Methods

visible :: Lens' (Title b v n) Bool

hidden :: Lens' (Title b v n) Bool

HasVisibility (TickLabels b v n)

Methods

visible :: Lens' (TickLabels b v n) Bool

hidden :: Lens' (TickLabels b v n) Bool

HasVisibility (AxisLabel b v n)

Methods

visible :: Lens' (AxisLabel b v n) Bool

hidden :: Lens' (AxisLabel b v n) Bool

HasVisibility (SingleAxis b v n)

Methods

visible :: Lens' (SingleAxis b v n) Bool

hidden :: Lens' (SingleAxis b v n) Bool

hide :: (MonadState s m, HasVisibility a) => ASetter' s a -> m ()

Set visible to False for the given setter.

hide minorTicks          :: State (Axis b v n) ()
hide (xAxis . gridLines) :: State (Axis b v n) ()

display :: (MonadState s m, HasVisibility a) => ASetter' s a -> m ()

Set visible to True for the given setter.

display minorGridLines :: State (Axis b v n) ()
display colourBar      :: State (Axis b v n) ()

Orientation

data Orientation

Constructors

Horizontal

Vertical

Instances

Eq Orientation

Methods

(==) :: Orientation -> Orientation -> Bool

(/=) :: Orientation -> Orientation -> Bool

Ord Orientation

Methods

compare :: Orientation -> Orientation -> Ordering

(<) :: Orientation -> Orientation -> Bool

(<=) :: Orientation -> Orientation -> Bool

(>) :: Orientation -> Orientation -> Bool

(>=) :: Orientation -> Orientation -> Bool

max :: Orientation -> Orientation -> Orientation

min :: Orientation -> Orientation -> Orientation

Show Orientation

Methods

showsPrec :: Int -> Orientation -> ShowS

show :: Orientation -> String

showList :: [Orientation] -> ShowS

HasOrientation Orientation

Methods

orientation :: Lens' Orientation Orientation

class HasOrientation a where

Class of things that have an orientation.

Minimal complete definition

orientation

Methods

orientation :: Lens' a Orientation

Lens onto the orientation of an object.

Instances

HasOrientation Orientation

Methods

orientation :: Lens' Orientation Orientation

HasOrientation (BarPlot n)

Methods

orientation :: Lens' (BarPlot n) Orientation

HasOrientation (BarLayout n)

Methods

orientation :: Lens' (BarLayout n) Orientation

HasOrientation (HistogramOptions n)

Methods

orientation :: Lens' (HistogramOptions n) Orientation

HasOrientation (HistogramPlot n)

Methods

orientation :: Lens' (HistogramPlot n) Orientation

HasOrientation p => HasOrientation (Plot p b)

Methods

orientation :: Lens' (Plot p b) Orientation

HasOrientation (Legend b n)

Methods

orientation :: Lens' (Legend b n) Orientation

HasOrientation (ColourBar b n)

Methods

orientation :: Lens' (ColourBar b n) Orientation

HasOrientation (MultiBarState b n a)

Methods

orientation :: Lens' (MultiBarState b n a) Orientation

orient :: HasOrientation o => o -> a -> a -> a

Pick the first a if the object has Horizontal orientation and the second a if the object has a Vertical orientation.

horizontal :: HasOrientation a => Lens' a Bool

Lens onto whether an object's orientation is horizontal.

vertical :: HasOrientation a => Lens' a Bool

Lens onto whether an object's orientation is vertical.

Legend entries

data LegendEntry b v n

Data type for holding a legend entry.

Instances

type V (LegendEntry b v n)

type V (LegendEntry b v n) = v

type N (LegendEntry b v n)

type N (LegendEntry b v n) = n

data LegendPic b v n

Type allowing use of the default legend picture (depending on the plot) or a custom legend picture with access to the PlotStyle.

Constructors

DefaultLegendPic

CustomLegendPic (PlotStyle b v n -> QDiagram b v n Any)

Instances

Default (LegendPic b v n)

Methods

def :: LegendPic b v n

mkLegendEntry :: Num n => String -> LegendEntry b v n

Make a legend entry with a default legendPicture and legendPrecedence 0 using the string as the legendText.

legendPicture :: Lens' (LegendEntry b v n) (LegendPic b v n)

The picture used in the legend entry.

legendText :: Lens' (LegendEntry b v n) String

The text used in the legend entry.

legendPrecedence :: Lens' (LegendEntry b v n) n

The order in which the legend entries are rendered. If precedence are equal, they entries are put in the order they are added to the axis.

Default is 0.

Axis spec

data AxisSpec v n

Information from the Axis necessary to render a Plotable.

Constructors

AxisSpec

Fields

• _specBounds :: v (n, n)
• _specTrans :: Transformation v n
• _specScale :: v LogScale
• _specColourMap :: ColourMap

Instances

type V (AxisSpec v n)

type V (AxisSpec v n) = v

type N (AxisSpec v n)

type N (AxisSpec v n) = n

specTrans :: forall v n. Lens' (AxisSpec v n) (Transformation v n)

specBounds :: forall v n. Lens' (AxisSpec v n) (v (n, n))

specScale :: forall v n. Lens' (AxisSpec v n) (v LogScale)

scaleNum :: Floating n => (n, n) -> LogScale -> n -> n

Scale a number by log10-ing it and linearly scaling it so it's within the same range.

specPoint :: (Applicative v, Additive v, Floating n) => AxisSpec v n -> Point v n -> Point v n

Apply log scaling and the transform to a point.

specColourMap :: forall v n. Lens' (AxisSpec v n) ColourMap

Positioning

data Placement

A Position is a point on an axis together with an anchor and a direction for the gap.

Constructors

Placement

Fields

• pAt :: V2 Rational
• pAnchor :: V2 Rational
• pGapDir :: Direction V2 Rational

Instances

Eq Placement

Methods

(==) :: Placement -> Placement -> Bool

(/=) :: Placement -> Placement -> Bool

Ord Placement

Methods

compare :: Placement -> Placement -> Ordering

(<) :: Placement -> Placement -> Bool

(<=) :: Placement -> Placement -> Bool

(>) :: Placement -> Placement -> Bool

(>=) :: Placement -> Placement -> Bool

max :: Placement -> Placement -> Placement

min :: Placement -> Placement -> Placement

Read Placement

Methods

readsPrec :: Int -> ReadS Placement

readList :: ReadS [Placement]

readPrec :: ReadPrec Placement

readListPrec :: ReadPrec [Placement]

Show Placement

Methods

showsPrec :: Int -> Placement -> ShowS

show :: Placement -> String

showList :: [Placement] -> ShowS

HasPlacement Placement

Methods

placement :: Lens' Placement Placement

placementAt :: Lens' Placement (V2 Rational)

placementAnchor :: Lens' Placement (V2 Rational)

gapDirection :: Lens' Placement (Direction V2 Rational)

class HasPlacement a where

Minimal complete definition

placement

Methods

placement :: Lens' a Placement

placementAt :: Lens' a (V2 Rational)

The position relative to the axis. V2 0 0 corresponds to the bottom left corner, V2 1 1 is the top right corner.

placementAnchor :: Lens' a (V2 Rational)

The anchor used for the object being positioned. V2 0 0 corresponds to the bottom left corner, V2 1 1 is the top right corner.

gapDirection :: Lens' a (Direction V2 Rational)

The direction to extend the gap when positioning.

Instances

HasPlacement Placement

Methods

placement :: Lens' Placement Placement

placementAt :: Lens' Placement (V2 Rational)

placementAnchor :: Lens' Placement (V2 Rational)

gapDirection :: Lens' Placement (Direction V2 Rational)

HasPlacement (Legend b n)

Methods

placement :: Lens' (Legend b n) Placement

placementAt :: Lens' (Legend b n) (V2 Rational)

placementAnchor :: Lens' (Legend b n) (V2 Rational)

gapDirection :: Lens' (Legend b n) (Direction V2 Rational)

HasPlacement (ColourBar b n)

Methods

placement :: Lens' (ColourBar b n) Placement

placementAt :: Lens' (ColourBar b n) (V2 Rational)

placementAnchor :: Lens' (ColourBar b n) (V2 Rational)

gapDirection :: Lens' (ColourBar b n) (Direction V2 Rational)

HasPlacement (Title b v n)

Methods

placement :: Lens' (Title b v n) Placement

placementAt :: Lens' (Title b v n) (V2 Rational)

placementAnchor :: Lens' (Title b v n) (V2 Rational)

gapDirection :: Lens' (Title b v n) (Direction V2 Rational)

class HasGap a where

Minimal complete definition

gap

Methods

gap :: Lens' a (N a)

The value of the gap when rendering.

Instances

HasGap (Legend b n)

Methods

gap :: Lens' (Legend b n) (N (Legend b n))

HasGap (ColourBar b n)

Methods

gap :: Lens' (ColourBar b n) (N (ColourBar b n))

HasGap (Title b v n)

Methods

gap :: Lens' (Title b v n) (N (Title b v n))

HasGap (TickLabels b v n)

Methods

gap :: Lens' (TickLabels b v n) (N (TickLabels b v n))

HasGap (AxisLabel b v n)

Methods

gap :: Lens' (AxisLabel b v n) (N (AxisLabel b v n))

placeAgainst :: (InSpace V2 n a, SameSpace a b, Enveloped a, HasOrigin b, Alignable b) => a -> Placement -> n -> b -> b

A tool for aligned one object to another. Positions b around the bounding box of a by translating b.

Common positions

Inside positions

topLeft :: Placement

top :: Placement

topRight :: Placement

left :: Placement

right :: Placement

bottomLeft :: Placement

bottom :: Placement

bottomRight :: Placement

Outside positions

leftAbove :: Placement

leftTop :: Placement

leftMid :: Placement

leftBottom :: Placement

leftBelow :: Placement

midAbove :: Placement

midBelow :: Placement

rightAbove :: Placement

rightTop :: Placement

rightMid :: Placement

rightBottom :: Placement

rightBelow :: Placement