Diagrams.Attributes

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.

Standard measures

ultraThin :: OrderedField n => Measure n

veryThin :: OrderedField n => Measure n

thin :: OrderedField n => Measure n

medium :: OrderedField n => Measure n

thick :: OrderedField n => Measure n

veryThick :: OrderedField n => Measure n

ultraThick :: OrderedField n => Measure n

none :: OrderedField n => Measure n

tiny :: OrderedField n => Measure n

verySmall :: OrderedField n => Measure n

small :: OrderedField n => Measure n

normal :: OrderedField n => Measure n

large :: OrderedField n => Measure n

veryLarge :: OrderedField n => Measure n

huge :: OrderedField n => Measure n

Line width

data LineWidth n

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

Instances

Semigroup (LineWidth n)

Typeable * n => AttributeClass (LineWidth n)

getLineWidth :: LineWidth n -> n

_LineWidth :: (Typeable n, OrderedField n) => Iso' (LineWidth n) n

_LineWidthM :: (Typeable n, OrderedField n) => Iso' (LineWidthM n) (Measure n)

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

Set the line (stroke) width.

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

Apply a LineWidth attribute.

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

Lens onto a measured line width in a style.

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

Lens onto a measured line width in a style.

_lineWidthU :: (Typeable n, OrderedField n) => Lens' (Style v n) (Maybe n)

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

Default for lineWidth.

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

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

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

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

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

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

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

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

Dashing

data Dashing n

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

Constructors

Dashing [n] n

Instances

Functor Dashing

Eq n => Eq (Dashing n)

Semigroup (Dashing n)

Typeable * n => AttributeClass (Dashing n)

getDashing :: Dashing n -> Dashing n

dashing

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

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

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

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

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

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

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

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

_dashing :: (Typeable n, OrderedField n) => Lens' (Style v n) (Maybe (Measured n (Dashing n)))

Lens onto a measured dashing attribute in a style.

_dashingU :: (Typeable n, OrderedField n) => Lens' (Style v n) (Maybe (Dashing n))

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

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.

Methods

toAlphaColour :: c -> AlphaColour Double

Convert a color to its standard representation, AlphaColour.

fromAlphaColour :: AlphaColour Double -> c

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

(~) * a Double => Color (Colour a)

(~) * a Double => Color (AlphaColour a)

data SomeColor

An existential wrapper for instances of the Color class.

Constructors

forall c . Color c => SomeColor c

Instances

Show SomeColor

Color SomeColor

_SomeColor :: Iso' SomeColor (AlphaColour Double)

Isomorphism between SomeColor and AlphaColour Double.

someToAlpha :: SomeColor -> AlphaColour Double

Opacity

data Opacity

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

AttributeClass Opacity

_Opacity :: Iso' Opacity Double

getOpacity :: Opacity -> Double

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

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

Lens onto the opacity in a style.

Converting colors

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

Convert to sRGBA.

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

Deprecated: Renamed to colorToSRGBA.

Convert to sRGBA.

Line stuff

Cap style

data LineCap

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

Ord LineCap

Show LineCap

Semigroup LineCap

Last semigroup structure.

Default LineCap

AttributeClass LineCap

getLineCap :: LineCap -> LineCap

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

Set the line end cap attribute.

_lineCap :: Lens' (Style v n) LineCap

Lens onto the line cap in a style.

Join style

data LineJoin

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

Ord LineJoin

Show LineJoin

Semigroup LineJoin

Last semigroup structure.

Default LineJoin

AttributeClass LineJoin

getLineJoin :: LineJoin -> LineJoin

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

Set the segment join style.

_lineJoin :: Lens' (Style v n) LineJoin

Lens onto the line join type in a style.

Miter limit

newtype LineMiterLimit

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

Constructors

LineMiterLimit (Last Double)

Instances

Eq LineMiterLimit

Ord LineMiterLimit

Semigroup LineMiterLimit

Default LineMiterLimit

AttributeClass LineMiterLimit

_LineMiterLimit :: Iso' LineMiterLimit Double

getLineMiterLimit :: LineMiterLimit -> Double

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

Set the miter limit for joins with LineJoinMiter.

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

Apply a LineMiterLimit attribute.

_lineMiterLimit :: Lens' (Style v n) Double

Lens onto the line miter limit in a style.

Recommend optics

_Recommend :: Prism' (Recommend a) a

Prism onto a Recommend.

_Commit :: Prism' (Recommend a) a

Prism onto a Commit.

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

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

isCommitted :: Lens' (Recommend a) Bool

Lens onto whether something is committed or not.

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

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.