Plots.Axis.Ticks

Ticks for being placed on an axis or a ColourBar.

Major ticks

data MajorTicks v n

The big ticks on the axis line.

Instances

HasMajorTicks f (MajorTicks v n)

Methods

majorTicks :: LensLike' f (MajorTicks v n) (MajorTicks (V (MajorTicks v n)) (N (MajorTicks v n)))

majorTicksFunction :: LensLike' f (MajorTicks v n) ((N (MajorTicks v n), N (MajorTicks v n)) -> [N (MajorTicks v n)])

majorTicksAlignment :: LensLike' f (MajorTicks v n) TicksAlignment

majorTicksLength :: LensLike' f (MajorTicks v n) (N (MajorTicks v n))

majorTicksStyle :: LensLike' f (MajorTicks v n) (Style (V (MajorTicks v n)) (N (MajorTicks v n)))

TypeableFloat n => Default (MajorTicks v n)

Methods

def :: MajorTicks v n

HasVisibility (MajorTicks v n)

Methods

visible :: Lens' (MajorTicks v n) Bool

hidden :: Lens' (MajorTicks v n) Bool

type V (MajorTicks v n)

type V (MajorTicks v n) = v

type N (MajorTicks v n)

type N (MajorTicks v n) = n

class HasMajorTicks f a where

Class of things that have a MajorTicks.

Minimal complete definition

majorTicks

Methods

majorTicks :: LensLike' f a (MajorTicks (V a) (N a))

Lens onto the MajorTicks of something.

majorTicksFunction :: Functor f => LensLike' f a ((N a, N a) -> [N a])

The function used to place ticks for this axis, given the bounds of the axis. The result of these major ticks are also used as guides for MinorTicks, MajorGridLines and MinorGridLines.

Default is linearMinorTicks 5.

majorTicksAlignment :: Functor f => LensLike' f a TicksAlignment

Alignment of the major ticks. Choose between autoTicks (default), centreTicks, insideTicks or outsideTicks.

majorTicksLength :: Functor f => LensLike' f a (N a)

The total length the major ticks.

Default is 7.

majorTicksStyle :: Functor f => LensLike' f a (Style (V a) (N a))

The style used to render the major ticks.

Default is lwO 0.6 mempty (subject to change).

Instances

Functor f => HasMajorTicks f (Ticks v n)

Methods

majorTicks :: LensLike' f (Ticks v n) (MajorTicks (V (Ticks v n)) (N (Ticks v n)))

majorTicksFunction :: LensLike' f (Ticks v n) ((N (Ticks v n), N (Ticks v n)) -> [N (Ticks v n)])

majorTicksAlignment :: LensLike' f (Ticks v n) TicksAlignment

majorTicksLength :: LensLike' f (Ticks v n) (N (Ticks v n))

majorTicksStyle :: LensLike' f (Ticks v n) (Style (V (Ticks v n)) (N (Ticks v n)))

HasMajorTicks f (MajorTicks v n)

Methods

majorTicks :: LensLike' f (MajorTicks v n) (MajorTicks (V (MajorTicks v n)) (N (MajorTicks v n)))

majorTicksFunction :: LensLike' f (MajorTicks v n) ((N (MajorTicks v n), N (MajorTicks v n)) -> [N (MajorTicks v n)])

majorTicksAlignment :: LensLike' f (MajorTicks v n) TicksAlignment

majorTicksLength :: LensLike' f (MajorTicks v n) (N (MajorTicks v n))

majorTicksStyle :: LensLike' f (MajorTicks v n) (Style (V (MajorTicks v n)) (N (MajorTicks v n)))

Functor f => HasMajorTicks f (ColourBar b n)

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)))

(Applicative f, Traversable c) => HasMajorTicks f (Axis b c n)

Methods

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

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

majorTicksAlignment :: LensLike' f (Axis b c n) TicksAlignment

majorTicksLength :: LensLike' f (Axis b c n) (N (Axis b c n))

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

Functor f => HasMajorTicks f (SingleAxis b v n)

Methods

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

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

majorTicksAlignment :: LensLike' f (SingleAxis b v n) TicksAlignment

majorTicksLength :: LensLike' f (SingleAxis b v n) (N (SingleAxis b v n))

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

majorTicksHelper

Arguments

:: (RealFrac n, Floating n)

=> [n]

Allowed numbers (up to powers of 10)

-> n

desired number of ticks

-> (n, n)

bounds

-> [n]

tick positions

Choose ticks whose step size is a multiple of 10 of the allowed numbers and tries to match the number of desired ticks.

Note that the resulting tick positions may go out of the range of the bounds. This is so the minor ticks can be chosen correctly if a tick doesn't end exactly on a bound. When we render, we ignore all ticks outside the bounds.

logMajorTicks :: (RealFrac n, Floating n) => n -> (n, n) -> [n]

