Chart.Svg

Conversion from a chart to SVG.

ChartSvg

data ChartSvg

Specification of a chart ready to be rendered to SVG includes:

• svg options
• hud options
• any extra hud elements beyond the usual options
• an underlying chart tree.

See Data.Examples for usage.

Constructors

ChartSvg

Fields

• svgOptions :: SvgOptions
• hudOptions :: HudOptions
• extraHuds :: [Hud]
• charts :: ChartTree

Instances

Monoid ChartSvg

Defined in Chart.Svg

Methods

mempty :: ChartSvg

mappend :: ChartSvg -> ChartSvg -> ChartSvg

mconcat :: [ChartSvg] -> ChartSvg

Semigroup ChartSvg

Defined in Chart.Svg

Methods

(<>) :: ChartSvg -> ChartSvg -> ChartSvg

sconcat :: NonEmpty ChartSvg -> ChartSvg

stimes :: Integral b => b -> ChartSvg -> ChartSvg

Generic ChartSvg

Defined in Chart.Svg

Associated Types

type Rep ChartSvg :: Type -> Type

Methods

from :: ChartSvg -> Rep ChartSvg x

to :: Rep ChartSvg x -> ChartSvg

type Rep ChartSvg

Defined in Chart.Svg

type Rep ChartSvg = D1 ('MetaData "ChartSvg" "Chart.Svg" "chart-svg-0.3.3-HRZp9R2U1Kt6XiFnJzSSfo" 'False) (C1 ('MetaCons "ChartSvg" 'PrefixI 'True) ((S1 ('MetaSel ('Just "svgOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SvgOptions) :*: S1 ('MetaSel ('Just "hudOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HudOptions)) :*: (S1 ('MetaSel ('Just "extraHuds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Hud]) :*: S1 ('MetaSel ('Just "charts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChartTree))))

toChartTree :: ChartSvg -> ChartTree

consume the huds transforming a ChartSvg to a ChartTree

writeChartSvg :: FilePath -> ChartSvg -> IO ()

Write to a file.

chartSvg :: ChartSvg -> Text

Render a chart using the supplied svg and hud config.

>>> chartSvg mempty
"<svg width=\"450.0\" height=\"300.0\" viewBox=\"-0.75 -0.5 1.5 1.0\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"><style>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: #0d0d0d;\n  }\n  .ticklines g, .tickglyph g, .legendBorder g {\n    stroke: #0d0d0d;\n  }\n  .legendBorder g {\n    fill: #f0f0f0;\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: #f0f0f0;\n  }\n  .ticklines g, .tickglyph g, .legendBorder g {\n    stroke: #f0f0f0;\n  }\n  .legendBorder g {\n    fill: #0d0d0d;\n  }\n}</style><g class=\"chart\"></g><g class=\"hud\"></g></svg>"

initialCanvas :: ChartAspect -> ChartTree -> CanvasBox

The initial canvas before applying Huds

>>> initialCanvas (FixedAspect 1.5) (unnamed [RectChart defaultRectStyle [one]])
Rect -0.75 0.75 -0.5 0.5

SVG Options

data SvgOptions

SVG tag options.

>>> defaultSvgOptions
SvgOptions {svgHeight = 300.0, cssOptions = CssOptions {shapeRendering = NoShapeRendering, preferColorScheme = PreferHud, cssExtra = ""}}

Constructors

SvgOptions

Fields

• svgHeight :: Double
• cssOptions :: CssOptions

Instances

Generic SvgOptions

Defined in Chart.Svg

Associated Types

type Rep SvgOptions :: Type -> Type

Methods

from :: SvgOptions -> Rep SvgOptions x

to :: Rep SvgOptions x -> SvgOptions

Show SvgOptions

Defined in Chart.Svg

Methods

showsPrec :: Int -> SvgOptions -> ShowS

show :: SvgOptions -> String

showList :: [SvgOptions] -> ShowS

Eq SvgOptions

Defined in Chart.Svg

Methods

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

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

type Rep SvgOptions

Defined in Chart.Svg

type Rep SvgOptions = D1 ('MetaData "SvgOptions" "Chart.Svg" "chart-svg-0.3.3-HRZp9R2U1Kt6XiFnJzSSfo" 'False) (C1 ('MetaCons "SvgOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "svgHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "cssOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CssOptions)))

defaultSvgOptions :: SvgOptions

The official svg options

SVG Style primitives

data CssOptions

css options

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

Constructors

CssOptions

Fields

• shapeRendering :: CssShapeRendering
• preferColorScheme :: CssPreferColorScheme
• cssExtra :: Text

Instances

Generic CssOptions

Defined in Chart.Svg

Associated Types

type Rep CssOptions :: Type -> Type

Methods

from :: CssOptions -> Rep CssOptions x

to :: Rep CssOptions x -> CssOptions

Show CssOptions

Defined in Chart.Svg

Methods

showsPrec :: Int -> CssOptions -> ShowS

show :: CssOptions -> String

showList :: [CssOptions] -> ShowS

Eq CssOptions

Defined in Chart.Svg

Methods

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

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

type Rep CssOptions

Defined in Chart.Svg

type Rep CssOptions = D1 ('MetaData "CssOptions" "Chart.Svg" "chart-svg-0.3.3-HRZp9R2U1Kt6XiFnJzSSfo" '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 Text))))

defaultCssOptions :: CssOptions

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

data CssShapeRendering

CSS shape rendering options

Constructors

UseGeometricPrecision

UseCssCrisp

NoShapeRendering

Instances

Generic CssShapeRendering

Defined in Chart.Svg

Associated Types

type Rep CssShapeRendering :: Type -> Type

Methods

from :: CssShapeRendering -> Rep CssShapeRendering x

to :: Rep CssShapeRendering x -> CssShapeRendering

Show CssShapeRendering

Defined in Chart.Svg

Methods

showsPrec :: Int -> CssShapeRendering -> ShowS

show :: CssShapeRendering -> String

showList :: [CssShapeRendering] -> ShowS

Eq CssShapeRendering

Defined in Chart.Svg

Methods

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

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

type Rep CssShapeRendering

Defined in Chart.Svg

type Rep CssShapeRendering = D1 ('MetaData "CssShapeRendering" "Chart.Svg" "chart-svg-0.3.3-HRZp9R2U1Kt6XiFnJzSSfo" '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)))

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.Svg

Associated Types

type Rep CssPreferColorScheme :: Type -> Type

Methods

from :: CssPreferColorScheme -> Rep CssPreferColorScheme x

to :: Rep CssPreferColorScheme x -> CssPreferColorScheme

Show CssPreferColorScheme

Defined in Chart.Svg

Methods

showsPrec :: Int -> CssPreferColorScheme -> ShowS

show :: CssPreferColorScheme -> String

showList :: [CssPreferColorScheme] -> ShowS

Eq CssPreferColorScheme

Defined in Chart.Svg

Methods

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

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

type Rep CssPreferColorScheme

Defined in Chart.Svg

type Rep CssPreferColorScheme = D1 ('MetaData "CssPreferColorScheme" "Chart.Svg" "chart-svg-0.3.3-HRZp9R2U1Kt6XiFnJzSSfo" '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)))

cssShapeRendering :: CssShapeRendering -> Text

CSS shape rendering text snippet

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

CSS prefer-color-scheme text snippet