Chart.Markup

Conversion between ChartOptions and Markup representations.

Documentation

newtype Markup

A list of Elements or Tree Tokens

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

Constructors

Markup

Fields

• elements :: [Element]

Instances

Monoid Markup

Defined in MarkupParse

Methods

mempty :: Markup

mappend :: Markup -> Markup -> Markup

mconcat :: [Markup] -> Markup

Semigroup Markup

Defined in MarkupParse

Methods

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

sconcat :: NonEmpty Markup -> Markup

stimes :: Integral b => b -> Markup -> Markup

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.1.1-Ux2cyiaJyB5WjBazMvHjb" 'True) (C1 ('MetaCons "Markup" 'PrefixI 'True) (S1 ('MetaSel ('Just "elements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Element])))

data ChartOptions

A product type consisting of a ChartTree, HudOptions and MarkupOptions, which is what you need to create Markup.

Constructors

ChartOptions

Fields

• markupOptions :: MarkupOptions
• hudOptions :: HudOptions
• chartTree :: 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.6.0.0-HjsGv1l8hv76XDZORokPY6" '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 "chartTree") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChartTree))))

forgetHud :: ChartOptions -> ChartOptions

Processes the hud options and turns them into charts, rescales the existing charts, resets the hud options to mempty, and turns on ScalePArea in chart styles.

Note that this is a destructive operation, and, in particular, that

view #chartTree (forgetHud (mempty & set #chartTree c)) /= c

markupChartOptions :: ChartOptions -> Markup

Convert ChartOptions to Markup

