Copyright	(c) 2011-2015 diagrams-lib team (see LICENSE)
License	BSD-style (see LICENSE)
Maintainer	diagrams-discuss@googlegroups.com
Safe Haskell	None
Language	Haskell2010

Diagrams.Attributes

Contents

Standard measures
Line width
Dashing
Color
- Opacity
- Converting colors
Line stuff
Recommend optics

Description

Diagrams may have attributes which affect the way they are rendered. This module defines some common attributes; particular backends may also define more backend-specific attributes.

Every attribute type must have a semigroup structure, that is, an associative binary operation for combining two attributes into one. Unless otherwise noted, all the attributes defined here use the Last structure, that is, combining two attributes simply keeps the second one and throws away the first. This means that child attributes always override parent attributes.

Synopsis

Standard measures

ultraThin :: OrderedField n => Measure n Source #

veryThin :: OrderedField n => Measure n Source #

thin :: OrderedField n => Measure n Source #

medium :: OrderedField n => Measure n Source #

thick :: OrderedField n => Measure n Source #

veryThick :: OrderedField n => Measure n Source #

ultraThick :: OrderedField n => Measure n Source #

none :: OrderedField n => Measure n Source #

tiny :: OrderedField n => Measure n Source #

verySmall :: OrderedField n => Measure n Source #

small :: OrderedField n => Measure n Source #

normal :: OrderedField n => Measure n Source #

large :: OrderedField n => Measure n Source #

veryLarge :: OrderedField n => Measure n Source #

huge :: OrderedField n => Measure n Source #

Line width

data LineWidth n Source #

Line widths specified on child nodes always override line widths specified at parent nodes.

Instances

Semigroup (LineWidth n) Source #
Methods (<>) :: LineWidth n -> LineWidth n -> LineWidth n # sconcat :: NonEmpty (LineWidth n) -> LineWidth n # stimes :: Integral b => b -> LineWidth n -> LineWidth n #
Typeable * n => AttributeClass (LineWidth n) Source #

getLineWidth :: LineWidth n -> n Source #

_LineWidth :: Iso' (LineWidth n) n Source #

_LineWidthM :: Iso' (LineWidthM n) (Measure n) Source #

lineWidth :: (N a ~ n, HasStyle a, Typeable n) => Measure n -> a -> a Source #

Set the line (stroke) width.

lineWidthM :: (N a ~ n, HasStyle a, Typeable n) => LineWidthM n -> a -> a Source #

Apply a LineWidth attribute.

_lineWidth :: (Typeable n, OrderedField n) => Lens' (Style v n) (Measure n) Source #

Lens onto a measured line width in a style.

_lw :: (Typeable n, OrderedField n) => Lens' (Style v n) (Measure n) Source #

Lens onto a measured line width in a style.

_lineWidthU :: Typeable n => Lens' (Style v n) (Maybe n) Source #

Lens onto the unmeasured linewith attribute. This is useful for backends to use on styles once they have been unmeasured. Using on a diagram style could lead to unexpected results.

lw :: (N a ~ n, HasStyle a, Typeable n) => Measure n -> a -> a Source #

Default for lineWidth.

lwN :: (N a ~ n, HasStyle a, Typeable n, Num n) => n -> a -> a Source #

A convenient synonym for 'lineWidth (normalized w)'.

lwO :: (N a ~ n, HasStyle a, Typeable n) => n -> a -> a Source #

A convenient synonym for 'lineWidth (output w)'.

lwL :: (N a ~ n, HasStyle a, Typeable n, Num n) => n -> a -> a Source #

A convenient sysnonym for 'lineWidth (local w)'.

lwG :: (N a ~ n, HasStyle a, Typeable n, Num n) => n -> a -> a Source #

A convenient synonym for 'lineWidth (global w)'.

Dashing

data Dashing n Source #

Create lines that are dashing... er, dashed.

Constructors

