/usr/share/doc/libghc-chart-doc/html/Graphics-Rendering-Chart-SparkLine.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.Rendering.Chart.SparkLine</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-Rendering-Chart-SparkLine.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-Rendering-Chart-SparkLine.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Chart-1.8.1: A library for generating 2D Charts and Plots</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) Hitesh Jasani, 2008, Malcolm Wallace 2011, Tim Docker 2014</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Graphics.Rendering.Chart.SparkLine</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">SparkLine type</a></li><li><a href="#g:2">Drawing options</a></li><li><a href="#g:3">Size calculation</a></li><li><a href="#g:4">Rendering function</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Sparklines are mini graphs inspired by Edward Tufte; see
 <a href="http://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0001OR">http://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0001OR</a>
 and
 <a href="http://en.wikipedia.org/wiki/Sparkline">http://en.wikipedia.org/wiki/Sparkline</a> for more information.</p><p>The original implementation (by Hitesh Jasani) used the gd
 package as a backend renderer, and is still available at
 <a href="http://hackage.haskell.org/package/hsparklines">http://hackage.haskell.org/package/hsparklines</a>.</p><p>The present version integrates with
 the Chart package, in the sense that Sparklines are just another
 kind of (<code>ToRenderable a =&gt; a</code>), so they can be composed into grids
 and used with the rest of Chart.</p><pre>dp :: [Double]
dp = [24,21,32.3,24,15,34,43,55,57,72,74,75,73,72,55,44]

