Chart.Markup

An intermediary representation not unlike SVG or XML but only forming a subset of these standards.

Documentation

newtype Attributes

A collection of attributes as a ByteString key-value map.

Constructors

Attributes

Fields

• attMap :: Map ByteString ByteString

Instances

Monoid Attributes

Defined in Chart.Markup

Methods

mempty :: Attributes

mappend :: Attributes -> Attributes -> Attributes

mconcat :: [Attributes] -> Attributes

Semigroup Attributes

Defined in Chart.Markup

Methods

(<>) :: Attributes -> Attributes -> Attributes

sconcat :: NonEmpty Attributes -> Attributes

stimes :: Integral b => b -> Attributes -> Attributes

Generic Attributes

Defined in Chart.Markup

Associated Types

type Rep Attributes :: Type -> Type

Methods

from :: Attributes -> Rep Attributes x

to :: Rep Attributes x -> Attributes

Show Attributes

Defined in Chart.Markup

Methods

showsPrec :: Int -> Attributes -> ShowS

show :: Attributes -> String

showList :: [Attributes] -> ShowS

Eq Attributes

Defined in Chart.Markup

Methods

(==) :: Attributes -> Attributes -> Bool

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

ToExpr Attributes

Defined in Chart.Markup

Methods

toExpr :: Attributes -> Expr

listToExpr :: [Attributes] -> Expr

type Rep Attributes

Defined in Chart.Markup

type Rep Attributes = D1 ('MetaData "Attributes" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'True) (C1 ('MetaCons "Attributes" 'PrefixI 'True) (S1 ('MetaSel ('Just "attMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ByteString ByteString))))

attribute :: (ByteString, ByteString) -> Attributes

Create a singleton Attributes

data Markup

A representation of SVG (and XML) markup with no specific knowledge of SVG or XML syntax rules.

>>> let c0 = ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty
>>> markupChartOptions c0
Markup {tag = "svg", atts = Attributes {attMap = fromList [("height","300"),("viewBox","-0.75 -0.5 1.5 1.0"),("width","450"),("xmlns","http://www.w3.org/2000/svg"),("xmlns:xlink","http://www.w3.org/1999/xlink")]}, contents = [MarkupLeaf (Markup {tag = "style", atts = Attributes {attMap = fromList []}, contents = [Content ""]}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("class","chart")]}, contents = []}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("class","hud")]}, contents = []})]}

Constructors

Markup

Fields

• tag :: ByteString
• atts :: Attributes
• contents :: [Content]

Instances

Generic Markup

Defined in Chart.Markup

Associated Types

type Rep Markup :: Type -> Type

Methods

from :: Markup -> Rep Markup x

to :: Rep Markup x -> Markup

Show Markup

Defined in Chart.Markup

Methods

showsPrec :: Int -> Markup -> ShowS

show :: Markup -> String

showList :: [Markup] -> ShowS

Eq Markup

Defined in Chart.Markup

Methods

(==) :: Markup -> Markup -> Bool

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

ToExpr Markup

Defined in Chart.Markup

Methods

toExpr :: Markup -> Expr

listToExpr :: [Markup] -> Expr

type Rep Markup

Defined in Chart.Markup

type Rep Markup = D1 ('MetaData "Markup" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "Markup" 'PrefixI 'True) (S1 ('MetaSel ('Just "tag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :*: (S1 ('MetaSel ('Just "atts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Attributes) :*: S1 ('MetaSel ('Just "contents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Content]))))

data Content

The things that can be inside (form the Content of) a Markup element, especially in a DOM context. Comments are unused by the library representation of a chart and are here to help with parsing arbitrary svg in the wild.

>>> contents (markupChartOptions c0)
[MarkupLeaf (Markup {tag = "style", atts = Attributes {attMap = fromList []}, contents = [Content ""]}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("class","chart")]}, contents = []}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("class","hud")]}, contents = []})]

Constructors

Content ByteString

Comment ByteString

MarkupLeaf Markup

Instances

Generic Content

Defined in Chart.Markup

Associated Types

type Rep Content :: Type -> Type

Methods

from :: Content -> Rep Content x

to :: Rep Content x -> Content

Show Content

Defined in Chart.Markup

Methods

showsPrec :: Int -> Content -> ShowS

show :: Content -> String

showList :: [Content] -> ShowS

Eq Content

Defined in Chart.Markup

Methods

(==) :: Content -> Content -> Bool

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

ToExpr Content

Defined in Chart.Markup

Methods

toExpr :: Content -> Expr

listToExpr :: [Content] -> Expr

type Rep Content

Defined in Chart.Markup

