Data.Path

SVG path manipulation

Svg Paths

Every element of an SVG path can be thought of as exactly two points in space, with instructions of how to draw a curve between them. From this point of view, one which this library adopts, a path chart is thus very similar to a line chart. There's just a lot more information about the style to deal with.

References:

SVG d

SVG path

data PathData a

Representation of a single SVG path data point

Constructors

StartP (Point a)

Starting position

LineP (Point a)

line (from previous position)

CubicP (Point a) (Point a) (Point a)

cubic bezier curve

QuadP (Point a) (Point a)

quad bezier curve

ArcP (ArcInfo a) (Point a)

Instances

Generic (PathData a)

Defined in Data.Path

Associated Types

type Rep (PathData a) :: Type -> Type

Methods

from :: PathData a -> Rep (PathData a) x

to :: Rep (PathData a) x -> PathData a

(Ord a, Additive a, Show a) => Show (PathData a)

Defined in Data.Path

Methods

showsPrec :: Int -> PathData a -> ShowS

show :: PathData a -> String

showList :: [PathData a] -> ShowS

Eq a => Eq (PathData a)

Defined in Data.Path

Methods

(==) :: PathData a -> PathData a -> Bool

(/=) :: PathData a -> PathData a -> Bool

type Rep (PathData a)

Defined in Data.Path

type Rep (PathData a) = D1 ('MetaData "PathData" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) ((C1 ('MetaCons "StartP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a))) :+: C1 ('MetaCons "LineP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)))) :+: (C1 ('MetaCons "CubicP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)))) :+: (C1 ('MetaCons "QuadP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a))) :+: C1 ('MetaCons "ArcP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ArcInfo a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a))))))

pointPath :: PathData a -> Point a

View the Point part of a PathData

movePath :: Additive a => Point a -> PathData a -> PathData a

Move the Point part of a PathData

scalePath :: Multiplicative a => a -> PathData a -> PathData a

Multiplicatively scale a PathData

projectPath :: Rect Double -> Rect Double -> Point Double -> PathData Double -> PathData Double

Project a PathData from one Rect (XY plave) to a new one.

projectPaths :: Rect Double -> Rect Double -> [PathData Double] -> [PathData Double]

Project a list of connected PathDatas from one Rect (XY plave) to a new one.

pathBoxes :: [PathData Double] -> Maybe (Rect Double)

Bounding box for a list of path XYs.

pathBox :: Point Double -> PathData Double -> Rect Double

Bounding box for a path info, start and end Points.

Path maths

data ArcInfo a

Information about an individual arc path.

Constructors

ArcInfo

Fields

• radii :: Point a

  ellipse radii

• phi :: a

  rotation of the ellipse. positive means counter-clockwise (which is different to SVG).

• large :: Bool
• clockwise :: Bool

  sweep means clockwise

Instances

Generic (ArcInfo a)

Defined in Data.Path

Associated Types

type Rep (ArcInfo a) :: Type -> Type

Methods

from :: ArcInfo a -> Rep (ArcInfo a) x

to :: Rep (ArcInfo a) x -> ArcInfo a

(Ord a, Additive a, Show a) => Show (ArcInfo a)

Defined in Data.Path

Methods

showsPrec :: Int -> ArcInfo a -> ShowS

show :: ArcInfo a -> String

showList :: [ArcInfo a] -> ShowS

Eq a => Eq (ArcInfo a)

Defined in Data.Path

Methods

(==) :: ArcInfo a -> ArcInfo a -> Bool

(/=) :: ArcInfo a -> ArcInfo a -> Bool

type Rep (ArcInfo a)

Defined in Data.Path

