Chart 1.5.2 → 1.5.3

raw patch · 3 files changed

+26/−9 lines, 3 filesPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

API changes (from Hackage documentation)

Files

• Chart.cabal +1/−1
• Graphics/Rendering/Chart.hs +9/−5
• Graphics/Rendering/Chart/Easy.hs +16/−3

@@ -1,5 +1,5 @@ Name: Chart-Version: 1.5.2+Version: 1.5.3 License: BSD3 License-file: LICENSE Copyright: Tim Docker, 2006-2014

@@ -6,11 +6,15 @@ -- -- A framework for creating 2D charts in Haskell. ----- The basic model is that you define a value representing a chart to--- be displayed, and then convert it to a 'Renderable' by applying--- 'toRenderable'. This 'Renderable' is then actually output by--- calling a function in an appropriate graphics backend, eg--- 'renderableToFile'.+-- For the simplest API, see the "Graphics.Rendering.Chart.Easy"+-- module.+--+-- When more control is required, understanding the various data types+-- is necessary. The basic model is that you define a value+-- representing a chart to be displayed (eg. a `Layout`), and then+-- convert it to a 'Renderable' by applying 'toRenderable'. This+-- 'Renderable' is then actually output by calling a function in an+-- appropriate graphics backend, eg 'renderableToFile'. -- -- Currently, there are three types of charts: --

@@ -5,13 +5,26 @@ -- Copyright   :  (c) Tim Docker 2014 -- License     :  BSD-style (see chart/COPYRIGHT) --+-- A high level API for generating a plot quickly.+--  -- Importing the Easy module brings into scope all core functions and types required -- for working with the chart library. This includes key external dependencies such as -- Control.Len and Data.Colour. The module also provides several helper functions for--- quickly generating common plots.+-- quickly generating common plots. Note that chart backends must still be explicitly+-- imported, as some backends cannot be built on all platforms. ----- Note that chart backends must still be explicitly imported, as some backends cannot--- be built on all platforms.+-- Example usage:+--+-- > import Graphics.Rendering.Chart.Easy+-- > import Graphics.Rendering.Chart.Backend.Cairo+-- > +-- > signal :: [Double] -> [(Double,Double)]+-- > signal xs = [ (x,(sin (x*3.14159/45) + 1) / 2 * (sin (x*3.14159/5))) | x <- xs ]+-- > +-- > main = toFile def "example.png" $ do+-- >     layout_title .= "Amplitude Modulation"+-- >     plot (line "am" [signal [0,(0.5)..400]])+-- >     plot (points "am points" (signal [0,7..400]))  module Graphics.Rendering.Chart.Easy(