Chart.Hud

A hud stands for head-up display, and is a collective noun used to name chart elements that assist in data interpretation or otherwise annotate and decorate data.

This includes axes, titles, borders, frames, background canvaii, tick marks and tick value labels.

Hud

data Hud

Heads-up display additions to charts

A Hud is composed of:

• A priority for the hud element in the chart folding process.
• A chart tree with a state dependency on the chart being created.

Constructors

Hud

Fields

• priority :: Priority

  priority for ordering of transformations

• hud :: State HudChart ChartTree

  additional charts

Instances

Generic Hud

Defined in Chart.Hud

Associated Types

type Rep Hud :: Type -> Type

Methods

from :: Hud -> Rep Hud x

to :: Rep Hud x -> Hud

type Rep Hud

Defined in Chart.Hud

type Rep Hud = D1 ('MetaData "Hud" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "Hud" 'PrefixI 'True) (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Priority) :*: S1 ('MetaSel ('Just "hud") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (State HudChart ChartTree))))

newtype Priority

The priority of a Hud element or transformation, lower value means higher priority.

Lower priority (higher values) huds will tend to be placed on the outside of a chart.

Hud elements are rendered in order from high to low priority and the positioning of hud elements can depend on the positioning of elements that have already been included. Equal priority values will be placed in the same process step.

The first example below, based in lineExample but with the legend placed on the right and coloured frames to help accentuate effects, includes (in order of priority):

• an inner frame, representing the core data area of the chart (Priority 1)
• the axes (defaultPriority (5))
• the titles (Priority 12)
• the legend (Priority 50)
• an outer frame which is transparent and used to pad out the chart (Priority 100).

priorityv1Example = lineExample & (#hudOptions % #frames) .~ [(1, FrameOptions (Just defaultRectStyle) 0), (100, FrameOptions (Just (defaultRectStyle & #color .~ (palette1 4 & opac' .~ 0.05) & #borderColor .~ palette1 4)) 0.1)] & #hudOptions % #legends %~ fmap (first (const (Priority 50))) & #hudOptions % #legends %~ fmap (second (set #place PlaceRight))

The second variation below drops the title priorities to below the legend:

priorityv2Example = priorityv1Example & #hudOptions % #titles %~ fmap (first (const (Priority 51)))

Constructors

Priority

Fields

• priority :: Double

Instances

Generic Priority

Defined in Chart.Hud

Associated Types

type Rep Priority :: Type -> Type

Methods

from :: Priority -> Rep Priority x

to :: Rep Priority x -> Priority

Num Priority

Defined in Chart.Hud

Methods

(+) :: Priority -> Priority -> Priority

(-) :: Priority -> Priority -> Priority

(*) :: Priority -> Priority -> Priority

negate :: Priority -> Priority

abs :: Priority -> Priority

signum :: Priority -> Priority

fromInteger :: Integer -> Priority

Fractional Priority

Defined in Chart.Hud

Methods

(/) :: Priority -> Priority -> Priority

recip :: Priority -> Priority

fromRational :: Rational -> Priority

Show Priority

Defined in Chart.Hud

Methods

showsPrec :: Int -> Priority -> ShowS

show :: Priority -> String

showList :: [Priority] -> ShowS

Eq Priority

Defined in Chart.Hud

Methods

(==) :: Priority -> Priority -> Bool

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

Ord Priority

Defined in Chart.Hud

Methods

compare :: Priority -> Priority -> Ordering

(<) :: Priority -> Priority -> Bool

(<=) :: Priority -> Priority -> Bool

(>) :: Priority -> Priority -> Bool

(>=) :: Priority -> Priority -> Bool

max :: Priority -> Priority -> Priority

min :: Priority -> Priority -> Priority

type Rep Priority

Defined in Chart.Hud

type Rep Priority = D1 ('MetaData "Priority" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'True) (C1 ('MetaCons "Priority" 'PrefixI 'True) (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

defaultPriority :: Priority

An arbitrary 5.0

>>> defaultPriority
Priority {priority = 5.0}

type HudBox = Rect Double

A type for Rect to represent the entire bounding box of a chart, including the Hud

type CanvasBox = Rect Double

A type for Rect to represent the bounding box of the canvas portion of a chart, excluding Hud elements

type DataBox = Rect Double

A type for Rect to represent the bounding box of the data elements a chart, which can be a different metric to Canvas and Hud Rects

data HudChart

Type to track the split of Chart elements into Hud and Canvas

• charts: charts that form the canvas or data elements of the chart; the rectangular dimension which is considered to be the data representation space.
• hud: charts that form the Hud.
• dataBox: The bounding box of the underlying data domain.

This is done to support functionality where we can choose whether to normalise the chart aspect based on the entire chart (FixedAspect) or on just the data visualisation space (CanvasAspect).

Constructors

HudChart

Fields

• chart :: ChartTree
• hud :: ChartTree
• dataBox :: DataBox

Instances

Generic HudChart

Defined in Chart.Hud

Associated Types

type Rep HudChart :: Type -> Type

Methods

from :: HudChart -> Rep HudChart x

to :: Rep HudChart x -> HudChart

Show HudChart

Defined in Chart.Hud

Methods

showsPrec :: Int -> HudChart -> ShowS

show :: HudChart -> String

showList :: [HudChart] -> ShowS

Eq HudChart

Defined in Chart.Hud

Methods

(==) :: HudChart -> HudChart -> Bool

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

type Rep HudChart

Defined in Chart.Hud

type Rep HudChart = D1 ('MetaData "HudChart" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "HudChart" 'PrefixI 'True) (S1 ('MetaSel ('Just "chart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChartTree) :*: (S1 ('MetaSel ('Just "hud") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChartTree) :*: S1 ('MetaSel ('Just "dataBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataBox))))

canvasBox' :: Lens' HudChart (Maybe CanvasBox)

A lens between a HudChart and the bounding box of the canvas

canvasStyleBox' :: Getter HudChart (Maybe CanvasBox)

A lens between a HudChart and the bounding box of the canvas, including style extensions.

hudBox' :: Lens' HudChart (Maybe HudBox)

lens between a HudChart and its hud bounding box, not including style.

hudStyleBox' :: Getter HudChart (Maybe HudBox)

a lens between a HudChart and the bounding box of the hud.

Hud Processing

runHudWith

Arguments

:: CanvasBox

initial canvas

-> DataBox

initial data space

-> [Hud]

huds to add

-> ChartTree

underlying chart

-> ChartTree

integrated chart tree

Combine huds and charts to form a new Chart using the supplied initial canvas and data dimensions. Note that chart data is transformed by this computation (a linear type might be useful here).

runHud

Arguments

:: CanvasBox

initial canvas dimension

-> [Hud]

huds

-> ChartTree

underlying charts

-> ChartTree

integrated chart list

Combine huds and charts to form a new ChartTree with a supplied initial canvas dimension.

Note that the original chart data are transformed and irrevocably forgotten by this computation.

HudOptions

data HudOptions

Typical, configurable hud elements. Anything else can be hand-coded as a Hud.

Constructors

HudOptions

Fields

• chartAspect :: ChartAspect
• axes :: [(Priority, AxisOptions)]
• frames :: [(Priority, FrameOptions)]
• legends :: [(Priority, LegendOptions)]
• titles :: [(Priority, Title)]

Instances

Monoid HudOptions

Defined in Chart.Hud

Methods

mempty :: HudOptions

mappend :: HudOptions -> HudOptions -> HudOptions

mconcat :: [HudOptions] -> HudOptions

Semigroup HudOptions

Defined in Chart.Hud

Methods

(<>) :: HudOptions -> HudOptions -> HudOptions

sconcat :: NonEmpty HudOptions -> HudOptions

stimes :: Integral b => b -> HudOptions -> HudOptions

Generic HudOptions

Defined in Chart.Hud

Associated Types

type Rep HudOptions :: Type -> Type

Methods

from :: HudOptions -> Rep HudOptions x

to :: Rep HudOptions x -> HudOptions

Show HudOptions

Defined in Chart.Hud

Methods

showsPrec :: Int -> HudOptions -> ShowS

show :: HudOptions -> String

showList :: [HudOptions] -> ShowS

Eq HudOptions

Defined in Chart.Hud

Methods

(==) :: HudOptions -> HudOptions -> Bool

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

type Rep HudOptions

Defined in Chart.Hud

type Rep HudOptions = D1 ('MetaData "HudOptions" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "HudOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chartAspect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChartAspect) :*: S1 ('MetaSel ('Just "axes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Priority, AxisOptions)])) :*: (S1 ('MetaSel ('Just "frames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Priority, FrameOptions)]) :*: (S1 ('MetaSel ('Just "legends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Priority, LegendOptions)]) :*: S1 ('MetaSel ('Just "titles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Priority, Title)])))))

defaultHudOptions :: HudOptions

The official hud options.

• A fixed chart aspect (width:height) of 1.5
• An x axis at the bottom and y axis at the left.
• The default tick style for each axis of an axis bar, tick glyphs (or marks), automated tick labels, and tick (or grid) lines.
• A high Priority (and thus inner), low-opacity frame, representing the data area of the chart.
• A low priority (outer), transparent frame, providing some padding around the chart.

addHud :: HudOptions -> ChartTree -> ChartTree

Decorate a ChartTree with HudOptions

initialCanvas :: ChartAspect -> ChartTree -> Rect Double

The initial canvas before applying Huds

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

colourHudOptions :: (Colour -> Colour) -> HudOptions -> HudOptions

alter a colour with a function

toHuds :: HudOptions -> DataBox -> ([Hud], DataBox)

Make Huds and potential data box extension; from a HudOption and an initial data box.

Hud Effects

closes :: Traversable f => f (State HudChart ChartTree) -> State HudChart ()

Absorb a series of state-dependent tress into state.

fromEffect :: Priority -> State HudChart () -> Hud

Wrap a state effect into a Hud

applyChartAspect :: ChartAspect -> State HudChart ()

Apply a ChartAspect

getHudBox :: ChartAspect -> HudChart -> Maybe HudBox

Supply the bounding box of the HudChart given a ChartAspect.

Hud primitives

data AxisOptions

axis options

Constructors

AxisOptions

Fields

• bar :: Maybe AxisBar
• adjust :: Maybe Adjustments
• ticks :: Ticks
• place :: Place

Instances

Generic AxisOptions

Defined in Chart.Hud

Associated Types

type Rep AxisOptions :: Type -> Type

Methods

from :: AxisOptions -> Rep AxisOptions x

to :: Rep AxisOptions x -> AxisOptions

Show AxisOptions

Defined in Chart.Hud

Methods

showsPrec :: Int -> AxisOptions -> ShowS

show :: AxisOptions -> String

showList :: [AxisOptions] -> ShowS

Eq AxisOptions

Defined in Chart.Hud

Methods

(==) :: AxisOptions -> AxisOptions -> Bool

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

type Rep AxisOptions

Defined in Chart.Hud

type Rep AxisOptions = D1 ('MetaData "AxisOptions" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "AxisOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AxisBar)) :*: S1 ('MetaSel ('Just "adjust") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Adjustments))) :*: (S1 ('MetaSel ('Just "ticks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Ticks) :*: S1 ('MetaSel ('Just "place") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place))))

defaultAxisOptions :: AxisOptions

The official axis

flipAxis :: AxisOptions -> AxisOptions

flip an axis from being an X dimension to a Y one or vice-versa.

data FrameOptions

Options for hud frames

>>> defaultFrameOptions
FrameOptions {frame = Just (RectStyle {borderSize = 0.0, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 1.00 1.00 1.00 0.02}), buffer = 0.0}

Constructors

FrameOptions

Fields

• frame :: Maybe RectStyle
• buffer :: Double

Instances

Generic FrameOptions

Defined in Chart.Hud

Associated Types

type Rep FrameOptions :: Type -> Type

Methods

from :: FrameOptions -> Rep FrameOptions x

to :: Rep FrameOptions x -> FrameOptions

Show FrameOptions

Defined in Chart.Hud

Methods

showsPrec :: Int -> FrameOptions -> ShowS

show :: FrameOptions -> String

showList :: [FrameOptions] -> ShowS

Eq FrameOptions

Defined in Chart.Hud

Methods

(==) :: FrameOptions -> FrameOptions -> Bool

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

type Rep FrameOptions

Defined in Chart.Hud

type Rep FrameOptions = D1 ('MetaData "FrameOptions" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "FrameOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "frame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RectStyle)) :*: S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))

defaultFrameOptions :: FrameOptions

The official hud frame

data Place

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

Constructors

PlaceLeft

PlaceRight

PlaceTop

PlaceBottom

PlaceAbsolute (Point Double)

Instances

Generic Place

Defined in Chart.Hud

Associated Types

type Rep Place :: Type -> Type

Methods

from :: Place -> Rep Place x

to :: Rep Place x -> Place

Show Place

Defined in Chart.Hud

Methods

showsPrec :: Int -> Place -> ShowS

show :: Place -> String

showList :: [Place] -> ShowS

Eq Place

Defined in Chart.Hud

Methods

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

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

type Rep Place

Defined in Chart.Hud

type Rep Place = D1 ('MetaData "Place" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) ((C1 ('MetaCons "PlaceLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlaceRight" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PlaceTop" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PlaceBottom" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlaceAbsolute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Point Double))))))

placeText :: Place -> Text

textifier

data AxisBar

The bar on an axis representing the x or y plane.

>>> defaultAxisBar
AxisBar {style = RectStyle {borderSize = 0.0, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 0.05 0.05 0.05 0.40}, size = 4.0e-3, buffer = 1.0e-2, overhang = 2.0e-3}

Constructors

AxisBar

Fields

• style :: RectStyle
• size :: Double
• buffer :: Double
• overhang :: Double

  extension over the edges of the axis range

Instances

Generic AxisBar

Defined in Chart.Hud

Associated Types

type Rep AxisBar :: Type -> Type

Methods

from :: AxisBar -> Rep AxisBar x

to :: Rep AxisBar x -> AxisBar

Show AxisBar

Defined in Chart.Hud

Methods

showsPrec :: Int -> AxisBar -> ShowS

show :: AxisBar -> String

showList :: [AxisBar] -> ShowS

Eq AxisBar

Defined in Chart.Hud

Methods

(==) :: AxisBar -> AxisBar -> Bool

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

type Rep AxisBar

Defined in Chart.Hud

type Rep AxisBar = D1 ('MetaData "AxisBar" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "AxisBar" 'PrefixI 'True) ((S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RectStyle) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "overhang") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))

defaultAxisBar :: AxisBar

The official axis bar

data Title

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

>>> defaultTitle "title"
Title {text = "title", style = TextStyle {size = 0.12, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.45, vsize = 1.1, vshift = -0.25, rotation = Nothing, scalex = ScaleX, frame = Nothing}, place = PlaceTop, anchor = AnchorMiddle, buffer = 4.0e-2}

Constructors

Title

Fields

• text :: Text
• style :: TextStyle
• place :: Place
• anchor :: Anchor
• buffer :: Double

Instances

Generic Title

Defined in Chart.Hud

Associated Types

type Rep Title :: Type -> Type

Methods

from :: Title -> Rep Title x

to :: Rep Title x -> Title

Show Title

Defined in Chart.Hud

Methods

showsPrec :: Int -> Title -> ShowS

show :: Title -> String

showList :: [Title] -> ShowS

Eq Title

Defined in Chart.Hud

Methods

(==) :: Title -> Title -> Bool

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

type Rep Title

Defined in Chart.Hud

type Rep Title = D1 ('MetaData "Title" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "Title" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextStyle)) :*: (S1 ('MetaSel ('Just "place") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place) :*: (S1 ('MetaSel ('Just "anchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Anchor) :*: S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))))

defaultTitle :: Text -> Title

The official hud title

data Ticks

xy coordinate markings

>>> defaultTicks
Ticks {style = TickRound (FormatN {fstyle = FSCommaPrec, sigFigs = Just 1, maxDistinguishIterations = 4, addLPad = True, cutRightZeros = True}) 8 TickExtend, gtick = Just (GlyphStyle {size = 3.0e-2, color = Colour 0.05 0.05 0.05 0.40, borderColor = Colour 0.05 0.05 0.05 0.40, borderSize = 4.0e-3, shape = VLineGlyph, rotation = Nothing, translate = Nothing},3.0e-2), ttick = Just (TextStyle {size = 5.0e-2, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.45, vsize = 1.1, vshift = -0.25, rotation = Nothing, scalex = ScaleX, frame = Nothing},3.3e-2), ltick = Just (LineStyle {size = 5.0e-3, color = Colour 0.05 0.05 0.05 0.05, linecap = Nothing, linejoin = Nothing, dasharray = Nothing, dashoffset = Nothing},0.0)}

Constructors

Ticks

Fields

• style :: TickStyle
• gtick :: Maybe (GlyphStyle, Double)
• ttick :: Maybe (TextStyle, Double)
• ltick :: Maybe (LineStyle, Double)

Instances

Generic Ticks

Defined in Chart.Hud

Associated Types

type Rep Ticks :: Type -> Type

Methods

from :: Ticks -> Rep Ticks x

to :: Rep Ticks x -> Ticks

Show Ticks

Defined in Chart.Hud

Methods

showsPrec :: Int -> Ticks -> ShowS

show :: Ticks -> String

showList :: [Ticks] -> ShowS

Eq Ticks

Defined in Chart.Hud

Methods

(==) :: Ticks -> Ticks -> Bool

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

type Rep Ticks

Defined in Chart.Hud

type Rep Ticks = D1 ('MetaData "Ticks" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "Ticks" 'PrefixI 'True) ((S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TickStyle) :*: S1 ('MetaSel ('Just "gtick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (GlyphStyle, Double)))) :*: (S1 ('MetaSel ('Just "ttick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (TextStyle, Double))) :*: S1 ('MetaSel ('Just "ltick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (LineStyle, Double))))))

defaultGlyphTick :: GlyphStyle

The official glyph tick

defaultTextTick :: TextStyle

The official text tick

defaultLineTick :: LineStyle

The official line tick

defaultTicks :: Ticks

The official tick

data TickStyle

Style of tick marks on an axis.

Constructors

TickNone

no ticks on axis

TickLabels [Text]

specific labels (equidistant placement)

TickRound FormatN Int TickExtend

sensibly rounded ticks, a guide to how many, and whether to extend beyond the data bounding box

TickExact FormatN Int

exactly n equally spaced ticks

TickPlaced [(Double, Text)]

specific labels and placement

Instances

Generic TickStyle

Defined in Chart.Hud

Associated Types

type Rep TickStyle :: Type -> Type

Methods

from :: TickStyle -> Rep TickStyle x

to :: Rep TickStyle x -> TickStyle

Show TickStyle

Defined in Chart.Hud

Methods

showsPrec :: Int -> TickStyle -> ShowS

show :: TickStyle -> String

showList :: [TickStyle] -> ShowS

Eq TickStyle

Defined in Chart.Hud

Methods

(==) :: TickStyle -> TickStyle -> Bool

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

type Rep TickStyle

Defined in Chart.Hud

type Rep TickStyle = D1 ('MetaData "TickStyle" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) ((C1 ('MetaCons "TickNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TickLabels" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) :+: (C1 ('MetaCons "TickRound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormatN) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TickExtend))) :+: (C1 ('MetaCons "TickExact" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FormatN) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "TickPlaced" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Double, Text)])))))

defaultTickStyle :: TickStyle

The official tick style

>>> defaultTickStyle
TickRound (FormatN {fstyle = FSCommaPrec, sigFigs = Just 1, maxDistinguishIterations = 4, addLPad = True, cutRightZeros = True}) 8 TickExtend

tickStyleText :: TickStyle -> Text

textifier

data TickExtend

Whether Ticks are allowed to extend the data range

Constructors

TickExtend

NoTickExtend

Instances

Generic TickExtend

Defined in Chart.Hud

Associated Types

type Rep TickExtend :: Type -> Type

Methods

from :: TickExtend -> Rep TickExtend x

to :: Rep TickExtend x -> TickExtend

Show TickExtend

Defined in Chart.Hud

Methods

showsPrec :: Int -> TickExtend -> ShowS

show :: TickExtend -> String

showList :: [TickExtend] -> ShowS

Eq TickExtend

Defined in Chart.Hud

Methods

(==) :: TickExtend -> TickExtend -> Bool

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

type Rep TickExtend

Defined in Chart.Hud

type Rep TickExtend = D1 ('MetaData "TickExtend" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "TickExtend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoTickExtend" 'PrefixI 'False) (U1 :: Type -> Type))

adjustTicks :: Adjustments -> HudBox -> DataBox -> Place -> Ticks -> Ticks

adjust Tick for sane font sizes etc

data Adjustments

options for prettifying axis decorations

>>> defaultAdjustments
Adjustments {maxXRatio = 8.0e-2, maxYRatio = 6.0e-2, angledRatio = 0.12, allowDiagonal = True}

Constructors

Adjustments

Fields

• maxXRatio :: Double
• maxYRatio :: Double
• angledRatio :: Double
• allowDiagonal :: Bool

Instances

Generic Adjustments

Defined in Chart.Hud

Associated Types

type Rep Adjustments :: Type -> Type

Methods

from :: Adjustments -> Rep Adjustments x

to :: Rep Adjustments x -> Adjustments

Show Adjustments

Defined in Chart.Hud

Methods

showsPrec :: Int -> Adjustments -> ShowS

show :: Adjustments -> String

showList :: [Adjustments] -> ShowS

Eq Adjustments

Defined in Chart.Hud

Methods

(==) :: Adjustments -> Adjustments -> Bool

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

type Rep Adjustments

Defined in Chart.Hud

type Rep Adjustments = D1 ('MetaData "Adjustments" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "Adjustments" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxXRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "maxYRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "angledRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "allowDiagonal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

defaultAdjustments :: Adjustments

The official hud adjustments.

data LegendOptions

Legend options

>>> defaultLegendOptions
LegendOptions {size = 0.3, buffer = 0.1, vgap = 0.2, hgap = 0.1, textStyle = TextStyle {size = 0.18, color = Colour 0.05 0.05 0.05 1.00, anchor = AnchorMiddle, hsize = 0.45, vsize = 1.1, vshift = -0.25, rotation = Nothing, scalex = ScaleX, frame = Nothing}, innerPad = 0.1, outerPad = 2.0e-2, frame = Just (RectStyle {borderSize = 1.0e-2, borderColor = Colour 0.05 0.05 0.05 1.00, color = Colour 0.05 0.05 0.05 0.00}), place = PlaceRight, overallScale = 0.25, content = []}

Constructors

LegendOptions

Fields

• size :: Double
• buffer :: Double
• vgap :: Double
• hgap :: Double
• textStyle :: TextStyle
• innerPad :: Double
• outerPad :: Double
• frame :: Maybe RectStyle
• place :: Place
• overallScale :: Double
• content :: [(Text, [Chart])]

Instances

Generic LegendOptions

Defined in Chart.Hud

Associated Types

type Rep LegendOptions :: Type -> Type

Methods

from :: LegendOptions -> Rep LegendOptions x

to :: Rep LegendOptions x -> LegendOptions

Show LegendOptions

Defined in Chart.Hud

Methods

showsPrec :: Int -> LegendOptions -> ShowS

show :: LegendOptions -> String

showList :: [LegendOptions] -> ShowS

Eq LegendOptions

Defined in Chart.Hud

Methods

(==) :: LegendOptions -> LegendOptions -> Bool

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

type Rep LegendOptions

Defined in Chart.Hud

type Rep LegendOptions = D1 ('MetaData "LegendOptions" "Chart.Hud" "chart-svg-0.4.0-IvsDYjPAAoJCAgDXwgibUh" 'False) (C1 ('MetaCons "LegendOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "vgap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "hgap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "textStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextStyle)))) :*: ((S1 ('MetaSel ('Just "innerPad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "outerPad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "frame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RectStyle)))) :*: (S1 ('MetaSel ('Just "place") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place) :*: (S1 ('MetaSel ('Just "overallScale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, [Chart])]))))))

defaultLegendOptions :: LegendOptions

The official legend options

Option to Hud

frameHud :: FrameOptions -> State HudChart ChartTree

Make a frame hud transformation.

legend :: LegendOptions -> State HudChart ChartTree

Make a legend from LegendOptions

legendHud :: LegendOptions -> ChartTree -> State HudChart ChartTree

Make a legend hud element, from a bespoke ChartTree.

legendFrame :: LegendOptions -> ChartTree -> ChartTree

frame a legend