Dashing [n] n

Instances

Functor Dashing Source #
Methods fmap :: (a -> b) -> Dashing a -> Dashing b # (<$) :: a -> Dashing b -> Dashing a #
Eq n => Eq (Dashing n) Source #
Methods (==) :: Dashing n -> Dashing n -> Bool # (/=) :: Dashing n -> Dashing n -> Bool #
Semigroup (Dashing n) Source #
Methods (<>) :: Dashing n -> Dashing n -> Dashing n # sconcat :: NonEmpty (Dashing n) -> Dashing n # stimes :: Integral b => b -> Dashing n -> Dashing n #
Typeable * n => AttributeClass (Dashing n) Source #

getDashing :: Dashing n -> Dashing n Source #

dashing Source #

Arguments

:: (N a ~ n, HasStyle a, Typeable n)
=> [Measure n]	A list specifying alternate lengths of on and off portions of the stroke. The empty list indicates no dashing.
-> Measure n	An offset into the dash pattern at which the stroke should start.
-> a
-> a

Set the line dashing style.

dashingN :: (N a ~ n, HasStyle a, Typeable n, Num n) => [n] -> n -> a -> a Source #

A convenient synonym for 'dashing (normalized w)'.

dashingO :: (N a ~ n, HasStyle a, Typeable n) => [n] -> n -> a -> a Source #

A convenient synonym for 'dashing (output w)'.

dashingL :: (N a ~ n, HasStyle a, Typeable n, Num n) => [n] -> n -> a -> a Source #

A convenient sysnonym for 'dashing (local w)'.

dashingG :: (N a ~ n, HasStyle a, Typeable n, Num n) => [n] -> n -> a -> a Source #

A convenient synonym for 'dashing (global w)'.

_dashing :: Typeable n => Lens' (Style v n) (Maybe (Measured n (Dashing n))) Source #

Lens onto a measured dashing attribute in a style.

_dashingU :: Typeable n => Lens' (Style v n) (Maybe (Dashing n)) Source #

Lens onto the unmeasured Dashing attribute. This is useful for backends to use on styles once they have been unmeasured. Using on a diagram style could lead to unexpected results.

Color

