Granite.Svg · granite-0.7.4.0

datadata Plot

#

Plot configuration parameters.

Controls the appearance and layout of generated charts.

Constructors

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

valuedefPlot :: Plot

#

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
  }

datadata LegendPos

#

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.

Instances2Eq, Show

Eq LegendPosDefined in granite-0.7.4.0 · Granite
Show LegendPosDefined in granite-0.7.4.0 · Granite

datadata Color

#

A 24-bit RGB colour.

Constructors

Color !Word8 !Word8 !Word8

Instances3Eq, Read, Show

Eq ColorDefined in granite-0.7.4.0 · Granite.Color
Read ColorDefined in granite-0.7.4.0 · Granite.Color
Show ColorDefined in granite-0.7.4.0 · Granite.Color

patternpattern Black :: Color

#

patternpattern Blue :: Color

#

patternpattern BrightBlack :: Color

#

patternpattern BrightBlue :: Color

#

patternpattern BrightCyan :: Color

#

patternpattern BrightGreen :: Color

#

patternpattern BrightMagenta :: Color

#

patternpattern BrightRed :: Color

#

patternpattern BrightWhite :: Color

#

patternpattern BrightYellow :: Color

#

patternpattern Cyan :: Color

#

patternpattern Default :: Color

#

patternpattern Green :: Color

#

patternpattern Magenta :: Color

#

patternpattern Red :: Color

#

patternpattern White :: Color

#

patternpattern Yellow :: Color

#

datadata AxisEnv

#

What the formatter gets to know about the axis/ticks

Constructors

AxisEnv
- 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

typetype LabelFormatter = AxisEnv -> Int -> Double -> Text

#

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.

datadata Bins

#

Defines the binning parameters.

Constructors

Bins
- nBins :: Int
- lo :: Double
- hi :: Double

Instances2Eq, Show

Eq BinsDefined in granite-0.7.4.0 · Granite
Show BinsDefined in granite-0.7.4.0 · Granite

valuebins :: Int -> Double -> Double -> Bins

#

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

valueseries

:: 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

valuescatter :: [(Text, [(Double, Double)])] -> Plot -> Text

#

valuelineGraph :: [(Text, [(Double, Double)])] -> Plot -> Text

#

valuebars :: [(Text, Double)] -> Plot -> Text

#

valuestackedBars :: [(Text, [(Text, Double)])] -> Plot -> Text

#

valuehistogram :: Bins -> [Double] -> Plot -> Text

#

valuepie :: [(Text, Double)] -> Plot -> Text

#

valueheatmap :: [[Double]] -> Plot -> Text

#

valueboxPlot :: [(Text, [Double])] -> Plot -> Text

#

valuearea :: [(Text, [(Double, Double)])] -> Plot -> Text

#

valueribbon :: [(Text, [(Double, Double, Double)])] -> Plot -> Text

#

valuedensity :: [(Text, [Double])] -> Plot -> Text

#

valueerrorBars :: [(Text, [(Double, Double, Double, Double)])] -> Plot -> Text

#

valuefunnel :: [(Text, Double)] -> Plot -> Text

#

valuepolarLine :: [(Text, [(Double, Double)])] -> Plot -> Text

#

valuewaterfall :: [(Text, Double, Double)] -> Plot -> Text

#

valuedistPlot :: [(Text, [Double])] -> Plot -> Text

#

valuegauss

:: [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).