Graphics.Svg.Types

This module define all the types used in the definition of a svg scene.

Most of the types are lensified.

Basic building types

type Coord = Float

Basic coordiante type.

data Origin

Tell if a path command is absolute (in the current user coordiante) or relative to the previous poitn.

Constructors

OriginAbsolute

Next point in absolute coordinate

OriginRelative

Next point relative to the previous

Instances

Eq Origin

Show Origin

type Point = (Number, Number)

Possibly context dependant point.

type RPoint = V2 Coord

Real Point, fully determined and not dependant of the rendering context.

data PathCommand

Path command definition.

Constructors

MoveTo Origin [RPoint]

M or m command

LineTo Origin [RPoint]

Line to, L or l Svg path command.

HorizontalTo Origin [Coord]

Equivalent to the H or h svg path command.

VerticalTo Origin [Coord]

Equivalent to the V or v svg path command.

CurveTo Origin [(RPoint, RPoint, RPoint)]

Cubic bezier, C or c command

SmoothCurveTo Origin [(RPoint, RPoint)]

Smooth cubic bezier, equivalent to S or s command

QuadraticBezier Origin [(RPoint, RPoint)]

Quadratic bezier, Q or q command

SmoothQuadraticBezierCurveTo Origin [RPoint]

Quadratic bezier, T or t command

ElipticalArc Origin [(Coord, Coord, Coord, Coord, Coord, RPoint)]

Eliptical arc, A or a command.

EndPath

Close the path, Z or z svg path command.

Instances

Eq PathCommand

Show PathCommand

data Transformation

Describe the content of the transformation attribute. see _transform and transform.

Constructors

TransformMatrix Coord Coord Coord Coord Coord Coord

Directly encode the translation matrix.

Translate Float Float

Translation along a vector

Scale Float (Maybe Float)

Scaling on both axis or on X axis and Y axis.

Rotate Float (Maybe (Float, Float))

Rotation around `(0, 0)` or around an optional point.

SkewX Float

Skew transformation along the X axis.

SkewY Float

Skew transformation along the Y axis.

TransformUnknown

Unkown transformation, like identity.

Instances

Eq Transformation

Show Transformation

data ElementRef

Correspond to the possible values of the the attributes which are either none or `url(#elem)`

Constructors

RefNone

Value for none

Ref String

Equivalent to `url()` attribute.

Instances

Eq ElementRef

Show ElementRef

data CoordinateUnits

Define the possible values of various *units attributes used in the definition of the gradients and masks.

Constructors

CoordUserSpace

userSpaceOnUse value

CoordBoundingBox

objectBoundingBox value

Instances

Eq CoordinateUnits

Show CoordinateUnits

Building helpers

toPoint :: Number -> Number -> Point

Little helper function to build a point.

serializeNumber :: Number -> String

Encode the number to string which can be used in a CSS or a svg attributes.

serializeTransformation :: Transformation -> String

Convert the Transformation to a string which can be directly used in a svg attributes.

serializeTransformations :: [Transformation] -> String

Transform a list of transformations to a string for svg transform attributes.

Drawing control types

data Cap

Describe how the line should be terminated when stroking them. Describe the values of the `stroke-linecap` attribute. See _strokeLineCap

Constructors

CapRound

End with a round (round value)

CapButt

Define straight just at the end (butt value)

CapSquare

Straight further of the ends (square value)

Instances

Eq Cap

Show Cap

data LineJoin

Define the possible values of the `stroke-linejoin` attribute. see _strokeLineJoin

Constructors

JoinMiter

miter value

JoinBevel

bevel value

JoinRound

round value

Instances

Eq LineJoin

Show LineJoin

data Tree

Main type for the scene description, reorient to specific type describing each tag.

Constructors

None

UseTree

Fields

useInformation :: !Use

useSubTree :: !(Maybe Tree)

GroupTree !(Group Tree)

SymbolTree !(Symbol Tree)

PathTree !Path

CircleTree !Circle

PolyLineTree !PolyLine

PolygonTree !Polygon

EllipseTree !Ellipse

LineTree !Line

RectangleTree !Rectangle

TextTree !(Maybe TextPath) !Text

ImageTree !Image

Instances

Eq Tree

Show Tree

CssMatcheable Tree

WithDefaultSvg Tree

WithDrawAttributes Tree

data Number

Encode complex number possibly dependant to the current render size.

Constructors

Num Float

Simple coordinate in current user coordinate.

Px Float

With suffix px

Em Float

Number relative to the current font size.

Percent Float

Number relative to the current viewport size.

Pc Float

Mm Float

Number in millimeters, relative to DPI.

Cm Float

Number in centimeters, relative to DPI.

Point Float

