Charts

Serving Charts

serveChart :: Port -> Chart -> IO ()

Serve a single static chart on the given port

serveDynamicChart :: Port -> ((Chart -> IO ()) -> IO ()) -> IO ()

Serve a chart on the given port. The application can update the chart using the given handler.

Creating Charts

Automatic Charts

autoChart :: forall row. (ChartRowHeaderAuto row, ChartRowAuto row) => ChartOptions -> ChartStyle -> [row] -> Chart

Create a chart from the provided options, style, and data by inferring column header types.

Prefer autoChartWithHeaders when you know your column headers up front.

E.g. The following generates a 2-series bar chart with 4 sections, A, B, C, D

myAutoChart :: Chart
myAutoChart = autoChart defaultChartOptions BarChart myData
  where
    myData :: [(T.Text, Float, Int)]
    myData = [ (A, 16, 20)
             , (B, 11, 23)
             , (C, 9, 25)
             , (D, 8, 34)
             ]

autoChartWithHeaders :: forall row. ChartRowAuto row => ChartOptions -> ChartStyle -> [Column] -> [row] -> Chart

Create a chart from the provided options, style, and data, but use the explicitly provided column headers and types.

E.g. The following generates a 2-series bar chart with 4 sections, A, B, C, D

myAutoChart :: Chart
myAutoChart = autoChartWithHeaders defaultChartOptions BarChart headers myData
  where
    headers :: [Column]
    headers = [StringColumn Series, NumberColumn Successes, NumberColumn Inconclusive]
    myData :: [(T.Text, Float, Int)]
    myData = [ (A, 16, 20)
             , (B, 11, 23)
             , (C, 9, 25)
             , (D, 8, 34)
             ]

Manual Charts

buildChart :: ChartOptions -> ChartStyle -> [Column] -> [[Value]] -> Chart

Construct a chart.

e.g.

myChart :: Chart
myChart = buildChart defaultChartOptions BarChart
  [StringColumn Year, NumberColumn Population]
  [ [ String "2004", Number 1000 ]
  , [ String "2005", Number 1170 ]
  , [ String "2006", Number 660 ]
  , [ String "2007", Number 1030 ]
  ]

Chart Options

defaultChartOptions :: ChartOptions

Empty chart options

data ChartOptions

I plan to make this typesafe for each partiular chart type but that's a LOT of work, so for now it's just free-form, if you'd actually use this, please make an issue on Github so I know folks need this behaviour :)

Find your chart in the chart gallery to see which options it will accept.

https://developers.google.com/chart/interactive/docs/gallery

Constructors

ChartOptions Value

Instances

ToJSON ChartOptions

Defined in Charts.Internal.Chart

Methods

toJSON :: ChartOptions -> Value

toEncoding :: ChartOptions -> Encoding

toJSONList :: [ChartOptions] -> Value

toEncodingList :: [ChartOptions] -> Encoding

Assorted Types

data Chart

The primary chart type.

Instances

ToJSON Chart

Defined in Charts.Internal.Chart

Methods

toJSON :: Chart -> Value

toEncoding :: Chart -> Encoding

toJSONList :: [Chart] -> Value

toEncodingList :: [Chart] -> Encoding

data Column

Valid Column types. Each "data" column also accepts a column header. Role columns do not.

See https://developers.google.com/chart/interactive/docs/roles

Constructors

NumberColumn Text

StringColumn Text

BoolColumn Text

DateColumn Text

DateTimeColumn Text

TimeOfDayColumn Text

AnnotationColumn

AnnotationTextColumn

CertaintyColumn

EmphasisColumn

IntervalColumn

ScopeColumn

StyleColumn

TooltipColumn

DomainColumn

This is typically inferred and explicitly

DataColumn

This is typically inferred and explicitly

Instances

Eq Column

Defined in Charts.Internal.Chart

Methods

(==) :: Column -> Column -> Bool

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

Show Column

Defined in Charts.Internal.Chart

Methods

showsPrec :: Int -> Column -> ShowS

show :: Column -> String

showList :: [Column] -> ShowS

ToJSON Column

Defined in Charts.Internal.Chart

Methods

toJSON :: Column -> Value

toEncoding :: Column -> Encoding

toJSONList :: [Column] -> Value

toEncodingList :: [Column] -> Encoding

data ChartStyle

Supported chart types See https://developers.google.com/chart/interactive/docs/gallery

Constructors

LineChart

Histogram

BarChart

ColumnChart

ScatterChart

AreaChart

PieChart

BubbleChart

SteppedAreaChart

CandlestickChart

Instances

Eq ChartStyle

Defined in Charts.Internal.Chart

Methods

(==) :: ChartStyle -> ChartStyle -> Bool

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

Ord ChartStyle

Defined in Charts.Internal.Chart

Methods

compare :: ChartStyle -> ChartStyle -> Ordering

(<) :: ChartStyle -> ChartStyle -> Bool

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

(>) :: ChartStyle -> ChartStyle -> Bool

(>=) :: ChartStyle -> ChartStyle -> Bool

max :: ChartStyle -> ChartStyle -> ChartStyle

min :: ChartStyle -> ChartStyle -> ChartStyle

Show ChartStyle

Defined in Charts.Internal.Chart

Methods

showsPrec :: Int -> ChartStyle -> ShowS

show :: ChartStyle -> String

showList :: [ChartStyle] -> ShowS

ToJSON ChartStyle

Defined in Charts.Internal.Chart

Methods

toJSON :: ChartStyle -> Value

toEncoding :: ChartStyle -> Encoding

toJSONList :: [ChartStyle] -> Value

toEncodingList :: [ChartStyle] -> Encoding

type ChartRowAuto a = (ADT a, Constraints a ToJSON)

A constraint representing a type which can be converted into a chart row

This constraint is satisfied by tuple types containing JSON serializable types.

E.g. data rows of type (Text, Int, Float) will infer a chart with a String column and two number columns.

You shouldn't need to implement any instances of this constraint yourself.

type ChartRowHeaderAuto a = Constraints a ChartColumn

A constraint that a column-type can be determined for all elements of the provided tuple type.

class ChartColumn a where

Class representing types for which a column type can be inferred.

You can implement your own instances for this if you like, but generally shouldn't need to.

Methods

columnHeader :: Proxy a -> Column

Instances

ChartColumn Bool

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy Bool -> Column

ChartColumn Double

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy Double -> Column

ChartColumn Float

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy Float -> Column

ChartColumn Int

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy Int -> Column

ChartColumn Scientific

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy Scientific -> Column

ChartColumn String

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy String -> Column

ChartColumn Text

Defined in Charts.Internal.Auto

Methods

columnHeader :: Proxy Text -> Column