axlsx 1.2.0 → 1.3.3

data/lib/axlsx/util/constants.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
 
   # XML Encoding
@@ -31,6 +30,9 @@ module Axlsx
   # xml schema namespace
   CORE_NS_XSI = "http://www.w3.org/2001/XMLSchema-instance"
 
+  # Digital signature namespace
+  DIGITAL_SIGNATURE_NS = "http://schemas.openxmlformats.org/package/2006/digital-signature"
+
   # spreadsheet drawing namespace
   XML_NS_XDR = "http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"
 
@@ -61,6 +63,9 @@ module Axlsx
   # core rels namespace
   CORE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties"
 
+  # digital signature rels namespace
+  DIGITAL_SIGNATURE_R = "http://schemas.openxmlformats.org/package/2006/relationships/digital- signature/signature"
+
   # styles rels namespace
   STYLES_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"
 
@@ -76,7 +81,7 @@ module Axlsx
   # image rels namespace
   IMAGE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
 
-  # image rels namespace
+  # hyperlink rels namespace
   HYPERLINK_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
 
   # comment rels namespace
@@ -118,6 +123,15 @@ module Axlsx
   # core content type
   CORE_CT = "application/vnd.openxmlformats-package.core-properties+xml"
 
+  # digital signature xml content type
+  DIGITAL_SIGNATURE_XML_CT = "application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml"
+
+  # digital signature origin content type
+  DIGITAL_SIGNATURE_ORIGIN_CT = "application/vnd.openxmlformats-package.digital-signature-origin"
+
+  # digital signature certificate content type
+  DIGITAL_SIGNATURE_CERTIFICATE_CT = "application/vnd.openxmlformats-package.digital-signature-certificate"
+
   # chart content type
   CHART_CT = "application/vnd.openxmlformats-officedocument.drawingml.chart+xml"
 
@@ -136,6 +150,7 @@ module Axlsx
   #drawing content type
   DRAWING_CT = "application/vnd.openxmlformats-officedocument.drawing+xml"
 
+
   # xml content type extensions
   XML_EX = "xml"
 
@@ -247,11 +262,14 @@ module Axlsx
   # error message for RegexValidator
   ERR_REGEX = "Invalid Data. %s does not match %s."
 
+  # error message for RangeValidator
+  ERR_RANGE = "Invalid Data. %s must be between %s and %s, (inclusive:%s) you gave: %s"
+
   # error message for sheets that use a name which is longer than 31 bytes
   ERR_SHEET_NAME_TOO_LONG = "Your worksheet name '%s' is too long. Worksheet names must be 31 characters (bytes) or less"
-  
+
   # error message for sheets that use a name which includes a colon
-  
+
   ERR_SHEET_NAME_COLON_FORBIDDEN = "Your worksheet name '%s' contains a colon, which is not allowed by MS Excel and will cause repair warnings. Please change the name of your sheet."
 
   # error message for duplicate sheet names
@@ -268,4 +286,87 @@ module Axlsx
 
   # error message for non 'integerish' value
   ERR_INTEGERISH = "You value must be, or be castable via to_i, an Integer. You provided %s"