Place n ticks at powers of 10 on the axis.

Minor ticks

data MinorTicks v n

The small ticks on the axis line.

Instances

HasMinorTicks f (MinorTicks v n)

Methods

minorTicks :: LensLike' f (MinorTicks v n) (MinorTicks (V (MinorTicks v n)) (N (MinorTicks v n)))

minorTicksFunction :: LensLike' f (MinorTicks v n) ([N (MinorTicks v n)] -> (N (MinorTicks v n), N (MinorTicks v n)) -> [N (MinorTicks v n)])

minorTicksAlignment :: LensLike' f (MinorTicks v n) TicksAlignment

minorTicksLength :: LensLike' f (MinorTicks v n) (N (MinorTicks v n))

minorTicksStyle :: LensLike' f (MinorTicks v n) (Style (V (MinorTicks v n)) (N (MinorTicks v n)))

TypeableFloat n => Default (MinorTicks v n)

Methods

def :: MinorTicks v n

HasVisibility (MinorTicks v n)

Methods

visible :: Lens' (MinorTicks v n) Bool

hidden :: Lens' (MinorTicks v n) Bool

type V (MinorTicks v n)

type V (MinorTicks v n) = v

type N (MinorTicks v n)

type N (MinorTicks v n) = n

class HasMinorTicks f a where

Class of things that have a single MinorTicks.

Minimal complete definition

minorTicks

Methods

minorTicks :: LensLike' f a (MinorTicks (V a) (N a))

Lens onto the MinorTicks of something.

minorTicksFunction :: Functor f => LensLike' f a ([N a] -> (N a, N a) -> [N a])

The function used to place ticks for this axis, given the result of majorTicksFunction and the bounds of the axis.

Default is linearMinorTicks 3.

minorTicksAlignment :: Functor f => LensLike' f a TicksAlignment

Alignment of the minor ticks. Choose between autoTicks (default), centreTicks, insideTicks or outsideTicks.

minorTicksLength :: Functor f => LensLike' f a (N a)

The total length the minor ticks.

Default is 3.

minorTicksStyle :: Functor f => LensLike' f a (Style (V a) (N a))

The style used to render the minor ticks.

Default is lwO 0.4 mempty (subject to change).

Instances

Functor f => HasMinorTicks f (Ticks v n)

Methods

minorTicks :: LensLike' f (Ticks v n) (MinorTicks (V (Ticks v n)) (N (Ticks v n)))

minorTicksFunction :: LensLike' f (Ticks v n) ([N (Ticks v n)] -> (N (Ticks v n), N (Ticks v n)) -> [N (Ticks v n)])

minorTicksAlignment :: LensLike' f (Ticks v n) TicksAlignment

minorTicksLength :: LensLike' f (Ticks v n) (N (Ticks v n))

minorTicksStyle :: LensLike' f (Ticks v n) (Style (V (Ticks v n)) (N (Ticks v n)))

HasMinorTicks f (MinorTicks v n)

Methods

minorTicks :: LensLike' f (MinorTicks v n) (MinorTicks (V (MinorTicks v n)) (N (MinorTicks v n)))

minorTicksFunction :: LensLike' f (MinorTicks v n) ([N (MinorTicks v n)] -> (N (MinorTicks v n), N (MinorTicks v n)) -> [N (MinorTicks v n)])

minorTicksAlignment :: LensLike' f (MinorTicks v n) TicksAlignment

minorTicksLength :: LensLike' f (MinorTicks v n) (N (MinorTicks v n))

minorTicksStyle :: LensLike' f (MinorTicks v n) (Style (V (MinorTicks v n)) (N (MinorTicks v n)))

(Applicative f, Traversable c) => HasMinorTicks f (Axis b c n)

Methods

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

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

minorTicksAlignment :: LensLike' f (Axis b c n) TicksAlignment

minorTicksLength :: LensLike' f (Axis b c n) (N (Axis b c n))

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

Functor f => HasMinorTicks f (SingleAxis b v n)

Methods

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

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

minorTicksAlignment :: LensLike' f (SingleAxis b v n) TicksAlignment

minorTicksLength :: LensLike' f (SingleAxis b v n) (N (SingleAxis b v n))

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

minorTicksHelper

Arguments

:: Fractional n

=> Int

Number of minor ticks between each major tick

-> [n]

Positions of major ticks

-> (n, n)

Bounds

-> [n]

Minor tick positions

Place n linear spaced ticks between each major tick.

Both major and minor ticks

data Ticks v n

Both MajorTicks and MinorTicks together.

Instances

Functor f => HasTicks f (Ticks v n)

Methods

bothTicks :: LensLike' f (Ticks v n) (Ticks (V (Ticks v n)) (N (Ticks v n)))

Functor f => HasMinorTicks f (Ticks v n)

Methods

