Copyright	(c) 2025
License	MIT
Maintainer	mschavinda@gmail.com
Safe Haskell	None
Language	GHC2021

Granite.Svg

Description

SVG plotting backend that mirrors the API of Granite. Each chart function returns a self-contained SVG document as Text.

Synopsis

data Plot = Plot {
- widthChars :: Int
- heightChars :: Int
- leftMargin :: Int
- bottomMargin :: Int
- titleMargin :: Int
- xBounds :: (Maybe Double, Maybe Double)
- yBounds :: (Maybe Double, Maybe Double)
- plotTitle :: Text
- legendPos :: LegendPos
- colorPalette :: [Color]
- xFormatter :: LabelFormatter
- yFormatter :: LabelFormatter
- xNumTicks :: Int
- yNumTicks :: Int
}
defPlot :: Plot
data LegendPos
- = LegendRight
- | LegendBottom
- | LegendNone
data Color where
- Color !Word8 !Word8 !Word8
- pattern Black :: Color
- pattern Red :: Color
- pattern Green :: Color
- pattern Yellow :: Color
- pattern Blue :: Color
- pattern Magenta :: Color
- pattern Cyan :: Color
- pattern White :: Color
- pattern BrightBlack :: Color
- pattern BrightRed :: Color
- pattern BrightGreen :: Color
- pattern BrightYellow :: Color
- pattern BrightBlue :: Color
- pattern BrightMagenta :: Color
- pattern BrightCyan :: Color
- pattern BrightWhite :: Color
- pattern Default :: Color
data AxisEnv = AxisEnv {
- domain :: (Double, Double)
- tickIndex :: Int
- tickCount :: Int
}
type LabelFormatter = AxisEnv -> Int -> Double -> Text
data Bins = Bins {
- nBins :: Int
- lo :: Double
- hi :: Double
}
bins :: Int -> Double -> Double -> Bins
series :: Text -> [(Double, Double)] -> (Text, [(Double, Double)])
scatter :: [(Text, [(Double, Double)])] -> Plot -> Text
lineGraph :: [(Text, [(Double, Double)])] -> Plot -> Text
bars :: [(Text, Double)] -> Plot -> Text
stackedBars :: [(Text, [(Text, Double)])] -> Plot -> Text
histogram :: Bins -> [Double] -> Plot -> Text
pie :: [(Text, Double)] -> Plot -> Text
heatmap :: [[Double]] -> Plot -> Text
boxPlot :: [(Text, [Double])] -> Plot -> Text
area :: [(Text, [(Double, Double)])] -> Plot -> Text
ribbon :: [(Text, [(Double, Double, Double)])] -> Plot -> Text
density :: [(Text, [Double])] -> Plot -> Text
errorBars :: [(Text, [(Double, Double, Double, Double)])] -> Plot -> Text
funnel :: [(Text, Double)] -> Plot -> Text
polarLine :: [(Text, [(Double, Double)])] -> Plot -> Text
waterfall :: [(Text, Double, Double)] -> Plot -> Text
distPlot :: [(Text, [Double])] -> Plot -> Text
gauss :: [Double] -> [(Text, Double)] -> Plot -> Text

Documentation

data Plot Source #

Plot configuration parameters.

Controls the appearance and layout of generated charts.

Constructors

Plot

Fields

widthChars :: Int
Width of the plot area in terminal characters (default: 60)
heightChars :: Int
Height of the plot area in terminal characters (default: 20)
leftMargin :: Int
Space reserved for y-axis labels (default: 6)
bottomMargin :: Int
Space reserved for x-axis labels (default: 2)
titleMargin :: Int
Space above the plot for the title (default: 1)
xBounds :: (Maybe Double, Maybe Double)
Optional manual x-axis bounds (min, max). Nothing uses automatic bounds with 5% padding.
yBounds :: (Maybe Double, Maybe Double)
Optional manual y-axis bounds (min, max). Nothing uses automatic bounds with 5% padding.
plotTitle :: Text
Title displayed above the plot (default: empty)
legendPos :: LegendPos
Position of the legend (default: LegendRight)
colorPalette :: [Color]
Color palette that'll be used by the plot.
xFormatter :: LabelFormatter
Formatter for x-axis labels.
yFormatter :: LabelFormatter
Formatter for y-axis labels.
xNumTicks :: Int
Number of ticks on the x axis.
yNumTicks :: Int
Number of ticks on the y axis.

defPlot :: Plot Source #

Default plot configuration.

Creates a 60×20 character plot with reasonable defaults:

defPlot = Plot
  { widthChars   = 60
  , heightChars  = 20
  , leftMargin   = 6
  , bottomMargin = 2
  , titleMargin  = 1
  , xBounds      = (Nothing, Nothing)
  , yBounds      = (Nothing, Nothing)
  , plotTitle    = ""
  , legendPos    = LegendRight
  , colorPalette = [ BrightBlue, BrightMagenta, BrightCyan, BrightGreen, BrightYellow, BrightRed, BrightWhite, BrightBlack]
  , xFormatter   = \ _ _ v -> show v
  , yFormatter   = \ _ _ v -> show v
  , xNumTicks    = 2
  , yNumTicks    = 2
  }

data LegendPos Source #

Position of the legend in the plot.

Constructors

