| Copyright | (C) 2015-2017 Christopher Chalmers |
|---|---|
| License | BSD-style (see the file LICENSE) |
| Maintainer | Christopher Chalmers |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Plots.Axis.Labels
Description
There are two kinds of labels this module deals with: The AxisLabel
labels are placed next to an axis line. The TickLabels are the
numbers (usually) next to each major tick on an axis line.
Synopsis
- class HasAxisLabel f a where
- axisLabel :: LensLike' f a (AxisLabel (V a))
- axisLabelText :: Functor f => LensLike' f a String
- axisLabelTextFunction :: Functor f => LensLike' f a (TextFunction (V a))
- axisLabelGap :: Functor f => LensLike' f a Double
- axisLabelStyle :: Functor f => LensLike' f a (Style (V a) Double)
- axisLabelPosition :: Functor f => LensLike' f a AxisLabelPosition
- axisLabelPlacement :: Functor f => LensLike' f a AxisLabelPosition
- data AxisLabel v
- data AxisLabelPosition
- data AxisLabelPlacement
- data TickLabels v
- class HasTickLabels f a where
- tickLabel :: LensLike' f a (TickLabels (V a))
- tickLabelTextFunction :: Functor f => LensLike' f a (TextFunction (V a))
- tickLabelFunction :: Functor f => LensLike' f a ([Double] -> (Double, Double) -> [(Double, String)])
- tickLabelStyle :: Functor f => LensLike' f a (Style (V a) Double)
- tickLabelGap :: Functor f => LensLike' f a Double
- tickLabelPositions :: (HasTickLabels f a, Settable f) => LensLike' f a [(Double, String)]
- atMajorTicks :: (Double -> String) -> [Double] -> (Double, Double) -> [(Double, String)]
- type TextFunction v = TextAlignment Double -> String -> Diagram v
Axis line labels
class HasAxisLabel f a where Source #
Minimal complete definition
Methods
axisLabel :: LensLike' f a (AxisLabel (V a)) Source #
The options for the label of the axis. This can be used on various levels of the axis:
axisLabel::Traversal'(Axisb c n) (AxisLabel(BaseSpacec) n)axisLabel::Lens'(SingleAxisv) (AxisLabelv n)axisLabel::Lens'(AxisLabelv n) (AxisLabelv n)
axisLabelText :: Functor f => LensLike' f a String Source #
The text to use when labeling the axis.
axisLabelTextFunction :: Functor f => LensLike' f a (TextFunction (V a)) Source #
The TextFunction to render the text of the axis label.
axisLabelGap :: Functor f => LensLike' f a Double Source #
The gap between the axis and the labels, in the direction
corresponding to the axisLabelPosition.
axisLabelStyle :: Functor f => LensLike' f a (Style (V a) Double) Source #
The Style to use on the rendered text.
axisLabelPosition :: Functor f => LensLike' f a AxisLabelPosition Source #
The position the label will be placed parallel to the axis.
axisLabelPlacement :: Functor f => LensLike' f a AxisLabelPosition Source #
Whether the axis label should be placed inside or outside the axis.
Instances
AxisLabel describes the label next to each axis line. They are
normally set with the xLabel and yLabel
helper function:
myAxis = r2Axis &~ doxLabel.= "time (s)"yLabel.= "height (m)"
See HasAxisLabel for more advanced settings.
Instances
data AxisLabelPosition Source #
The position of the AxisLabel along the axis.
Constructors
| MiddleAxisLabel | |
| LowerAxisLabel | |
| UpperAxisLabel |
data AxisLabelPlacement Source #
Whether the AxisLabel should be inside or outside the axis.
Constructors
| InsideAxisLabel | |
| OutsideAxisLabel |
Axis tick labels
data TickLabels v Source #
TickLabels describes how to draw the labels next to ticks. See
HasTickLabels for more options.
Instances
| HasTickLabels f (TickLabels v) Source # | |
Defined in Plots.Axis.Labels Methods tickLabel :: LensLike' f (TickLabels v) (TickLabels (V (TickLabels v))) Source # tickLabelTextFunction :: LensLike' f (TickLabels v) (TextFunction (V (TickLabels v))) Source # tickLabelFunction :: LensLike' f (TickLabels v) ([Double] -> (Double, Double) -> [(Double, String)]) Source # tickLabelStyle :: LensLike' f (TickLabels v) (Style (V (TickLabels v)) Double) Source # tickLabelGap :: LensLike' f (TickLabels v) Double Source # | |
| Default (TickLabels V3) Source # | |
Defined in Plots.Axis.Labels Methods def :: TickLabels V3 # | |
| Default (TickLabels V2) Source # | |
Defined in Plots.Axis.Labels Methods def :: TickLabels V2 # | |
| HasGap (TickLabels v) Source # | |
Defined in Plots.Axis.Labels | |
| HasVisibility (TickLabels v) Source # | |
Defined in Plots.Axis.Labels | |
| type N (TickLabels v) Source # | |
Defined in Plots.Axis.Labels | |
| type V (TickLabels v) Source # | |
Defined in Plots.Axis.Labels type V (TickLabels v) = v | |
class HasTickLabels f a where Source #
Minimal complete definition
Methods
tickLabel :: LensLike' f a (TickLabels (V a)) Source #
The options for the label of ticks. This can be used on various levels of the axis:
tickLabel::Traversal'(Tickc) (TickLabels(BaseSpacec))tickLabel::Lens'(SingleAxisv) (TickLabelsv)tickLabel::Lens'(TickLabelv) (TickLabelsv)
tickLabelTextFunction :: Functor f => LensLike' f a (TextFunction (V a)) Source #
The TextFunction to render the text.
Default is mkText.
tickLabelFunction :: Functor f => LensLike' f a ([Double] -> (Double, Double) -> [(Double, String)]) Source #
Tick labels functions are used to draw the tick labels. They have access to the major ticks and the current bounds. Returns the position of the tick and label to use at that position.
Default is atMajorTicks floatShow
tickLabelStyle :: Functor f => LensLike' f a (Style (V a) Double) Source #
The Style to use on the rendered text.
Default is fontSize (output 11)
tickLabelGap :: Functor f => LensLike' f a Double Source #
The gap between the axis and the tick labels.
Default is 12.
Instances
tickLabelPositions :: (HasTickLabels f a, Settable f) => LensLike' f a [(Double, String)] Source #
Setter over the final positions the major ticks. This is not as
general as tickLabelFunction because you don't have access to the
bounds but it can be useful when you know exactly what ticks you
want to add or modify existing tick positions or to add an extra
value:
xAxis . tickLabelPositions .= [(1, "apples"), (2, "oranges"), (3, "bananas"] yAxis . tickLabelPositions <>= [(1.5, "critial mass")]
If you want to change or add normal ticks see majorTicksFunction.
atMajorTicks :: (Double -> String) -> [Double] -> (Double, Double) -> [(Double, String)] Source #
Make a TickLabelFunction by specifying how to draw a single label
from a position on the axis.
Misc
type TextFunction v = TextAlignment Double -> String -> Diagram v Source #
Function to render the axis label from a string. This is very basic now and will be replace by a more sophisticated system.