diff --git a/chart-unit.cabal b/chart-unit.cabal --- a/chart-unit.cabal +++ b/chart-unit.cabal @@ -5,10 +5,9 @@ -- hash: c39db1e3a55127346b3e41e1ba315b1d704563184f7b39b9a3885f64e76b4387 name: chart-unit -version: 0.6.0.2 +version: 0.6.1.0 synopsis: Native haskell charts. -description: . - <> +description: <> . chart-unit is a native haskell charting library designed: . @@ -16,7 +15,7 @@ . - towards a minimalist look and feel . - - to provide a set of default values that are robust across differet data and physical chart scales + - to provide a set of default values that are robust across different data and physical chart scales . - around provision of a small but core set of chart types. . diff --git a/examples/mainExample.hs b/examples/mainExample.hs --- a/examples/mainExample.hs +++ b/examples/mainExample.hs @@ -7,7 +7,6 @@ import Chart import Control.Lens import Data.Generics.Labels() --- import qualified Diagrams.Prelude as D import NumHask.Prelude ls :: [[Pair Double]] @@ -37,8 +36,8 @@ defYAxis ] -titles :: [(TitleOptions, Text)] -titles = +titles' :: [(TitleOptions, Text)] +titles' = [ (def, "Example Chart") , ( #align .~ AlignCenter $ #text . #rotation .~ 90 $ @@ -54,8 +53,8 @@ , "bottom right, non-essential note") ] -legends :: [(LegendType, Text)] -legends = +legends' :: [(LegendType, Text)] +legends' = [(LegendText def, "legend")] <> [(LegendPixel (blob ublue) 0.05, "pixel")] <> [(LegendRect def 0.05, "rect")] <> @@ -74,10 +73,10 @@ sixbyfour [ LineChart (zip lopts ls) , HudChart $ - #titles .~ titles $ + #titles .~ titles' $ #axes .~ as $ #axes %~ map (#outerPad .~ 1) $ - #legends .~ [#chartType .~ legends $ def] $ + #legends .~ [#chartType .~ legends' $ def] $ def]) main :: IO () diff --git a/examples/sourceExamples.hs b/examples/sourceExamples.hs --- a/examples/sourceExamples.hs +++ b/examples/sourceExamples.hs @@ -385,8 +385,8 @@ (#alignH .~ AlignLeft)) $ #gap .~ 0.0001 $ def -legends :: [(LegendType, Text)] -legends = +legends' :: [(LegendType, Text)] +legends' = [(LegendText def, "legend")] <> [(LegendPixel (blob ublue) 0.05, "pixel")] <> -- [ (LegendArrow (def & #minStaffWidth .~ 0.01 & #minHeadLength .~ 0.03) 0.05, "arrow")] <> [(LegendRect def 0.05, "rect")] <> @@ -398,7 +398,7 @@ ["short", "much longer name", "line 3"] legendExample :: Chart b -legendExample = legend $ #chartType .~ legends $ def +legendExample = legend $ #chartType .~ legends' $ def -- * Chart.Bar examples barExample :: Chart b diff --git a/src/Chart.hs b/src/Chart.hs --- a/src/Chart.hs +++ b/src/Chart.hs @@ -77,8 +77,8 @@ -- -- Using data-default, lens and OverloadedLabels tends to encourage a vertical style, which may annoy line counters, but lead to clear code and ease of editing. -- --- > titles :: [(TitleOptions, Text)] --- > titles = +-- > titles' :: [(TitleOptions, Text)] +-- > titles' = -- > [ (def, "Example Chart") -- > , ( #align .~ AlignCenter $ -- > #text . #rotation .~ 90 $ @@ -94,8 +94,8 @@ -- > , "bottom right, non-essential note") -- > ] -- > --- > legends :: [(LegendType, Text)] --- > legends = +-- > legends' :: [(LegendType, Text)] +-- > legends' = -- > [(LegendText def, "legend")] <> -- > [(LegendPixel (blob ublue) 0.05, "pixel")] <> -- > [(LegendRect def 0.05, "rect")] <> @@ -113,10 +113,10 @@ -- > mainExample = withHud_ opts sixbyfour (lineChart lopts) ls -- > where -- > opts = --- > #titles .~ titles $ +-- > #titles .~ titles' $ -- > #axes .~ as $ -- > #axes %~ map (#outerPad .~ 1) $ --- > #legends .~ [#chartType .~ legends $ def] $ +-- > #legends .~ [#chartType .~ legends' $ def] $ -- > def -- > -- > main :: IO () @@ -171,17 +171,17 @@ ) where import Chart.ADT -import Chart.Arrow -import Chart.Bar +import Chart.Arrow hiding (color) +import Chart.Bar hiding (orientation) import Chart.Core import Chart.Data import Chart.Data.Time -import Chart.Glyph +import Chart.Glyph hiding (color, size, borderSize, borderColor) import Chart.Hud -import Chart.Line -import Chart.Rect +import Chart.Line hiding (color) +import Chart.Rect hiding (borderSize, borderColor) import Chart.Svg -import Chart.Text +import Chart.Text hiding (orientation, size, color) import Data.Colour import Data.Colour.Names import Data.Colour.Palette.ColorSet diff --git a/src/Chart/Arrow.hs b/src/Chart/Arrow.hs --- a/src/Chart/Arrow.hs +++ b/src/Chart/Arrow.hs @@ -4,7 +4,7 @@ module Chart.Arrow ( Arrow(..) , ArrowHTStyle(..) - , ArrowOptions(ArrowOptions) + , ArrowOptions(..) , normArrows , arrows , arrowChart diff --git a/src/Chart/Bar.hs b/src/Chart/Bar.hs --- a/src/Chart/Bar.hs +++ b/src/Chart/Bar.hs @@ -10,7 +10,7 @@ -- | bar charts module Chart.Bar - ( BarOptions(BarOptions) + ( BarOptions(..) , BarValueAcc(..) , BarData(..) , barDataLowerUpper diff --git a/src/Chart/Glyph.hs b/src/Chart/Glyph.hs --- a/src/Chart/Glyph.hs +++ b/src/Chart/Glyph.hs @@ -3,7 +3,7 @@ -- | Glyphs are (typically) small shapes symbolically representing a data point. module Chart.Glyph - ( GlyphOptions(GlyphOptions) + ( GlyphOptions(..) , GlyphShape(..) , glyphShape , glyph_ diff --git a/src/Chart/Hud.hs b/src/Chart/Hud.hs --- a/src/Chart/Hud.hs +++ b/src/Chart/Hud.hs @@ -11,7 +11,7 @@ -- | Hud (Heads up display) is a collective noun for axes, titles & legends -- module Chart.Hud - ( HudOptions(HudOptions) + ( HudOptions(..) , hud , withHud , withHud_ @@ -19,21 +19,21 @@ , placeGap , TickStyle(..) , precision - , AxisOptions(AxisOptions) + , AxisOptions(..) , defXAxis , defYAxis , axis - , AutoOptions(AutoOptions) + , AutoOptions(..) , adjustAxis , axisSane , computeTicks - , TitleOptions(TitleOptions) + , TitleOptions(..) , title , LegendType(..) - , LegendOptions(LegendOptions) + , LegendOptions(..) , legend , GridStyle(..) - , GridOptions(GridOptions) + , GridOptions(..) , GridPos(..) , gridPos , defXGrid @@ -44,7 +44,7 @@ import Chart.Arrow import Chart.Core import Chart.Glyph -import Chart.Line (LineOptions(LineOptions), lines, oneline) +import Chart.Line (LineOptions(..), lines, oneline) import Chart.Rect import Chart.Text import qualified Control.Foldl as L @@ -460,8 +460,8 @@ -- | Create a legend based on a LegendOptions -- --- > legends :: [(LegendType, Text)] --- > legends = +-- > legends' :: [(LegendType, Text)] +-- > legends' = -- > [(LegendText def, "legend")] <> [(LegendPixel (blob ublue) 0.05, "pixel")] <> -- > -- [ (LegendArrow (def & #minStaffWidth .~ 0.01 & #minHeadLength .~ 0.03) 0.05, "arrow")] <> -- > [(LegendRect def 0.05, "rect")] <> @@ -473,7 +473,7 @@ -- > ["short", "much longer name", "line 3"] -- > -- > legendExample :: Chart b --- > legendExample = legend $ #chartType .~ legends $ def +-- > legendExample = legend $ #chartType .~ legends' $ def -- -- ![legend example](other/legendExample.svg) -- diff --git a/src/Chart/Line.hs b/src/Chart/Line.hs --- a/src/Chart/Line.hs +++ b/src/Chart/Line.hs @@ -7,7 +7,7 @@ -- | Points on a chart connected by lines. module Chart.Line - ( LineOptions(LineOptions) + ( LineOptions(..) , oneline , lines , glines diff --git a/src/Chart/Rect.hs b/src/Chart/Rect.hs --- a/src/Chart/Rect.hs +++ b/src/Chart/Rect.hs @@ -7,7 +7,7 @@ -- | rectangular chart elements module Chart.Rect - ( RectOptions(RectOptions) + ( RectOptions(..) , blob , box , clear @@ -21,7 +21,7 @@ , pixels , pixelChart , pixelChart_ - , PixelationOptions(PixelationOptions) + , PixelationOptions(..) , pixelate , pixelateChart ) where diff --git a/src/Chart/Svg.hs b/src/Chart/Svg.hs --- a/src/Chart/Svg.hs +++ b/src/Chart/Svg.hs @@ -6,7 +6,7 @@ -- | Svg rendering module Chart.Svg - ( SvgOptions(SvgOptions) + ( SvgOptions(..) , renderSvg , toText , toFile diff --git a/src/Chart/Text.hs b/src/Chart/Text.hs --- a/src/Chart/Text.hs +++ b/src/Chart/Text.hs @@ -4,9 +4,9 @@ -- | textual chart elements module Chart.Text - ( TextOptions(TextOptions) - , TextPathOptions(TextPathOptions) - , TextSvgOptions(TextSvgOptions) + ( TextOptions(..) + , TextPathOptions(..) + , TextSvgOptions(..) , TextType(..) , TextFont(..) , textFont @@ -14,7 +14,7 @@ , texts , textChart , textChart_ - , LabelOptions(LabelOptions) + , LabelOptions(..) , labelled ) where @@ -29,7 +29,6 @@ import NumHask.Prelude hiding (rotate) import NumHask.Rect - -- | options specific to text as an SVG path newtype TextPathOptions = TextPathOptions { font :: TextFont @@ -57,13 +56,13 @@ -- | text options data TextOptions = TextOptions - { size :: Double - , alignH :: AlignH - , alignV :: AlignV - , color :: AlphaColour Double - , textFillRule :: FillRule - , rotation :: Double - , textType :: TextType + { size :: Double -- ^ size as ratio to overall chart size (default: 0.08) + , alignH :: AlignH -- ^ horizontal alignment (default: 'AlignCenter') + , alignV :: AlignV -- ^ vertical alignment (default: 'AlignMid') + , color :: AlphaColour Double -- ^ default: greyish + , textFillRule :: FillRule -- ^ default: 'EvenOdd' + , rotation :: Double -- ^ in degrees from the horozontal (default: 0 degrees) + , textType :: TextType -- ^ default: 'TextPath' def } deriving (Show, Generic) instance Default TextOptions where