diagrams-lib-1.0.1: Embedded domain-specific language for declarative graphics

Diagrams.TwoD.Align

Description

Alignment combinators specialized for two dimensions. See Diagrams.Align for more general alignment combinators.

The basic idea is that alignment is achieved by moving diagrams' local origins relative to their envelopes or traces (or some other sort of boundary). For example, to align several diagrams along their tops, we first move their local origins to the upper edge of their boundary (using e.g. `map alignTop`), and then put them together with their local origins along a horizontal line (using e.g. `hcat` from Diagrams.TwoD.Combinators).

Synopsis

# Absolute alignment

## Align by envelope

alignL :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Align along the left edge, i.e. translate the diagram in a horizontal direction so that the local origin is on the left edge of the envelope.

alignR :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Align along the right edge.

alignT :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Align along the top edge.

alignB :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Align along the bottom edge.

alignTL :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

alignTR :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

alignBL :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

alignBR :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

## Align by trace

snugL :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugR :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugT :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugB :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugTL :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugTR :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugBL :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugBR :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

# Relative alignment

alignX :: (Alignable a, HasOrigin a, V a ~ R2) => Double -> a -> aSource

`alignX` and `snugX` move the local origin horizontally as follows:

• `alignX (-1)` moves the local origin to the left edge of the boundary;
• `align 1` moves the local origin to the right edge;
• any other argument interpolates linearly between these. For example, `alignX 0` centers, `alignX 2` moves the origin one "radius" to the right of the right edge, and so on.
• `snugX` works the same way.

snugX :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => Double -> a -> aSource

See the documentation for `alignX`.

alignY :: (Alignable a, HasOrigin a, V a ~ R2) => Double -> a -> aSource

Like `alignX`, but moving the local origin vertically, with an argument of `1` corresponding to the top edge and `(-1)` corresponding to the bottom edge.

snugY :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => Double -> a -> aSource

# Centering

centerX :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Center the local origin along the X-axis.

centerY :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Center the local origin along the Y-axis.

centerXY :: (Alignable a, HasOrigin a, V a ~ R2) => a -> aSource

Center along both the X- and Y-axes.

snugCenterX :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugCenterY :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource

snugCenterXY :: (Fractional (Scalar (V a)), Alignable a, Traced a, HasOrigin a, V a ~ R2) => a -> aSource