Copyright	(C) 2016 Christopher Chalmers
License	BSD-style (see the file LICENSE)
Maintainer	Christopher Chalmers
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Plots.Axis.Title

Description

The title used for a plot.

Synopsis

Documentation

Instances

Default (Title V3) Source #
Instance details Defined in Plots.Axis.Title Methods def :: Title V3 #
Default (Title V2) Source #
Instance details Defined in Plots.Axis.Title Methods def :: Title V2 #
HasPlacement (Title v) Source #
Instance details Defined in Plots.Axis.Title Methods placement :: Lens' (Title v) Placement Source # placementAt :: Lens' (Title v) (V2 Rational) Source # placementAnchor :: Lens' (Title v) (V2 Rational) Source # gapDirection :: Lens' (Title v) (Direction V2 Double) Source #
HasGap (Title v) Source #
Instance details Defined in Plots.Axis.Title Methods gap :: Lens' (Title v) Double Source #
HasVisibility (Title v) Source #
Instance details Defined in Plots.Axis.Title Methods visible :: Lens' (Title v) Bool Source # hidden :: Lens' (Title v) Bool Source #
HasTitle (Title v) Source #
Instance details Defined in Plots.Axis.Title Methods title :: Lens' (Title v) (Title (V (Title v))) Source # titleText :: Lens' (Title v) String Source # titleStyle :: Lens' (Title v) (Style (V (Title v)) Double) Source # titlePlacement :: Lens' (Title v) Placement Source # titleTextFunction :: Lens' (Title v) (TextAlignment Double -> String -> Diagram (V (Title v))) Source # titleAlignment :: Lens' (Title v) (TextAlignment Double) Source # titleGap :: Lens' (Title v) Double Source #
type N (Title v) Source #
Instance details Defined in Plots.Axis.Title type N (Title v) = Double
type V (Title v) Source #
Instance details Defined in Plots.Axis.Title type V (Title v) = v

class HasTitle a where Source #

Minimal complete definition

Methods

The text used for the title. If the string is empty, no title is drawn.

Default is ""

The style applied to the title.

Default is mempty.

The placement of the title against the axis.

Default is mempty.

titleTextFunction :: Lens' a (TextAlignment Double -> String -> Diagram (V a)) Source #

The function used to draw the title text.

Default is mkText.

The TextAlignment used for the title text. This is given to the titleTextFunction.

Default is BoxAlignedText 0.5 0.

The gap between the axis and the title.

Default is mempty.

Instances

HasTitle (Title v) Source #
Instance details Defined in Plots.Axis.Title Methods title :: Lens' (Title v) (Title (V (Title v))) Source # titleText :: Lens' (Title v) String Source # titleStyle :: Lens' (Title v) (Style (V (Title v)) Double) Source # titlePlacement :: Lens' (Title v) Placement Source # titleTextFunction :: Lens' (Title v) (TextAlignment Double -> String -> Diagram (V (Title v))) Source # titleAlignment :: Lens' (Title v) (TextAlignment Double) Source # titleGap :: Lens' (Title v) Double Source #
HasTitle (Axis c) Source #
Instance details Defined in Plots.Axis Methods title :: Lens' (Axis c) (Title (V (Axis c))) Source # titleText :: Lens' (Axis c) String Source # titleStyle :: Lens' (Axis c) (Style (V (Axis c)) Double) Source # titlePlacement :: Lens' (Axis c) Placement Source # titleTextFunction :: Lens' (Axis c) (TextAlignment Double -> String -> Diagram (V (Axis c))) Source # titleAlignment :: Lens' (Axis c) (TextAlignment Double) Source # titleGap :: Lens' (Axis c) Double Source #

drawTitle :: BoundingBox V2 Double -> Title V2 -> Diagram V2 Source #

Render the title and place it around the bounding box.