Plots.Axis.ColourBar

Options for rendering a colour bar, either attached to an axis or rendered separately.

To change the colour map used for the colour bar see axisColourMap from Plots.Style.

The colour bar

data ColourBar b n

Options for drawing a colour bar. Note that for an axis, the ColourMap is stored in the AxisStyle. These options are for other aspects of the bar, not the colours used.

Instances

Functor f => HasMajorGridLines f (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

majorGridLines :: LensLike' f (ColourBar b n) (MajorGridLines (V (ColourBar b n)) (N (ColourBar b n)))

majorGridLinesFunction :: LensLike' f (ColourBar b n) (GridLineFunction (N (ColourBar b n)))

majorGridLinesStyle :: LensLike' f (ColourBar b n) (Style (V (ColourBar b n)) (N (ColourBar b n)))

Functor f => HasMajorTicks f (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

majorTicks :: LensLike' f (ColourBar b n) (MajorTicks (V (ColourBar b n)) (N (ColourBar b n)))

majorTicksFunction :: LensLike' f (ColourBar b n) ((N (ColourBar b n), N (ColourBar b n)) -> [N (ColourBar b n)])

majorTicksAlignment :: LensLike' f (ColourBar b n) TicksAlignment

majorTicksLength :: LensLike' f (ColourBar b n) (N (ColourBar b n))

majorTicksStyle :: LensLike' f (ColourBar b n) (Style (V (ColourBar b n)) (N (ColourBar b n)))

Functor f => HasMinorTicks f (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

minorTicks :: LensLike' f (ColourBar b n) (MinorTicks (V (ColourBar b n)) (N (ColourBar b n)))

minorTicksFunction :: LensLike' f (ColourBar b n) ([N (ColourBar b n)] -> (N (ColourBar b n), N (ColourBar b n)) -> [N (ColourBar b n)])

minorTicksAlignment :: LensLike' f (ColourBar b n) TicksAlignment

minorTicksLength :: LensLike' f (ColourBar b n) (N (ColourBar b n))

minorTicksStyle :: LensLike' f (ColourBar b n) (Style (V (ColourBar b n)) (N (ColourBar b n)))

Functor f => HasTickLabels f (ColourBar b n) b

Defined in Plots.Axis.ColourBar

Methods

tickLabel :: LensLike' f (ColourBar b n) (TickLabels b (V (ColourBar b n)) (N (ColourBar b n)))

tickLabelTextFunction :: LensLike' f (ColourBar b n) (TextFunction b (V (ColourBar b n)) (N (ColourBar b n)))

tickLabelFunction :: LensLike' f (ColourBar b n) ([N (ColourBar b n)] -> (N (ColourBar b n), N (ColourBar b n)) -> [(N (ColourBar b n), String)])

tickLabelStyle :: LensLike' f (ColourBar b n) (Style (V (ColourBar b n)) (N (ColourBar b n)))

tickLabelGap :: LensLike' f (ColourBar b n) (N (ColourBar b n))

Typeable n => HasStyle (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

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

HasGap (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

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

HasOrientation (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

orientation :: Lens' (ColourBar b n) Orientation

HasPlacement (ColourBar b n)

Defined in Plots.Axis.ColourBar

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)

HasVisibility (ColourBar b n)

Defined in Plots.Axis.ColourBar

Methods

visible :: Lens' (ColourBar b n) Bool

hidden :: Lens' (ColourBar b n) Bool

HasColourBar (ColourBar b n) b

Defined in Plots.Axis.ColourBar

Methods

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

colourBarDraw :: Lens' (ColourBar b n) (ColourMap -> QDiagram b V2 (N (ColourBar b n)) Any)

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

colourBarLengthFunction :: Lens' (ColourBar b n) (N (ColourBar b n) -> N (ColourBar b n))

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

colourBarStyle :: Lens' (ColourBar b n) (Style V2 (N (ColourBar b n)))

type N (ColourBar b n)

Defined in Plots.Axis.ColourBar

type N (ColourBar b n) = n

type V (ColourBar b n)

Defined in Plots.Axis.ColourBar

type V (ColourBar b n) = V2

class HasColourBar a b | a -> b where

Minimal complete definition

colourBar

Methods

colourBar :: Lens' a (ColourBar b (N a))

Lens onto the ColourBar.

colourBarDraw :: Lens' a (ColourMap -> QDiagram b V2 (N a) Any)

How to draw the colour bar. Expects a 1 by 1 box with the gradient going from left to right, without an outline with origin in the middle of the left side. See gradientColourBar and pathColourBar.

The colour map this function recieves it given by axisColourMap from Plots.Style

Default is gradientColourBar.

colourBarWidth :: Lens' a (N a)

The width (orthogonal to the colour bar direction) of the colour bar.

Default is 20.

colourBarLengthFunction :: Lens' a (N a -> N a)

Set the length of the colour bar given the length of the axis the colour bar is aligned to.

Default is id.

colourBarGap :: Lens' a (N a)

Gap between the axis and the colour bar (if rendered with an axis).

Default is 20.

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

Style used for the outline of a colour bar.

Instances

HasColourBar (ColourBar b n) b

Defined in Plots.Axis.ColourBar

Methods

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

colourBarDraw :: Lens' (ColourBar b n) (ColourMap -> QDiagram b V2 (N (ColourBar b n)) Any)

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

colourBarLengthFunction :: Lens' (ColourBar b n) (N (ColourBar b n) -> N (ColourBar b n))

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

colourBarStyle :: Lens' (ColourBar b n) (Style V2 (N (ColourBar b n)))

HasColourBar (Axis b v n) b

Defined in Plots.Axis

Methods

colourBar :: Lens' (Axis b v n) (ColourBar b (N (Axis b v n)))

colourBarDraw :: Lens' (Axis b v n) (ColourMap -> QDiagram b V2 (N (Axis b v n)) Any)

colourBarWidth :: Lens' (Axis b v n) (N (Axis b v n))

colourBarLengthFunction :: Lens' (Axis b v n) (N (Axis b v n) -> N (Axis b v n))

colourBarGap :: Lens' (Axis b v n) (N (Axis b v n))

colourBarStyle :: Lens' (Axis b v n) (Style V2 (N (Axis b v n)))

defColourBar :: (Renderable (Text n) b, Renderable (Path V2 n) b, TypeableFloat n) => ColourBar b n

The default colour bar.

Rendering options

gradientColourBar :: (TypeableFloat n, Renderable (Path V2 n) b) => ColourMap -> QDiagram b V2 n Any

The colour bar generated by a gradient texture. The final diagram is 1 by 1, with origin at the middle of the left side. This can be used as the colourBarDraw function.

This may not be supported by all backends.

pathColourBar :: (TypeableFloat n, Renderable (Path V2 n) b) => Int -> ColourMap -> QDiagram b V2 n Any

Construct a colour bar made up of n solid square paths. The final diagram is 1 by 1, with origin at the middle of the left side. This can be used as the colourBarDraw function.

Rendering colour bars

renderColourBar

Arguments

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

=> ColourBar b n

options for colour bar

-> ColourMap

map to use

-> (n, n)

bounds of the values on the colour bar

-> n

length of the colour bar

-> QDiagram b V2 n Any

Render a colour bar by it's self at a given width. Note this ignores colourBarGap and colourBarLengthFunction.

addColourBar

Arguments

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

=> BoundingBox V2 n

bounding box to place against

-> ColourBar b n

-> ColourMap

-> (n, n)

-> QDiagram b V2 n Any

Add a colour bar to an object, using the bounding box for the object.