Chart.Hud

Hud (Heads up display) is a collective noun for axes, titles & legends

todo: refactor me please. A hud for a chart uses beside to combine elements, and this restricts the hud to the outside of the chart canvas. This tends to make hud elements (such as gridlines) harder to implement than they should be.

Documentation

data HudOptions b

Various options for a hud.

Defaults to the classical x- and y-axis, a sixbyfour aspect, no titles and no legends

Constructors

HudOptions

Fields

• hudPad :: Double
• hudAxes :: [AxisOptions b]
• hudGrids :: [GridOptions]
• hudTitles :: [(TitleOptions, Text)]
• hudLegends :: [LegendOptions b]
• hudRange :: Maybe (Rect Double)
• hudAspect :: Aspect
• hudCanvas :: RectOptions

Instances

Default (HudOptions b)

Methods

def :: HudOptions b

hud :: HudOptions b -> Chart b

Create a hud.

hud def

todo: the example highlights the issues with using beside. The x-axis is placed first, and then the y-axis. In setting that beside the combination of the canvas, and the x-axis, it calculates the middle, which has moved slightly from the canvas middle.

withHud :: Foldable f => HudOptions b -> (Aspect -> Rect Double -> [f (Pair Double)] -> Chart b) -> [f (Pair Double)] -> Chart b

create a chart with a hud from data (using the data range)

withHudExample :: Chart b
withHudExample = withHud hopts (lineChart lopts) ls
    where
      hopts = def {hudTitles=[(def,"withHud Example")],
                   hudLegends=[def {legendChartType=zipWith (\x y ->
                   (LegendLine x 0.05, y)) lopts ["line1", "line2", "line3"]}]}

data Orientation

Orientation for a hud element. Watch this space for curvature!

Constructors

Hori

Vert

data Place

Placement of hud elements around (what is implicity but maybe shouldn't just be) a rectangular canvas

Constructors

PlaceLeft

PlaceRight

PlaceTop

PlaceBottom

Instances

Eq Place

Methods

(==) :: Place -> Place -> Bool

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

Show Place

Methods

showsPrec :: Int -> Place -> ShowS

show :: Place -> String

showList :: [Place] -> ShowS

placeOutside :: Num n => Place -> V2 n

Direction to place stuff on the outside of the built-up hud

placeGap :: (Monoid m, Semigroup m, Ord n, Floating n) => Place -> n -> QDiagram b V2 n m -> QDiagram b V2 n m

A gap to add when placing elements.

data TickStyle

Style of tick marks on an axis.

Constructors

TickNone

no ticks on axis

TickLabels [Text]

specific labels

TickRound Int

sensibly rounded ticks and a guide to how many

TickExact Int

exactly n equally spaced ticks

TickPlaced [(Double, Text)]

specific labels and placement

precision :: Int -> [Double] -> [Text]

Provide formatted text for a list of numbers so that they are just distinguished. 'precision 2 ticks' means give the tick labels as much precision as is needed for them to be distinguished, but with at least 2 significant figues.

data AxisOptions b

Axes are somewhat complicated. For instance, they contain a range within which tick marks need to be supplied or computed.

Constructors

AxisOptions

Fields

• axisPad :: Double
• axisOrientation :: Orientation
• axisPlace :: Place
• axisRect :: RectOptions
• axisRectHeight :: Double
• axisMark :: GlyphOptions b
• axisMarkStart :: Double
• axisGap :: Double
• axisLabel :: LabelOptions
• axisTickStyle :: TickStyle

Instances

Default (AxisOptions b)

Methods

def :: AxisOptions b

defXAxis :: AxisOptions b

default X axis

defYAxis :: AxisOptions b

default Y axis

axis :: AxisOptions b -> Range Double -> Range Double -> Chart b

create an axis, based on AxisOptions, a physical aspect, and a range

Under-the-hood, the axis function has gone through many a refactor, and still has a ways to go. A high degree of technical debt tends to acrue here.

axisExample :: Chart b
axisExample = axis aopts one (Range 0 100000)
  where
    aopts = def {axisLabel=(axisLabel def) {
                 labelGap=0.0001, labelText=(labelText (axisLabel def)) {
                 textSize=0.06, textAlignH=AlignLeft, textRotation=(-45)}}}

data TitleOptions

Options for titles. Defaults to center aligned, and placed at Top of the hud

Constructors

TitleOptions

Fields

• titleText :: TextOptions
• titleAlign :: AlignH
• titlePlace :: Place
• titleGap :: Double

Instances

Default TitleOptions

Methods

def :: TitleOptions

title :: Aspect -> TitleOptions -> Text -> Chart b

Create a title for a chart. The logic used to work out placement is flawed due to being able to freely specify text rotation. It works for specific rotations (Top, Bottom at 0, Left at 90, Right @ 270)

data LegendType b

LegendType reuses all the various chart option types to help formulate a legend

Constructors

LegendText TextOptions

LegendGlyph (GlyphOptions b)

LegendLine LineOptions Double

LegendGLine (GlyphOptions b) LineOptions Double

LegendRect RectOptions Double

LegendArrow (ArrowOptions Double) Double

LegendPixel RectOptions Double

data LegendOptions b

Legend options. todo: allow for horizontal concatenation.

Constructors

LegendOptions

Fields

• legendChartType :: [(LegendType b, Text)]
• legendInnerPad :: Double
• legendInnerSep :: Double
• legendGap :: Double
• legendRowPad :: Double
• legendPlace :: Place
• legendAlign :: AlignH
• legendSep :: Double
• legendRect :: RectOptions
• legendText :: TextOptions

Instances

Default (LegendOptions b)

Methods

def :: LegendOptions b

legend :: LegendOptions b -> Chart b

Create a legend based on a LegendOptions

legendExample :: Chart b
legendExample = legend $ def {legendChartType=legends}
    where
      legends =
          [ (LegendText def, "legend")] <>
          [ (LegendPixel (blob (withOpacity blue 0.4)) 0.05, "pixel")] <>
          -- [ (LegendArrow (def {arrowMinStaffWidth=0.01,
          --                     arrowMinHeadLength=0.03}) 0.05, "arrow")] <>
          [ (LegendRect def 0.05, "rect")] <>
          [ (LegendGLine def def 0.10, "glyph+line")] <>
          [ (LegendGlyph def, "just a glyph")] <>
          (zipWith (\x y -> (LegendLine x 0.05, y))
           lopts ["short", "much longer name", "line 3"])

data GridStyle

Style of grid lines

Constructors

GridNone

no ticks on axis

GridRound Pos Int

sensibly rounded line placement and a guide to how many

GridExact Pos Int

exactly n lines using Pos

GridPlaced [Double]

specific line placement

data GridOptions

Options for gridlines.

Constructors

GridOptions

Fields

• gridOrientation :: Orientation
• gridStyle :: GridStyle
• gridLine :: LineOptions

Instances

Default GridOptions

Methods

def :: GridOptions

defXGrid :: GridOptions

defYGrid :: GridOptions

gridl :: GridOptions -> Aspect -> Rect Double -> Chart b

Create a grid line for a chart.