+
+  # Regex to match forbidden control characters
+  # The following will be automatically stripped from worksheets.
+  #
+  # x00 Null
+  # x01 Start Of Heading
+  # x02 Start Of Text
+  # x03End Of Text
+  # x04 End Of Transmission
+  # x05 Enquiry
+  # x06 Acknowledge
+  # x07 Bell
+  # x08 Backspace
+  # x0B Line Tabulation
+  # x0C Form Feed
+  # x0E Shift Out
+  # x0F Shift In
+  # x10 Data Link Escape
+  # x11 Device Control One
+  # x12 Device Control Two
+  # x13 Device Control Three
+  # x14 Device Control Four
+  # x15 Negative Acknowledge
+  # x16 Synchronous Idle
+  # x17 End Of Transmission Block
+  # x18 Cancel
+  # x19 End Of Medium
+  # x1A Substitute
+  # x1B Escape
+  # x1C Information Separator Four
+  # x1D Information Separator Three
+  # x1E Information Separator Two
+  # x1F Information Separator One
+  #
+  # The following are not dealt with. 
+  # If you have this in your data, expect excel to blow up!
+  #
+  # x7F	Delete
+  # x80	Control 0080
+  # x81	Control 0081
+  # x82	Break Permitted Here
+  # x83	No Break Here
+  # x84	Control 0084
+  # x85	Next Line (Nel)
+  # x86	Start Of Selected Area
+  # x87	End Of Selected Area
+  # x88	Character Tabulation Set
+  # x89	Character Tabulation With Justification
+  # x8A	Line Tabulation Set
+  # x8B	Partial Line Forward
+  # x8C	Partial Line Backward
+  # x8D	Reverse Line Feed
+  # x8E	Single Shift Two
+  # x8F	Single Shift Three
+  # x90	Device Control String
+  # x91	Private Use One
+  # x92	Private Use Two
+  # x93	Set Transmit State
+  # x94	Cancel Character
+  # x95	Message Waiting
+  # x96	Start Of Guarded Area
+  # x97	End Of Guarded Area
+  # x98	Start Of String
+  # x99	Control 0099
+  # x9A	Single Character Introducer
+  # x9B	Control Sequence Introducer
+  # x9C	String Terminator
+  # x9D	Operating System Command
+  # x9E	Privacy Message
+  # x9F	Application Program Command
+  #
+  # The following are allowed:
+  #
+  # x0A Line Feed (Lf)
+  # x0D Carriage Return (Cr)
+  # x09 Character Tabulation
+  # @see http://www.codetable.net/asciikeycodes
+  pattern = "[\x0-\x08\x0B\x0C\x0E-\x1F]"
+  pattern= pattern.respond_to?(:encode) ? pattern.encode('UTF-8') : pattern
+  
+  # The regular expression used to remove control characters from worksheets
+  CONTROL_CHAR_REGEX = Regexp.new(pattern, 'n')
+
 end

data/lib/axlsx/util/options_parser.rb

@@ -0,0 +1,15 @@
+module Axlsx
+  # This module defines a single method for parsing options in class
+  # initializers.
+  module OptionsParser
+
+    # Parses an options hash by calling any defined method by the same
+    # name of the key postfixed with an '='
+    # @param [Hash] options Options to parse.
+    def parse_options(options={})
+      options.each do |key, value|
+        self.send("#{key}=", value) if self.respond_to?("#{key}=") && value != nil
+      end
+    end
+  end
+end

data/lib/axlsx/util/serialized_attributes.rb

@@ -0,0 +1,46 @@
+module Axlsx
+  # This module allows us to define a list of symbols defining which
+  # attributes will be serialized for a class.
+  module SerializedAttributes
+
+    # Extend with class methods
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # class methods applied to all includers
+    module ClassMethods
+
+      # This is the method to be used in inheriting classes to specify 
+      # which of the instance values are serializable
+      def serializable_attributes(*symbols)
+        @xml_attributes = symbols
+      end
+
+      # a reader for those attributes
+      def xml_attributes
+        @xml_attributes
+      end
+    end
+
+    # serializes the instance values of the defining object based on the 
+    # list of serializable attributes.
+    # @param [String] str The string instance to append this
+    # serialization to.
+    # @param [Hash] additional_attributes An option key value hash for
+    # defining values that are not serializable attributes list.
+    def serialized_attributes(str = '', additional_attributes = {})
+      key_value_pairs = instance_values
+      key_value_pairs.each do |key, value|
+        key_value_pairs.delete(key) if value == nil
+        key_value_pairs.delete(key) unless self.class.xml_attributes.include?(key.to_sym)
+      end
+      key_value_pairs.merge! additional_attributes
+
+      key_value_pairs.each do |key, value|
+        str << "#{Axlsx.camel(key, false)}=\"#{value}\" "
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/util/simple_typed_list.rb

@@ -44,13 +44,15 @@ module Axlsx
       @list
     end
 
+    alias :to_a :to_ary
+
     # Unlock the list
     # @return [self]
     def unlock
       @locked_at = nil
       self
     end
