Chart.Surface

Surface chart combinators.

A common chart is to present a set of rectangles on the XY plane with colour representing values of the underlying data. This library uses the term surface chart but it is often referred to as a heatmap.

Documentation

data SurfaceData

Main surface data elements

Constructors

SurfaceData

Fields

• surfaceRect :: Rect Double

  XY Coordinates of surface.

• surfaceColor :: Colour

  Surface colour.

Instances

Generic SurfaceData

Defined in Chart.Surface

Associated Types

type Rep SurfaceData :: Type -> Type

Methods

from :: SurfaceData -> Rep SurfaceData x

to :: Rep SurfaceData x -> SurfaceData

Show SurfaceData

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceData -> ShowS

show :: SurfaceData -> String

showList :: [SurfaceData] -> ShowS

Eq SurfaceData

Defined in Chart.Surface

Methods

(==) :: SurfaceData -> SurfaceData -> Bool

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

type Rep SurfaceData

Defined in Chart.Surface

type Rep SurfaceData = D1 ('MetaData "SurfaceData" "Chart.Surface" "chart-svg-0.6.0.0-HjsGv1l8hv76XDZORokPY6" 'False) (C1 ('MetaCons "SurfaceData" 'PrefixI 'True) (S1 ('MetaSel ('Just "surfaceRect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Rect Double)) :*: S1 ('MetaSel ('Just "surfaceColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Colour)))

data SurfaceOptions

Options for a Surface chart.

Constructors

SurfaceOptions

Fields

• soStyle :: SurfaceStyle

  surface style

• soGrain :: Point Int

  The grain or granularity of the chart

• soRange :: Rect Double

  Chart range

Instances

Generic SurfaceOptions

Defined in Chart.Surface

Associated Types

type Rep SurfaceOptions :: Type -> Type

Methods

from :: SurfaceOptions -> Rep SurfaceOptions x

to :: Rep SurfaceOptions x -> SurfaceOptions

Show SurfaceOptions

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceOptions -> ShowS

show :: SurfaceOptions -> String

showList :: [SurfaceOptions] -> ShowS

Eq SurfaceOptions

Defined in Chart.Surface

Methods

(==) :: SurfaceOptions -> SurfaceOptions -> Bool

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

type Rep SurfaceOptions

Defined in Chart.Surface

type Rep SurfaceOptions = D1 ('MetaData "SurfaceOptions" "Chart.Surface" "chart-svg-0.6.0.0-HjsGv1l8hv76XDZORokPY6" 'False) (C1 ('MetaCons "SurfaceOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "soStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SurfaceStyle) :*: (S1 ('MetaSel ('Just "soGrain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point Int)) :*: S1 ('MetaSel ('Just "soRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Rect Double)))))

defaultSurfaceOptions :: SurfaceOptions

official style

data SurfaceStyle

A surface chart is a specialization of a RectChart

>>> defaultSurfaceStyle
SurfaceStyle {surfaceColors = [Colour 0.02 0.73 0.80 1.00,Colour 0.02 0.29 0.48 1.00], surfaceRectStyle = Style {size = 6.0e-2, borderSize = 0.0, color = Colour 0.05 0.05 0.05 1.00, borderColor = Colour 0.00 0.00 0.00 0.00, scaleP = NoScaleP, anchor = AnchorMiddle, rotation = Nothing, translate = Nothing, escapeText = EscapeText, frame = Nothing, lineCap = Nothing, lineJoin = Nothing, dasharray = Nothing, dashoffset = Nothing, hsize = 0.6, vsize = 1.1, vshift = -0.25, glyphShape = SquareGlyph}}

Constructors

SurfaceStyle

Fields

• surfaceColors :: [Colour]

  list of colours to interpolate between.

• surfaceRectStyle :: Style

Instances

Generic SurfaceStyle

Defined in Chart.Surface

Associated Types

type Rep SurfaceStyle :: Type -> Type

Methods

from :: SurfaceStyle -> Rep SurfaceStyle x

to :: Rep SurfaceStyle x -> SurfaceStyle

Show SurfaceStyle

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceStyle -> ShowS

show :: SurfaceStyle -> String

showList :: [SurfaceStyle] -> ShowS

Eq SurfaceStyle

Defined in Chart.Surface

Methods

(==) :: SurfaceStyle -> SurfaceStyle -> Bool

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

type Rep SurfaceStyle

Defined in Chart.Surface

type Rep SurfaceStyle = D1 ('MetaData "SurfaceStyle" "Chart.Surface" "chart-svg-0.6.0.0-HjsGv1l8hv76XDZORokPY6" 'False) (C1 ('MetaCons "SurfaceStyle" 'PrefixI 'True) (S1 ('MetaSel ('Just "surfaceColors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Colour]) :*: S1 ('MetaSel ('Just "surfaceRectStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Style)))

defaultSurfaceStyle :: SurfaceStyle

The official surface style.

mkSurfaceData :: (Point Double -> Double) -> Rect Double -> Grid (Rect Double) -> [Colour] -> ([SurfaceData], Range Double)

Create surface data from a function on a Point

surfaces :: Style -> [SurfaceData] -> [Chart]

surface chart without any hud trimmings

surfacef :: (Point Double -> Double) -> SurfaceOptions -> ([Chart], Range Double)

Create a surface chart from a function.

data SurfaceLegendOptions

Legend specialization for a surface chart.

Constructors

SurfaceLegendOptions

Fields

• sloAxisOptions :: AxisOptions
• sloWidth :: Double

  Width of the legend glyph

• sloResolution :: Int

  Resolution of the legend glyph

• sloDataRange :: Range Double
• sloRect :: Rect Double

  Placement of the legend versus normalised chart placement

• sloSurfaceStyle :: SurfaceStyle

Instances

Generic SurfaceLegendOptions

Defined in Chart.Surface

Associated Types

type Rep SurfaceLegendOptions :: Type -> Type

Methods

from :: SurfaceLegendOptions -> Rep SurfaceLegendOptions x

to :: Rep SurfaceLegendOptions x -> SurfaceLegendOptions

Show SurfaceLegendOptions

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceLegendOptions -> ShowS

show :: SurfaceLegendOptions -> String

showList :: [SurfaceLegendOptions] -> ShowS

Eq SurfaceLegendOptions

Defined in Chart.Surface

Methods

(==) :: SurfaceLegendOptions -> SurfaceLegendOptions -> Bool

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

type Rep SurfaceLegendOptions

Defined in Chart.Surface

type Rep SurfaceLegendOptions = D1 ('MetaData "SurfaceLegendOptions" "Chart.Surface" "chart-svg-0.6.0.0-HjsGv1l8hv76XDZORokPY6" 'False) (C1 ('MetaCons "SurfaceLegendOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sloAxisOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AxisOptions) :*: (S1 ('MetaSel ('Just "sloWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "sloResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :*: (S1 ('MetaSel ('Just "sloDataRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Range Double)) :*: (S1 ('MetaSel ('Just "sloRect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Rect Double)) :*: S1 ('MetaSel ('Just "sloSurfaceStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SurfaceStyle)))))

defaultSurfaceLegendOptions :: SurfaceLegendOptions

official surface legend options

surfaceLegendAxisOptions :: AxisOptions

AxisOptions for a surface chart legend.

gridReferenceChart :: SurfaceLegendOptions -> ChartTree

Chart used as a reference to a surface chart.

addSurfaceLegend :: SurfaceLegendOptions -> ChartTree -> ChartTree

Add a surface legend to a main surface chart.