Plots.Axis.Title

The title used for a plot.

Documentation

data Title b v n

Instances

(Renderable (Text n) b, TypeableFloat n) => Default (Title b V2 n)

Defined in Plots.Axis.Title

Methods

def :: Title b V2 n

HasGap (Title b v n)

Defined in Plots.Axis.Title

Methods

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

HasPlacement (Title b v n)

Defined in Plots.Axis.Title

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)

HasVisibility (Title b v n)

Defined in Plots.Axis.Title

Methods

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

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

HasTitle (Title b v n) b

Defined in Plots.Axis.Title

Methods

title :: Lens' (Title b v n) (Title b (V (Title b v n)) (N (Title b v n)))

titleText :: Lens' (Title b v n) String

titleStyle :: Lens' (Title b v n) (Style (V (Title b v n)) (N (Title b v n)))

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

titleTextFunction :: Lens' (Title b v n) (TextAlignment (N (Title b v n)) -> String -> QDiagram b (V (Title b v n)) (N (Title b v n)) Any)

titleAlignment :: Lens' (Title b v n) (TextAlignment (N (Title b v n)))

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

type N (Title b v n)

Defined in Plots.Axis.Title

type N (Title b v n) = n

type V (Title b v n)

Defined in Plots.Axis.Title

type V (Title b v n) = v

class HasTitle a b | a -> b where

Minimal complete definition

title

Methods

title :: Lens' a (Title b (V a) (N a))

titleText :: Lens' a String

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

Default is ""

titleStyle :: Lens' a (Style (V a) (N a))

The style applied to the title.

Default is mempty.

titlePlacement :: Lens' a Placement

The placement of the title against the axis.

Default is mempty.

titleTextFunction :: Lens' a (TextAlignment (N a) -> String -> QDiagram b (V a) (N a) Any)

The function used to draw the title text.

Default is mkText.

titleAlignment :: Lens' a (TextAlignment (N a))

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

Default is BoxAlignedText 0.5 0.

titleGap :: Lens' a (N a)

The gap between the axis and the title.

Default is mempty.

Instances

HasTitle (Axis b c n) b

Defined in Plots.Axis

Methods

title :: Lens' (Axis b c n) (Title b (V (Axis b c n)) (N (Axis b c n)))

titleText :: Lens' (Axis b c n) String

titleStyle :: Lens' (Axis b c n) (Style (V (Axis b c n)) (N (Axis b c n)))

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

titleTextFunction :: Lens' (Axis b c n) (TextAlignment (N (Axis b c n)) -> String -> QDiagram b (V (Axis b c n)) (N (Axis b c n)) Any)

titleAlignment :: Lens' (Axis b c n) (TextAlignment (N (Axis b c n)))

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

HasTitle (Title b v n) b

Defined in Plots.Axis.Title

Methods

title :: Lens' (Title b v n) (Title b (V (Title b v n)) (N (Title b v n)))

titleText :: Lens' (Title b v n) String

titleStyle :: Lens' (Title b v n) (Style (V (Title b v n)) (N (Title b v n)))

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

titleTextFunction :: Lens' (Title b v n) (TextAlignment (N (Title b v n)) -> String -> QDiagram b (V (Title b v n)) (N (Title b v n)) Any)

titleAlignment :: Lens' (Title b v n) (TextAlignment (N (Title b v n)))

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

drawTitle :: TypeableFloat n => BoundingBox V2 n -> Title b V2 n -> QDiagram b V2 n Any

Render the title and place it around the bounding box.