-    
+
     # join operator
     # @param [Array] v the array to join
     # @raise [ArgumentError] if any of the values being joined are not
@@ -60,7 +62,7 @@ module Axlsx
       v.each do |item| 
         DataTypeValidator.validate "SimpleTypedList.+", @allowed_types, item
         @list << item 
-      end 
+      end
     end
 
     # Concat operator
@@ -105,6 +107,18 @@ module Axlsx
       v
     end
 
+    # inserts an item at the index specfied
+    # @param [Integer] index
+    # @param [Any] v
+    # @raise [ArgumentError] if the index is protected by locking
+    # @raise [ArgumentError] if the index is not one of the allowed types
+    def insert(index, v)
+      DataTypeValidator.validate "SimpleTypedList.<<", @allowed_types, v
+      raise ArgumentError, "Item is protected and cannot be changed" if protected? index
+      @list.insert(index, v)
+      v
+    end
+
     # determines if the index is protected
     # @param [Integer] index
     def protected? index

data/lib/axlsx/util/validators.rb

@@ -14,6 +14,24 @@ module Axlsx
     end
   end
 
+  # Validate that the value provided is between a specific range
+  # Note that no data conversions will be done for you!
+  # Comparisons will be made using < and > or <= and <= when the inclusive parameter is true
+  class RangeValidator
+    # @param [String] name The name of what is being validated
+    # @param [Any] min The minimum allowed value
+    # @param [Any] max The maximum allowed value
+    # @param [Any] value The value to be validated
+    # @param [Boolean] inclusive Flag indicating if the comparison should be inclusive.
+    def self.validate(name, min, max, value, inclusive = true)
+      passes = if inclusive
+                 min <= value && value <= max
+               else
+                 min < value && value < max
+               end
+      raise ArgumentError, (ERR_RANGE % [value.inspect, min.to_s, max.to_s, inclusive]) unless passes
+    end
+  end
   # Validates the value against the regular expression provided.
   class RegexValidator
     # @param [String] name The name of what is being validated. This is included in the output when the value is invalid
@@ -73,7 +91,7 @@ module Axlsx
   # @raise [ArgumentError] raised if the value is not a Fixnun, Integer, Float value greater or equal to 0
   # @return [Boolean] true if the data is valid
   def self.validate_unsigned_numeric(v)
-    DataTypeValidator.validate("Invalid column width", [Fixnum, Integer, Float], v, lambda { |arg| arg.respond_to?(:>=) && arg >= 0 })
+    DataTypeValidator.validate("Invalid column width", [Fixnum, Integer, Float], v, lambda { |arg| arg.respond_to?(:>=) && arg.to_i >= 0 })
   end
 
   # Requires that the value is a Fixnum or Integer
@@ -112,7 +130,7 @@ module Axlsx
   def self.validate_scale_10_400(v)
     DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg >= 10 && arg <= 400 }
   end
-  
+
   # Requires that the value is an integer ranging from 10 to 400 or 0.
   def self.validate_scale_0_10_400(v)
     DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg == 0 || (arg >= 10 && arg <= 400) }
@@ -122,14 +140,21 @@ module Axlsx
   def self.validate_page_orientation(v)
     RestrictionValidator.validate "page_orientation", [:default, :landscape, :portrait], v
   end
+  # Requires that the value is one of :none, :single, :double, :singleAccounting, :doubleAccounting
+  def self.validate_cell_u(v)
+    RestrictionValidator.validate "cell run style u", [:none, :single, :double, :singleAccounting, :doubleAccounting], v
+  end
 
+  def self.validate_family(v)
+    RestrictionValidator.validate "cell run style family", 1..5, v
+  end
   # Requires that the value is valid pattern type.
   # valid pattern types must be one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown,
   # :darkUp, :darkGrid, :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, or :gray0625.
   # @param [Any] v The value validated
   def self.validate_pattern_type(v)
     RestrictionValidator.validate :pattern_type, [:none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown, :darkUp, :darkGrid,
-       :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, :gray0625], v
+                                                  :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, :gray0625], v
   end
 
   # Requires that the value is one of the ST_TimePeriod types