Diagrams outsources all things color-related to Russell O'Connor's very nice colour package (http://hackage.haskell.org/package/colour). For starters, it provides a large collection of standard color names. However, it also provides a rich set of combinators for combining and manipulating colors; see its documentation for more information.

class Color c where Source #

The Color type class encompasses color representations which can be used by the Diagrams library. Instances are provided for both the Colour and AlphaColour types from the Data.Colour library.

Minimal complete definition

toAlphaColour, fromAlphaColour

Methods

toAlphaColour :: c -> AlphaColour Double Source #

Convert a color to its standard representation, AlphaColour.

fromAlphaColour :: AlphaColour Double -> c Source #

Convert from an AlphaColour Double. Note that this direction may lose some information. For example, the instance for Colour drops the alpha channel.

Instances

Color SomeColor Source #
Methods toAlphaColour :: SomeColor -> AlphaColour Double Source # fromAlphaColour :: AlphaColour Double -> SomeColor Source #
(~) * a Double => Color (Colour a) Source #
Methods toAlphaColour :: Colour a -> AlphaColour Double Source # fromAlphaColour :: AlphaColour Double -> Colour a Source #
(~) * a Double => Color (AlphaColour a) Source #
Methods toAlphaColour :: AlphaColour a -> AlphaColour Double Source # fromAlphaColour :: AlphaColour Double -> AlphaColour a Source #

data SomeColor Source #

An existential wrapper for instances of the Color class.

Constructors

Color c => SomeColor c

Instances

Show SomeColor Source #
Methods showsPrec :: Int -> SomeColor -> ShowS # show :: SomeColor -> String # showList :: [SomeColor] -> ShowS #
Color SomeColor Source #
Methods toAlphaColour :: SomeColor -> AlphaColour Double Source # fromAlphaColour :: AlphaColour Double -> SomeColor Source #

_SomeColor :: Iso' SomeColor (AlphaColour Double) Source #

Isomorphism between SomeColor and AlphaColour Double.

someToAlpha :: SomeColor -> AlphaColour Double Source #

Opacity

data Opacity Source #

Although the individual colors in a diagram can have transparency, the opacity/transparency of a diagram as a whole can be specified with the Opacity attribute. The opacity is a value between 1 (completely opaque, the default) and 0 (completely transparent). Opacity is multiplicative, that is, opacity o1 . opacity o2 === opacity (o1 * o2). In other words, for example, opacity 0.8 means "decrease this diagram's opacity to 80% of its previous opacity".

Instances

Semigroup Opacity Source #
Methods (<>) :: Opacity -> Opacity -> Opacity # sconcat :: NonEmpty Opacity -> Opacity # stimes :: Integral b => b -> Opacity -> Opacity #
AttributeClass Opacity Source #

_Opacity :: Iso' Opacity Double Source #

getOpacity :: Opacity -> Double Source #

opacity :: HasStyle a => Double -> a -> a Source #

Multiply the opacity (see Opacity) by the given value. For example, opacity 0.8 means "decrease this diagram's opacity to 80% of its previous opacity".

_opacity :: Lens' (Style v n) Double Source #

Lens onto the opacity in a style.

Converting colors

colorToSRGBA :: Color c => c -> (Double, Double, Double, Double) Source #

Convert to sRGBA.

colorToRGBA :: Color c => c -> (Double, Double, Double, Double) Source #

Deprecated: Renamed to colorToSRGBA.

Convert to sRGBA.

Line stuff

Cap style

data LineCap Source #

What sort of shape should be placed at the endpoints of lines?

Constructors

LineCapButt	Lines end precisely at their endpoints.
LineCapRound	Lines are capped with semicircles centered on endpoints.
LineCapSquare	Lines are capped with a squares centered on endpoints.

Instances

Eq LineCap Source #
Methods (==) :: LineCap -> LineCap -> Bool # (/=) :: LineCap -> LineCap -> Bool #
Ord LineCap Source #
Methods compare :: LineCap -> LineCap -> Ordering # (<) :: LineCap -> LineCap -> Bool # (<=) :: LineCap -> LineCap -> Bool # (>) :: LineCap -> LineCap -> Bool # (>=) :: LineCap -> LineCap -> Bool # max :: LineCap -> LineCap -> LineCap # min :: LineCap -> LineCap -> LineCap #
Show LineCap Source #
Methods showsPrec :: Int -> LineCap -> ShowS # show :: LineCap -> String # showList :: [LineCap] -> ShowS #
Semigroup LineCap Source #	Last semigroup structure.
Methods (<>) :: LineCap -> LineCap -> LineCap # sconcat :: NonEmpty LineCap -> LineCap # stimes :: Integral b => b -> LineCap -> LineCap #
Default LineCap Source #
Methods def :: LineCap #
AttributeClass LineCap Source #

getLineCap :: LineCap -> LineCap Source #

lineCap :: HasStyle a => LineCap -> a -> a Source #

Set the line end cap attribute.

_lineCap :: Lens' (Style v n) LineCap Source #

Lens onto the line cap in a style.

Join style

data LineJoin Source #

How should the join points between line segments be drawn?

Constructors

LineJoinMiter	Use a "miter" shape (whatever that is).
LineJoinRound	Use rounded join points.
LineJoinBevel	Use a "bevel" shape (whatever that is). Are these... carpentry terms?

Instances

Eq LineJoin Source #
Methods (==) :: LineJoin -> LineJoin -> Bool # (/=) :: LineJoin -> LineJoin -> Bool #
Ord LineJoin Source #
Methods compare :: LineJoin -> LineJoin -> Ordering # (<) :: LineJoin -> LineJoin -> Bool # (<=) :: LineJoin -> LineJoin -> Bool # (>) :: LineJoin -> LineJoin -> Bool # (>=) :: LineJoin -> LineJoin -> Bool # max :: LineJoin -> LineJoin -> LineJoin # min :: LineJoin -> LineJoin -> LineJoin #
Show LineJoin Source #
Methods showsPrec :: Int -> LineJoin -> ShowS # show :: LineJoin -> String # showList :: [LineJoin] -> ShowS #
Semigroup LineJoin Source #	Last semigroup structure.
Methods (<>) :: LineJoin -> LineJoin -> LineJoin # sconcat :: NonEmpty LineJoin -> LineJoin # stimes :: Integral b => b -> LineJoin -> LineJoin #
Default LineJoin Source #
Methods def :: LineJoin #
AttributeClass LineJoin Source #

getLineJoin :: LineJoin -> LineJoin Source #

lineJoin :: HasStyle a => LineJoin -> a -> a Source #

Set the segment join style.

_lineJoin :: Lens' (Style v n) LineJoin Source #

Lens onto the line join type in a style.

Miter limit

newtype LineMiterLimit Source #

Miter limit attribute affecting the LineJoinMiter joins. For some backends this value may have additional effects.

Constructors

LineMiterLimit (Last Double)

Instances

Eq LineMiterLimit Source #
Methods (==) :: LineMiterLimit -> LineMiterLimit -> Bool # (/=) :: LineMiterLimit -> LineMiterLimit -> Bool #
Ord LineMiterLimit Source #
Methods compare :: LineMiterLimit -> LineMiterLimit -> Ordering # (<) :: LineMiterLimit -> LineMiterLimit -> Bool # (<=) :: LineMiterLimit -> LineMiterLimit -> Bool # (>) :: LineMiterLimit -> LineMiterLimit -> Bool # (>=) :: LineMiterLimit -> LineMiterLimit -> Bool # max :: LineMiterLimit -> LineMiterLimit -> LineMiterLimit # min :: LineMiterLimit -> LineMiterLimit -> LineMiterLimit #
Semigroup LineMiterLimit Source #
Methods (<>) :: LineMiterLimit -> LineMiterLimit -> LineMiterLimit # sconcat :: NonEmpty LineMiterLimit -> LineMiterLimit # stimes :: Integral b => b -> LineMiterLimit -> LineMiterLimit #
Default LineMiterLimit Source #
Methods def :: LineMiterLimit #
AttributeClass LineMiterLimit Source #

_LineMiterLimit :: Iso' LineMiterLimit Double Source #

getLineMiterLimit :: LineMiterLimit -> Double Source #

lineMiterLimit :: HasStyle a => Double -> a -> a Source #

Set the miter limit for joins with LineJoinMiter.

lineMiterLimitA :: HasStyle a => LineMiterLimit -> a -> a Source #

Apply a LineMiterLimit attribute.

_lineMiterLimit :: Lens' (Style v n) Double Source #

Lens onto the line miter limit in a style.

Recommend optics

_Recommend :: Prism' (Recommend a) a Source #

Prism onto a Recommend.

_Commit :: Prism' (Recommend a) a Source #

Prism onto a Commit.

_recommend :: Lens (Recommend a) (Recommend b) a b Source #

Lens onto the value inside either a Recommend or Commit. Unlike committed, this is a valid lens.

isCommitted :: Lens' (Recommend a) Bool Source #

Lens onto whether something is committed or not.

committed :: Iso (Recommend a) (Recommend b) a b Source #

Commit a value for any Recommend. This is *not* a valid Iso because the resulting Recommend b is always a Commit. This is useful because it means any Recommend styles set with a lens will not be accidentally overridden. If you want a valid lens onto a recommend value use _recommend.

Other lenses that use this are labeled with a warning.