Copyright	(C) 2015 Christopher Chalmers
License	BSD-style (see the file LICENSE)
Maintainer	Christopher Chalmers
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Plots.Axis.Grid

Contents

Grid lines
Extra traversals
Grid line functions

Description

Lines that go along the axis. Supports major and minor grid lines separately for each axis.

Synopsis

Grid lines

data GridLines v n Source #

Type holding information about both major and minor grid lines.

Instances

Functor f => HasGridLines f (GridLines v n) Source #
Methods gridLines :: LensLike' f (GridLines v n) (GridLines (V (GridLines v n)) (N (GridLines v n))) Source #
Functor f => HasMinorGridLines f (GridLines v n) Source #
Methods minorGridLines :: LensLike' f (GridLines v n) (MinorGridLines (V (GridLines v n)) (N (GridLines v n))) Source # minorGridLinesFunction :: LensLike' f (GridLines v n) (GridLineFunction (N (GridLines v n))) Source # minorGridLinesStyle :: LensLike' f (GridLines v n) (Style (V (GridLines v n)) (N (GridLines v n))) Source #
Functor f => HasMajorGridLines f (GridLines v n) Source #
Methods majorGridLines :: LensLike' f (GridLines v n) (MajorGridLines (V (GridLines v n)) (N (GridLines v n))) Source # majorGridLinesFunction :: LensLike' f (GridLines v n) (GridLineFunction (N (GridLines v n))) Source # majorGridLinesStyle :: LensLike' f (GridLines v n) (Style (V (GridLines v n)) (N (GridLines v n))) Source #
(Typeable * n, Floating n) => Default (GridLines v n) Source #
Methods def :: GridLines v n #
Typeable * n => HasStyle (GridLines v n) Source #
Methods applyStyle :: Style (V (GridLines v n)) (N (GridLines v n)) -> GridLines v n -> GridLines v n #
type V (GridLines v n) Source #
type V (GridLines v n) = v
type N (GridLines v n) Source #
type N (GridLines v n) = n

class (HasMinorGridLines f a, HasMajorGridLines f a) => HasGridLines f a where Source #

Minimal complete definition

gridLines

Methods

gridLines :: LensLike' f a (GridLines (V a) (N a)) Source #

Instances

Functor f => HasGridLines f (GridLines v n) Source #
Methods gridLines :: LensLike' f (GridLines v n) (GridLines (V (GridLines v n)) (N (GridLines v n))) Source #
(Applicative f, Traversable c) => HasGridLines f (Axis b c n) Source #
Methods gridLines :: LensLike' f (Axis b c n) (GridLines (V (Axis b c n)) (N (Axis b c n))) Source #
Functor f => HasGridLines f (SingleAxis b v n) Source #
Methods gridLines :: LensLike' f (SingleAxis b v n) (GridLines (V (SingleAxis b v n)) (N (SingleAxis b v n))) Source #

data MajorGridLines v n Source #

Instances

HasMajorGridLines f (MajorGridLines v n) Source #
Methods majorGridLines :: LensLike' f (MajorGridLines v n) (MajorGridLines (V (MajorGridLines v n)) (N (MajorGridLines v n))) Source # majorGridLinesFunction :: LensLike' f (MajorGridLines v n) (GridLineFunction (N (MajorGridLines v n))) Source # majorGridLinesStyle :: LensLike' f (MajorGridLines v n) (Style (V (MajorGridLines v n)) (N (MajorGridLines v n))) Source #
(Typeable * n, Floating n) => Default (MajorGridLines v n) Source #
Methods def :: MajorGridLines v n #
Typeable * n => HasStyle (MajorGridLines v n) Source #
Methods applyStyle :: Style (V (MajorGridLines v n)) (N (MajorGridLines v n)) -> MajorGridLines v n -> MajorGridLines v n #
HasVisibility (MajorGridLines v n) Source #
Methods visible :: Lens' (MajorGridLines v n) Bool Source # hidden :: Lens' (MajorGridLines v n) Bool Source #
type V (MajorGridLines v n) Source #
type V (MajorGridLines v n) = v
type N (MajorGridLines v n) Source #
type N (MajorGridLines v n) = n

class HasMajorGridLines f a where Source #

Minimal complete definition

majorGridLines

Methods

majorGridLines :: LensLike' f a (MajorGridLines (V a) (N a)) Source #