type Rep (ArcInfo a) = D1 ('MetaData "ArcInfo" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "ArcInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "radii") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "phi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :*: (S1 ('MetaSel ('Just "large") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "clockwise") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data ArcPosition a

Specification of an Arc using positional referencing as per SVG standard.

Constructors

ArcPosition

Fields

• posStart :: Point a
• posEnd :: Point a
• posInfo :: ArcInfo a

Instances

Generic (ArcPosition a)

Defined in Data.Path

Associated Types

type Rep (ArcPosition a) :: Type -> Type

Methods

from :: ArcPosition a -> Rep (ArcPosition a) x

to :: Rep (ArcPosition a) x -> ArcPosition a

(Ord a, Additive a, Show a) => Show (ArcPosition a)

Defined in Data.Path

Methods

showsPrec :: Int -> ArcPosition a -> ShowS

show :: ArcPosition a -> String

showList :: [ArcPosition a] -> ShowS

Eq a => Eq (ArcPosition a)

Defined in Data.Path

Methods

(==) :: ArcPosition a -> ArcPosition a -> Bool

(/=) :: ArcPosition a -> ArcPosition a -> Bool

type Rep (ArcPosition a)

Defined in Data.Path

type Rep (ArcPosition a) = D1 ('MetaData "ArcPosition" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "ArcPosition" 'PrefixI 'True) (S1 ('MetaSel ('Just "posStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: (S1 ('MetaSel ('Just "posEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "posInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ArcInfo a)))))

data ArcCentroid a

Arc specification based on centroidal interpretation.

See: https://www.w3.org/TR/SVG/implnote.html#ArcConversionEndpointToCenter

Constructors

ArcCentroid

Fields

• centroid :: Point a

  ellipse center

• radius :: Point a

  ellipse radii

• cphi :: a

  ellipse rotation

• ang0 :: a

  starting point angle to the x-axis

• angdiff :: a

  difference between ending point angle and starting point angle

Instances

Generic (ArcCentroid a)

Defined in Data.Path

Associated Types

type Rep (ArcCentroid a) :: Type -> Type

Methods

from :: ArcCentroid a -> Rep (ArcCentroid a) x

to :: Rep (ArcCentroid a) x -> ArcCentroid a

(Ord a, Additive a, Show a) => Show (ArcCentroid a)

Defined in Data.Path

Methods

showsPrec :: Int -> ArcCentroid a -> ShowS

show :: ArcCentroid a -> String

showList :: [ArcCentroid a] -> ShowS

Eq a => Eq (ArcCentroid a)

Defined in Data.Path

Methods

(==) :: ArcCentroid a -> ArcCentroid a -> Bool

(/=) :: ArcCentroid a -> ArcCentroid a -> Bool

type Rep (ArcCentroid a)

Defined in Data.Path

type Rep (ArcCentroid a) = D1 ('MetaData "ArcCentroid" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "ArcCentroid" 'PrefixI 'True) ((S1 ('MetaSel ('Just "centroid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "radius") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a))) :*: (S1 ('MetaSel ('Just "cphi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: (S1 ('MetaSel ('Just "ang0") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "angdiff") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))))

arcCentroid :: (Ord a, FromInteger a, TrigField a, ExpField a) => ArcPosition a -> ArcCentroid a

convert from an ArcPosition spec to ArcCentroid spec.

See also this

>>> let p = ArcPosition (Point 0 0) (Point 1 0) (ArcInfo (Point 1 0.5) (pi/4) False True)
>>> arcCentroid p
ArcCentroid {centroid = Point 0.20952624903444356 (-0.48412291827592724), radius = Point 1.0 0.5, cphi = 0.7853981633974483, ang0 = 1.3753858999692936, angdiff = -1.823476581936975}

arcPosition :: (Ord a, Absolute a, TrigField a) => ArcCentroid a -> ArcPosition a

Convert from an ArcCentroid to an ArcPosition specification.

Morally,

arcPosition . arcCentroid == id

Not isomorphic if:

• angle diff is pi and large is True
• radii are less than they should be and thus get scaled up.

arcBox :: ArcPosition Double -> Rect Double

compute the bounding box for an arcBox

let p = ArcPosition (Point 0 0) (Point 1 0) (ArcInfo (Point 1 0.5) (pi/4) False True)
arcBox p

arcDerivs :: Point Double -> Double -> (Double, Double)

Potential arc turning points.

>>> arcDerivs (Point 1 0.5) (pi/4)
(-0.4636476090008061,0.4636476090008062)

ellipse :: (Direction b, Dir b ~ a, Affinity b a, TrigField a) => b -> b -> a -> a -> b

Ellipse formulae

>>> ellipse zero (Point 1 2) (pi/6) pi
Point (-0.8660254037844388) (-0.4999999999999997)

Compare this "elegent" definition from stackexchange

\[\dfrac{((x-h)\cos(A)+(y-k)\sin(A))^2}{a^2}+\dfrac{((x-h) \sin(A)-(y-k) \cos(A))^2}{b^2}=1\]

with the haskell code:

c + (rotate phi |. (r * ray theta))

See also: wolfram

data QuadPosition a

Quadratic bezier curve expressed in positional terms.

Constructors

QuadPosition

Fields

• qposStart :: Point a

  starting point

• qposEnd :: Point a

  ending point

• qposControl :: Point a

  control point

Instances

Generic (QuadPosition a)

Defined in Data.Path

Associated Types

type Rep (QuadPosition a) :: Type -> Type

Methods

from :: QuadPosition a -> Rep (QuadPosition a) x

to :: Rep (QuadPosition a) x -> QuadPosition a

(Ord a, Additive a, Show a) => Show (QuadPosition a)

Defined in Data.Path

Methods

showsPrec :: Int -> QuadPosition a -> ShowS

show :: QuadPosition a -> String

showList :: [QuadPosition a] -> ShowS

Eq a => Eq (QuadPosition a)

Defined in Data.Path

Methods

(==) :: QuadPosition a -> QuadPosition a -> Bool

(/=) :: QuadPosition a -> QuadPosition a -> Bool

type Rep (QuadPosition a)

Defined in Data.Path

type Rep (QuadPosition a) = D1 ('MetaData "QuadPosition" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "QuadPosition" 'PrefixI 'True) (S1 ('MetaSel ('Just "qposStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: (S1 ('MetaSel ('Just "qposEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "qposControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)))))

data QuadPolar a

Quadratic bezier curve with control point expressed in polar terms normalised to the start - end line.

Constructors

QuadPolar

Fields

• qpolStart :: Point a

  starting point

• qpolEnd :: Point a

  ending point

• qpolControl :: Polar a

  control point in terms of distance from and angle to the qp0 - qp2 line

Instances

Generic (QuadPolar a)

Defined in Data.Path

Associated Types

type Rep (QuadPolar a) :: Type -> Type

Methods

from :: QuadPolar a -> Rep (QuadPolar a) x

to :: Rep (QuadPolar a) x -> QuadPolar a

(Ord a, Additive a, Show a) => Show (QuadPolar a)

Defined in Data.Path

Methods

showsPrec :: Int -> QuadPolar a -> ShowS

show :: QuadPolar a -> String

showList :: [QuadPolar a] -> ShowS

Eq a => Eq (QuadPolar a)

Defined in Data.Path

Methods

(==) :: QuadPolar a -> QuadPolar a -> Bool

(/=) :: QuadPolar a -> QuadPolar a -> Bool

type Rep (QuadPolar a)

Defined in Data.Path

type Rep (QuadPolar a) = D1 ('MetaData "QuadPolar" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "QuadPolar" 'PrefixI 'True) (S1 ('MetaSel ('Just "qpolStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: (S1 ('MetaSel ('Just "qpolEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "qpolControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Polar a)))))

quadPosition :: TrigField a => QuadPolar a -> QuadPosition a

Convert from a polar to a positional representation of a quadratic bezier.

quadPosition . quadPolar == id
quadPolar . quadPosition == id

>>> quadPosition $ quadPolar (QuadPosition (Point 0 0) (Point 1 1) (Point 2 (-1)))
QuadPosition {qposStart = Point 0.0 0.0, qposEnd = Point 1.0 1.0, qposControl = Point 2.0 (-0.9999999999999998)}

quadPolar :: (Eq a, TrigField a, ExpField a) => QuadPosition a -> QuadPolar a

Convert from a positional to a polar representation of a cubic bezier.

>>> quadPolar (QuadPosition (Point 0 0) (Point 1 1) (Point 2 (-1)))
QuadPolar {qpolStart = Point 0.0 0.0, qpolEnd = Point 1.0 1.0, qpolControl = Polar {radial = 2.1213203435596424, azimuth = -0.7853981633974483}}

quadBox :: QuadPosition Double -> Rect Double

Bounding box for a QuadPosition

>>> quadBox (QuadPosition (Point 0 0) (Point 1 1) (Point 2 (-1)))
Rect 0.0 1.3333333333333335 (-0.33333333333333337) 1.0

quadBezier :: (FromInteger a, ExpField a) => QuadPosition a -> a -> Point a

The quadratic bezier equation

>>> quadBezier (QuadPosition (Point 0 0) (Point 1 1) (Point 2 (-1))) 0.33333333
Point 0.9999999933333332 (-0.33333333333333326)

quadDerivs :: QuadPosition Double -> [Double]

QuadPosition turning points.

>>> quadDerivs (QuadPosition (Point 0 0) (Point 1 1) (Point 2 (-1)))
[0.6666666666666666,0.3333333333333333]

data CubicPosition a

Cubic bezier curve

Note that the ordering is different to the svg standard.

Constructors

CubicPosition

Fields

• cposStart :: Point a

  starting point

• cposEnd :: Point a

  ending point

• cposControl1 :: Point a

  control point 1

• cposControl2 :: Point a

  control point 2

Instances

Generic (CubicPosition a)

Defined in Data.Path

Associated Types

type Rep (CubicPosition a) :: Type -> Type

Methods

from :: CubicPosition a -> Rep (CubicPosition a) x

to :: Rep (CubicPosition a) x -> CubicPosition a

(Ord a, Additive a, Show a) => Show (CubicPosition a)

Defined in Data.Path

Methods

showsPrec :: Int -> CubicPosition a -> ShowS

show :: CubicPosition a -> String

showList :: [CubicPosition a] -> ShowS

Eq a => Eq (CubicPosition a)

Defined in Data.Path

Methods

(==) :: CubicPosition a -> CubicPosition a -> Bool

(/=) :: CubicPosition a -> CubicPosition a -> Bool

type Rep (CubicPosition a)

Defined in Data.Path

type Rep (CubicPosition a) = D1 ('MetaData "CubicPosition" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "CubicPosition" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cposStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "cposEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a))) :*: (S1 ('MetaSel ('Just "cposControl1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "cposControl2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)))))

data CubicPolar a

A polar representation of a cubic bezier with control points expressed as polar and normalised to the start - end line.

Constructors

CubicPolar

Fields

• cpolStart :: Point a

  starting point

• cpolEnd :: Point a

  ending point

• cpolControl1 :: Polar a

  control point in terms of distance from and angle to the start end line

• cpolControl2 :: Polar a

  control point in terms of distance from and angle to the start end line

Instances

Generic (CubicPolar a)

Defined in Data.Path

Associated Types

type Rep (CubicPolar a) :: Type -> Type

Methods

from :: CubicPolar a -> Rep (CubicPolar a) x

to :: Rep (CubicPolar a) x -> CubicPolar a

(Ord a, Additive a, Show a) => Show (CubicPolar a)

Defined in Data.Path

Methods

showsPrec :: Int -> CubicPolar a -> ShowS

show :: CubicPolar a -> String

showList :: [CubicPolar a] -> ShowS

Eq a => Eq (CubicPolar a)

Defined in Data.Path

Methods

(==) :: CubicPolar a -> CubicPolar a -> Bool

(/=) :: CubicPolar a -> CubicPolar a -> Bool

type Rep (CubicPolar a)

Defined in Data.Path

type Rep (CubicPolar a) = D1 ('MetaData "CubicPolar" "Data.Path" "chart-svg-0.7.0.0-4dcr9v8qVDf788ykYWIDig" 'False) (C1 ('MetaCons "CubicPolar" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cpolStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a)) :*: S1 ('MetaSel ('Just "cpolEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point a))) :*: (S1 ('MetaSel ('Just "cpolControl1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Polar a)) :*: S1 ('MetaSel ('Just "cpolControl2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Polar a)))))

cubicPosition :: (Eq a, TrigField a, ExpField a) => CubicPolar a -> CubicPosition a

Convert from a polar to a positional representation of a cubic bezier.

cubicPosition . cubicPolar == id
cubicPolar . cubicPosition == id

>>> cubicPosition $ cubicPolar (CubicPosition (Point 0 0) (Point 1 1) (Point 1 (-1)) (Point 0 2))
CubicPosition {cposStart = Point 0.0 0.0, cposEnd = Point 1.0 1.0, cposControl1 = Point 1.0 (-1.0), cposControl2 = Point 1.6653345369377348e-16 2.0}

cubicPolar :: (Eq a, ExpField a, TrigField a) => CubicPosition a -> CubicPolar a

Convert from a positional to a polar representation of a cubic bezier.

cubicPosition . cubicPolar == id
cubicPolar . cubicPosition == id

>>> cubicPolar (CubicPosition (Point 0 0) (Point 1 1) (Point 1 (-1)) (Point 0 2))
CubicPolar {cpolStart = Point 0.0 0.0, cpolEnd = Point 1.0 1.0, cpolControl1 = Polar {radial = 1.1180339887498947, azimuth = -1.2490457723982544}, cpolControl2 = Polar {radial = 1.1180339887498947, azimuth = 1.8925468811915387}}

cubicBox :: CubicPosition Double -> Rect Double

Bounding box for a CubicPosition

>>> cubicBox (CubicPosition (Point 0 0) (Point 1 1) (Point 1 (-1)) (Point 0 2))
Rect 0.0 1.0 (-0.20710678118654752) 1.2071067811865475

cubicBezier :: (FromInteger a, TrigField a) => CubicPosition a -> a -> Point a

The cubic bezier equation

>>> cubicBezier (CubicPosition (Point 0 0) (Point 1 1) (Point 1 (-1)) (Point 0 2)) 0.8535533905932737
Point 0.6767766952966369 1.2071067811865475

cubicDerivs :: CubicPosition Double -> [Double]

Turning point positions for a CubicPosition (0,1 or 2)

>>> cubicDerivs (CubicPosition (Point 0 0) (Point 1 1) (Point 1 (-1)) (Point 0 2))
[0.8535533905932737,0.14644660940672624,0.5]

singletonCubic :: CubicPosition Double -> [PathData Double]

Convert cubic position to path data.

singletonQuad :: QuadPosition Double -> [PathData Double]

Convert quad position to path data.

singletonArc :: ArcPosition Double -> [PathData Double]

Convert arc position to path data.

singletonPie :: Point Double -> ArcPosition Double -> [PathData Double]

Convert arc position to a pie slice, with a specific center.