type Rep Content = D1 ('MetaData "Content" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "Content" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: (C1 ('MetaCons "Comment" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "MarkupLeaf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Markup))))

renderMarkup :: Markup -> Text

render markup to Text compliant with being an SVG object (and XML element)

>>> renderMarkup (markupChartOptions c0)
"<svg height=\"300\" viewBox=\"-0.75 -0.5 1.5 1.0\" width=\"450\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"><style></style><g class=\"chart\"/><g class=\"hud\"/></svg>"

encodeMarkup :: Markup -> ByteString

render markup to a ByteString compliant with being an SVG object (and XML element)

>>> encodeMarkup (markupChartOptions c0)
"<svg height=\"300\" viewBox=\"-0.75 -0.5 1.5 1.0\" width=\"450\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"><style></style><g class=\"chart\"/><g class=\"hud\"/></svg>"

data ChartOptions

A product type representing charts, hud options and markup options, which can be transformed into Markup.

Constructors

ChartOptions

Fields

• markupOptions :: MarkupOptions
• hudOptions :: HudOptions
• charts :: ChartTree

Instances

Monoid ChartOptions

Defined in Chart.Markup

Methods

mempty :: ChartOptions

mappend :: ChartOptions -> ChartOptions -> ChartOptions

mconcat :: [ChartOptions] -> ChartOptions

Semigroup ChartOptions

Defined in Chart.Markup

Methods

(<>) :: ChartOptions -> ChartOptions -> ChartOptions

sconcat :: NonEmpty ChartOptions -> ChartOptions

stimes :: Integral b => b -> ChartOptions -> ChartOptions

Generic ChartOptions

Defined in Chart.Markup

Associated Types

type Rep ChartOptions :: Type -> Type

Methods

from :: ChartOptions -> Rep ChartOptions x

to :: Rep ChartOptions x -> ChartOptions

Show ChartOptions

Defined in Chart.Markup

Methods

showsPrec :: Int -> ChartOptions -> ShowS

show :: ChartOptions -> String

showList :: [ChartOptions] -> ShowS

Eq ChartOptions

Defined in Chart.Markup

Methods

(==) :: ChartOptions -> ChartOptions -> Bool

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

type Rep ChartOptions

Defined in Chart.Markup

type Rep ChartOptions = D1 ('MetaData "ChartOptions" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "ChartOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "markupOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MarkupOptions) :*: (S1 ('MetaSel ('Just "hudOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HudOptions) :*: S1 ('MetaSel ('Just "charts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChartTree))))

markupChartOptions :: ChartOptions -> Markup

Convert ChartOptions to Markup

>>> markupChartOptions (ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty)
Markup {tag = "svg", atts = Attributes {attMap = fromList [("height","300"),("viewBox","-0.75 -0.5 1.5 1.0"),("width","450"),("xmlns","http://www.w3.org/2000/svg"),("xmlns:xlink","http://www.w3.org/1999/xlink")]}, contents = [MarkupLeaf (Markup {tag = "style", atts = Attributes {attMap = fromList []}, contents = [Content ""]}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("class","chart")]}, contents = []}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("class","hud")]}, contents = []})]}

markupChartTree :: ChartTree -> [Markup]

Convert a ChartTree to markup

>>> lineExample & view #charts & markupChartTree
[Markup {tag = "g", atts = Attributes {attMap = fromList [("class","line")]}, contents = [MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("fill","none"),("stroke","rgb(2%, 73%, 80%)"),("stroke-opacity","1.0"),("stroke-width","0.0150")]}, contents = [MarkupLeaf (Markup {tag = "polyline", atts = Attributes {attMap = fromList [("points","0,-1.0 1.0,-1.0 2.0,-5.0")]}, contents = []})]}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("fill","none"),("stroke","rgb(2%, 29%, 48%)"),("stroke-opacity","1.0"),("stroke-width","0.0150")]}, contents = [MarkupLeaf (Markup {tag = "polyline", atts = Attributes {attMap = fromList [("points","0,0 2.8,-3.0")]}, contents = []})]}),MarkupLeaf (Markup {tag = "g", atts = Attributes {attMap = fromList [("fill","none"),("stroke","rgb(66%, 7%, 55%)"),("stroke-opacity","1.0"),("stroke-width","0.0150")]}, contents = [MarkupLeaf (Markup {tag = "polyline", atts = Attributes {attMap = fromList [("points","0.5,-4.0 0.5,0")]}, contents = []})]})]}]

markupChart :: Chart -> Maybe Markup

Convert a Chart to Markup

>>> lineExample & view #charts & foldOf charts' & head & markupChart
Just (Markup {tag = "g", atts = Attributes {attMap = fromList [("fill","none"),("stroke","rgb(2%, 73%, 80%)"),("stroke-opacity","1.0"),("stroke-width","0.0150")]}, contents = [MarkupLeaf (Markup {tag = "polyline", atts = Attributes {attMap = fromList [("points","0,-1.0 1.0,-1.0 2.0,-5.0")]}, contents = []})]})

