lib/squid.rb in squid-1.0.0.beta2 vs lib/squid.rb in squid-1.0.0.beta3
- old
+ new
@@ -5,11 +5,11 @@
# Provides the `chart` method to use in Prawn::Document
# @see http://prawnpdf.org/api-docs/2.0/Prawn/Document.html
module Interface
# Plots a graph the current document.
#
- # @param [Hash<#to_s, [Hash<#to_s, Numeric>]>] data the series to plot in
+ # @param [Hash<#to_s, [Hash<#to_s, Numeric>]>] data the series to plot in
# the graph. Each key is the name of the series, and each value contains
# the values for the series. Values are also a hash, where each key is
# a category, and each value the numerical value for that category.
# @param [Hash] settings the option to customize the graph.
# @option settings [Boolean] :baseline (true) whether to plot the baseline.
@@ -19,11 +19,11 @@
# @option settings [Integer] :every (1) how often to plot the categories.
# @option settings [Symbol] :format (:integer) the format of axis values.
# @option settings [Numeric] :height (250) the full height of the graph.
# @option settings [Boolean] :labels (false) whether to plot value labels.
# @option settings [<Boolean, Hash>] :legend (true) whether to plot the
- # legend. If a Hash is provided, the `:offset` option can be set to
- # specify the offset between the legend and the right margin.
+ # legend. If a Hash is provided, the `:right` and `:bottom` options can be
+ # set to specify the right and bottom margin of the legend.
# @option settings [Numeric] :line_width (3) the line width for line graphs.
# @option settings [Numeric] :steps (4) the number of gridlines.
# @option settings [Boolean] :ticks (true) whether to plot the ticks.
# @option settings [Symbol] :type (:column) the type of graph.
def chart(data = {}, settings = {})