The options for how to draw the grid lines. This can be used on various levels of the axis:

majorGridLines :: Traversal' (Axis b c n)       (GridLines (BaseSpace c) n)
majorGridLines :: Lens'      (SingleAxis b v n) (GridLines v n)
majorGridLines :: Lens'      (GridLines v n)    (GridLines v n)

majorGridLinesFunction :: Functor f => LensLike' f a (GridLineFunction (N a)) Source #

The function to calculate location of the major grid lines given location of the major ticks and bounds.

majorGridLinesStyle :: Functor f => LensLike' f a (Style (V a) (N a)) Source #

The style applied to the major grid lines.

Instances

Functor f => HasMajorGridLines f (GridLines v n) Source #
Methods majorGridLines :: LensLike' f (GridLines v n) (MajorGridLines (V (GridLines v n)) (N (GridLines v n))) Source # majorGridLinesFunction :: LensLike' f (GridLines v n) (GridLineFunction (N (GridLines v n))) Source # majorGridLinesStyle :: LensLike' f (GridLines v n) (Style (V (GridLines v n)) (N (GridLines v n))) Source #
HasMajorGridLines f (MajorGridLines v n) Source #
Methods majorGridLines :: LensLike' f (MajorGridLines v n) (MajorGridLines (V (MajorGridLines v n)) (N (MajorGridLines v n))) Source # majorGridLinesFunction :: LensLike' f (MajorGridLines v n) (GridLineFunction (N (MajorGridLines v n))) Source # majorGridLinesStyle :: LensLike' f (MajorGridLines v n) (Style (V (MajorGridLines v n)) (N (MajorGridLines v n))) Source #
(Applicative f, Traversable c) => HasMajorGridLines f (Axis b c n) Source #
Methods majorGridLines :: LensLike' f (Axis b c n) (MajorGridLines (V (Axis b c n)) (N (Axis b c n))) Source # majorGridLinesFunction :: LensLike' f (Axis b c n) (GridLineFunction (N (Axis b c n))) Source # majorGridLinesStyle :: LensLike' f (Axis b c n) (Style (V (Axis b c n)) (N (Axis b c n))) Source #
Functor f => HasMajorGridLines f (SingleAxis b v n) Source #
Methods majorGridLines :: LensLike' f (SingleAxis b v n) (MajorGridLines (V (SingleAxis b v n)) (N (SingleAxis b v n))) Source # majorGridLinesFunction :: LensLike' f (SingleAxis b v n) (GridLineFunction (N (SingleAxis b v n))) Source # majorGridLinesStyle :: LensLike' f (SingleAxis b v n) (Style (V (SingleAxis b v n)) (N (SingleAxis b v n))) Source #

data MinorGridLines v n Source #

Instances

HasMinorGridLines f (MinorGridLines v n) Source #
Methods minorGridLines :: LensLike' f (MinorGridLines v n) (MinorGridLines (V (MinorGridLines v n)) (N (MinorGridLines v n))) Source # minorGridLinesFunction :: LensLike' f (MinorGridLines v n) (GridLineFunction (N (MinorGridLines v n))) Source # minorGridLinesStyle :: LensLike' f (MinorGridLines v n) (Style (V (MinorGridLines v n)) (N (MinorGridLines v n))) Source #
(Typeable * n, Floating n) => Default (MinorGridLines v n) Source #
Methods def :: MinorGridLines v n #
Typeable * n => HasStyle (MinorGridLines v n) Source #
Methods applyStyle :: Style (V (MinorGridLines v n)) (N (MinorGridLines v n)) -> MinorGridLines v n -> MinorGridLines v n #
HasVisibility (MinorGridLines v n) Source #	Hidden by default.
Methods visible :: Lens' (MinorGridLines v n) Bool Source # hidden :: Lens' (MinorGridLines v n) Bool Source #
type V (MinorGridLines v n) Source #
type V (MinorGridLines v n) = v
type N (MinorGridLines v n) Source #
type N (MinorGridLines v n) = n

class HasMinorGridLines f a where Source #

Minimal complete definition

minorGridLines

Methods

minorGridLines :: LensLike' f a (MinorGridLines (V a) (N a)) Source #

The options for how to draw the grid lines. This can be used on various levels of the axis:

minorGridLines :: Traversal' (Axis b c n)       (GridLines (BaseSpace c) n)
minorGridLines :: Lens'      (SingleAxis b v n) (GridLines v n)
minorGridLines :: Lens'      (GridLines v n)    (GridLines v n)