@@ -226,7 +251,7 @@ module Axlsx
   def self.validate_data_validation_error_style(v)
     RestrictionValidator.validate :validate_data_validation_error_style, [:information, :stop, :warning], v
   end
-  
+
   # Requires that the value is valid data validation operator.
   # valid operators must be one of lessThan, lessThanOrEqual, equal,
   # notEqual, greaterThanOrEqual, greaterThan, between, notBetween
@@ -234,28 +259,28 @@ module Axlsx
   def self.validate_data_validation_operator(v)
     RestrictionValidator.validate :data_validation_operator, [:lessThan, :lessThanOrEqual, :equal, :notEqual, :greaterThanOrEqual, :greaterThan, :between, :notBetween], v
   end
-  
+
   # Requires that the value is valid data validation type.
   # valid types must be one of custom, data, decimal, list, none, textLength, time, whole
   # @param [Any] v The value validated
   def self.validate_data_validation_type(v)
     RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole], v
   end
-  
+
   # Requires that the value is a valid sheet view type.
   # valid types must be one of normal, page_break_preview, page_layout
   # @param [Any] v The value validated
   def self.validate_sheet_view_type(v)
     RestrictionValidator.validate :sheet_view_type, [:normal, :page_break_preview, :page_layout], v
   end
-  
+
   # Requires that the value is a valid active pane type.
   # valid types must be one of bottom_left, bottom_right, top_left, top_right
   # @param [Any] v The value validated
   def self.validate_pane_type(v)
     RestrictionValidator.validate :active_pane_type, [:bottom_left, :bottom_right, :top_left, :top_right], v
   end
-  
+
   # Requires that the value is a valid split state type.
   # valid types must be one of frozen, frozen_split, split
   # @param [Any] v The value validated

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
-# encoding: UTF-8
 module Axlsx
+
   # The current version
-  VERSION="1.2.0"
+  VERSION = "1.3.3"
 end

data/lib/axlsx/workbook/defined_name.rb

@@ -49,12 +49,15 @@ module Axlsx
   # @example
   #     For clarification: LOG10 is always a cell reference, LOG10() is always formula, LOGO1000 can be a defined name that overrides a cell reference.
   class DefinedName
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
     # creates a new DefinedName.
     # @param [String] formula - the formula the defined name references
     # @param [Hash] options - A hash of key/value pairs that will be mapped to this instances attributes.
-    # 
+    #
     # @option [String] name - Specifies the name that appears in the user interface for the defined name.
-    #                         This attribute is required. 
+    #                         This attribute is required.
     #                         The following built-in names are defined in this SpreadsheetML specification:
     #                         Print
     #                           _xlnm.Print_Area: this defined name specifies the workbook's print area.
@@ -96,10 +99,9 @@ module Axlsx
     #                                        version of the workbook that is published to or rendered on a Web or application server.
     def initialize(formula, options={})
       @formula = formula
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
+
     attr_reader :local_sheet_id
 
     # The local sheet index (0-based)
@@ -109,64 +111,17 @@ module Axlsx
       @local_sheet_id = value
     end
 
