Text.LaTeX.Packages.TikZ.Syntax

This module defines the syntax of a TikZ script.

To generate a TikZ script, first create a TPath using data constructors, or alternatively, use a PathBuilder from the Text.LaTeX.Packages.TikZ.PathBuilder module.

Once a TPath is created, use path to render a picture from it. Use scope to apply some parameters to your picture, such line width or color.

Points

data TPoint

A point in TikZ.

Instances

Show TPoint

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> TPoint -> ShowS

show :: TPoint -> String

showList :: [TPoint] -> ShowS

Render TPoint

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: TPoint -> Text

pointAt :: Measure -> Measure -> TPoint

Point using Measures for coordinantes.

pointAtXY :: Double -> Double -> TPoint

Point using numbers as coordinates.

pointAtXYZ :: Double -> Double -> Double -> TPoint

Three-dimensional point.

relPoint :: TPoint -> TPoint

Makes a point relative to the previous.

relPoint_ :: TPoint -> TPoint

Paths

Types

data TPath

Type for TikZ paths. Every TPath has two fundamental points: the starting point and the last point. The starting point is set using the Start constructor. The last point then is modified by the other constructors. Below a explanation of each one of them. Note that both starting point and last point may coincide. You can use the functions startingPoint and lastPoint to calculate them. After creating a TPath, use path to do something useful with it.

Constructors

Start TPoint

Let y = Start p.

Operation: Set the starting point of a path.

Last point: The last point of y is p.

Cycle TPath

Let y = Cycle x.

Operation: Close a path with a line from the last point of x to the starting point of x.

Last point: The last point of y is the starting point of x.

Line TPath TPoint

Let y = Line x p.

Operation: Extend the current path from the last point of x in a straight line to p.

Last point: The last point of y is p.

Rectangle TPath TPoint

Let y = Rectangle x p.

Operation: Define a rectangle using the last point of x as one corner and p as the another corner.

Last point: The last point of y is p.

Circle TPath Double

Let y = Circle x r.

Operation: Define a circle with center at the last point of x and radius r.

Last point: The last point of y is the same as the last point of x.

Ellipse TPath Double Double

Let y = Ellipse x r1 r2.

Operation: Define a ellipse with center at the last point of x, width the double of r1 and height the double of r2.

Last point: The last point of y is the same as the last point of x.

Grid TPath [GridOption] TPoint

Node TPath LaTeX

Let y = Node x l.

Operation: Set a text centered at the last point of x.

Last point: The last point of y is the same as the last point of x.

Instances

Show TPath

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> TPath -> ShowS

show :: TPath -> String

showList :: [TPath] -> ShowS

Render TPath

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: TPath -> Text

newtype GridOption

Constructors

GridStep Step

Instances

Show GridOption

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> GridOption -> ShowS

show :: GridOption -> String

showList :: [GridOption] -> ShowS

Render GridOption

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: GridOption -> Text

data Step

Constructors

DimStep Measure

XYStep Double

PointStep TPoint

Instances

Show Step

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> Step -> ShowS

show :: Step -> String

showList :: [Step] -> ShowS

Render Step

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: Step -> Text

Critical points

startingPoint :: TPath -> TPoint

Calculate the starting point of a TPath.

lastPoint :: TPath -> TPoint

Calculate the last point of a TPath.

Functions

(->-) :: TPath -> TPoint -> TPath

Alias of Line.

Parameters

data Parameter

Parameters to use in a scope to change how things are rendered within that scope.

Constructors

TWidth Measure

TColor TikZColor

TScale Double

TRotate Double

Angle is in degrees.

Instances

Show Parameter

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

Render Parameter

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: Parameter -> Text

data TikZColor

Color models accepted by TikZ.

Constructors

BasicColor Color

RGBColor Word8 Word8 Word8

Instances

Show TikZColor

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> TikZColor -> ShowS

show :: TikZColor -> String

showList :: [TikZColor] -> ShowS

Render TikZColor

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: TikZColor -> Text

data Color

Basic colors.

Constructors

Red

Green

Blue

Yellow

Cyan

Magenta

Black

White

