-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Easily plot distributions from the distribution package..
--   
@package distribution-plot
@version 1.0.0.0


-- | This module provides functions to plot distributions to files.
module Data.Distribution.Plot

-- | Plots the given distributions to PNG file.
--   
--   See <a>plotWith</a> for more options.
plot :: (Show a, Ord a) => FilePath -> [Distribution a] -> IO ()

-- | Plots the given distributions to a file.
plotWith :: Ord a => PlotOptions a -> FilePath -> [Distribution a] -> IO ()

-- | Options for plotting distributions.
data PlotOptions a
PlotOptions :: Aggregator a -> String -> [String] -> [AlphaColour Double] -> (a -> String) -> (Int, Int) -> FileFormat -> Set a -> Bool -> Bool -> PlotOptions a

-- | Aggregator to apply on the values. Defaults to identity.
getAggregator :: PlotOptions a -> Aggregator a

-- | Title of the plot. Defaults to the empty string.
getTitle :: PlotOptions a -> String

-- | Labels of the distributions. Defaults to <tt>[]</tt>.
getLabels :: PlotOptions a -> [String]

-- | Colors for the distributions. Defaults to <a>defaultColorSeq</a>.
getColors :: PlotOptions a -> [AlphaColour Double]

-- | How to display the values. Defaults to <tt>show</tt>.
getDisplayer :: PlotOptions a -> a -> String

-- | Dimension of the output image. Defaults to <tt>(600, 400)</tt>.
getDimensions :: PlotOptions a -> (Int, Int)

-- | Format of the output image. Defaults to <tt>PNG</tt>.
getFormat :: PlotOptions a -> FileFormat

-- | Values to display unconditionally. Defaults to the empty set.
getExtraDomain :: PlotOptions a -> Set a

-- | Whether to stack bars. Defaults to <tt>False</tt>.
getStacked :: PlotOptions a -> Bool

-- | <tt>True</tt> to put distributions on the x-axis, <tt>False</tt> to
--   put values on the x-axis. Defaults to <tt>False</tt>.
getInversed :: PlotOptions a -> Bool

-- | Lens for <a>getAggregator</a>.
plot_aggregator :: Simple Lens (PlotOptions a) (Aggregator a)

-- | Lens for <a>getTitle</a>.
plot_title :: Simple Lens (PlotOptions a) String

-- | Lens for <a>getLabels</a>.
plot_labels :: Simple Lens (PlotOptions a) [String]

-- | Lens for <a>getColors</a>.
plot_colors :: Simple Lens (PlotOptions a) [AlphaColour Double]

-- | Lens for <a>getDisplayer</a>.
plot_displayer :: Simple Lens (PlotOptions a) (a -> String)

-- | Lens for <a>getDisplayer</a>.
plot_dimensions :: Simple Lens (PlotOptions a) (Int, Int)

-- | Lens for <a>getFormat</a>.
plot_format :: Simple Lens (PlotOptions a) FileFormat

-- | Lens for <a>getExtraDomain</a>.
plot_extra_domain :: Simple Lens (PlotOptions a) (Set a)

-- | Lens for <a>getStacked</a>.
plot_stacked :: Simple Lens (PlotOptions a) Bool

-- | Lens for <a>getInversed</a>.
plot_inversed :: Simple Lens (PlotOptions a) Bool
instance Show a => Default (PlotOptions a)