Contents

module Prawn
  module Graph
    
    # A Prawn::Graph::Series represents a series of data which are to be plotted
    # on a chart.
    #
    class Series
      attr_accessor :values, :options

      DEFAULT_OPTIONS = {
        title:            nil,
        type:             :bar,
        mark_average:     false,
        mark_minimum:     false,
        mark_maximum:     false,
      }

      def initialize(values = [], options = {})
        @values   = values
        @options  = OpenStruct.new(DEFAULT_OPTIONS.merge(options))
      end

      # @return [String] The value of +options.title+.
      #
      def title
        options.title
      end

      # @return [Symbol] The value of +options.type+.
      #
      def type
        options.type
      end

      # @param value [Object] a value to be added to the series. Must be of the same kind as other +values+.
      # @return [Array] The modified +values+ object.
      #
      def <<(value)
        @values << value
      end

      # @return [Numeric] The smallest value stored in the +values+ of this Series.
      #
      def min
        @values.min || 0
      end

      # @return [Numeric] The largest value stored in the +values+ of this Series.
      #
      def max
        @values.max || 0
      end

      # @return [Numeric] The average value stored in the +values+ of this Series.
      #
      def avg
        if size > 0
          @values.inject(:+) / size
        else
          0
        end
      end

      # @return [Numeric] The size of the +values+ stored in this Series.
      #
      def size
        @values.size
      end

      # @deprecated Provided to allow for tempory backwards compatibilty with legacy graph drawing. Do not use.
      # @return [Array] Series represented as an array in the format [ title, val1, val2... ]
      #
      def to_a
        warn "[DEPRECATION] Series#to_a is deprecated and will be removed in a future version of prawn-graph."
        [options.title, @values].compact.flatten
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
prawn-graph-0.9.1	lib/prawn/graph/series.rb
prawn-graph-0.9.0	lib/prawn/graph/series.rb