>>> markupChartOptions (ChartOptions (defaultMarkupOptions & #cssOptions % #preferColorScheme .~ PreferNormal) mempty mempty) & markdown_ Compact Xml
"<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"300\" height=\"300\" viewBox=\"-0.5 -0.5 1.0 1.0\"><style>\nsvg { font-family: system-ui,-apple-system,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",\"Liberation Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n}\n\nticktext { font-family: SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;\n}\n\n</style><g class=\"chart\"></g><g class=\"hud\"></g></svg>"

markupChartTree :: ChartTree -> Markup

Convert a ChartTree to markup

>>> lineExample & view #chartTree & markupChartTree & markdown_ Compact Xml
"<g class=\"line\"><g stroke-width=\"0.0150\" stroke=\"rgb(2%, 73%, 80%)\" stroke-opacity=\"1.0\" fill=\"none\"><polyline points=\"0,-1.0 1.0,-1.0 2.0,-5.0\"/></g><g stroke-width=\"0.0150\" stroke=\"rgb(2%, 29%, 48%)\" stroke-opacity=\"1.0\" fill=\"none\"><polyline points=\"0,0 2.8,-3.0\"/></g><g stroke-width=\"0.0150\" stroke=\"rgb(66%, 7%, 55%)\" stroke-opacity=\"1.0\" fill=\"none\"><polyline points=\"0.5,-4.0 0.5,0\"/></g></g>"

markupChart :: Chart -> Markup

Convert a Chart to Markup

>>> import MarkupParse
>>> import Optics.Core
>>> import Control.Category ((>>>))
>>> lineExample & toListOf (#chartTree % charts') & mconcat & fmap (markupChart >>> markdown_ Compact Xml)
["<g stroke-width=\"0.0150\" stroke=\"rgb(2%, 73%, 80%)\" stroke-opacity=\"1.0\" fill=\"none\"><polyline points=\"0,-1.0 1.0,-1.0 2.0,-5.0\"/></g>","<g stroke-width=\"0.0150\" stroke=\"rgb(2%, 29%, 48%)\" stroke-opacity=\"1.0\" fill=\"none\"><polyline points=\"0,0 2.8,-3.0\"/></g>","<g stroke-width=\"0.0150\" stroke=\"rgb(66%, 7%, 55%)\" stroke-opacity=\"1.0\" fill=\"none\"><polyline points=\"0.5,-4.0 0.5,0\"/></g>"]

header :: Maybe Double -> Rect Double -> Markup -> Markup

Create the classic SVG element

>>> header (Just 300) (Rect (-0.75) 0.75 (-0.5) 0.5) (element_ "foo" []) & markdown_ Compact Xml
"<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\"><foo></foo></svg>"

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=\"300\" height=\"300\" viewBox=\"-0.5 -0.5 1.0 1.0\"><style>\nsvg { font-family: system-ui,-apple-system,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",\"Liberation Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n}\n\nticktext { font-family: SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;\n}\n\n</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=\"300\" height=\"300\" viewBox=\"-0.5 -0.5 1.0 1.0\"><style>\nsvg { font-family: system-ui,-apple-system,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",\"Liberation Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n}\n\nticktext { font-family: SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;\n}\n\n</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, fontFamilies = "\nsvg { font-family: system-ui,-apple-system,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",\"Liberation Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n}\n\nticktext { font-family: SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;\n}\n\n", cssExtra = ""}

Constructors

CssOptions

Fields

• shapeRendering :: ShapeRendering
• preferColorScheme :: PreferColorScheme
• fontFamilies :: ByteString
• 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.6.0.0-HjsGv1l8hv76XDZORokPY6" 'False) (C1 ('MetaCons "CssOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shapeRendering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShapeRendering) :*: S1 ('MetaSel ('Just "preferColorScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PreferColorScheme)) :*: (S1 ('MetaSel ('Just "fontFamilies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: 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 PreferColorScheme

CSS prefer-color-scheme options

Constructors

PreferHud

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

PreferDark

PreferLight

PreferNormal

Instances

Generic PreferColorScheme

Defined in Chart.Markup

Associated Types

type Rep PreferColorScheme :: Type -> Type

Methods

from :: PreferColorScheme -> Rep PreferColorScheme x

to :: Rep PreferColorScheme x -> PreferColorScheme

Show PreferColorScheme

Defined in Chart.Markup

Methods

showsPrec :: Int -> PreferColorScheme -> ShowS

show :: PreferColorScheme -> String

showList :: [PreferColorScheme] -> ShowS

Eq PreferColorScheme

Defined in Chart.Markup

Methods

(==) :: PreferColorScheme -> PreferColorScheme -> Bool

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

type Rep PreferColorScheme

Defined in Chart.Markup

type Rep PreferColorScheme = D1 ('MetaData "PreferColorScheme" "Chart.Markup" "chart-svg-0.6.0.0-HjsGv1l8hv76XDZORokPY6" '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) -> PreferColorScheme -> 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 ShapeRendering

CSS glyphShape rendering options

Constructors

UseGeometricPrecision

UseCssCrisp

NoShapeRendering

Instances

Generic ShapeRendering

Defined in Chart.Markup

Associated Types

type Rep ShapeRendering :: Type -> Type

Methods

from :: ShapeRendering -> Rep ShapeRendering x

to :: Rep ShapeRendering x -> ShapeRendering

Show ShapeRendering

Defined in Chart.Markup

Methods

showsPrec :: Int -> ShapeRendering -> ShowS

show :: ShapeRendering -> String

showList :: [ShapeRendering] -> ShowS

Eq ShapeRendering

Defined in Chart.Markup

Methods

(==) :: ShapeRendering -> ShapeRendering -> Bool

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

type Rep ShapeRendering

Defined in Chart.Markup

type Rep ShapeRendering = D1 ('MetaData "ShapeRendering" "Chart.Markup" "chart-svg-0.6.0.0-HjsGv1l8hv76XDZORokPY6" '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

data MarkupOptions

Markup options.

>>> defaultMarkupOptions
MarkupOptions {markupHeight = Just 300.0, chartAspect = FixedAspect 1.5, cssOptions = CssOptions {shapeRendering = NoShapeRendering, preferColorScheme = PreferHud, fontFamilies = "\nsvg { font-family: system-ui,-apple-system,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",\"Liberation Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n}\n\nticktext { font-family: SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;\n}\n\n", cssExtra = ""}, renderStyle = Compact}

Constructors

MarkupOptions

Fields

• markupHeight :: Maybe Double
• chartAspect :: ChartAspect
• cssOptions :: CssOptions
• renderStyle :: RenderStyle

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.6.0.0-HjsGv1l8hv76XDZORokPY6" 'False) (C1 ('MetaCons "MarkupOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "markupHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "chartAspect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChartAspect)) :*: (S1 ('MetaSel ('Just "cssOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CssOptions) :*: S1 ('MetaSel ('Just "renderStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RenderStyle))))

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"

defaultCssFontFamilies :: ByteString

default fonts.