minorTicks :: LensLike' f (Ticks v n) (MinorTicks (V (Ticks v n)) (N (Ticks v n)))

minorTicksFunction :: LensLike' f (Ticks v n) ([N (Ticks v n)] -> (N (Ticks v n), N (Ticks v n)) -> [N (Ticks v n)])

minorTicksAlignment :: LensLike' f (Ticks v n) TicksAlignment

minorTicksLength :: LensLike' f (Ticks v n) (N (Ticks v n))

minorTicksStyle :: LensLike' f (Ticks v n) (Style (V (Ticks v n)) (N (Ticks v n)))

Functor f => HasMajorTicks f (Ticks v n)

Methods

majorTicks :: LensLike' f (Ticks v n) (MajorTicks (V (Ticks v n)) (N (Ticks v n)))

majorTicksFunction :: LensLike' f (Ticks v n) ((N (Ticks v n), N (Ticks v n)) -> [N (Ticks v n)])

majorTicksAlignment :: LensLike' f (Ticks v n) TicksAlignment

majorTicksLength :: LensLike' f (Ticks v n) (N (Ticks v n))

majorTicksStyle :: LensLike' f (Ticks v n) (Style (V (Ticks v n)) (N (Ticks v n)))

TypeableFloat n => Default (Ticks v n)

Methods

def :: Ticks v n

Typeable * n => HasStyle (Ticks v n)

Methods

applyStyle :: Style (V (Ticks v n)) (N (Ticks v n)) -> Ticks v n -> Ticks v n

type V (Ticks v n)

type V (Ticks v n) = v

type N (Ticks v n)

type N (Ticks v n) = n

class (HasMinorTicks f a, HasMajorTicks f a) => HasTicks f a where

Class of things with both MajorTicks and MinorTicks.

Minimal complete definition

bothTicks

Methods

bothTicks :: LensLike' f a (Ticks (V a) (N a))

Instances

Functor f => HasTicks f (Ticks v n)

Methods

bothTicks :: LensLike' f (Ticks v n) (Ticks (V (Ticks v n)) (N (Ticks v n)))

(Applicative f, Traversable c) => HasTicks f (Axis b c n)

Methods

bothTicks :: LensLike' f (Axis b c n) (Ticks (V (Axis b c n)) (N (Axis b c n)))

Functor f => HasTicks f (SingleAxis b v n)

Methods

bothTicks :: LensLike' f (SingleAxis b v n) (Ticks (V (SingleAxis b v n)) (N (SingleAxis b v n)))

ticksAlign :: (HasTicks f a, Applicative f) => LensLike' f a TicksAlignment

Traversal over both major and minor tick alignment.

ticksStyle :: (HasTicks f a, Applicative f) => LensLike' f a (Style (V a) (N a))

Traversal over both major and minor tick styles.

ticksVisible :: (HasTicks f a, Applicative f) => LensLike' f a Bool

Traversal over the visibility of both major and minor ticks.

Tick alignment

data TicksAlignment

Set the portion of the tick above and below the axis.

Constructors

TickSpec !Rational !Rational

AutoTick

Instances

Eq TicksAlignment

Methods

(==) :: TicksAlignment -> TicksAlignment -> Bool

(/=) :: TicksAlignment -> TicksAlignment -> Bool

Show TicksAlignment

Methods

showsPrec :: Int -> TicksAlignment -> ShowS

show :: TicksAlignment -> String

showList :: [TicksAlignment] -> ShowS

autoTicks :: TicksAlignment

Set the tick type depending on the axis line position. centreTick for middleAxis, insideTick for everything else.

centreTicks :: TicksAlignment

Set the tick to be in the centre of the axis with total length of the corresponding tick length.

centerTicks :: TicksAlignment

Synonym for centreTicks.

insideTicks :: TicksAlignment

Align the ticks to be inside a box axis.

outsideTicks :: TicksAlignment

Align the ticks to be outside a box axis.

Helper functions

hideTicks :: HasTicks Identity a => a -> a

Hides the Minor ticks when trying to render something. This can be used on multiple types:

hideTicks :: Axis b c n       -> Axis b c n
hideTicks :: SingleAxis b v n -> SingleAxis b v n
hideTicks :: Ticks v n        -> Ticks v n
hideTicks :: MinorTicks v n   -> MinorTicks v n

majorTickPositions :: (HasMajorTicks f a, Settable f) => LensLike' f a [N a]

Setter over the final positions the major ticks. This is not as general as majorTicksFunction 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.

minorTickPositions :: (HasMinorTicks f a, Settable f) => LensLike' f a [N a]

Setter over the final positions the major ticks. This is not as general as minorTicksFunction 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.

linearMajorTicks :: (RealFrac n, Floating n) => n -> (n, n) -> [n]

Ticks whose value ends in 1, 0.5, 0.25, 0.2 (*10^n).