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; a surface chart (often called a heatmap).

SurfaceData, the rectangle and the color value, is a different shape to the usual data elements of a chart, so there is a bit more wrangling to do compared with other chart types.

Documentation

data SurfaceData

Main surface data elements

Constructors

SurfaceData

Fields

• surfaceRect :: Rect Double

  XY Coordinates of surface.

• surfaceColor :: Colour

  Surface colour.

Instances

Eq SurfaceData

Defined in Chart.Surface

Methods

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

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

Show SurfaceData

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceData -> ShowS

show :: SurfaceData -> String

showList :: [SurfaceData] -> ShowS

Generic SurfaceData

Defined in Chart.Surface

Associated Types

type Rep SurfaceData :: Type -> Type

Methods

from :: SurfaceData -> Rep SurfaceData x

to :: Rep SurfaceData x -> SurfaceData

type Rep SurfaceData

Defined in Chart.Surface

type Rep SurfaceData = D1 ('MetaData "SurfaceData" "Chart.Surface" "chart-svg-0.2.3-inplace" 'False) (C1 ('MetaCons "SurfaceData" 'PrefixI 'True) (S1 ('MetaSel ('Just "surfaceRect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Rect Double)) :*: S1 ('MetaSel ('Just "surfaceColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (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

Eq SurfaceOptions

Defined in Chart.Surface

Methods

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

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

Show SurfaceOptions

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceOptions -> ShowS

show :: SurfaceOptions -> String

showList :: [SurfaceOptions] -> ShowS

Generic SurfaceOptions

Defined in Chart.Surface

Associated Types

type Rep SurfaceOptions :: Type -> Type

Methods

from :: SurfaceOptions -> Rep SurfaceOptions x

to :: Rep SurfaceOptions x -> SurfaceOptions

type Rep SurfaceOptions

Defined in Chart.Surface

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

defaultSurfaceOptions :: SurfaceOptions

official style

data SurfaceStyle

A surface chart is a specialization of a RectA chart

>>> defaultSurfaceStyle
SurfaceStyle {surfaceColors = [Colour 0.69 0.35 0.16 1.00,Colour 0.65 0.81 0.89 1.00], surfaceRectStyle = RectStyle {borderSize = 0.0, borderColor = Colour 0.00 0.00 0.00 0.00, color = Colour 0.05 0.05 0.05 1.00}}

Constructors

SurfaceStyle

Fields

• surfaceColors :: [Colour]

  list of colours to interpolate between.

• surfaceRectStyle :: RectStyle

Instances

Eq SurfaceStyle

Defined in Chart.Surface

Methods

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

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

Show SurfaceStyle

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceStyle -> ShowS

show :: SurfaceStyle -> String

showList :: [SurfaceStyle] -> ShowS

Generic SurfaceStyle

Defined in Chart.Surface

Associated Types

type Rep SurfaceStyle :: Type -> Type

Methods

from :: SurfaceStyle -> Rep SurfaceStyle x

to :: Rep SurfaceStyle x -> SurfaceStyle

type Rep SurfaceStyle

Defined in Chart.Surface

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

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 :: RectStyle -> [SurfaceData] -> [Chart Double]

surface chart without any hud trimmings

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

create a surface chart from a function.

surfacefl :: (Point Double -> Double) -> SurfaceOptions -> SurfaceLegendOptions -> ([Chart Double], [Hud Double])

Create a surface chart and accompanying legend from a function.

data SurfaceLegendOptions

Legend specialization for a surface chart.

Constructors

SurfaceLegendOptions

Fields

• sloStyle :: SurfaceStyle
• sloTitle :: Text
• sloWidth :: Double

  Width of the legend glyph

• sloResolution :: Int

  Resolution of the legend glyph

• sloAxisOptions :: AxisOptions
• sloLegendOptions :: LegendOptions

Instances

Eq SurfaceLegendOptions

Defined in Chart.Surface

Methods

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

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

Show SurfaceLegendOptions

Defined in Chart.Surface

Methods

showsPrec :: Int -> SurfaceLegendOptions -> ShowS

show :: SurfaceLegendOptions -> String

showList :: [SurfaceLegendOptions] -> ShowS

Generic SurfaceLegendOptions

Defined in Chart.Surface

Associated Types

type Rep SurfaceLegendOptions :: Type -> Type

Methods

from :: SurfaceLegendOptions -> Rep SurfaceLegendOptions x

to :: Rep SurfaceLegendOptions x -> SurfaceLegendOptions

type Rep SurfaceLegendOptions

Defined in Chart.Surface

type Rep SurfaceLegendOptions = D1 ('MetaData "SurfaceLegendOptions" "Chart.Surface" "chart-svg-0.2.3-inplace" 'False) (C1 ('MetaCons "SurfaceLegendOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sloStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SurfaceStyle) :*: (S1 ('MetaSel ('Just "sloTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sloWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "sloResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "sloAxisOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AxisOptions) :*: S1 ('MetaSel ('Just "sloLegendOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LegendOptions)))))

defaultSurfaceLegendOptions :: Text -> SurfaceLegendOptions

official surface legend options