-    # string attributes that will be added when this class is evaluated
-    STRING_ATTRIBUTES = [:short_cut_key, :status_bar, :help, :description, :custom_menu, :comment]
-
-    # boolean attributes that will be added when this class is evaluated
-    BOOLEAN_ATTRIBUTES = [:workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden] 
-
-    # Dynamically create string attribute accessors
-    STRING_ATTRIBUTES.each do |attr|
-      class_eval %{
-        # The #{attr} attribute reader
-        # @return [String]
-        attr_reader :#{attr}
-
-        # The #{attr} writer
-        # @param [String] value The value to assign to #{attr}
-        # @return [String]
-        def #{attr}=(value)
-          Axlsx::validate_string(value)
-          @#{attr}= value
-        end
-      }
-    end
-
-    # Dynamically create boolean attribute accessors
-    BOOLEAN_ATTRIBUTES.each do |attr|
-      class_eval %{
-      # The #{attr} attribute reader
-      # @return [Boolean]
-      attr_reader :#{attr}
+    string_attr_accessor :short_cut_key, :status_bar, :help, :description, :custom_menu, :comment, :name, :formula
 
-      # The #{attr} writer
-      # @param [Boolean] value The value to assign to #{attr}
-      # @return [Boolean]
-      def #{attr}=(value)
-        Axlsx::validate_boolean(value)
-        @#{attr} = value
-      end
-      }
-    end
-   
-    attr_reader :name
-    # The name of this defined name. Please refer to the class documentation for more information
-    def name=(value)
-      Axlsx::RestrictionValidator.validate 'DefinedName.name', %w(_xlnm.Print_Area _xlnm.Print_Titles _xlnm.Criteria _xlnm._FilterDatabase _xlnm.Extract _xlnm.Consolidate_Area _xlnm.Database _xlnm.Sheet_Title), value
-      @name = value
-    end
+    boolean_attr_accessor :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden
 
-    # The formula this defined name references
-    attr_reader :formula
+    serializable_attributes :short_cut_key, :status_bar, :help, :description, :custom_menu, :comment,
+      :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden, :name, :local_sheet_id
 
     def to_xml_string(str='')
       raise ArgumentError, 'you must specify the name for this defined name. Please read the documentation for Axlsx::DefinedName for more details' unless name 
-      str << '<definedName'
-      instance_values.each do |name, value| 
-        unless name == 'formula'
-          str << ' ' << Axlsx::camel(name, false) << "='#{value}'"
-        end
-      end
+      str << '<definedName '
+      serialized_attributes str
       str << '>' << @formula
       str << '</definedName>'
     end

data/lib/axlsx/workbook/workbook.rb

@@ -1,14 +1,17 @@
 # -*- coding: utf-8 -*-
 module Axlsx
-require 'axlsx/workbook/worksheet/auto_filter.rb'
+require 'axlsx/workbook/worksheet/sheet_calc_pr.rb'
+require 'axlsx/workbook/worksheet/auto_filter/auto_filter.rb'
 require 'axlsx/workbook/worksheet/date_time_converter.rb'
 require 'axlsx/workbook/worksheet/protected_range.rb'
 require 'axlsx/workbook/worksheet/protected_ranges.rb'
 require 'axlsx/workbook/worksheet/cell.rb'
 require 'axlsx/workbook/worksheet/page_margins.rb'
+require 'axlsx/workbook/worksheet/page_set_up_pr.rb'
 require 'axlsx/workbook/worksheet/page_setup.rb'
 require 'axlsx/workbook/worksheet/print_options.rb'
 require 'axlsx/workbook/worksheet/cfvo.rb'
+require 'axlsx/workbook/worksheet/cfvos.rb'
 require 'axlsx/workbook/worksheet/color_scale.rb'
 require 'axlsx/workbook/worksheet/data_bar.rb'
 require 'axlsx/workbook/worksheet/icon_set.rb'
@@ -27,10 +30,13 @@ require 'axlsx/workbook/worksheet/dimension.rb'
 require 'axlsx/workbook/worksheet/sheet_data.rb'
 require 'axlsx/workbook/worksheet/worksheet_drawing.rb'
 require 'axlsx/workbook/worksheet/worksheet_comments.rb'
+require 'axlsx/workbook/worksheet/worksheet_hyperlink'
+require 'axlsx/workbook/worksheet/worksheet_hyperlinks'
 require 'axlsx/workbook/worksheet/worksheet.rb'
 require 'axlsx/workbook/shared_strings_table.rb'
 require 'axlsx/workbook/defined_name.rb'
 require 'axlsx/workbook/defined_names.rb'
+require 'axlsx/workbook/worksheet/table_style_info.rb'
 require 'axlsx/workbook/worksheet/table.rb'
 require 'axlsx/workbook/worksheet/tables.rb'
 require 'axlsx/workbook/worksheet/data_validation.rb'