header :: Double -> Rect Double -> [Markup] -> Markup

Create the classic SVG element

>>> header 100 one [Markup "foo" mempty mempty]
Markup {tag = "svg", atts = Attributes {attMap = fromList [("height","100"),("viewBox","-0.5 -0.5 1.0 1.0"),("width","100"),("xmlns","http://www.w3.org/2000/svg"),("xmlns:xlink","http://www.w3.org/1999/xlink")]}, contents = [MarkupLeaf (Markup {tag = "foo", atts = Attributes {attMap = fromList []}, contents = []})]}

renderChartOptions :: ChartOptions -> Text

Render ChartOptions to an SVG Text snippet

>>> renderChartOptions (ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty)
"<svg height=\"300\" viewBox=\"-0.75 -0.5 1.5 1.0\" width=\"450\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"><style></style><g class=\"chart\"/><g class=\"hud\"/></svg>"

encodeChartOptions :: ChartOptions -> ByteString

Render ChartOptions to an SVG ByteString

>>> encodeChartOptions (ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty)
"<svg height=\"300\" viewBox=\"-0.75 -0.5 1.5 1.0\" width=\"450\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"><style></style><g class=\"chart\"/><g class=\"hud\"/></svg>"

writeChartOptions :: FilePath -> ChartOptions -> IO ()

Convert ChartOptions to an SVG ByteString and save to a file

data CssOptions

css options

>>> defaultCssOptions
CssOptions {shapeRendering = NoShapeRendering, preferColorScheme = PreferHud, cssExtra = ""}

Constructors

CssOptions

Fields

• shapeRendering :: CssShapeRendering
• preferColorScheme :: CssPreferColorScheme
• cssExtra :: ByteString

Instances

Generic CssOptions

Defined in Chart.Markup

Associated Types

type Rep CssOptions :: Type -> Type

Methods

from :: CssOptions -> Rep CssOptions x

to :: Rep CssOptions x -> CssOptions

Show CssOptions

Defined in Chart.Markup

Methods

showsPrec :: Int -> CssOptions -> ShowS

show :: CssOptions -> String

showList :: [CssOptions] -> ShowS

Eq CssOptions

Defined in Chart.Markup

Methods

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

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

type Rep CssOptions

Defined in Chart.Markup