Instances

Show Color

Defined in Text.LaTeX.Packages.Color

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Render Color

Defined in Text.LaTeX.Packages.Color

Methods

render :: Color -> Text

data Word8

8-bit unsigned integer type

Instances

Bounded Word8

Since: base-2.1

Defined in GHC.Word

Methods

minBound :: Word8

maxBound :: Word8

Enum Word8

Since: base-2.1

Defined in GHC.Word

Methods

succ :: Word8 -> Word8

pred :: Word8 -> Word8

toEnum :: Int -> Word8

fromEnum :: Word8 -> Int

enumFrom :: Word8 -> [Word8]

enumFromThen :: Word8 -> Word8 -> [Word8]

enumFromTo :: Word8 -> Word8 -> [Word8]

enumFromThenTo :: Word8 -> Word8 -> Word8 -> [Word8]

Eq Word8

Since: base-2.1

Defined in GHC.Word

Methods

(==) :: Word8 -> Word8 -> Bool

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

Integral Word8

Since: base-2.1

Defined in GHC.Word

Methods

quot :: Word8 -> Word8 -> Word8

rem :: Word8 -> Word8 -> Word8

div :: Word8 -> Word8 -> Word8

mod :: Word8 -> Word8 -> Word8

quotRem :: Word8 -> Word8 -> (Word8, Word8)

divMod :: Word8 -> Word8 -> (Word8, Word8)

toInteger :: Word8 -> Integer

Data Word8

Since: base-4.0.0.0

Defined in Data.Data

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word8 -> c Word8

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word8

toConstr :: Word8 -> Constr

dataTypeOf :: Word8 -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Word8)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word8)

gmapT :: (forall b. Data b => b -> b) -> Word8 -> Word8

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word8 -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word8 -> r

gmapQ :: (forall d. Data d => d -> u) -> Word8 -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Word8 -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word8 -> m Word8

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word8 -> m Word8

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word8 -> m Word8

Num Word8

Since: base-2.1

Defined in GHC.Word

Methods

(+) :: Word8 -> Word8 -> Word8

(-) :: Word8 -> Word8 -> Word8

(*) :: Word8 -> Word8 -> Word8

negate :: Word8 -> Word8

abs :: Word8 -> Word8

signum :: Word8 -> Word8

fromInteger :: Integer -> Word8

Ord Word8

Since: base-2.1

Defined in GHC.Word

Methods

compare :: Word8 -> Word8 -> Ordering

(<) :: Word8 -> Word8 -> Bool

(<=) :: Word8 -> Word8 -> Bool

(>) :: Word8 -> Word8 -> Bool

(>=) :: Word8 -> Word8 -> Bool

max :: Word8 -> Word8 -> Word8

min :: Word8 -> Word8 -> Word8

Read Word8

Since: base-2.1

Defined in GHC.Read

Methods

readsPrec :: Int -> ReadS Word8

readList :: ReadS [Word8]

readPrec :: ReadPrec Word8

readListPrec :: ReadPrec [Word8]

Real Word8

Since: base-2.1

Defined in GHC.Word

Methods

toRational :: Word8 -> Rational

Show Word8

Since: base-2.1

Defined in GHC.Word

Methods

showsPrec :: Int -> Word8 -> ShowS

show :: Word8 -> String

showList :: [Word8] -> ShowS

Ix Word8

Since: base-2.1

Defined in GHC.Word

Methods

range :: (Word8, Word8) -> [Word8]

index :: (Word8, Word8) -> Word8 -> Int

unsafeIndex :: (Word8, Word8) -> Word8 -> Int

inRange :: (Word8, Word8) -> Word8 -> Bool

rangeSize :: (Word8, Word8) -> Int

unsafeRangeSize :: (Word8, Word8) -> Int

Lift Word8

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Word8 -> Q Exp

Function Word8

Defined in Test.QuickCheck.Function

Methods

function :: (Word8 -> b) -> Word8 :-> b

Arbitrary Word8

Defined in Test.QuickCheck.Arbitrary

Methods

arbitrary :: Gen Word8

shrink :: Word8 -> [Word8]

