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

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

ApplyStyle ColourBar

Defined in Plots.Axis.ColourBar

Methods

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

HasStyle ColourBar

Defined in Plots.Axis.ColourBar

Methods

style :: Lens' ColourBar (Style (V ColourBar) (N ColourBar))

HasPlacement ColourBar

Defined in Plots.Axis.ColourBar

Methods

placement :: Lens' ColourBar Placement

placementAt :: Lens' ColourBar (V2 Rational)

placementAnchor :: Lens' ColourBar (V2 Rational)

gapDirection :: Lens' ColourBar (Direction V2 Double)

HasGap ColourBar

Defined in Plots.Axis.ColourBar

Methods

gap :: Lens' ColourBar Double

HasOrientation ColourBar

Defined in Plots.Axis.ColourBar

Methods

orientation :: Lens' ColourBar Orientation

HasVisibility ColourBar

Defined in Plots.Axis.ColourBar

Methods

visible :: Lens' ColourBar Bool

hidden :: Lens' ColourBar Bool

HasColourBar ColourBar

Defined in Plots.Axis.ColourBar

Methods

colourBar :: Lens' ColourBar ColourBar

colourBarDraw :: Lens' ColourBar (ColourMap -> Diagram V2)

colourBarWidth :: Lens' ColourBar Double

colourBarLengthFunction :: Lens' ColourBar (Double -> Double)

colourBarGap :: Lens' ColourBar Double

colourBarStyle :: Lens' ColourBar (Style V2 Double)

Functor f => HasTickLabels f ColourBar

Defined in Plots.Axis.ColourBar

Methods

tickLabel :: LensLike' f ColourBar (TickLabels (V ColourBar))

tickLabelTextFunction :: LensLike' f ColourBar (TextFunction (V ColourBar))

tickLabelFunction :: LensLike' f ColourBar ([Double] -> (Double, Double) -> [(Double, String)])

tickLabelStyle :: LensLike' f ColourBar (Style (V ColourBar) Double)

tickLabelGap :: LensLike' f ColourBar Double

Functor f => HasMajorGridLines f ColourBar

Defined in Plots.Axis.ColourBar

Methods

majorGridLines :: LensLike' f ColourBar (MajorGridLines (V ColourBar))

majorGridLinesFunction :: LensLike' f ColourBar (GridLineFunction Double)

majorGridLinesStyle :: LensLike' f ColourBar (Style (V ColourBar) Double)

Functor f => HasMinorTicks f ColourBar

Defined in Plots.Axis.ColourBar

Methods

minorTicks :: LensLike' f ColourBar (MinorTicks (V ColourBar))

minorTicksFunction :: LensLike' f ColourBar ([Double] -> (Double, Double) -> [Double])

minorTicksAlignment :: LensLike' f ColourBar TicksAlignment

minorTicksLength :: LensLike' f ColourBar Double

minorTicksStyle :: LensLike' f ColourBar (Style (V ColourBar) Double)

Functor f => HasMajorTicks f ColourBar

Defined in Plots.Axis.ColourBar

Methods

majorTicks :: LensLike' f ColourBar (MajorTicks (V ColourBar))

majorTicksFunction :: LensLike' f ColourBar ((Double, Double) -> [Double])

majorTicksAlignment :: LensLike' f ColourBar TicksAlignment

majorTicksLength :: LensLike' f ColourBar Double

majorTicksStyle :: LensLike' f ColourBar (Style (V ColourBar) Double)

type N ColourBar

Defined in Plots.Axis.ColourBar

type N ColourBar = Double

type V ColourBar

Defined in Plots.Axis.ColourBar

type V ColourBar = V2

class HasColourBar a where

Minimal complete definition

colourBar

Methods

colourBar :: Lens' a ColourBar

Lens onto the ColourBar.

colourBarDraw :: Lens' a (ColourMap -> Diagram V2)

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 Double

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

Default is 20.

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

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 Double

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

Default is 20.

colourBarStyle :: Lens' a (Style V2 Double)

Style used for the outline of a colour bar.

Instances

HasColourBar ColourBar

Defined in Plots.Axis.ColourBar

Methods

colourBar :: Lens' ColourBar ColourBar

colourBarDraw :: Lens' ColourBar (ColourMap -> Diagram V2)

colourBarWidth :: Lens' ColourBar Double

colourBarLengthFunction :: Lens' ColourBar (Double -> Double)

colourBarGap :: Lens' ColourBar Double

colourBarStyle :: Lens' ColourBar (Style V2 Double)

HasColourBar (Axis v)

Defined in Plots.Axis

Methods

colourBar :: Lens' (Axis v) ColourBar

colourBarDraw :: Lens' (Axis v) (ColourMap -> Diagram V2)

colourBarWidth :: Lens' (Axis v) Double

colourBarLengthFunction :: Lens' (Axis v) (Double -> Double)

colourBarGap :: Lens' (Axis v) Double

colourBarStyle :: Lens' (Axis v) (Style V2 Double)

defColourBar :: ColourBar

The default colour bar.

Rendering options

gradientColourBar :: ColourMap -> Diagram V2

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 :: Int -> ColourMap -> Diagram V2

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

:: ColourBar

options for colour bar

-> ColourMap

map to use

-> (Double, Double)

bounds of the values on the colour bar

-> Double

length of the colour bar

-> Diagram V2

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

addColourBar

Arguments

:: BoundingBox V2 Double

bounding box to place against

-> ColourBar

-> ColourMap

-> (Double, Double)

-> Diagram V2

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