sl = SparkLine barSpark dp
fopts = FileOptions (sparkSize sl) PNG
renderableToFile fopts (sparkLineToRenderable sl) &quot;bar_spark.png&quot; 
</pre></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:SparkLine">SparkLine</a> = <a href="#v:SparkLine">SparkLine</a> {<ul class="subs"><li><a href="#v:sl_options">sl_options</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a></li><li><a href="#v:sl_data">sl_data</a> :: [<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a>]</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:SparkOptions">SparkOptions</a> = <a href="#v:SparkOptions">SparkOptions</a> {<ul class="subs"><li><a href="#v:so_smooth">so_smooth</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:so_step">so_step</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:so_height">so_height</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:so_limits">so_limits</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a>)</li><li><a href="#v:so_bgColor">so_bgColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></li><li><a href="#v:so_minColor">so_minColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></li><li><a href="#v:so_maxColor">so_maxColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></li><li><a href="#v:so_lastColor">so_lastColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></li><li><a href="#v:so_minMarker">so_minMarker</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:so_maxMarker">so_maxMarker</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:so_lastMarker">so_lastMarker</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul>}</li><li class="src short"><a href="#v:smoothSpark">smoothSpark</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a></li><li class="src short"><a href="#v:barSpark">barSpark</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a></li><li class="src short"><a href="#v:sparkSize">sparkSize</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><a href="#v:renderSparkLine">renderSparkLine</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="Graphics-Rendering-Chart-Backend-Impl.html#t:BackendProgram">BackendProgram</a> (<a href="Graphics-Rendering-Chart-Renderable.html#t:PickFn">PickFn</a> ())</li><li class="src short"><a href="#v:sparkLineToRenderable">sparkLineToRenderable</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="Graphics-Rendering-Chart-Renderable.html#t:Renderable">Renderable</a> ()</li><li class="src short"><a href="#v:sparkWidth">sparkWidth</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li></ul></div><div id="interface"><h1 id="g:1">SparkLine type</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:SparkLine" class="def">SparkLine</a> <a href="src/Graphics-Rendering-Chart-SparkLine.html#SparkLine" class="link">Source</a> <a href="#t:SparkLine" class="selflink">#</a></p><div class="doc"><p>A sparkline is a single sequence of data values, treated as y-values.
   The x-values are anonymous and implicit in the sequence.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:SparkLine" class="def">SparkLine</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:sl_options" class="def">sl_options</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a></dfn><div class="doc empty">&nbsp;</div></li><li><dfn class="src"><a id="v:sl_data" class="def">sl_data</a> :: [<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a>]</dfn><div class="doc empty">&nbsp;</div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:SparkLine" class="caption collapser" onclick="toggleSection('i:SparkLine')">Instances</p><div id="section.i:SparkLine" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SparkLine:ToRenderable:1" class="instance expander" onclick="toggleSection('i:id:SparkLine:ToRenderable:1')"></span> <a href="Graphics-Rendering-Chart-Renderable.html#t:ToRenderable">ToRenderable</a> <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a></span> <a href="src/Graphics-Rendering-Chart-SparkLine.html#line-102" class="link">Source</a> <a href="#t:SparkLine" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:SparkLine:ToRenderable:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:toRenderable">toRenderable</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="Graphics-Rendering-Chart-Renderable.html#t:Renderable">Renderable</a> () <a href="src/Graphics-Rendering-Chart-Renderable.html#toRenderable" class="link">Source</a> <a href="#v:toRenderable" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><h1 id="g:2">Drawing options</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:SparkOptions" class="def">SparkOptions</a> <a href="src/Graphics-Rendering-Chart-SparkLine.html#SparkOptions" class="link">Source</a> <a href="#t:SparkOptions" class="selflink">#</a></p><div class="doc"><p>Options to render the sparklines in different ways.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:SparkOptions" class="def">SparkOptions</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:so_smooth" class="def">so_smooth</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>smooth or bars</p></div></li><li><dfn class="src"><a id="v:so_step" class="def">so_step</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc"><p>step size</p></div></li><li><dfn class="src"><a id="v:so_height" class="def">so_height</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc"><p>graph height (pixels)</p></div></li><li><dfn class="src"><a id="v:so_limits" class="def">so_limits</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a>)</dfn><div class="doc"><p>data point limits</p></div></li><li><dfn class="src"><a id="v:so_bgColor" class="def">so_bgColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></dfn><div class="doc"><p>background color</p></div></li><li><dfn class="src"><a id="v:so_minColor" class="def">so_minColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></dfn><div class="doc"><p>color of minimum datapoint</p></div></li><li><dfn class="src"><a id="v:so_maxColor" class="def">so_maxColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></dfn><div class="doc"><p>color of maximum datapoint</p></div></li><li><dfn class="src"><a id="v:so_lastColor" class="def">so_lastColor</a> :: <a href="file:///usr/share/doc/libghc-colour-doc/html/Data-Colour-RGBSpace.html#t:Colour">Colour</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Double">Double</a></dfn><div class="doc"><p>color of last datapoint</p></div></li><li><dfn class="src"><a id="v:so_minMarker" class="def">so_minMarker</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>display minimum marker</p></div></li><li><dfn class="src"><a id="v:so_maxMarker" class="def">so_maxMarker</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>display maximum marker</p></div></li><li><dfn class="src"><a id="v:so_lastMarker" class="def">so_lastMarker</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>display last marker</p></div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:SparkOptions" class="caption collapser" onclick="toggleSection('i:SparkOptions')">Instances</p><div id="section.i:SparkOptions" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SparkOptions:Show:1" class="instance expander" onclick="toggleSection('i:id:SparkOptions:Show:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a></span> <a href="src/Graphics-Rendering-Chart-SparkLine.html#line-73" class="link">Source</a> <a href="#t:SparkOptions" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div id="section.i:id:SparkOptions:Show:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -&gt; <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a>] -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:smoothSpark" class="def">smoothSpark</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a> <a href="src/Graphics-Rendering-Chart-SparkLine.html#smoothSpark" class="link">Source</a> <a href="#v:smoothSpark" class="selflink">#</a></p><div class="doc"><p>Default options for a smooth sparkline.</p></div></div><div class="top"><p class="src"><a id="v:barSpark" class="def">barSpark</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkOptions">SparkOptions</a> <a href="src/Graphics-Rendering-Chart-SparkLine.html#barSpark" class="link">Source</a> <a href="#v:barSpark" class="selflink">#</a></p><div class="doc"><p>Default options for a barchart sparkline.</p></div></div><h1 id="g:3">Size calculation</h1><div class="top"><p class="src"><a id="v:sparkSize" class="def">sparkSize</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>) <a href="src/Graphics-Rendering-Chart-SparkLine.html#sparkSize" class="link">Source</a> <a href="#v:sparkSize" class="selflink">#</a></p><div class="doc"><p>Return the width and height of the SparkLine.</p></div></div><h1 id="g:4">Rendering function</h1><div class="top"><p class="src"><a id="v:renderSparkLine" class="def">renderSparkLine</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="Graphics-Rendering-Chart-Backend-Impl.html#t:BackendProgram">BackendProgram</a> (<a href="Graphics-Rendering-Chart-Renderable.html#t:PickFn">PickFn</a> ()) <a href="src/Graphics-Rendering-Chart-SparkLine.html#renderSparkLine" class="link">Source</a> <a href="#v:renderSparkLine" class="selflink">#</a></p><div class="doc"><p>Render a SparkLine to a drawing surface.</p></div></div><div class="top"><p class="src"><a id="v:sparkLineToRenderable" class="def">sparkLineToRenderable</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="Graphics-Rendering-Chart-Renderable.html#t:Renderable">Renderable</a> () <a href="src/Graphics-Rendering-Chart-SparkLine.html#sparkLineToRenderable" class="link">Source</a> <a href="#v:sparkLineToRenderable" class="selflink">#</a></p><div class="doc"><p>Create a renderable from a SparkLine.</p></div></div><div class="top"><p class="src"><a id="v:sparkWidth" class="def">sparkWidth</a> :: <a href="Graphics-Rendering-Chart-SparkLine.html#t:SparkLine">SparkLine</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Graphics-Rendering-Chart-SparkLine.html#sparkWidth" class="link">Source</a> <a href="#v:sparkWidth" class="selflink">#</a></p><div class="doc"><p>Compute the width of a SparkLine, for rendering purposes.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
libghc-chart-doc 1.8.1-1 / usr / share / doc / libghc-chart-doc / html / Graphics-Rendering-Chart-SparkLine.html
