Safe Haskell	None
Language	Haskell2010

Plots.Legend

Contents

Legend
Drawing a legend

Synopsis

data Legend
class HasLegend a where
- legend :: Lens' a Legend
- legendPlacement :: Lens' a Placement
- legendGap :: Lens' a Double
- legendStyle :: Lens' a (Style V2 Double)
- legendSpacing :: Lens' a Double
- legendTextWidth :: Lens' a Double
- legendTextFunction :: Lens' a (String -> Diagram V2)
- legendTextStyle :: Lens' a (Style V2 Double)
- legendOrientation :: Lens' a Orientation
drawLegend :: BoundingBox V2 Double -> [(Diagram V2, String)] -> Legend -> Diagram V2

Legend

data Legend Source #

The data type to describe how to draw a legend. For legend entries see LegendEntry.

Instances

Default Legend Source #
Instance details Defined in Plots.Legend Methods def :: Legend #
ApplyStyle Legend Source #
Instance details Defined in Plots.Legend Methods applyStyle :: Style (V Legend) (N Legend) -> Legend -> Legend
HasStyle Legend Source #	The style for the bounding box of the legend.
Instance details Defined in Plots.Legend Methods style :: Lens' Legend (Style (V Legend) (N Legend))
HasPlacement Legend Source #
Instance details Defined in Plots.Legend Methods placement :: Lens' Legend Placement Source # placementAt :: Lens' Legend (V2 Rational) Source # placementAnchor :: Lens' Legend (V2 Rational) Source # gapDirection :: Lens' Legend (Direction V2 Double) Source #
HasGap Legend Source #
Instance details Defined in Plots.Legend Methods gap :: Lens' Legend Double Source #
HasOrientation Legend Source #
Instance details Defined in Plots.Legend Methods orientation :: Lens' Legend Orientation Source #
HasVisibility Legend Source #
Instance details Defined in Plots.Legend Methods visible :: Lens' Legend Bool Source # hidden :: Lens' Legend Bool Source #
HasLegend Legend Source #
Instance details Defined in Plots.Legend Methods legend :: Lens' Legend Legend Source # legendPlacement :: Lens' Legend Placement Source # legendGap :: Lens' Legend Double Source # legendStyle :: Lens' Legend (Style V2 Double) Source # legendSpacing :: Lens' Legend Double Source # legendTextWidth :: Lens' Legend Double Source # legendTextFunction :: Lens' Legend (String -> Diagram V2) Source # legendTextStyle :: Lens' Legend (Style V2 Double) Source # legendOrientation :: Lens' Legend Orientation Source #
type N Legend Source #
Instance details Defined in Plots.Legend type N Legend = Double
type V Legend Source #
Instance details Defined in Plots.Legend type V Legend = V2

class HasLegend a where Source #

Minimal complete definition

legend

Methods

legend :: Lens' a Legend Source #

Lens onto the Legend of something.

legendPlacement :: Lens' a Placement Source #

The Placement of the legend relative to the Axis.

legendGap :: Lens' a Double Source #

The gap between the legend and the axis.

legendStyle :: Lens' a (Style V2 Double) Source #

The style applied to the surronding box of the legend.

legendSpacing :: Lens' a Double Source #

The spacing between entries in the legend.

legendTextWidth :: Lens' a Double Source #

The space given for the text in the legend.

legendTextFunction :: Lens' a (String -> Diagram V2) Source #

The function to generate the legend text.

legendTextStyle :: Lens' a (Style V2 Double) Source #

The style applied to the legend text.

legendOrientation :: Lens' a Orientation Source #

The way the legend entries are listed. (This will likely be replaced by a grid-like system)

Instances

HasLegend Legend Source #
Instance details Defined in Plots.Legend Methods legend :: Lens' Legend Legend Source # legendPlacement :: Lens' Legend Placement Source # legendGap :: Lens' Legend Double Source # legendStyle :: Lens' Legend (Style V2 Double) Source # legendSpacing :: Lens' Legend Double Source # legendTextWidth :: Lens' Legend Double Source # legendTextFunction :: Lens' Legend (String -> Diagram V2) Source # legendTextStyle :: Lens' Legend (Style V2 Double) Source # legendOrientation :: Lens' Legend Orientation Source #
HasLegend (Axis c) Source #
Instance details Defined in Plots.Axis Methods legend :: Lens' (Axis c) Legend Source # legendPlacement :: Lens' (Axis c) Placement Source # legendGap :: Lens' (Axis c) Double Source # legendStyle :: Lens' (Axis c) (Style V2 Double) Source # legendSpacing :: Lens' (Axis c) Double Source # legendTextWidth :: Lens' (Axis c) Double Source # legendTextFunction :: Lens' (Axis c) (String -> Diagram V2) Source # legendTextStyle :: Lens' (Axis c) (Style V2 Double) Source # legendOrientation :: Lens' (Axis c) Orientation Source #

Drawing a legend

drawLegend Source #

Arguments

:: BoundingBox V2 Double	bounding box to place legend against
-> [(Diagram V2, String)]	diagram pictures along with their key
-> Legend	options for drawing the legend
-> Diagram V2	rendered legend

Draw a legend to the bounding box using the legend entries and legend options.