Plots.Legend

Legend

data Legend b n

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

Instances

(TypeableFloat n, Renderable (Text n) b) => Default (Legend b n)

Methods

def :: Legend b n

TypeableFloat n => HasStyle (Legend b n)

Methods

applyStyle :: Style (V (Legend b n)) (N (Legend b n)) -> Legend b n -> Legend b n

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)

HasGap (Legend b n)

Methods

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

HasOrientation (Legend b n)

Methods

orientation :: Lens' (Legend b n) Orientation

HasVisibility (Legend b n)

Methods

visible :: Lens' (Legend b n) Bool

hidden :: Lens' (Legend b n) Bool

HasLegend (Legend b n) b

Methods

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

legendPlacement :: Lens' (Legend b n) Placement

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

legendStyle :: Lens' (Legend b n) (Style V2 (N (Legend b n)))

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

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

legendTextFunction :: Lens' (Legend b n) (String -> QDiagram b V2 (N (Legend b n)) Any)

legendTextStyle :: Lens' (Legend b n) (Style V2 (N (Legend b n)))

legendOrientation :: Lens' (Legend b n) Orientation

type V (Legend b n)

type V (Legend b n) = V2

type N (Legend b n)

type N (Legend b n) = n

class HasLegend a b | a -> b where

Minimal complete definition

legend

Methods

legend :: Lens' a (Legend b (N a))

Lens onto the Legend of something.

legendPlacement :: Lens' a Placement

The Placement of the legend relative to the Axis.

legendGap :: Lens' a (N a)

The gap between the legend and the axis.

legendStyle :: Lens' a (Style V2 (N a))

The style applied to the surronding box of the legend.

legendSpacing :: Lens' a (N a)

The spacing between entries in the legend.

legendTextWidth :: Lens' a (N a)

The space given for the text in the legend.

legendTextFunction :: Lens' a (String -> QDiagram b V2 (N a) Any)

The function to generate the legend text.

legendTextStyle :: Lens' a (Style V2 (N a))

The style applied to the legend text.

legendOrientation :: Lens' a Orientation

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

Instances

HasLegend (Legend b n) b

Methods

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

legendPlacement :: Lens' (Legend b n) Placement

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

legendStyle :: Lens' (Legend b n) (Style V2 (N (Legend b n)))

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

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

legendTextFunction :: Lens' (Legend b n) (String -> QDiagram b V2 (N (Legend b n)) Any)

legendTextStyle :: Lens' (Legend b n) (Style V2 (N (Legend b n)))

legendOrientation :: Lens' (Legend b n) Orientation

HasLegend (Axis b c n) b

Methods

legend :: Lens' (Axis b c n) (Legend b (N (Axis b c n)))

legendPlacement :: Lens' (Axis b c n) Placement

legendGap :: Lens' (Axis b c n) (N (Axis b c n))

legendStyle :: Lens' (Axis b c n) (Style V2 (N (Axis b c n)))

legendSpacing :: Lens' (Axis b c n) (N (Axis b c n))

legendTextWidth :: Lens' (Axis b c n) (N (Axis b c n))

legendTextFunction :: Lens' (Axis b c n) (String -> QDiagram b V2 (N (Axis b c n)) Any)

legendTextStyle :: Lens' (Axis b c n) (Style V2 (N (Axis b c n)))

legendOrientation :: Lens' (Axis b c n) Orientation

Drawing a legend

drawLegend

Arguments

:: (TypeableFloat n, Renderable (Path V2 n) b)

=> BoundingBox V2 n

bounding box to place legend against

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

diagram pictures along with their key

-> Legend b n

options for drawing the legend

-> QDiagram b V2 n Any

rendered legend

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