Chart

A haskell Charting library targetting SVGs

Usage

>>> import Chart

chart-svg works well with NumHask.Prelude and Control.Lens but neither are necessary.

>>> :set -XOverloadedLabels
>>> :set -XNoImplicitPrelude
>>> import Control.Lens
>>> import NumHask.Prelude

Overview

Charting consists of three highly-coupled conceptual layers:

1. the data to be represented.
2. how the data will be represented on a screen, and.
3. the creation of visual aids that help interpret the data; such as axes, gridlines and titles.

What is a Chart?

A Chart in this library consists of a specification of the first two items in the above list; data and data annotation.

• XY: a list of values, specified as either 2D points or rectangles.
• Annotation: a description of how the data should be represented on the screen.

>>> :t Chart
Chart :: Annotation -> [XY a] -> Chart a

What exactly is annotation and what is data is highly variant within charting practice. This construction treats position on the XY plane differently from other quantitative manifests such as color and size. The chief advantage of priveliging XY position is that scaling and integrating data with other chart elements becomes much easier. The disadvantage is that, to use quantitative tools such as size, data needs to be consciously separated into that which is position-orientated, and that which is defined as Annotation.

Here's some data; three lists of points that will form a line:

>>> let xs = fmap (fmap (uncurry Point)) [[(0.0, 1.0), (1.0, 1.0), (2.0, 5.0)], [(0.0, 0.0), (3.2, 3.0)], [(0.5, 4.0), (0.5, 0)]] :: [[Point Double]]

and an Annotation to describe representation of this data; three line styles with different colors and widths:

>>> let anns = zipWith (\w c -> LineA (LineStyle w c Nothing Nothing Nothing Nothing)) [0.015, 0.03, 0.01] palette1

and this is enough to create a Chart.

