Chart.Markup

Conversion between Chart and Markup representations.

Documentation

data Markup

A Tree list of markup Tokens

>>> markup Html "<foo class=\"bar\">baz</foo>"
That (Markup {standard = Html, markupTree = [Node {rootLabel = StartTag "foo" [Attr "class" "bar"], subForest = [Node {rootLabel = Content "baz", subForest = []}]}]})

Constructors

Markup

Fields

• standard :: Standard
• markupTree :: [Tree Token]

Instances

Generic Markup

Defined in MarkupParse

Associated Types

type Rep Markup :: Type -> Type

Methods

from :: Markup -> Rep Markup x

to :: Rep Markup x -> Markup

Show Markup

Defined in MarkupParse

Methods

showsPrec :: Int -> Markup -> ShowS

show :: Markup -> String

showList :: [Markup] -> ShowS

NFData Markup

Defined in MarkupParse

Methods

rnf :: Markup -> ()

Eq Markup

Defined in MarkupParse

Methods

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

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

Ord Markup

Defined in MarkupParse

Methods

compare :: Markup -> Markup -> Ordering

(<) :: Markup -> Markup -> Bool

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

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

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

max :: Markup -> Markup -> Markup

min :: Markup -> Markup -> Markup

ToExpr Markup

Defined in MarkupParse

Methods

toExpr :: Markup -> Expr

listToExpr :: [Markup] -> Expr

type Rep Markup

Defined in MarkupParse

type Rep Markup = D1 ('MetaData "Markup" "MarkupParse" "markup-parse-0.0.0.2-HnQ2lGo9uJcI0zQ43aTniK" 'False) (C1 ('MetaCons "Markup" 'PrefixI 'True) (S1 ('MetaSel ('Just "standard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Standard) :*: S1 ('MetaSel ('Just "markupTree") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tree Token])))

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.5.0.0-j0IiNmAoTijF1cKEqaYg" 'False) (C1 ('MetaCons "ChartOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "markupOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkupOptions) :*: (S1 ('MetaSel ('Just "hudOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HudOptions) :*: S1 ('MetaSel ('Just "charts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChartTree))))

markupChartOptions :: ChartOptions -> Markup

Convert ChartOptions to Markup

>>> markupChartOptions (ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty)
Markup {standard = Xml, markupTree = [Node {rootLabel = StartTag "svg" [Attr "xmlns" "http://www.w3.org/2000/svg",Attr "xmlns:xlink" "http://www.w3.org/1999/xlink",Attr "width" "450",Attr "height" "300",Attr "viewBox" "-0.75 -0.5 1.5 1.0"], subForest = [Node {rootLabel = StartTag "style" [], subForest = [Node {rootLabel = Content "", subForest = []}]},Node {rootLabel = StartTag "g" [Attr "class" "chart"], subForest = []},Node {rootLabel = StartTag "g" [Attr "class" "hud"], subForest = []}]}]}

markupChartTree :: ChartTree -> [Tree Token]

Convert a ChartTree to markup

>>> lineExample & view #charts & markupChartTree
[Node {rootLabel = StartTag "g" [Attr "class" "line"], subForest = [Node {rootLabel = StartTag "g" [Attr "stroke-width" "0.0150",Attr "stroke" "rgb(2%, 73%, 80%)",Attr "stroke-opacity" "1.0",Attr "fill" "none"], subForest = [Node {rootLabel = EmptyElemTag "polyline" [Attr "points" "0,-1.0 1.0,-1.0 2.0,-5.0"], subForest = []}]},Node {rootLabel = StartTag "g" [Attr "stroke-width" "0.0150",Attr "stroke" "rgb(2%, 29%, 48%)",Attr "stroke-opacity" "1.0",Attr "fill" "none"], subForest = [Node {rootLabel = EmptyElemTag "polyline" [Attr "points" "0,0 2.8,-3.0"], subForest = []}]},Node {rootLabel = StartTag "g" [Attr "stroke-width" "0.0150",Attr "stroke" "rgb(66%, 7%, 55%)",Attr "stroke-opacity" "1.0",Attr "fill" "none"], subForest = [Node {rootLabel = EmptyElemTag "polyline" [Attr "points" "0.5,-4.0 0.5,0"], subForest = []}]}]}]

markupChart :: Chart -> [Tree Token]

Convert a Chart to Markup

>>> lineExample & view #charts & foldOf charts' & head & markupChart
[Node {rootLabel = StartTag "g" [Attr "stroke-width" "0.0150",Attr "stroke" "rgb(2%, 73%, 80%)",Attr "stroke-opacity" "1.0",Attr "fill" "none"], subForest = [Node {rootLabel = EmptyElemTag "polyline" [Attr "points" "0,-1.0 1.0,-1.0 2.0,-5.0"], subForest = []}]}]

header :: Double -> Rect Double -> [Tree Token] -> Tree Token

Create the classic SVG element

>>> header 100 one [pure (StartTag "foo" [])]
Node {rootLabel = StartTag "svg" [Attr "xmlns" "http://www.w3.org/2000/svg",Attr "xmlns:xlink" "http://www.w3.org/1999/xlink",Attr "width" "100",Attr "height" "100",Attr "viewBox" "-0.5 -0.5 1.0 1.0"], subForest = [Node {rootLabel = StartTag "foo" [], subForest = []}]}

renderChartOptions :: ChartOptions -> Text

Render ChartOptions to an SVG Text snippet

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

encodeChartOptions :: ChartOptions -> ByteString

Render ChartOptions to an SVG ByteString

>>> encodeChartOptions (ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty)
"<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"450\" height=\"300\" viewBox=\"-0.75 -0.5 1.5 1.0\"><style></style><g class=\"chart\"></g><g class=\"hud\"></g></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.5.0.0-j0IiNmAoTijF1cKEqaYg" 'False) (C1 ('MetaCons "CssOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "shapeRendering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CssShapeRendering) :*: (S1 ('MetaSel ('Just "preferColorScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CssPreferColorScheme) :*: S1 ('MetaSel ('Just "cssExtra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (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.5.0.0-j0IiNmAoTijF1cKEqaYg" '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.5.0.0-j0IiNmAoTijF1cKEqaYg" '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 -> Tree Token

Convert CssOptions to Markup

>>> markupCssOptions defaultCssOptions
Node {rootLabel = StartTag "style" [], subForest = [Node {rootLabel = 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}", subForest = []}]}

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.5.0.0-j0IiNmAoTijF1cKEqaYg" 'False) (C1 ('MetaCons "MarkupOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "markupHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "cssOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (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"