type Rep CssOptions = D1 ('MetaData "CssOptions" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "CssOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "shapeRendering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CssShapeRendering) :*: (S1 ('MetaSel ('Just "preferColorScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CssPreferColorScheme) :*: S1 ('MetaSel ('Just "cssExtra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))

defaultCssOptions :: CssOptions

No special shape rendering and default hud responds to user color scheme preferences.

data CssPreferColorScheme

CSS prefer-color-scheme options

Constructors

PreferHud

includes css that switches approriate hud elements between light and dark.

PreferDark

PreferLight

PreferNormal

Instances

Generic CssPreferColorScheme

Defined in Chart.Markup

Associated Types

type Rep CssPreferColorScheme :: Type -> Type

Methods

from :: CssPreferColorScheme -> Rep CssPreferColorScheme x

to :: Rep CssPreferColorScheme x -> CssPreferColorScheme

Show CssPreferColorScheme

Defined in Chart.Markup

Methods

showsPrec :: Int -> CssPreferColorScheme -> ShowS

show :: CssPreferColorScheme -> String

showList :: [CssPreferColorScheme] -> ShowS

Eq CssPreferColorScheme

Defined in Chart.Markup

Methods

(==) :: CssPreferColorScheme -> CssPreferColorScheme -> Bool

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

type Rep CssPreferColorScheme

Defined in Chart.Markup

type Rep CssPreferColorScheme = D1 ('MetaData "CssPreferColorScheme" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) ((C1 ('MetaCons "PreferHud" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PreferDark" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PreferLight" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PreferNormal" 'PrefixI 'False) (U1 :: Type -> Type)))

cssPreferColorScheme :: (Colour, Colour) -> CssPreferColorScheme -> ByteString

CSS prefer-color-scheme text snippet

>>> cssPreferColorScheme (light, dark) PreferHud
"svg {\n  color-scheme: light dark;\n}\n{\n  .canvas g, .title g, .axisbar g, .ticktext g, .tickglyph g, .ticklines g, .legendContent g text {\n    fill: rgb(5%, 5%, 5%);\n  }\n  .ticklines g, .tickglyph g, .legendBorder g {\n    stroke: rgb(5%, 5%, 5%);\n  }\n  .legendBorder g {\n    fill: rgb(94%, 94%, 94%);\n  }\n}\n@media (prefers-color-scheme:dark) {\n  .canvas g, .title g, .axisbar g, .ticktext g, .tickglyph g, .ticklines g, .legendContent g text {\n    fill: rgb(94%, 94%, 94%);\n  }\n  .ticklines g, .tickglyph g, .legendBorder g {\n    stroke: rgb(94%, 94%, 94%);\n  }\n  .legendBorder g {\n    fill: rgb(5%, 5%, 5%);\n  }\n}"

fillSwitch :: (Colour, Colour) -> ByteString -> ByteString -> ByteString

CSS snippet to switch between dark and light mode

fillSwitch (color1, color2) "dark" "stuff"

... will default to color1 for elements of the "stuff" class, but switch to color2 if "dark" mode is preferred by the user.

data CssShapeRendering

CSS shape rendering options

Constructors

UseGeometricPrecision

UseCssCrisp

NoShapeRendering

Instances

Generic CssShapeRendering

Defined in Chart.Markup

Associated Types

type Rep CssShapeRendering :: Type -> Type

Methods

from :: CssShapeRendering -> Rep CssShapeRendering x

to :: Rep CssShapeRendering x -> CssShapeRendering

Show CssShapeRendering

Defined in Chart.Markup

Methods

showsPrec :: Int -> CssShapeRendering -> ShowS

show :: CssShapeRendering -> String

showList :: [CssShapeRendering] -> ShowS

Eq CssShapeRendering

Defined in Chart.Markup

Methods

(==) :: CssShapeRendering -> CssShapeRendering -> Bool

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

type Rep CssShapeRendering

Defined in Chart.Markup

type Rep CssShapeRendering = D1 ('MetaData "CssShapeRendering" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "UseGeometricPrecision" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UseCssCrisp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoShapeRendering" 'PrefixI 'False) (U1 :: Type -> Type)))

markupCssOptions :: CssOptions -> Markup

Convert CssOptions to Markup

>>> markupCssOptions defaultCssOptions
Markup {tag = "style", atts = Attributes {attMap = fromList []}, contents = [Content "svg {\n  color-scheme: light dark;\n}\n{\n  .canvas g, .title g, .axisbar g, .ticktext g, .tickglyph g, .ticklines g, .legendContent g text {\n    fill: rgb(5%, 5%, 5%);\n  }\n  .ticklines g, .tickglyph g, .legendBorder g {\n    stroke: rgb(5%, 5%, 5%);\n  }\n  .legendBorder g {\n    fill: rgb(94%, 94%, 94%);\n  }\n}\n@media (prefers-color-scheme:dark) {\n  .canvas g, .title g, .axisbar g, .ticktext g, .tickglyph g, .ticklines g, .legendContent g text {\n    fill: rgb(94%, 94%, 94%);\n  }\n  .ticklines g, .tickglyph g, .legendBorder g {\n    stroke: rgb(94%, 94%, 94%);\n  }\n  .legendBorder g {\n    fill: rgb(5%, 5%, 5%);\n  }\n}"]}

data MarkupOptions

Markup options.

>>> defaultMarkupOptions
MarkupOptions {markupHeight = 300.0, cssOptions = CssOptions {shapeRendering = NoShapeRendering, preferColorScheme = PreferHud, cssExtra = ""}}

Constructors

MarkupOptions

Fields

• markupHeight :: Double
• cssOptions :: CssOptions

Instances

Generic MarkupOptions

Defined in Chart.Markup

Associated Types

type Rep MarkupOptions :: Type -> Type

Methods

from :: MarkupOptions -> Rep MarkupOptions x

to :: Rep MarkupOptions x -> MarkupOptions

Show MarkupOptions

Defined in Chart.Markup

Methods

showsPrec :: Int -> MarkupOptions -> ShowS

show :: MarkupOptions -> String

showList :: [MarkupOptions] -> ShowS

Eq MarkupOptions

Defined in Chart.Markup

Methods

(==) :: MarkupOptions -> MarkupOptions -> Bool

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

type Rep MarkupOptions

Defined in Chart.Markup

type Rep MarkupOptions = D1 ('MetaData "MarkupOptions" "Chart.Markup" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "MarkupOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "markupHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "cssOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CssOptions)))

defaultMarkupOptions :: MarkupOptions

The official markup options

encodeNum :: Double -> ByteString

Show a Double, or rounded to 4 decimal places if this is shorter.

>>> encodeNum 1
"1.0"

>>> encodeNum 1.23456
"1.2346"

encodePx :: Double -> ByteString

SVG width and height, without any unit suffix, are defined as pixels, which are Integers

>>> encodePx 300.0
"300"