LegendRight	Display legend on the right side of the plot
LegendBottom	Display legend below the plot
LegendNone	Do not display legend.

Instances

Instances details

Show LegendPos Source #
Instance details Defined in Granite Methods showsPrec :: Int -> LegendPos -> ShowS # show :: LegendPos -> String # showList :: [LegendPos] -> ShowS #
Eq LegendPos Source #
Instance details Defined in Granite Methods (==) :: LegendPos -> LegendPos -> Bool # (/=) :: LegendPos -> LegendPos -> Bool #

data Color Source #

A 24-bit RGB colour.

Constructors

Color !Word8 !Word8 !Word8

Bundled Patterns

pattern Black :: Color
pattern Red :: Color
pattern Green :: Color
pattern Yellow :: Color
pattern Blue :: Color
pattern Magenta :: Color
pattern Cyan :: Color
pattern White :: Color
pattern BrightBlack :: Color
pattern BrightRed :: Color
pattern BrightGreen :: Color
pattern BrightYellow :: Color
pattern BrightBlue :: Color
pattern BrightMagenta :: Color
pattern BrightCyan :: Color
pattern BrightWhite :: Color
pattern Default :: Color

Instances

Instances details

Read Color Source #
Instance details Defined in Granite.Color Methods readsPrec :: Int -> ReadS Color # readList :: ReadS [Color] # readPrec :: ReadPrec Color # readListPrec :: ReadPrec [Color] #
Show Color Source #
Instance details Defined in Granite.Color Methods showsPrec :: Int -> Color -> ShowS # show :: Color -> String # showList :: [Color] -> ShowS #
Eq Color Source #
Instance details Defined in Granite.Color Methods (==) :: Color -> Color -> Bool # (/=) :: Color -> Color -> Bool #

data AxisEnv Source #

What the formatter gets to know about the axis/ticks

Constructors

AxisEnv
Fields domain :: (Double, Double) min/max of the axis in data space tickIndex :: Int index of THIS tick [0..tickCount-1] tickCount :: Int total number of ticks

type LabelFormatter Source #

Arguments

= AxisEnv	Axis context (domain, tick index/count, etc)
-> Int	Slot width budget in characters for this tick.
-> Double	Raw data value for the tick
-> Text	Rendered label (if it doesn't fit in the slot it will be truncated)

Axis-aware, width-limited, tick-label formatter.

Given:

axis context
a per-tick width budget (in terminal cells)
and the raw tick value.

returns the label to render.

data Bins Source #

Defines the binning parameters.

Constructors

Bins
Fields nBins :: Int lo :: Double hi :: Double

Instances

Instances details

Show Bins Source #
Instance details Defined in Granite Methods showsPrec :: Int -> Bins -> ShowS # show :: Bins -> String # showList :: [Bins] -> ShowS #
Eq Bins Source #
Instance details Defined in Granite Methods (==) :: Bins -> Bins -> Bool # (/=) :: Bins -> Bins -> Bool #

bins :: Int -> Double -> Double -> Bins Source #

Create a bin configuration for histograms.

bins 10 0 100  -- 10 bins from 0 to 100
bins 20 (-5) 5 -- 20 bins from -5 to 5

series Source #

Arguments

:: Text	Name of the series (appears in legend)
-> [(Double, Double)]	List of (x, y) data points
-> (Text, [(Double, Double)])

Create a named data series for multi-series plots.

let s1 = series "Dataset A" [(1,2), (2,4), (3,6)]
    s2 = series "Dataset B" [(1,3), (2,5), (3,7)]
    chart = scatter [s1, s2] defPlot

scatter :: [(Text, [(Double, Double)])] -> Plot -> Text Source #

lineGraph :: [(Text, [(Double, Double)])] -> Plot -> Text Source #

bars :: [(Text, Double)] -> Plot -> Text Source #

stackedBars :: [(Text, [(Text, Double)])] -> Plot -> Text Source #

histogram :: Bins -> [Double] -> Plot -> Text Source #

pie :: [(Text, Double)] -> Plot -> Text Source #

heatmap :: [[Double]] -> Plot -> Text Source #

boxPlot :: [(Text, [Double])] -> Plot -> Text Source #

area :: [(Text, [(Double, Double)])] -> Plot -> Text Source #

ribbon :: [(Text, [(Double, Double, Double)])] -> Plot -> Text Source #

density :: [(Text, [Double])] -> Plot -> Text Source #

errorBars :: [(Text, [(Double, Double, Double, Double)])] -> Plot -> Text Source #

funnel :: [(Text, Double)] -> Plot -> Text Source #

polarLine :: [(Text, [(Double, Double)])] -> Plot -> Text Source #

waterfall :: [(Text, Double, Double)] -> Plot -> Text Source #

distPlot :: [(Text, [Double])] -> Plot -> Text Source #

gauss Source #

Arguments

:: [Double]	Population sample (used to compute μ and σ)
-> [(Text, Double)]	Named markers as `(label, raw value)`; the largest z is highlighted
-> Plot
-> Text

Gaussian / normal-distribution chart in standard-deviation (z-score) units. Mirrors gauss: a KDE bell curve with a stippled scatter fill, an x-axis labelled in σ units, and lollipop annotations for named markers (the largest z highlighted as the outlier).