CoArbitrary Word8

Defined in Test.QuickCheck.Arbitrary

Methods

coarbitrary :: Word8 -> Gen b -> Gen b

Bits Word8

Since: base-2.1

Defined in GHC.Word

Methods

(.&.) :: Word8 -> Word8 -> Word8

(.|.) :: Word8 -> Word8 -> Word8

xor :: Word8 -> Word8 -> Word8

complement :: Word8 -> Word8

shift :: Word8 -> Int -> Word8

rotate :: Word8 -> Int -> Word8

zeroBits :: Word8

bit :: Int -> Word8

setBit :: Word8 -> Int -> Word8

clearBit :: Word8 -> Int -> Word8

complementBit :: Word8 -> Int -> Word8

testBit :: Word8 -> Int -> Bool

bitSizeMaybe :: Word8 -> Maybe Int

bitSize :: Word8 -> Int

isSigned :: Word8 -> Bool

shiftL :: Word8 -> Int -> Word8

unsafeShiftL :: Word8 -> Int -> Word8

shiftR :: Word8 -> Int -> Word8

unsafeShiftR :: Word8 -> Int -> Word8

rotateL :: Word8 -> Int -> Word8

rotateR :: Word8 -> Int -> Word8

popCount :: Word8 -> Int

FiniteBits Word8

Since: base-4.6.0.0

Defined in GHC.Word

Methods

finiteBitSize :: Word8 -> Int

countLeadingZeros :: Word8 -> Int

countTrailingZeros :: Word8 -> Int

Hashable Word8

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> Word8 -> Int

hash :: Word8 -> Int

Pretty Word8

Defined in Data.Text.Prettyprint.Doc.Internal

Methods

pretty :: Word8 -> Doc ann

prettyList :: [Word8] -> Doc ann

Random Word8

Defined in System.Random

Methods

randomR :: RandomGen g => (Word8, Word8) -> g -> (Word8, g)

random :: RandomGen g => g -> (Word8, g)

randomRs :: RandomGen g => (Word8, Word8) -> g -> [Word8]

randoms :: RandomGen g => g -> [Word8]

randomRIO :: (Word8, Word8) -> IO Word8

randomIO :: IO Word8

Render Word8

Defined in Text.LaTeX.Base.Render

Methods

render :: Word8 -> Text

TikZ

data TikZ

A TikZ script.

Instances

Show TikZ

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> TikZ -> ShowS

show :: TikZ -> String

showList :: [TikZ] -> ShowS

Render TikZ

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: TikZ -> Text

emptytikz :: TikZ

Just an empty script.

path :: [ActionType] -> TPath -> TikZ

A path can be used in different ways.

• Draw: Just draw the path.
• Fill: Fill the area inside the path.
• Clip: Clean everything outside the path.
• Shade: Shade the area inside the path.

It is possible to stack different effects in the list.

Example of usage:

path [Draw] $ Start (pointAtXY 0 0) ->- pointAtXY 1 1

Most common usages are exported as functions. See draw, fill, clip, shade, filldraw and shadedraw.

scope :: [Parameter] -> TikZ -> TikZ

Applies a scope to a TikZ script.

data ActionType

Different types of actions that can be performed with a TPath. See path for more information.

Constructors

Draw

Fill

Clip

Shade

Instances

Show ActionType

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

showsPrec :: Int -> ActionType -> ShowS

show :: ActionType -> String

showList :: [ActionType] -> ShowS

Render ActionType

Defined in Text.LaTeX.Packages.TikZ.Syntax

Methods

render :: ActionType -> Text

(->>) :: TikZ -> TikZ -> TikZ

Sequence two TikZ scripts.

Sugar

draw :: TPath -> TikZ

Equivalent to path [Draw].

fill :: TPath -> TikZ

Equivalent to path [Fill].

clip :: TPath -> TikZ

Equivalent to path [Clip].

shade :: TPath -> TikZ

Equivalent to path [Shade].

filldraw :: TPath -> TikZ

Equivalent to path [Fill,Draw].

shadedraw :: TPath -> TikZ

Equivalent to path [Shade,Draw].