Safe Haskell | Safe-Inferred |
---|---|
Language | GHC2021 |
Conversion between Chart and Markup representations.
Synopsis
- newtype Markup = Markup {}
- data ChartOptions = ChartOptions {}
- markupChartOptions :: ChartOptions -> Markup
- markupChartTree :: ChartTree -> Markup
- markupChart :: Chart -> Markup
- header :: Double -> Rect Double -> Markup -> Markup
- renderChartOptions :: ChartOptions -> Text
- encodeChartOptions :: ChartOptions -> ByteString
- writeChartOptions :: FilePath -> ChartOptions -> IO ()
- data CssOptions = CssOptions {}
- defaultCssOptions :: CssOptions
- data CssPreferColorScheme
- cssPreferColorScheme :: (Colour, Colour) -> CssPreferColorScheme -> ByteString
- fillSwitch :: (Colour, Colour) -> ByteString -> ByteString -> ByteString
- data CssShapeRendering
- markupCssOptions :: CssOptions -> Markup
- data MarkupOptions = MarkupOptions {}
- defaultMarkupOptions :: MarkupOptions
- encodeNum :: Double -> ByteString
- encodePx :: Double -> ByteString
Documentation
A list of Element
s or Tree
Token
s
>>>
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 = []}]}]})
data ChartOptions Source #
A product type representing charts, hud options and markup options, which can be transformed into Markup
.
Instances
markupChartOptions :: ChartOptions -> Markup Source #
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=\"450\" height=\"300\" viewBox=\"-0.75 -0.5 1.5 1.0\"><style></style><g class=\"chart\"></g><g class=\"hud\"></g></svg>"
markupChartTree :: ChartTree -> Markup Source #
Convert a ChartTree to markup
>>>
lineExample & view #charts & 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 Source #
Convert a Chart to Markup
>>>
lineExample & view #charts & foldOf charts' & head & 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>"
header :: Double -> Rect Double -> Markup -> Markup Source #
Create the classic SVG element
>>>
header 100 one (element_ "foo" []) & markdown_ Compact Xml
"<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"100\" height=\"100\" viewBox=\"-0.5 -0.5 1.0 1.0\"><foo></foo></svg>"
renderChartOptions :: ChartOptions -> Text Source #
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 Source #
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 () Source #
Convert ChartOptions to an SVG ByteString and save to a file
data CssOptions Source #
css options
>>>
defaultCssOptions
CssOptions {shapeRendering = NoShapeRendering, preferColorScheme = PreferHud, cssExtra = ""}
Instances
defaultCssOptions :: CssOptions Source #
No special shape rendering and default hud responds to user color scheme preferences.
data CssPreferColorScheme Source #
CSS prefer-color-scheme options
PreferHud | includes css that switches approriate hud elements between light and dark. |
PreferDark | |
PreferLight | |
PreferNormal |
Instances
cssPreferColorScheme :: (Colour, Colour) -> CssPreferColorScheme -> ByteString Source #
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 Source #
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 Source #
CSS shape rendering options
Instances
Generic CssShapeRendering Source # | |
Defined in Chart.Markup type Rep CssShapeRendering :: Type -> Type # from :: CssShapeRendering -> Rep CssShapeRendering x # to :: Rep CssShapeRendering x -> CssShapeRendering # | |
Show CssShapeRendering Source # | |
Defined in Chart.Markup showsPrec :: Int -> CssShapeRendering -> ShowS # show :: CssShapeRendering -> String # showList :: [CssShapeRendering] -> ShowS # | |
Eq CssShapeRendering Source # | |
Defined in Chart.Markup (==) :: CssShapeRendering -> CssShapeRendering -> Bool # (/=) :: CssShapeRendering -> CssShapeRendering -> Bool # | |
type Rep CssShapeRendering Source # | |
Defined in Chart.Markup type Rep CssShapeRendering = D1 ('MetaData "CssShapeRendering" "Chart.Markup" "chart-svg-0.5.1.1-8lY6oe5XleKGDEXDqpr6ug" '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 Source #
Convert CssOptions to Markup
data MarkupOptions Source #
Markup options.
>>>
defaultMarkupOptions
MarkupOptions {markupHeight = 300.0, cssOptions = CssOptions {shapeRendering = NoShapeRendering, preferColorScheme = PreferHud, cssExtra = ""}, renderStyle = Compact}
Instances
defaultMarkupOptions :: MarkupOptions Source #
The official markup options
encodeNum :: Double -> ByteString Source #
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 Source #
SVG width and height, without any unit suffix, are defined as pixels, which are Integers
>>>
encodePx 300.0
"300"