>>> let lineExample = mempty & (#chartList .~ zipWith Chart anns (fmap (fmap PointXY) xs)) & #hudOptions .~ defaultHudOptions & #svgOptions .~ defaultSvgOptions :: ChartSvg
>>> :t lineExample
lineExample :: ChartSvg

Most charts will, in reality, be a list of charts such as this, and much of the library API is designed for this.

writeChartSvg "other/lines.svg" lineExample

chart-svg takes inspiration from gaming heads-up display aesthetics. Chart decorations such as titles and axes are tools to interpret the landscape of data being viewed. They should be readily transparent, have sane defaults but be fully configurable.

The library considers a hud to be a recipe for the creation of a Chart list, but with the physical, on-the-page representation of the data in mind.

Here is the line chart presented with default hud options.

writeChartSvgHud "other/lineshud.svg" lineChart

Hud creation is a process of integrating the data domain and the physical representation. In the chart above, for example, the axis placement takes into account the physical attributes of the thick blue line which extends slightly beyond the abstract data range. The data area (the canvas) has also been extended so that a tick value (3.5 on the x-axis) can be included.

Beyond this, there is nothing special about hud elements such as tick marks and titles, axes. Once they are created (with runHudWith) they themselves become charts.

Chart

data Chart a

A Chart is annotated xy-data.

Constructors

Chart

Fields

• annotation :: Annotation

  annotation style for the data

• xys :: [XY a]

  list of data elements, either points or rectangles.

Instances

Eq a => Eq (Chart a)

Defined in Chart.Types

Methods

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

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

Show a => Show (Chart a)

Defined in Chart.Types

Methods

showsPrec :: Int -> Chart a -> ShowS

show :: Chart a -> String

showList :: [Chart a] -> ShowS

Generic (Chart a)

Defined in Chart.Types

Associated Types

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

Methods

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

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

type Rep (Chart a)

Defined in Chart.Types

type Rep (Chart a) = D1 ('MetaData "Chart" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "Chart" 'PrefixI 'True) (S1 ('MetaSel ('Just "annotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Annotation) :*: S1 ('MetaSel ('Just "xys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [XY a])))

moveChart :: Additive a => XY a -> [Chart a] -> [Chart a]

Translate the data in a chart.

projectXYs :: Rect Double -> [Chart Double] -> [Chart Double]

Project the xys of a chart to a new XY Space.

projectXYs (dataBox cs) cs == cs if cs is non-empty

projectXYsWith :: Rect Double -> Rect Double -> [Chart Double] -> [Chart Double]

Project chart xys to a new XY Space from an old XY Space

The projections needed are:

• project the $sel:xys:Chart
• project the control points of bezier curves
• project aspect changes only to radii of ellipticals.

projectXYsWith x x == id

projectArcPosition :: Rect Double -> Rect Double -> ArcPosition Double -> ArcInfo Double

project an ArcPosition given new and old Rects

The radii of the ellipse can be represented as:

Point rx 0 & Point 0 ry

These two points are firstly rotated by p and then undergo scaling...

Annotation

data Annotation

How data will be represented onscreen.

The definition of what might be an Annotation type is opinionated.

More complex combinations across Annotations can be constructed from combining charts. See glinesExample, lglyphExample and Chart.Bar for examples.

There may be exceptions, but the approximate magnitude of annotation values are in reference to the size of the screen. For example, a size of 0.01 (say), will means about 1% of the height and/or width of the screen height or width.

Constructors

RectA RectStyle

TextA TextStyle [Text]

GlyphA GlyphStyle

LineA LineStyle

PathA PathStyle [PathInfo Double]

BlankA

Instances

Eq Annotation

Defined in Chart.Types

Methods

(==) :: Annotation -> Annotation -> Bool

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

Show Annotation

Defined in Chart.Types

Methods

showsPrec :: Int -> Annotation -> ShowS

show :: Annotation -> String

showList :: [Annotation] -> ShowS

Generic Annotation

Defined in Chart.Types

Associated Types

type Rep Annotation :: Type -> Type

Methods

from :: Annotation -> Rep Annotation x

to :: Rep Annotation x -> Annotation

type Rep Annotation

Defined in Chart.Types

type Rep Annotation = D1 ('MetaData "Annotation" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) ((C1 ('MetaCons "RectA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RectStyle)) :+: (C1 ('MetaCons "TextA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextStyle) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])) :+: C1 ('MetaCons "GlyphA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GlyphStyle)))) :+: (C1 ('MetaCons "LineA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LineStyle)) :+: (C1 ('MetaCons "PathA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PathStyle) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PathInfo Double])) :+: C1 ('MetaCons "BlankA" 'PrefixI 'False) (U1 :: Type -> Type))))

annotationText :: Annotation -> Text

textifier

scaleAnn :: Double -> Annotation -> Annotation

Generically scale an Annotation.

scaleOpacAnn :: Double -> Annotation -> Annotation

dim (or brighten) the opacity of an Annotation by a scale

colourAnn :: Colour -> Annotation -> Annotation

select a main colour

padRect :: Num a => a -> Rect a -> Rect a

additive padding

Styles

data RectStyle

Rectangle styling

>>> defaultRectStyle
RectStyle {borderSize = 1.0e-2, borderColor = Colour 0.65 0.81 0.89 1.00, color = Colour 0.12 0.47 0.71 1.00}

Constructors

RectStyle

Fields

• borderSize :: Double
• borderColor :: Colour
• color :: Colour

Instances

Eq RectStyle

Defined in Chart.Types

Methods

(==) :: RectStyle -> RectStyle -> Bool

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

Show RectStyle

Defined in Chart.Types

Methods

showsPrec :: Int -> RectStyle -> ShowS

show :: RectStyle -> String

showList :: [RectStyle] -> ShowS

Generic RectStyle

Defined in Chart.Types

Associated Types

type Rep RectStyle :: Type -> Type

Methods

from :: RectStyle -> Rep RectStyle x

to :: Rep RectStyle x -> RectStyle

type Rep RectStyle

Defined in Chart.Types

type Rep RectStyle = D1 ('MetaData "RectStyle" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "RectStyle" 'PrefixI 'True) (S1 ('MetaSel ('Just "borderSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "borderColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour) :*: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour))))

defaultRectStyle :: RectStyle

the style

blob :: Colour -> RectStyle

solid rectangle, no border

>>> blob black
RectStyle {borderSize = 0.0, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 0.00 0.00 0.00 1.00}

clear :: RectStyle

transparent rect

>>> clear
RectStyle {borderSize = 0.0, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 0.00 0.00 0.00 0.00}

border :: Double -> Colour -> RectStyle

transparent rectangle, with border

>>> border 0.01 transparent
RectStyle {borderSize = 1.0e-2, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 0.00 0.00 0.00 0.00}

data TextStyle

Text styling

>>> defaultTextStyle
TextStyle {size = 8.0e-2, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.5, vsize = 1.45, nudge1 = -0.2, rotation = Nothing}

>>> let t = zipWith (\x y -> Chart (TextA (defaultTextStyle & (#size .~ (0.05 :: Double))) [x]) [PointXY y]) (fmap Text.singleton ['a' .. 'y']) [Point (sin (x * 0.1)) x | x <- [0 .. 25]]

Constructors

TextStyle

Fields

• size :: Double
• color :: Colour
• anchor :: Anchor
• hsize :: Double
• vsize :: Double
• nudge1 :: Double
• rotation :: Maybe Double

Instances

Eq TextStyle

Defined in Chart.Types

Methods

(==) :: TextStyle -> TextStyle -> Bool

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

Show TextStyle

Defined in Chart.Types

Methods

showsPrec :: Int -> TextStyle -> ShowS

show :: TextStyle -> String

showList :: [TextStyle] -> ShowS

Generic TextStyle

Defined in Chart.Types

Associated Types

type Rep TextStyle :: Type -> Type

Methods

from :: TextStyle -> Rep TextStyle x

to :: Rep TextStyle x -> TextStyle

type Rep TextStyle

Defined in Chart.Types

type Rep TextStyle = D1 ('MetaData "TextStyle" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "TextStyle" 'PrefixI 'True) ((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour) :*: S1 ('MetaSel ('Just "anchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Anchor))) :*: ((S1 ('MetaSel ('Just "hsize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "vsize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "nudge1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "rotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

defaultTextStyle :: TextStyle

the offical text style

data GlyphStyle

Glyph styling

>>> defaultGlyphStyle
GlyphStyle {size = 3.0e-2, color = Colour 0.65 0.81 0.89 1.00, borderColor = Colour 0.12 0.47 0.71 1.00, borderSize = 3.0e-3, shape = SquareGlyph, rotation = Nothing, translate = Nothing}

Constructors

GlyphStyle

Fields

• size :: Double

  glyph radius

• color :: Colour

  fill color

• borderColor :: Colour

  stroke color

• borderSize :: Double

  stroke width (adds a bit to the bounding box)

• shape :: GlyphShape
• rotation :: Maybe Double
• translate :: Maybe (Point Double)

Instances

Eq GlyphStyle

Defined in Chart.Types

Methods

(==) :: GlyphStyle -> GlyphStyle -> Bool

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

Show GlyphStyle

Defined in Chart.Types

Methods

showsPrec :: Int -> GlyphStyle -> ShowS

show :: GlyphStyle -> String

showList :: [GlyphStyle] -> ShowS

Generic GlyphStyle

Defined in Chart.Types

Associated Types

type Rep GlyphStyle :: Type -> Type

Methods

from :: GlyphStyle -> Rep GlyphStyle x

to :: Rep GlyphStyle x -> GlyphStyle

type Rep GlyphStyle

Defined in Chart.Types

type Rep GlyphStyle = D1 ('MetaData "GlyphStyle" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "GlyphStyle" 'PrefixI 'True) ((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour) :*: S1 ('MetaSel ('Just "borderColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour))) :*: ((S1 ('MetaSel ('Just "borderSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "shape") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GlyphShape)) :*: (S1 ('MetaSel ('Just "rotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "translate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Point Double)))))))

defaultGlyphStyle :: GlyphStyle

the offical glyph style

data GlyphShape

glyph shapes

Constructors

CircleGlyph

SquareGlyph

EllipseGlyph Double

RectSharpGlyph Double

RectRoundedGlyph Double Double Double

TriangleGlyph (Point Double) (Point Double) (Point Double)

VLineGlyph Double

HLineGlyph Double

PathGlyph Text

Instances

Eq GlyphShape

Defined in Chart.Types

Methods

(==) :: GlyphShape -> GlyphShape -> Bool

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

Show GlyphShape

Defined in Chart.Types

Methods

showsPrec :: Int -> GlyphShape -> ShowS

show :: GlyphShape -> String

showList :: [GlyphShape] -> ShowS

Generic GlyphShape

Defined in Chart.Types

Associated Types

type Rep GlyphShape :: Type -> Type

Methods

from :: GlyphShape -> Rep GlyphShape x

to :: Rep GlyphShape x -> GlyphShape

type Rep GlyphShape

Defined in Chart.Types

type Rep GlyphShape = D1 ('MetaData "GlyphShape" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (((C1 ('MetaCons "CircleGlyph" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SquareGlyph" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "EllipseGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :+: C1 ('MetaCons "RectSharpGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))) :+: ((C1 ('MetaCons "RectRoundedGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))) :+: C1 ('MetaCons "TriangleGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Point Double)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Point Double)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Point Double))))) :+: (C1 ('MetaCons "VLineGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :+: (C1 ('MetaCons "HLineGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :+: C1 ('MetaCons "PathGlyph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

glyphText :: GlyphShape -> Text

textifier

data LineStyle

line style

>>> defaultLineStyle
LineStyle {width = 1.2e-2, color = Colour 0.05 0.05 0.05 1.00, linecap = Nothing, linejoin = Nothing, dasharray = Nothing, dashoffset = Nothing}

See also https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute

Constructors

LineStyle

Fields

• width :: Double
• color :: Colour
• linecap :: Maybe LineCap
• linejoin :: Maybe LineJoin
• dasharray :: Maybe [Double]
• dashoffset :: Maybe Double

Instances

Eq LineStyle

Defined in Chart.Types

Methods

(==) :: LineStyle -> LineStyle -> Bool

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

Show LineStyle

Defined in Chart.Types

Methods

showsPrec :: Int -> LineStyle -> ShowS

show :: LineStyle -> String

showList :: [LineStyle] -> ShowS

Generic LineStyle

Defined in Chart.Types

Associated Types

type Rep LineStyle :: Type -> Type

Methods

from :: LineStyle -> Rep LineStyle x

to :: Rep LineStyle x -> LineStyle

type Rep LineStyle

Defined in Chart.Types

type Rep LineStyle = D1 ('MetaData "LineStyle" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "LineStyle" 'PrefixI 'True) ((S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour) :*: S1 ('MetaSel ('Just "linecap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LineCap)))) :*: (S1 ('MetaSel ('Just "linejoin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LineJoin)) :*: (S1 ('MetaSel ('Just "dasharray") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :*: S1 ('MetaSel ('Just "dashoffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

defaultLineStyle :: LineStyle

the official default line style

data LineCap

line cap style

Constructors

LineCapButt

LineCapRound

LineCapSquare

Instances

Eq LineCap

Defined in Chart.Types

Methods

(==) :: LineCap -> LineCap -> Bool

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

Show LineCap

Defined in Chart.Types

Methods

showsPrec :: Int -> LineCap -> ShowS

show :: LineCap -> String

showList :: [LineCap] -> ShowS

Generic LineCap

Defined in Chart.Types

Associated Types

type Rep LineCap :: Type -> Type

Methods

from :: LineCap -> Rep LineCap x

to :: Rep LineCap x -> LineCap

type Rep LineCap

Defined in Chart.Types

type Rep LineCap = D1 ('MetaData "LineCap" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "LineCapButt" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LineCapRound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LineCapSquare" 'PrefixI 'False) (U1 :: Type -> Type)))

fromLineCap :: IsString s => LineCap -> s

textifier

toLineCap :: (Eq s, IsString s) => s -> LineCap

readifier

data LineJoin

line cap style

Constructors

LineJoinMiter

LineJoinBevel

LineJoinRound

Instances

Eq LineJoin

Defined in Chart.Types

Methods

(==) :: LineJoin -> LineJoin -> Bool

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

Show LineJoin

Defined in Chart.Types

Methods

showsPrec :: Int -> LineJoin -> ShowS

show :: LineJoin -> String

showList :: [LineJoin] -> ShowS

Generic LineJoin

Defined in Chart.Types

Associated Types

type Rep LineJoin :: Type -> Type

Methods

from :: LineJoin -> Rep LineJoin x

to :: Rep LineJoin x -> LineJoin

type Rep LineJoin

Defined in Chart.Types

type Rep LineJoin = D1 ('MetaData "LineJoin" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "LineJoinMiter" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LineJoinBevel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LineJoinRound" 'PrefixI 'False) (U1 :: Type -> Type)))

fromLineJoin :: IsString s => LineJoin -> s

textifier

toLineJoin :: (Eq s, IsString s) => s -> LineJoin

readifier

fromDashArray :: [Double] -> Text

Convert a dash representation from a list to text

data Anchor

position anchor

Constructors

AnchorMiddle

AnchorStart

AnchorEnd

Instances

Eq Anchor

Defined in Chart.Types

Methods

(==) :: Anchor -> Anchor -> Bool

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

Show Anchor

Defined in Chart.Types

Methods

showsPrec :: Int -> Anchor -> ShowS

show :: Anchor -> String

showList :: [Anchor] -> ShowS

Generic Anchor

Defined in Chart.Types

Associated Types

type Rep Anchor :: Type -> Type

Methods

from :: Anchor -> Rep Anchor x

to :: Rep Anchor x -> Anchor

type Rep Anchor

Defined in Chart.Types

type Rep Anchor = D1 ('MetaData "Anchor" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "AnchorMiddle" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AnchorStart" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AnchorEnd" 'PrefixI 'False) (U1 :: Type -> Type)))

fromAnchor :: IsString s => Anchor -> s

text

toAnchor :: (Eq s, IsString s) => s -> Anchor

from text

data PathStyle

Path styling

>>> defaultPathStyle
PathStyle {borderSize = 1.0e-2, borderColor = Colour 0.65 0.81 0.89 1.00, color = Colour 0.12 0.47 0.71 1.00}

Constructors

PathStyle

Fields

• borderSize :: Double
• borderColor :: Colour
• color :: Colour

Instances

Eq PathStyle

Defined in Chart.Types

Methods

(==) :: PathStyle -> PathStyle -> Bool

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

Show PathStyle

Defined in Chart.Types

Methods

showsPrec :: Int -> PathStyle -> ShowS

show :: PathStyle -> String

showList :: [PathStyle] -> ShowS

Generic PathStyle

Defined in Chart.Types

Associated Types

type Rep PathStyle :: Type -> Type

Methods

from :: PathStyle -> Rep PathStyle x

to :: Rep PathStyle x -> PathStyle

type Rep PathStyle

Defined in Chart.Types

type Rep PathStyle = D1 ('MetaData "PathStyle" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "PathStyle" 'PrefixI 'True) (S1 ('MetaSel ('Just "borderSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "borderColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour) :*: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Colour))))

toPathChart :: PathStyle -> [(PathInfo Double, Point Double)] -> Chart Double

Convert from a path command list to a PathA chart

defaultPathStyle :: PathStyle

the style

Hud types

data ChartDims a

Dimensions that are tracked in the HudT:

• chartDim: the rectangular dimension of the physical representation of a chart on the screen so that new hud elements can be appended. Adding a hud piece tends to expand the chart dimension.
• canvasDim: the rectangular dimension of the canvas on which data will be represented. At times appending a hud element will cause the canvas dimension to shift.
• dataDim: the rectangular dimension of the data being represented. Adding hud elements can cause this to change.

Constructors

ChartDims

Fields

• chartDim :: Rect a
• canvasDim :: Rect a
• dataDim :: Rect a

Instances

Eq a => Eq (ChartDims a)

Defined in Chart.Types

Methods

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

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

Show a => Show (ChartDims a)

Defined in Chart.Types

Methods

showsPrec :: Int -> ChartDims a -> ShowS

show :: ChartDims a -> String

showList :: [ChartDims a] -> ShowS

Generic (ChartDims a)

Defined in Chart.Types

Associated Types

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

Methods

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

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

type Rep (ChartDims a)

Defined in Chart.Types

type Rep (ChartDims a) = D1 ('MetaData "ChartDims" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "ChartDims" 'PrefixI 'True) (S1 ('MetaSel ('Just "chartDim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Rect a)) :*: (S1 ('MetaSel ('Just "canvasDim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Rect a)) :*: S1 ('MetaSel ('Just "dataDim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Rect a)))))

newtype HudT m a

Hud monad transformer

Constructors

Hud

Fields

• unhud :: [Chart a] -> StateT (ChartDims a) m [Chart a]

Instances

Monad m => Semigroup (HudT m a)

Defined in Chart.Types

Methods

(<>) :: HudT m a -> HudT m a -> HudT m a

sconcat :: NonEmpty (HudT m a) -> HudT m a

stimes :: Integral b => b -> HudT m a -> HudT m a

Monad m => Monoid (HudT m a)

Defined in Chart.Types

Methods

mempty :: HudT m a

mappend :: HudT m a -> HudT m a -> HudT m a

mconcat :: [HudT m a] -> HudT m a

type Hud = HudT Identity

Heads-Up-Display for a Chart

simulHud :: (Ord a, Monad m) => HudT m a -> HudT m a -> HudT m a

run two hud's simultaneously (using the same original ChartDims state) rather than sequentially (which is the <> operation).

data HudOptions

Typical configurable hud elements. Anything else can be hand-coded as a HudT.

Constructors

HudOptions

Fields

• hudCanvas :: Maybe RectStyle
• hudTitles :: [Title]
• hudAxes :: [AxisOptions]
• hudLegend :: Maybe (LegendOptions, [(Annotation, Text)])

Instances

Eq HudOptions

Defined in Chart.Types

Methods

(==) :: HudOptions -> HudOptions -> Bool

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

Show HudOptions

Defined in Chart.Types

Methods

showsPrec :: Int -> HudOptions -> ShowS

show :: HudOptions -> String

showList :: [HudOptions] -> ShowS

Generic HudOptions

Defined in Chart.Types

Associated Types

type Rep HudOptions :: Type -> Type

Methods

from :: HudOptions -> Rep HudOptions x

to :: Rep HudOptions x -> HudOptions

Semigroup HudOptions

Defined in Chart.Types

Methods

(<>) :: HudOptions -> HudOptions -> HudOptions

sconcat :: NonEmpty HudOptions -> HudOptions

stimes :: Integral b => b -> HudOptions -> HudOptions

Monoid HudOptions

Defined in Chart.Types

Methods

mempty :: HudOptions

mappend :: HudOptions -> HudOptions -> HudOptions

mconcat :: [HudOptions] -> HudOptions

type Rep HudOptions

Defined in Chart.Types

type Rep HudOptions = D1 ('MetaData "HudOptions" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "HudOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hudCanvas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RectStyle)) :*: S1 ('MetaSel ('Just "hudTitles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Title])) :*: (S1 ('MetaSel ('Just "hudAxes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AxisOptions]) :*: S1 ('MetaSel ('Just "hudLegend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (LegendOptions, [(Annotation, Text)]))))))

defaultHudOptions :: HudOptions

The official hud options.

scaleOpacHudOptions :: HudOptions -> Double -> HudOptions

colourHudOptions :: Colour -> HudOptions -> HudOptions

alter the colour

defaultCanvas :: RectStyle

The official hud canvas

runHudWith

Arguments

:: Rect Double

initial canvas dimension

-> Rect Double

initial data dimension

-> [Hud Double]

huds to add

-> [Chart Double]

underlying chart

-> [Chart Double]

integrated chart list

Combine huds and charts to form a new Chart using the supplied initial canvas and data dimensions. Note that chart data is transformed by this computation (and the use of a linear type is an open question).

runHud

Arguments

:: Rect Double

initial canvas dimension

-> [Hud Double]

huds

-> [Chart Double]

underlying charts

-> [Chart Double]

integrated chart list

Combine huds and charts to form a new [Chart] using the supplied canvas and the actual data dimension.

Note that the original chart data are transformed and irrevocably lost by this computation.

makeHud :: Rect Double -> HudOptions -> ([Hud Double], [Chart Double])

Make huds from a HudOptions.

Some huds, such as the creation of tick values, can extend the data dimension of a chart, so we return a blank chart with the new data dimension. The complexity internally to this function is due to the creation of ticks and, specifically, gridSensible, which is not idempotent. As a result, a tick calculation that does extends the data area, can then lead to new tick values when applying TickRound etc.

data ChartAspect

The basis for the x-y ratio of the final chart

Default style features tend towards assuming that the usual height of the overall svg image is around 1, and ChartAspect is based on this assumption, so that a ChartAspect of "FixedAspect 1.5", say, means a height of 1 and a width of 1.5.

Constructors

FixedAspect Double

Rescale charts to a fixed x-y ratio, inclusive of hud and style features

CanvasAspect Double

Rescale charts to an overall height of 1, preserving the x-y ratio of the data canvas.

ChartAspect

Rescale charts to a height of 1, preserving the existing x-y ratio of the underlying charts, inclusive of hud and style.

UnadjustedAspect

Do not rescale.

Instances

Eq ChartAspect

Defined in Chart.Types

Methods

(==) :: ChartAspect -> ChartAspect -> Bool

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

Show ChartAspect

Defined in Chart.Types

Methods

showsPrec :: Int -> ChartAspect -> ShowS

show :: ChartAspect -> String

showList :: [ChartAspect] -> ShowS

Generic ChartAspect

Defined in Chart.Types

Associated Types

type Rep ChartAspect :: Type -> Type

Methods

from :: ChartAspect -> Rep ChartAspect x

to :: Rep ChartAspect x -> ChartAspect

type Rep ChartAspect

Defined in Chart.Types

type Rep ChartAspect = D1 ('MetaData "ChartAspect" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) ((C1 ('MetaCons "FixedAspect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :+: C1 ('MetaCons "CanvasAspect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))) :+: (C1 ('MetaCons "ChartAspect" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UnadjustedAspect" 'PrefixI 'False) (U1 :: Type -> Type)))

toChartAspect :: (Eq s, IsString s) => s -> Double -> ChartAspect

readifier

fromChartAspect :: IsString s => ChartAspect -> s

textifier

initialCanvas :: ChartAspect -> [Chart Double] -> Rect Double

calculation of the canvas given the ChartAspect

chartAspectHud :: Monad m => ChartAspect -> HudT m Double

Project the chart data given the ChartAspect

canvas :: Monad m => RectStyle -> HudT m Double

Make a canvas hud element.

title :: Monad m => Title -> HudT m Double

Add a title to a chart. The logic used to work out placement is flawed due to being able to freely specify text rotation. It works for specific rotations (Top, Bottom at 0, Left at 90, Right @ 270)

tick :: Monad m => Place -> Tick -> HudT m Double

Create tick glyphs (marks), lines (grid) and text (labels)

Hud primitives

data AxisOptions

axis options

Constructors

AxisOptions

Fields

• axisBar :: Maybe AxisBar
• adjust :: Maybe Adjustments
• axisTick :: Tick
• place :: Place

Instances

Eq AxisOptions

Defined in Chart.Types

Methods

(==) :: AxisOptions -> AxisOptions -> Bool

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

Show AxisOptions

Defined in Chart.Types

Methods

showsPrec :: Int -> AxisOptions -> ShowS

show :: AxisOptions -> String

showList :: [AxisOptions] -> ShowS

Generic AxisOptions

Defined in Chart.Types

Associated Types

type Rep AxisOptions :: Type -> Type

Methods

from :: AxisOptions -> Rep AxisOptions x

to :: Rep AxisOptions x -> AxisOptions

type Rep AxisOptions

Defined in Chart.Types

type Rep AxisOptions = D1 ('MetaData "AxisOptions" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "AxisOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "axisBar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AxisBar)) :*: S1 ('MetaSel ('Just "adjust") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Adjustments))) :*: (S1 ('MetaSel ('Just "axisTick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Tick) :*: S1 ('MetaSel ('Just "place") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place))))

defaultAxisOptions :: AxisOptions

The official axis

flipAxis :: AxisOptions -> AxisOptions

flip an axis from being an X dimension to a Y one or vice-versa.

data Place

Placement of elements around (what is implicity but maybe shouldn't just be) a rectangular canvas

Constructors

PlaceLeft

PlaceRight

PlaceTop

PlaceBottom

PlaceAbsolute (Point Double)

Instances

Eq Place

Defined in Chart.Types

Methods

(==) :: Place -> Place -> Bool

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

Show Place

Defined in Chart.Types

Methods

showsPrec :: Int -> Place -> ShowS

show :: Place -> String

showList :: [Place] -> ShowS

Generic Place

Defined in Chart.Types

Associated Types

type Rep Place :: Type -> Type

Methods

from :: Place -> Rep Place x

to :: Rep Place x -> Place

type Rep Place

Defined in Chart.Types

type Rep Place = D1 ('MetaData "Place" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) ((C1 ('MetaCons "PlaceLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlaceRight" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PlaceTop" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PlaceBottom" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlaceAbsolute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Point Double))))))

placeText :: Place -> Text

textifier

data AxisBar

The bar on an axis representing the x or y plane.

>>> defaultAxisBar
AxisBar {rstyle = RectStyle {borderSize = 0.0, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 0.05 0.05 0.05 0.40}, wid = 4.0e-3, buff = 1.0e-2}

Constructors

AxisBar

Fields

• rstyle :: RectStyle
• wid :: Double
• buff :: Double

Instances

Eq AxisBar

Defined in Chart.Types

Methods

(==) :: AxisBar -> AxisBar -> Bool

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

Show AxisBar

Defined in Chart.Types

Methods

showsPrec :: Int -> AxisBar -> ShowS

show :: AxisBar -> String

showList :: [AxisBar] -> ShowS

Generic AxisBar

Defined in Chart.Types

Associated Types

type Rep AxisBar :: Type -> Type

Methods

from :: AxisBar -> Rep AxisBar x

to :: Rep AxisBar x -> AxisBar

type Rep AxisBar

Defined in Chart.Types

type Rep AxisBar = D1 ('MetaData "AxisBar" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "AxisBar" 'PrefixI 'True) (S1 ('MetaSel ('Just "rstyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RectStyle) :*: (S1 ('MetaSel ('Just "wid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "buff") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))

defaultAxisBar :: AxisBar

The official axis bar

data Title

Options for titles. Defaults to center aligned, and placed at Top of the hud

>>> defaultTitle "title"
Title {text = "title", style = TextStyle {size = 0.12, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.5, vsize = 1.45, nudge1 = -0.2, rotation = Nothing}, place = PlaceTop, anchor = AnchorMiddle, buff = 4.0e-2}

Constructors

Title

Fields

• text :: Text
• style :: TextStyle
• place :: Place
• anchor :: Anchor
• buff :: Double

Instances

Eq Title

Defined in Chart.Types

Methods

(==) :: Title -> Title -> Bool

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

Show Title

Defined in Chart.Types

Methods

showsPrec :: Int -> Title -> ShowS

show :: Title -> String

showList :: [Title] -> ShowS

Generic Title

Defined in Chart.Types

Associated Types

type Rep Title :: Type -> Type

Methods

from :: Title -> Rep Title x

to :: Rep Title x -> Title

type Rep Title

Defined in Chart.Types

type Rep Title = D1 ('MetaData "Title" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "Title" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextStyle)) :*: (S1 ('MetaSel ('Just "place") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place) :*: (S1 ('MetaSel ('Just "anchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Anchor) :*: S1 ('MetaSel ('Just "buff") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))))

defaultTitle :: Text -> Title

The official hud title

data Tick

xy coordinate markings

>>> defaultTick
Tick {tstyle = TickRound (FormatComma (Just 2)) 8 TickExtend, gtick = Just (GlyphStyle {size = 3.0e-2, color = Colour 0.05 0.05 0.05 0.40, borderColor = Colour 0.05 0.05 0.05 0.40, borderSize = 2.0e-3, shape = VLineGlyph 5.0e-3, rotation = Nothing, translate = Nothing},1.25e-2), ttick = Just (TextStyle {size = 5.0e-2, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.5, vsize = 1.45, nudge1 = -0.2, rotation = Nothing},1.5e-2), ltick = Just (LineStyle {width = 5.0e-3, color = Colour 0.05 0.05 0.05 0.05, linecap = Nothing, linejoin = Nothing, dasharray = Nothing, dashoffset = Nothing},0.0)}

Constructors

Tick

Fields

• tstyle :: TickStyle
• gtick :: Maybe (GlyphStyle, Double)
• ttick :: Maybe (TextStyle, Double)
• ltick :: Maybe (LineStyle, Double)

Instances

Eq Tick

Defined in Chart.Types

Methods

(==) :: Tick -> Tick -> Bool

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

Show Tick

Defined in Chart.Types

Methods

showsPrec :: Int -> Tick -> ShowS

show :: Tick -> String

showList :: [Tick] -> ShowS

Generic Tick

Defined in Chart.Types

Associated Types

type Rep Tick :: Type -> Type

Methods

from :: Tick -> Rep Tick x

to :: Rep Tick x -> Tick

type Rep Tick

Defined in Chart.Types

type Rep Tick = D1 ('MetaData "Tick" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "Tick" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tstyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TickStyle) :*: S1 ('MetaSel ('Just "gtick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (GlyphStyle, Double)))) :*: (S1 ('MetaSel ('Just "ttick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (TextStyle, Double))) :*: S1 ('MetaSel ('Just "ltick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (LineStyle, Double))))))

defaultGlyphTick :: GlyphStyle

The official glyph tick

defaultTextTick :: TextStyle

The official text tick

defaultLineTick :: LineStyle

The official line tick

defaultTick :: Tick

The official tick

data TickStyle

Style of tick marks on an axis.

Constructors

TickNone

no ticks on axis

TickLabels [Text]

specific labels (equidistant placement)

TickRound FormatN Int TickExtend

sensibly rounded ticks, a guide to how many, and whether to extend beyond the data bounding box

TickExact FormatN Int

exactly n equally spaced ticks

TickPlaced [(Double, Text)]

specific labels and placement

Instances

Eq TickStyle

Defined in Chart.Types

Methods

(==) :: TickStyle -> TickStyle -> Bool

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

Show TickStyle

Defined in Chart.Types

Methods

showsPrec :: Int -> TickStyle -> ShowS

show :: TickStyle -> String

showList :: [TickStyle] -> ShowS

Generic TickStyle

Defined in Chart.Types

Associated Types

type Rep TickStyle :: Type -> Type

Methods

from :: TickStyle -> Rep TickStyle x

to :: Rep TickStyle x -> TickStyle

type Rep TickStyle

Defined in Chart.Types

type Rep TickStyle = D1 ('MetaData "TickStyle" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) ((C1 ('MetaCons "TickNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TickLabels" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) :+: (C1 ('MetaCons "TickRound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormatN) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TickExtend))) :+: (C1 ('MetaCons "TickExact" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormatN) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "TickPlaced" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Double, Text)])))))

defaultTickStyle :: TickStyle

The official tick style

tickStyleText :: TickStyle -> Text

textifier

data TickExtend

Whether Ticks are allowed to extend the data range

Constructors

TickExtend

NoTickExtend

Instances

Eq TickExtend

Defined in Chart.Types

Methods

(==) :: TickExtend -> TickExtend -> Bool

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

Show TickExtend

Defined in Chart.Types

Methods

showsPrec :: Int -> TickExtend -> ShowS

show :: TickExtend -> String

showList :: [TickExtend] -> ShowS

Generic TickExtend

Defined in Chart.Types

Associated Types

type Rep TickExtend :: Type -> Type

Methods

from :: TickExtend -> Rep TickExtend x

to :: Rep TickExtend x -> TickExtend

type Rep TickExtend

Defined in Chart.Types

type Rep TickExtend = D1 ('MetaData "TickExtend" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "TickExtend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoTickExtend" 'PrefixI 'False) (U1 :: Type -> Type))

adjustTick :: Adjustments -> Rect Double -> Rect Double -> Place -> Tick -> Tick

adjust Tick for sane font sizes etc

makeTickDates :: PosDiscontinuous -> Maybe Text -> Int -> [UTCTime] -> [(Int, Text)]

Convert a UTCTime list into sensible ticks, placed exactly

makeTickDatesContinuous :: PosDiscontinuous -> Maybe Text -> Int -> [UTCTime] -> [(Double, Text)]

Convert a UTCTime list into sensible ticks, placed on the (0,1) space

data Adjustments

options for prettifying axis decorations

>>> defaultAdjustments
Adjustments {maxXRatio = 8.0e-2, maxYRatio = 6.0e-2, angledRatio = 0.12, allowDiagonal = True}

Constructors

Adjustments

Fields

• maxXRatio :: Double
• maxYRatio :: Double
• angledRatio :: Double
• allowDiagonal :: Bool

Instances

Eq Adjustments

Defined in Chart.Types

Methods

(==) :: Adjustments -> Adjustments -> Bool

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

Show Adjustments

Defined in Chart.Types

Methods

showsPrec :: Int -> Adjustments -> ShowS

show :: Adjustments -> String

showList :: [Adjustments] -> ShowS

Generic Adjustments

Defined in Chart.Types

Associated Types

type Rep Adjustments :: Type -> Type

Methods

from :: Adjustments -> Rep Adjustments x

to :: Rep Adjustments x -> Adjustments

type Rep Adjustments

Defined in Chart.Types

type Rep Adjustments = D1 ('MetaData "Adjustments" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "Adjustments" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxXRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "maxYRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "angledRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "allowDiagonal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

defaultAdjustments :: Adjustments

The official hud adjustments.

data LegendOptions

Legend options

>>> defaultLegendOptions
LegendOptions {lsize = 0.3, vgap = 0.2, hgap = 0.1, ltext = TextStyle {size = 0.12, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.5, vsize = 1.45, nudge1 = -0.2, rotation = Nothing}, lmax = 10, innerPad = 0.1, outerPad = 2.0e-2, legendFrame = Just (RectStyle {borderSize = 1.0e-2, borderColor = Colour 0.05 0.05 0.05 1.00, color = Colour 0.05 0.05 0.05 0.00}), lplace = PlaceRight, lscale = 0.25}

Constructors

LegendOptions

Fields

• lsize :: Double
• vgap :: Double
• hgap :: Double
• ltext :: TextStyle
• lmax :: Int
• innerPad :: Double
• outerPad :: Double
• legendFrame :: Maybe RectStyle
• lplace :: Place
• lscale :: Double

Instances

Eq LegendOptions

Defined in Chart.Types

Methods

(==) :: LegendOptions -> LegendOptions -> Bool

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

Show LegendOptions

Defined in Chart.Types

Methods

showsPrec :: Int -> LegendOptions -> ShowS

show :: LegendOptions -> String

showList :: [LegendOptions] -> ShowS

Generic LegendOptions

Defined in Chart.Types

Associated Types

type Rep LegendOptions :: Type -> Type

Methods

from :: LegendOptions -> Rep LegendOptions x

to :: Rep LegendOptions x -> LegendOptions

type Rep LegendOptions

Defined in Chart.Types

type Rep LegendOptions = D1 ('MetaData "LegendOptions" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "LegendOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lsize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "vgap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "hgap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "ltext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextStyle) :*: S1 ('MetaSel ('Just "lmax") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "innerPad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "outerPad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "legendFrame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RectStyle)) :*: (S1 ('MetaSel ('Just "lplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place) :*: S1 ('MetaSel ('Just "lscale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))))

defaultLegendOptions :: LegendOptions

The official legend options

legendHud :: LegendOptions -> [Chart Double] -> Hud Double

Make a legend hud element taking into account the chart.

data Orientation

Verticle or Horizontal

Constructors

Vert

Hori

Instances

Eq Orientation

Defined in Chart.Types

Methods

(==) :: Orientation -> Orientation -> Bool

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

Show Orientation

Defined in Chart.Types

Methods

showsPrec :: Int -> Orientation -> ShowS

show :: Orientation -> String

showList :: [Orientation] -> ShowS

Generic Orientation

Defined in Chart.Types

Associated Types

type Rep Orientation :: Type -> Type

Methods

from :: Orientation -> Rep Orientation x

to :: Rep Orientation x -> Orientation

type Rep Orientation

Defined in Chart.Types

type Rep Orientation = D1 ('MetaData "Orientation" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "Vert" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Hori" 'PrefixI 'False) (U1 :: Type -> Type))

fromOrientation :: IsString s => Orientation -> s

textifier

toOrientation :: (Eq s, IsString s) => s -> Orientation

readifier

SVG primitives

data CssOptions

Constructors

UseGeometricPrecision

UseCssCrisp

NoCssOptions

Instances

Eq CssOptions

Defined in Chart.Types

Methods

(==) :: CssOptions -> CssOptions -> Bool

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

Show CssOptions

Defined in Chart.Types

Methods

showsPrec :: Int -> CssOptions -> ShowS

show :: CssOptions -> String

showList :: [CssOptions] -> ShowS

Generic CssOptions

Defined in Chart.Types

Associated Types

type Rep CssOptions :: Type -> Type

Methods

from :: CssOptions -> Rep CssOptions x

to :: Rep CssOptions x -> CssOptions

type Rep CssOptions

Defined in Chart.Types

type Rep CssOptions = D1 ('MetaData "CssOptions" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "UseGeometricPrecision" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UseCssCrisp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoCssOptions" 'PrefixI 'False) (U1 :: Type -> Type)))

data SvgOptions

SVG tag options.

>>> defaultSvgOptions
SvgOptions {svgHeight = 300.0, outerPad = Just 2.0e-2, innerPad = Nothing, chartFrame = Nothing, cssOptions = NoCssOptions, chartAspect = FixedAspect 1.5, background = Nothing}

Constructors

SvgOptions

Fields

• svgHeight :: Double
• outerPad :: Maybe Double
• innerPad :: Maybe Double
• chartFrame :: Maybe RectStyle
• cssOptions :: CssOptions
• chartAspect :: ChartAspect
• background :: Maybe Colour

Instances

Eq SvgOptions

Defined in Chart.Types

Methods

(==) :: SvgOptions -> SvgOptions -> Bool

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

Show SvgOptions

Defined in Chart.Types

Methods

showsPrec :: Int -> SvgOptions -> ShowS

show :: SvgOptions -> String

showList :: [SvgOptions] -> ShowS

Generic SvgOptions

Defined in Chart.Types

Associated Types

type Rep SvgOptions :: Type -> Type

Methods

from :: SvgOptions -> Rep SvgOptions x

to :: Rep SvgOptions x -> SvgOptions

type Rep SvgOptions

Defined in Chart.Types

type Rep SvgOptions = D1 ('MetaData "SvgOptions" "Chart.Types" "chart-svg-0.2.1-FFi0NOBdO1foP7qbjGvqx" 'False) (C1 ('MetaCons "SvgOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "svgHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "outerPad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "innerPad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: ((S1 ('MetaSel ('Just "chartFrame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RectStyle)) :*: S1 ('MetaSel ('Just "cssOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CssOptions)) :*: (S1 ('MetaSel ('Just "chartAspect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChartAspect) :*: S1 ('MetaSel ('Just "background") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Colour))))))

defaultSvgOptions :: SvgOptions

The official svg options

defaultSvgFrame :: RectStyle

frame style

Chart manipulation

padChart :: Double -> [Chart Double] -> [Chart Double]

additively pad a [Chart]

>>> padChart 0.1 [Chart (RectA defaultRectStyle) [RectXY one]]
[Chart {annotation = RectA (RectStyle {borderSize = 1.0e-2, borderColor = Colour 0.65 0.81 0.89 1.00, color = Colour 0.12 0.47 0.71 1.00}), xys = [R -0.5 0.5 -0.5 0.5]},Chart {annotation = BlankA, xys = [R -0.605 0.605 -0.605 0.605]}]

frameChart :: RectStyle -> Double -> [Chart Double] -> [Chart Double]

overlay a frame on some charts with some additive padding between

>>> frameChart defaultRectStyle 0.1 [Chart BlankA []]
[Chart {annotation = RectA (RectStyle {borderSize = 1.0e-2, borderColor = Colour 0.65 0.81 0.89 1.00, color = Colour 0.12 0.47 0.71 1.00}), xys = []},Chart {annotation = BlankA, xys = []}]

hori :: Double -> [[Chart Double]] -> [Chart Double]

horizontally stack a list of list of charts (proceeding to the right) with a gap between

vert :: Double -> [[Chart Double]] -> [Chart Double]

vertically stack a list of charts (proceeding upwards), aligning them to the left

stack :: Int -> Double -> [[Chart Double]] -> [Chart Double]

stack a list of charts horizontally, then vertically

Bounding box calculation

padBox :: Maybe (Rect Double) -> Rect Double

pad a Rect to remove singleton dimensions

dataBox :: Chart Double -> Maybe (Rect Double)

Rect of a Chart, not including style

dataBoxes :: [Chart Double] -> Maybe (Rect Double)

Rect of charts, not including style

dataBoxesS :: [Chart Double] -> Rect Double

Rect of charts, not including style, with defaults for Nothing and singleton dimensions if any.

styleBox :: Chart Double -> Maybe (Rect Double)

the geometric dimensions of a Chart inclusive of style geometry, but excluding PathA effects

styleBoxes :: [Chart Double] -> Maybe (Rect Double)

the extra geometric dimensions of a [Chart]

styleBoxesS :: [Chart Double] -> Rect Double

the extra geometric dimensions of a [Chart], adjusted for Nothing or singleton dimensions.

styleBoxText :: TextStyle -> Text -> Point Double -> Rect Double

the extra area from text styling

styleBoxGlyph :: GlyphStyle -> Rect Double

the extra area from glyph styling

Re-exports

module Chart.Render

module Chart.Bar

module Chart.Surface

module Data.Colour

module Data.FormatN

module Data.Path

module NumHask.Space