@@ -147,6 +153,14 @@ require 'axlsx/workbook/worksheet/selection.rb'
     @@date1904 = false
 
 
+    # A quick helper to retrive a worksheet by name
+    # @param [String] name The name of the sheet you are looking for
+    # @return [Worksheet] The sheet found, or nil
+    def sheet_by_name(name)
+      index = @worksheets.index { |sheet| sheet.name == name }
+      @worksheets[index] if index
+    end
+
     # lets come back to this later when we are ready for parsing.
     #def self.parse entry
     #  io = entry.get_input_stream
@@ -155,7 +169,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     #  w.parse_string :date1904, "//xmlns:workbookPr/@date1904"
     #  w
     #end
-
+    
     # Creates a new Workbook
     # The recomended way to work with workbooks is via Package#workbook
     # @option options [Boolean] date1904. If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.
@@ -201,6 +215,23 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # see @use_autowidth
     def use_autowidth=(v=true) Axlsx::validate_boolean v; @use_autowidth = v; end
 
+    # inserts a worksheet into this workbook at the position specified.
+    # It the index specified is out of range, the worksheet will be added to the end of the 
+    # worksheets collection
+    # @return [Worksheet]
+    # @param index The zero based position to insert the newly created worksheet
+    # @param [Hash] options Options to pass into the worksheed during initialization.
+    # @option options [String] name The name of the worksheet
+    # @option options [Hash] page_margins The page margins for the worksheet
+    def insert_worksheet(index=0, options={})
+      worksheet = Worksheet.new(self, options)
+      @worksheets.delete_at(@worksheets.size - 1)
+      @worksheets.insert(index, worksheet)
+      yield worksheet if block_given?
+      worksheet
+    end
+
+    #
     # Adds a worksheet to this workbook
     # @return [Worksheet]
     # @option options [String] name The name of the worksheet.

data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb

@@ -0,0 +1,77 @@
+
+require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
+require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
+
+module Axlsx
+
+  #This class represents an auto filter range in a worksheet
+  class AutoFilter
+
+    # creates a new Autofilter object
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # The range the autofilter should be applied to.
+    # This should be a string like 'A1:B8'
+    # @return [String]
+    attr_accessor :range
+
+    # the formula for the defined name required for this auto filter
+    # This prepends the worksheet name to the absolute cell reference
+    # e.g. A1:B2 -> 'Sheet1'!$A$1:$B$2
+    # @return [String]
+    def defined_name
+      return unless range
+      Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name)})
+    end
+
+    # A collection of filterColumns for this auto_filter
+    # @return [SimpleTypedList]
+    def columns
+      @columns ||= SimpleTypedList.new FilterColumn
+    end
+
+    # Adds a filter column. This is the recommended way to create and manage filter columns for your autofilter.
+    # In addition to the require id and type parameters, options will be passed to the filter column during instantiation.
+    # @param [String] col_id Zero-based index indicating the AutoFilter column to which this filter information applies.
+    # @param [Symbol] filter_type A symbol representing one of the supported filter types.
+    # @param [Hash] options a hash of options to pass into the generated filter
+    # @return [FilterColumn]
+    def add_column(col_id, filter_type, options = {})
+      columns << FilterColumn.new(col_id, filter_type, options)
+      columns.last
+    end
+
+    # actually performs the filtering of rows who's cells do not 
+    # match the filter.  
+    def apply
+      first_cell, last_cell = range.split(':')
+      start_point = Axlsx::name_to_indices(first_cell)
+      end_point = Axlsx::name_to_indices(last_cell)
+      # The +1 is so we skip the header row with the filter drop downs
+      rows = worksheet.rows[(start_point.last+1)..end_point.last] || []
+
+      column_offset = start_point.first
+      columns.each do |column|
+        rows.each do |row|
+          next if row.hidden
+          column.apply(row, column_offset)
+        end
+      end
+    end
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str='')
+      return unless range
+      str << "<autoFilter ref='#{range}'>"
+      columns.each { |filter_column| filter_column.to_xml_string(str) }
+      str << "</autoFilter>"
+    end
+
+  end
+end