minorGridLinesFunction :: Functor f => LensLike' f a (GridLineFunction (N a)) Source #

The function to calculate location of the minor grid lines given location of the minor ticks and bounds.

minorGridLinesStyle :: Functor f => LensLike' f a (Style (V a) (N a)) Source #

The style applied to the minor grid lines.

Instances

Functor f => HasMinorGridLines f (GridLines v n) Source #
Methods minorGridLines :: LensLike' f (GridLines v n) (MinorGridLines (V (GridLines v n)) (N (GridLines v n))) Source # minorGridLinesFunction :: LensLike' f (GridLines v n) (GridLineFunction (N (GridLines v n))) Source # minorGridLinesStyle :: LensLike' f (GridLines v n) (Style (V (GridLines v n)) (N (GridLines v n))) Source #
HasMinorGridLines f (MinorGridLines v n) Source #
Methods minorGridLines :: LensLike' f (MinorGridLines v n) (MinorGridLines (V (MinorGridLines v n)) (N (MinorGridLines v n))) Source # minorGridLinesFunction :: LensLike' f (MinorGridLines v n) (GridLineFunction (N (MinorGridLines v n))) Source # minorGridLinesStyle :: LensLike' f (MinorGridLines v n) (Style (V (MinorGridLines v n)) (N (MinorGridLines v n))) Source #
(Applicative f, Traversable c) => HasMinorGridLines f (Axis b c n) Source #
Methods minorGridLines :: LensLike' f (Axis b c n) (MinorGridLines (V (Axis b c n)) (N (Axis b c n))) Source # minorGridLinesFunction :: LensLike' f (Axis b c n) (GridLineFunction (N (Axis b c n))) Source # minorGridLinesStyle :: LensLike' f (Axis b c n) (Style (V (Axis b c n)) (N (Axis b c n))) Source #
Functor f => HasMinorGridLines f (SingleAxis b v n) Source #
Methods minorGridLines :: LensLike' f (SingleAxis b v n) (MinorGridLines (V (SingleAxis b v n)) (N (SingleAxis b v n))) Source # minorGridLinesFunction :: LensLike' f (SingleAxis b v n) (GridLineFunction (N (SingleAxis b v n))) Source # minorGridLinesStyle :: LensLike' f (SingleAxis b v n) (Style (V (SingleAxis b v n)) (N (SingleAxis b v n))) Source #

Extra traversals

gridLinesStyle :: (HasGridLines f a, Applicative f) => LensLike' f a (Style (V a) (N a)) Source #

Traversal over both the major and minor grid styles. This can be used at several levels in the axis:

gridLinesVisible :: (HasGridLines f a, Applicative f) => LensLike' f a Bool Source #

Traversal over both the major and minor grid styles.

gridLinesVisible :: Traversal' (Axis b c n) Bool
gridLinesVisible :: Traversal' (SingleAxis b v n) Bool
gridLinesVisible :: Traversal' (GridLines v n) Bool

hideGridLines :: (HasGridLines Identity a, MonadState a m) => m () Source #

Hide both major and minor grid lines.

hideGridLines :: Axis b c n       -> Axis b c n
hideGridLines :: SingleAxis b c n -> SingleAxis b c n
hideGridLines :: GridLines b c n  -> GridLines b c n

showGridLines :: (HasGridLines Identity a, MonadState a m) => m () Source #

Show both major and minor grid lines.

showGridLines :: Axis b c n       -> Axis b c n
showGridLines :: SingleAxis b c n -> SingleAxis b c n
showGridLines :: GridLines b c n  -> GridLines b c n

Grid line functions

type GridLineFunction n = [n] -> (n, n) -> [n] Source #

A grid line function takes the positions of the respective ticks (minor ticks for minor grid lines, major ticks for major grid lines) and the bounds of the axis and returns the positions of the grid lines.

These functions are used in conjuction with majorGridLineFunction and minorGridLineFunction to control how the lines are drawn.

onTicksGridLineFunction :: GridLineFunction n Source #

Place grid lines at the same position as the respective ticks. This is the Default.

emptyGridLineFunction :: GridLineFunction n Source #

The GridLineFunction such that no grid lines appear.

See hideGridLines, majorGridLineVisible or minorGridLineVisible if you just want to hide the grid lines.