Number in points, relative to DPI.

Inches Float

Number in inches, relative to DPI.

Instances

Eq Number

Show Number

data Spread

Define the possible values for the spreadMethod values used for the gradient definitions.

Constructors

SpreadRepeat

reapeat value

SpreadPad

pad value

SpreadReflect

`reflect value`

Instances

Eq Spread

Show Spread

data Texture

Describe the different value which can be used in the fill or stroke attributes.

Constructors

ColorRef PixelRGBA8

Direct solid color (rgb)

TextureRef String

Link to a complex texture (url(#name))

FillNone

Equivalent to the none value.

Instances

Eq Texture

Show Texture

data Element

Sum types helping keeping track of all the namable elemens in a SVG document.

Constructors

ElementLinearGradient LinearGradient

ElementRadialGradient RadialGradient

ElementGeometry Tree

ElementPattern Pattern

ElementMarker Marker

ElementMask Mask

ElementClipPath ClipPath

Instances

Show Element

data FillRule

Describe the possile filling algorithms. Map the values of the `fill-rule` attributes.

Constructors

FillEvenOdd

Correspond to the evenodd value.

FillNonZero

Correspond to the nonzero value.

Instances

Eq FillRule

Show FillRule

data FontStyle

Classify the font style, used to search a matching font in the FontCache.

Constructors

FontStyleNormal

FontStyleItalic

FontStyleOblique

Instances

Eq FontStyle

Show FontStyle

type Dpi = Int

Alias describing a dot per inch information used for size calculation (see toUserUnit).

class WithDefaultSvg a where

Define an empty 'default' element for the SVG tree. It is used as base when parsing the element from XML.

Methods

defaultSvg :: a

The default element.

Instances

WithDefaultSvg DrawAttributes

WithDefaultSvg PolyLine

WithDefaultSvg Polygon

WithDefaultSvg Line

WithDefaultSvg Rectangle

WithDefaultSvg Path

WithDefaultSvg Circle

WithDefaultSvg Ellipse

WithDefaultSvg Image

WithDefaultSvg Use

WithDefaultSvg TextInfo

WithDefaultSvg TextSpan

WithDefaultSvg TextPath

WithDefaultSvg Text

WithDefaultSvg Marker

WithDefaultSvg Tree

WithDefaultSvg GradientStop

WithDefaultSvg LinearGradient

WithDefaultSvg RadialGradient

WithDefaultSvg Mask

WithDefaultSvg ClipPath

WithDefaultSvg Pattern

WithDefaultSvg (Group a)

WithDefaultSvg (Symbol a)

Main type

data Document

Represent a full svg document with style, geometry and named elements.

Constructors

Document

Fields

_viewBox :: Maybe (Int, Int, Int, Int)

_width :: Maybe Number

_height :: Maybe Number

_elements :: [Tree]

_definitions :: Map String Element

_description :: String

_styleRules :: [CssRule]

_documentLocation :: FilePath

Instances

Show Document

HasDocument Document

class HasDocument c where

Lenses associated to a SVG document.

Methods

document :: Lens' c Document

definitions :: Lens' c (Map String Element)

description :: Lens' c String

documentLocation :: Lens' c FilePath

elements :: Lens' c [Tree]

height :: Lens' c (Maybe Number)

styleRules :: Lens' c [CssRule]

viewBox :: Lens' c (Maybe (Int, Int, Int, Int))

width :: Lens' c (Maybe Number)

Instances

HasDocument Document

documentSize :: Dpi -> Document -> (Int, Int)

Calculate the document size in function of the different available attributes in the document.

Drawing attributes

data DrawAttributes

This type define how to draw any primitives, which color to use, how to stroke the primitives and the potential transformations to use.

All these attributes are propagated to the children.

Constructors

DrawAttributes

Fields

_strokeWidth :: !(Last Number)

Attribute corresponding to the `stroke-width` SVG attribute.

_strokeColor :: !(Last Texture)

Correspond to the stroke attribute.

_strokeOpacity :: !(Maybe Float)

Define the `stroke-opacity` attribute, the transparency for the border.

_strokeLineCap :: !(Last Cap)

Correspond to the `stroke-linecap` SVG attribute

_strokeLineJoin :: !(Last LineJoin)

Correspond to the `stroke-linejoin` SVG attribute

_strokeMiterLimit :: !(Last Float)

Define the distance of the miter join, correspond to the `stroke-miterlimit` attritbue.

_fillColor :: !(Last Texture)

Define the filling color of the elements. Corresponding to the fill attribute.

_fillOpacity :: !(Maybe Float)

Define the `fill-opacity` attribute, the transparency for the content.

_transform :: !(Maybe [Transformation])

Content of the transform attribute

_fillRule :: !(Last FillRule)

Define the `fill-rule` used during the rendering.

_maskRef :: !(Last ElementRef)

Define the mask attribute.

_clipPathRef :: !(Last ElementRef)

Define the `clip-path` attribute.

_clipRule :: !(Last FillRule)

Define the `clip-rule` attribute.

_attrClass :: ![Text]

Map to the `class` attribute. Used for the CSS rewriting.

_attrId :: !(Maybe String)

Map to the id attribute. Used for the CSS rewriting.

_strokeOffset :: !(Last Number)

Define the start distance of the dashing pattern. Correspond to the `stroke-dashoffset` attribute.

_strokeDashArray :: !(Last [Number])

Define the dashing pattern for the lines. Correspond to the `stroke-dasharray` attribute.

_fontSize :: !(Last Number)

Current size of the text, correspond to the `font-size` SVG attribute.

_fontFamily :: !(Last [String])

Define the possible fonts to be used for text rendering. Map to the `font-family` attribute.

_fontStyle :: !(Last FontStyle)

Map to the `font-style` attribute.

_textAnchor :: !(Last TextAnchor)

Define how to interpret the text position, correspond to the `text-anchor` attribute.

_markerStart :: !(Last ElementRef)

Define the marker used for the start of the line. Correspond to the `marker-start` attribute.

_markerMid :: !(Last ElementRef)

Define the marker used for every point of the polyline/path Correspond to the `marker-mid` attribute.

_markerEnd :: !(Last ElementRef)

Define the marker used for the end of the line. Correspond to the `marker-end` attribute.

Instances

Eq DrawAttributes

Show DrawAttributes

Monoid DrawAttributes

WithDefaultSvg DrawAttributes

HasDrawAttributes DrawAttributes

class HasDrawAttributes c where

Lenses for the DrawAttributes type.

Methods

drawAttributes :: Lens' c DrawAttributes

attrClass :: Lens' c [Text]

attrId :: Lens' c (Maybe String)

clipPathRef :: Lens' c (Last ElementRef)

clipRule :: Lens' c (Last FillRule)

fillColor :: Lens' c (Last Texture)

fillOpacity :: Lens' c (Maybe Float)

fillRule :: Lens' c (Last FillRule)

fontFamily :: Lens' c (Last [String])

fontSize :: Lens' c (Last Number)

fontStyle :: Lens' c (Last FontStyle)

markerEnd :: Lens' c (Last ElementRef)

markerMid :: Lens' c (Last ElementRef)

markerStart :: Lens' c (Last ElementRef)

maskRef :: Lens' c (Last ElementRef)

strokeColor :: Lens' c (Last Texture)

strokeDashArray :: Lens' c (Last [Number])

strokeLineCap :: Lens' c (Last Cap)

strokeLineJoin :: Lens' c (Last LineJoin)

strokeMiterLimit :: Lens' c (Last Float)

strokeOffset :: Lens' c (Last Number)

strokeOpacity :: Lens' c (Maybe Float)

strokeWidth :: Lens' c (Last Number)

textAnchor :: Lens' c (Last TextAnchor)

transform :: Lens' c (Maybe [Transformation])

Instances

HasDrawAttributes DrawAttributes

class WithDrawAttributes a where

Class helping find the drawing attributes for all the SVG attributes.

Methods

drawAttr :: Lens' a DrawAttributes

Lens which can be used to read/write primitives.

Instances

WithDrawAttributes PolyLine

WithDrawAttributes Polygon

WithDrawAttributes Line

WithDrawAttributes Rectangle

WithDrawAttributes Path

WithDrawAttributes Circle

WithDrawAttributes Ellipse

WithDrawAttributes Image

WithDrawAttributes Use

WithDrawAttributes Text

WithDrawAttributes Marker

WithDrawAttributes Tree

WithDrawAttributes Mask

WithDrawAttributes ClipPath

WithDrawAttributes Pattern

WithDrawAttributes (Group a)

WithDrawAttributes (Symbol a)

SVG drawing primitives

Rectangle

data Rectangle

Define a rectangle. Correspond to `<rectangle>` svg tag.

Constructors

Rectangle

Fields

_rectDrawAttributes :: DrawAttributes

Rectangle drawing attributes.

_rectUpperLeftCorner :: Point

Upper left corner of the rectangle, correspond to the attributes x and y.

_rectWidth :: Number

Rectangle width, correspond, strangely, to the width attribute.

_rectHeight :: Number

Rectangle height, correspond, amazingly, to the height attribute.

_rectCornerRadius :: (Number, Number)

Define the rounded corner radius radius of the rectangle. Correspond to the rx and ry attributes.

Instances

Eq Rectangle

Show Rectangle

WithDefaultSvg Rectangle

WithDrawAttributes Rectangle

HasRectangle Rectangle

class HasRectangle c where

Lenses for the Rectangle type.

Methods

rectangle :: Lens' c Rectangle

rectCornerRadius :: Lens' c (Number, Number)

rectDrawAttributes :: Lens' c DrawAttributes

rectHeight :: Lens' c Number

rectUpperLeftCorner :: Lens' c Point

rectWidth :: Lens' c Number

Instances

HasRectangle Rectangle

Line

data Line

Define a simple line. Correspond to the `<line>` tag.

Constructors

Line

Fields

_lineDrawAttributes :: DrawAttributes

Drawing attributes of line.

_linePoint1 :: Point

First point of the the line, correspond to the x1 and y1 attributes.

_linePoint2 :: Point

Second point of the the line, correspond to the x2 and y2 attributes.

Instances

Eq Line

Show Line

WithDefaultSvg Line

WithDrawAttributes Line

HasLine Line

class HasLine c where

Lenses for the Line type.

Methods

line :: Lens' c Line

lineDrawAttributes :: Lens' c DrawAttributes

linePoint1 :: Lens' c Point

linePoint2 :: Lens' c Point

Instances

HasLine Line

Polygon

data Polygon

Primitive decriving polygon composed of segements. Correspond to the `<polygon>` tag

Constructors

Polygon

Fields

_polygonDrawAttributes :: DrawAttributes

Drawing attributes for the polygon.

_polygonPoints :: [RPoint]

Points of the polygon. Correspond to the points attributes.

Instances

Eq Polygon

Show Polygon

WithDefaultSvg Polygon

WithDrawAttributes Polygon

HasPolygon Polygon

class HasPolygon c where

Lenses for the Polygon type

Methods

polygon :: Lens' c Polygon

polygonDrawAttributes :: Lens' c DrawAttributes

polygonPoints :: Lens' c [RPoint]

Instances

HasPolygon Polygon

Polyline

data PolyLine

This primitive describe an unclosed suite of segments. Correspond to the `<polyline>` tag.

Constructors

PolyLine

Fields

_polyLineDrawAttributes :: DrawAttributes

drawing attributes of the polyline.

_polyLinePoints :: [RPoint]

Geometry definition of the polyline. correspond to the points attribute

Instances

Eq PolyLine

Show PolyLine

WithDefaultSvg PolyLine

WithDrawAttributes PolyLine

HasPolyLine PolyLine

class HasPolyLine c where

Lenses for the PolyLine type.

Methods

polyLine :: Lens' c PolyLine

polyLineDrawAttributes :: Lens' c DrawAttributes

polyLinePoints :: Lens' c [RPoint]

Instances

HasPolyLine PolyLine

Path

data Path

Type mapping the `<path>` svg tag.

Constructors

Path

Fields

_pathDrawAttributes :: DrawAttributes

Drawing attributes of the path.

_pathDefinition :: [PathCommand]

Definition of the path, correspond to the d attributes.

Instances

Eq Path

Show Path

WithDefaultSvg Path

WithDrawAttributes Path

HasPath Path

class HasPath c where

Lenses for the Path type

Methods

path :: Lens' c Path

pathDefinition :: Lens' c [PathCommand]

pathDrawAttributes :: Lens' c DrawAttributes

Instances

HasPath Path

Circle

data Circle

Define a `<circle>`.

Constructors

Circle

Fields

_circleDrawAttributes :: DrawAttributes

Drawing attributes of the circle.

_circleCenter :: Point

Define the center of the circle, describe the cx and cy attributes.

_circleRadius :: Number

Radius of the circle, equivalent to the r attribute.

Instances

Eq Circle

Show Circle

WithDefaultSvg Circle

WithDrawAttributes Circle

HasCircle Circle

class HasCircle c where

Lenses for the Circle type.

Methods

circle :: Lens' c Circle

circleCenter :: Lens' c Point

circleDrawAttributes :: Lens' c DrawAttributes

circleRadius :: Lens' c Number

Instances

HasCircle Circle

Ellipse

data Ellipse

Define an `<ellipse>`

Constructors

Ellipse

Fields

_ellipseDrawAttributes :: DrawAttributes

Drawing attributes of the ellipse.

_ellipseCenter :: Point

Center of the ellipse, map to the cx and cy attributes.

_ellipseXRadius :: Number

Radius along the X axis, map the rx attribute.

_ellipseYRadius :: Number

Radius along the Y axis, map the ry attribute.

Instances

Eq Ellipse

Show Ellipse

WithDefaultSvg Ellipse

WithDrawAttributes Ellipse

HasEllipse Ellipse

class HasEllipse c where

Lenses for the ellipse type.

Methods

ellipse :: Lens' c Ellipse

ellipseCenter :: Lens' c Point

ellipseDrawAttributes :: Lens' c DrawAttributes

ellipseXRadius :: Lens' c Number

ellipseYRadius :: Lens' c Number

Instances

HasEllipse Ellipse

Image

data Image

Define an `<image>` tag.

Constructors

Image

Fields

_imageDrawAttributes :: DrawAttributes

Drawing attributes of the image

_imageCornerUpperLeft :: Point

Position of the image referenced by its upper left corner.

_imageWidth :: Number

Image width

_imageHeight :: Number

Image Height

_imageHref :: String

Image href, pointing to the real image.

Instances

Eq Image

Show Image

WithDefaultSvg Image

WithDrawAttributes Image

HasImage Image

class HasImage c where

Lenses for the Image type.

Methods

image :: Lens' c Image

imageCornerUpperLeft :: Lens' c Point

imageDrawAttributes :: Lens' c DrawAttributes

imageHeight :: Lens' c Number

imageHref :: Lens' c String

imageWidth :: Lens' c Number

Instances

HasImage Image

Use

data Use

Define an `<use>` for a named content. Every named content can be reused in the document using this element.

Constructors

Use

Fields

_useBase :: Point

Position where to draw the used element. Correspond to the x and y attributes.

_useName :: String

Referenced name, correspond to `xlink:href` attribute.

_useWidth :: Maybe Number

Define the width of the region where to place the element. Map to the width attribute.

_useHeight :: Maybe Number

Define the height of the region where to place the element. Map to the height attribute.

_useDrawAttributes :: DrawAttributes

Use draw attributes.

Instances

Eq Use

Show Use

WithDefaultSvg Use

WithDrawAttributes Use

HasUse Use

class HasUse c where

Lenses for the Use type.

Methods

use :: Lens' c Use

useBase :: Lens' c Point

useDrawAttributes :: Lens' c DrawAttributes

useHeight :: Lens' c (Maybe Number)

useName :: Lens' c String

useWidth :: Lens' c (Maybe Number)

Instances

HasUse Use

Grouping primitives

Group

data Group a

Define a SVG group, corresponding `<g>` tag.

Constructors

Group

Fields

_groupDrawAttributes :: !DrawAttributes

Group drawing attributes, propagated to all of its children.

_groupChildren :: ![a]

Content of the group, corresponding to all the tags inside the `<g>` tag.

_groupViewBox :: !(Maybe (Int, Int, Int, Int))

Mapped to the attribute viewBox

Instances

Eq a => Eq (Group a)

Show a => Show (Group a)

WithDefaultSvg (Group a)

WithDrawAttributes (Group a)

HasGroup (Group a0) a0

class HasGroup c a | c -> a where

Lenses associated to the Group type.

Methods

group :: Lens' c (Group a)

groupChildren :: Lens' c [a]

groupDrawAttributes :: Lens' c DrawAttributes

groupViewBox :: Lens' c (Maybe (Int, Int, Int, Int))

Instances

HasGroup (Group a0) a0

Symbol

newtype Symbol a

Define the `<symbol>` tag, equivalent to a named group.

Constructors

Symbol

Fields

_groupOfSymbol :: Group a

Instances

Eq a => Eq (Symbol a)

Show a => Show (Symbol a)

WithDefaultSvg (Symbol a)

WithDrawAttributes (Symbol a)

groupOfSymbol :: forall a a. Iso (Symbol a) (Symbol a) (Group a) (Group a)

Lenses associated with the Symbol type.

Text related types

Text

data Text

Define the global `<tag>` SVG tag.

Constructors

Text

Fields

_textAdjust :: !TextAdjust

Define the lengthAdjust attribute.

_textRoot :: !TextSpan

Root of the text content.

Instances

Eq Text

Show Text

WithDefaultSvg Text

WithDrawAttributes Text

HasText Text

class HasText c where

Lenses for the Text type.

Methods

text :: Lens' c Text

textAdjust :: Lens' c TextAdjust

textRoot :: Lens' c TextSpan

Instances

HasText Text

data TextAnchor

Tell where to anchor the text, where the position given is realative to the text.

Constructors

TextAnchorStart

The text with left aligned, or start at the postion If the point is the * then the text will be printed this way:

  *THE_TEXT_TO_PRINT

Equivalent to the start value.

TextAnchorMiddle

The text is middle aligned, so the text will be at the left and right of the position:

   THE_TEXT*TO_PRINT

Equivalent to the middle value.

TextAnchorEnd

The text is right aligned.

   THE_TEXT_TO_PRINT*

Equivalent to the end value.

Instances

Eq TextAnchor

Show TextAnchor

textAt :: Point -> Text -> Text

Little helper to create a SVG text at a given baseline position.

Text path

data TextPath

Describe the `<textpath>` SVG tag.

Constructors

TextPath

Fields

_textPathStartOffset :: !Number

Define the beginning offset on the path, the startOffset attribute.

_textPathName :: !String

Define the `xlink:href` attribute.

_textPathMethod :: !TextPathMethod

Correspond to the method attribute.

_textPathSpacing :: !TextPathSpacing

Correspond to the spacing attribute.

_textPathData :: ![PathCommand]

Real content of the path.

Instances

Eq TextPath

Show TextPath

WithDefaultSvg TextPath

HasTextPath TextPath

class HasTextPath c where

Lenses for the TextPath type.

Methods

textPath :: Lens' c TextPath

textPathData :: Lens' c [PathCommand]

textPathMethod :: Lens' c TextPathMethod

textPathName :: Lens' c String

textPathSpacing :: Lens' c TextPathSpacing

textPathStartOffset :: Lens' c Number

Instances

HasTextPath TextPath

data TextPathSpacing

Describe the content of the spacing text path attribute.

Constructors

TextPathSpacingExact

Map to the exact value.

TextPathSpacingAuto

Map to the auto value.

Instances

Eq TextPathSpacing

Show TextPathSpacing

data TextPathMethod

Describe the content of the method attribute on text path.

Constructors

TextPathAlign

Map to the align value.

TextPathStretch

Map to the stretch value.

Instances

Eq TextPathMethod

Show TextPathMethod

Text span.

data TextSpanContent

Define the content of a `<tspan>` tag.

Constructors

SpanText !Text

Raw text

SpanTextRef !String

Equivalent to a `<tref>`

SpanSub !TextSpan

Define a `<tspan>`

Instances

Eq TextSpanContent

Show TextSpanContent

data TextSpan

Define a `<tspan>` tag.

Constructors

TextSpan

Fields

_spanInfo :: !TextInfo

Placing information for the text.

_spanDrawAttributes :: !DrawAttributes

Drawing attributes for the text span.

_spanContent :: ![TextSpanContent]

Content of the span.

Instances

Eq TextSpan

Show TextSpan

WithDefaultSvg TextSpan

HasTextSpan TextSpan

class HasTextSpan c where

Lenses for the TextSpan type.

Methods

textSpan :: Lens' c TextSpan

spanContent :: Lens' c [TextSpanContent]

spanDrawAttributes :: Lens' c DrawAttributes

spanInfo :: Lens' c TextInfo

Instances

HasTextSpan TextSpan

data TextInfo

Define position information associated to `<text>` or `<tspan>` svg tag.

Constructors

TextInfo

Fields

_textInfoX :: ![Number]

x attribute.

_textInfoY :: ![Number]

y attribute.

_textInfoDX :: ![Number]

dx attribute.

_textInfoDY :: ![Number]

dy attribute.

_textInfoRotate :: ![Float]

rotate attribute.

_textInfoLength :: !(Maybe Number)

textLength attribute.

Instances

Eq TextInfo

Show TextInfo

Monoid TextInfo

WithDefaultSvg TextInfo

HasTextInfo TextInfo

class HasTextInfo c where

Lenses for the TextInfo type.

Methods

textInfo :: Lens' c TextInfo

textInfoDX :: Lens' c [Number]

textInfoDY :: Lens' c [Number]

textInfoLength :: Lens' c (Maybe Number)

textInfoRotate :: Lens' c [Float]

textInfoX :: Lens' c [Number]

textInfoY :: Lens' c [Number]

Instances

HasTextInfo TextInfo

data TextAdjust

Define the possible values of the lengthAdjust attribute.

Constructors

TextAdjustSpacing

Value spacing

TextAdjustSpacingAndGlyphs

Value spacingAndGlyphs

Instances

Eq TextAdjust

Show TextAdjust

Marker definition

data Marker

Define the `<marker>` tag.

Constructors

Marker

Fields

_markerDrawAttributes :: DrawAttributes

Draw attributes of the marker.

_markerRefPoint :: (Number, Number)

Define the reference point of the marker. correspond to the refX and refY attributes.

_markerWidth :: Maybe Number

Define the width of the marker. Correspond to the markerWidth attribute.

_markerHeight :: Maybe Number

Define the height of the marker. Correspond to the markerHeight attribute.

_markerOrient :: Maybe MarkerOrientation

Correspond to the orient attribute.

_markerUnits :: Maybe MarkerUnit

Map the markerUnits attribute.

_markerViewBox :: !(Maybe (Int, Int, Int, Int))

Optional viewbox

_markerElements :: [Tree]

Elements defining the marker.

Instances

Eq Marker

Show Marker

WithDefaultSvg Marker

WithDrawAttributes Marker

HasMarker Marker

data MarkerOrientation

Define the orientation, associated to the orient attribute on the Marker

Constructors

OrientationAuto

Auto value

OrientationAngle Coord

Specific angle.

Instances

Eq MarkerOrientation

Show MarkerOrientation

data MarkerUnit

Define the content of the markerUnits attribute on the Marker.

Constructors

MarkerUnitStrokeWidth

Value strokeWidth

MarkerUnitUserSpaceOnUse

Value userSpaceOnUse

Instances

Eq MarkerUnit

Show MarkerUnit

class HasMarker c where

Lenses for the Marker type.

Methods

marker :: Lens' c Marker

markerDrawAttributes :: Lens' c DrawAttributes

markerElements :: Lens' c [Tree]

markerHeight :: Lens' c (Maybe Number)

markerOrient :: Lens' c (Maybe MarkerOrientation)

markerRefPoint :: Lens' c (Number, Number)

markerUnits :: Lens' c (Maybe MarkerUnit)

markerViewBox :: Lens' c (Maybe (Int, Int, Int, Int))

markerWidth :: Lens' c (Maybe Number)

Instances

HasMarker Marker

Gradient definition

data GradientStop

Define a color stop for the gradients. Represent the `<stop>` SVG tag.

Constructors

GradientStop

Fields

_gradientOffset :: Float

Gradient offset between 0 and 1, correspond to the offset attribute.

_gradientColor :: PixelRGBA8

Color of the gradient stop. Correspond to the `stop-color` attribute.

Instances

Eq GradientStop

Show GradientStop

WithDefaultSvg GradientStop

HasGradientStop GradientStop

class HasGradientStop c where

Lenses for the GradientStop type.

Methods

gradientStop :: Lens' c GradientStop

gradientColor :: Lens' c PixelRGBA8

gradientOffset :: Lens' c Float

Instances

HasGradientStop GradientStop

Linear Gradient

data LinearGradient

Define a `<linearGradient>` tag.

Constructors

LinearGradient

Fields

_linearGradientUnits :: CoordinateUnits

Define coordinate system of the gradient, associated to the gradientUnits attribute.

_linearGradientStart :: Point

Point defining the beginning of the line gradient. Associated to the x1 and y1 attribute.

_linearGradientStop :: Point

Point defining the end of the line gradient. Associated to the x2 and y2 attribute.

_linearGradientSpread :: Spread

Define how to handle the values outside the gradient start and stop. Associated to the spreadMethod attribute.

_linearGradientTransform :: [Transformation]

Define the transformation to apply to the gradient points. Associated to the gradientTransform attribute.

_linearGradientStops :: [GradientStop]

List of color stops of the linear gradient.

Instances

Eq LinearGradient

Show LinearGradient

WithDefaultSvg LinearGradient

HasLinearGradient LinearGradient

class HasLinearGradient c where

Lenses for the LinearGradient type.

Methods

linearGradient :: Lens' c LinearGradient

linearGradientSpread :: Lens' c Spread

linearGradientStart :: Lens' c Point

linearGradientStop :: Lens' c Point

linearGradientStops :: Lens' c [GradientStop]

linearGradientTransform :: Lens' c [Transformation]

linearGradientUnits :: Lens' c CoordinateUnits

Instances

HasLinearGradient LinearGradient

Radial Gradient

data RadialGradient

Define a `<radialGradient>` tag.

Constructors

RadialGradient

Fields

_radialGradientUnits :: CoordinateUnits

Define coordinate system of the gradient, associated to the gradientUnits attribute.

_radialGradientCenter :: Point

Center of the radial gradient. Associated to the cx and cy attributes.

_radialGradientRadius :: Number

Radius of the radial gradient. Associated to the r attribute.

_radialGradientFocusX :: Maybe Number

X coordinate of the focus point of the radial gradient. Associated to the fx attribute.

_radialGradientFocusY :: Maybe Number

Y coordinate of the focus point of the radial gradient. Associated to the fy attribute.

_radialGradientSpread :: Spread

Define how to handle the values outside the gradient start and stop. Associated to the spreadMethod attribute.

_radialGradientTransform :: [Transformation]

Define the transformation to apply to the gradient points. Associated to the gradientTransform attribute.

_radialGradientStops :: [GradientStop]

List of color stops of the radial gradient.

Instances

Eq RadialGradient

Show RadialGradient

WithDefaultSvg RadialGradient

HasRadialGradient RadialGradient

class HasRadialGradient c where

Lenses for the RadialGradient type.

Methods

radialGradient :: Lens' c RadialGradient

radialGradientCenter :: Lens' c Point

radialGradientFocusX :: Lens' c (Maybe Number)

radialGradientFocusY :: Lens' c (Maybe Number)

radialGradientRadius :: Lens' c Number

radialGradientSpread :: Lens' c Spread

radialGradientStops :: Lens' c [GradientStop]

radialGradientTransform :: Lens' c [Transformation]

radialGradientUnits :: Lens' c CoordinateUnits

Instances

HasRadialGradient RadialGradient

Pattern definition

data Pattern

Define a `<pattern>` tag.

Constructors

Pattern

Fields

_patternDrawAttributes :: DrawAttributes

Pattern drawing attributes.

_patternViewBox :: Maybe (Int, Int, Int, Int)

Possible viewBox.

_patternWidth :: Number

Width of the pattern tile, mapped to the width attribute

_patternHeight :: Number

Height of the pattern tile, mapped to the height attribute

_patternPos :: Point

Pattern tile base, mapped to the x and y attributes.

_patternElements :: [Tree]

Elements used in the pattern.

_patternUnit :: CoordinateUnits

Define the cordinate system to use for the pattern. Mapped to the patternUnits attribute.

Instances

Show Pattern

WithDefaultSvg Pattern

WithDrawAttributes Pattern

HasPattern Pattern

class HasPattern c where

Lenses for the Patter type.

Methods

pattern :: Lens' c Pattern

patternDrawAttributes :: Lens' c DrawAttributes

patternElements :: Lens' c [Tree]

patternHeight :: Lens' c Number

patternPos :: Lens' c Point

patternUnit :: Lens' c CoordinateUnits

patternViewBox :: Lens' c (Maybe (Int, Int, Int, Int))

patternWidth :: Lens' c Number

Instances

HasPattern Pattern

Mask definition

data Mask

Define a SVG `<mask>` tag.

Constructors

Mask

Fields

_maskDrawAttributes :: DrawAttributes

Drawing attributes of the Mask

_maskContentUnits :: CoordinateUnits

Correspond to the maskContentUnits attributes.

_maskUnits :: CoordinateUnits

Mapping to the maskUnits attribute.

_maskPosition :: Point

Map to the x and y attributes.

_maskWidth :: Number

Map to the width attribute

_maskHeight :: Number

Map to the height attribute.

_maskContent :: [Tree]

Children of the `<mask>` tag.

Instances

Eq Mask

Show Mask

WithDefaultSvg Mask

WithDrawAttributes Mask

HasMask Mask

class HasMask c where

Lenses for the Mask type.

Methods

mask :: Lens' c Mask

maskContent :: Lens' c [Tree]

maskContentUnits :: Lens' c CoordinateUnits

maskDrawAttributes :: Lens' c DrawAttributes

maskHeight :: Lens' c Number

maskPosition :: Lens' c Point

maskUnits :: Lens' c CoordinateUnits

maskWidth :: Lens' c Number

Instances

HasMask Mask

Clip path definition

data ClipPath

Define a `<clipPath>` tag.

Constructors

ClipPath

Fields

_clipPathDrawAttributes :: DrawAttributes

_clipPathUnits :: CoordinateUnits

Maps to the clipPathUnits attribute

_clipPathContent :: [Tree]

Maps to the content of the tree

Instances

Eq ClipPath

Show ClipPath

WithDefaultSvg ClipPath

WithDrawAttributes ClipPath

HasClipPath ClipPath

class HasClipPath c where

Lenses for the ClipPath type.

Methods

clipPath :: Lens' c ClipPath

clipPathContent :: Lens' c [Tree]

clipPathDrawAttributes :: Lens' c DrawAttributes

clipPathUnits :: Lens' c CoordinateUnits

Instances

HasClipPath ClipPath

MISC functions

isPathArc :: PathCommand -> Bool

Tell if the path command is an ElipticalArc.

isPathWithArc :: Foldable f => f PathCommand -> Bool

Tell if a full path contain an ElipticalArc.

nameOfTree :: Tree -> Text

For every element of a svg tree, associate it's SVG tag name.

zipTree :: ([[Tree]] -> Tree) -> Tree -> Tree

Map a tree while propagating context information. The function passed in parameter receive a list representing the the path used to go arrive to the current node.

mapTree :: (Tree -> Tree) -> Tree -> Tree

Helper function mapping every tree element.

foldTree :: (a -> Tree -> a) -> a -> Tree -> a

Fold all nodes of a SVG tree.

toUserUnit :: Dpi -> Number -> Number

This function replace all device dependant units to user units given it's DPI configuration. Preserve percentage and em notation.

mapNumber :: (Float -> Float) -> Number -> Number

Helper function to modify inner value of a number