Description

class Axlsx::FilterColumn

The filterColumn collection identifies a particular column in the AutoFilter range and specifies filter information that has been applied to this column. If a column in the AutoFilter range has no criteria specified, then there is no corresponding filterColumn collection expressed for that column.

Note:

This class yeilds its filter object as that is where the vast majority of processing will be done

Creates a new FilterColumn object

Parameters:

  • col_id (Integer|Cell)

    The zero based index for the column to which this filter will be applied

  • filter_type (Symbol)

    The symbolized class name of the filter to apply to this column.

  • options (Hash) (defaults to: {})

    options for this object and the filter

  • [Boolean] (Hash)

    a customizable set of options

Yields:

  • (@filter)

Apply the filters for this column filtered.

Parameters:

  • row (Array)

    A row from a worksheet that needs to be

Zero-based index indicating the AutoFilter column to which this filter information applies.

The actual filter being dealt with here This could be any one of the allowed filter types

Flag indicating whether the AutoFilter button for this column is hidden.

Parameters:

  • hidden (Boolean)

    Flag indicating whether the AutoFilter button for this column is hidden.

Flag indicating whether the filter button is visible. When the cell containing the filter button is merged with another cell, the filter button can be hidden, and not drawn.

Flag indicating whether the AutoFilter button is show. This is undocumented in the spec, but exists in the schema file as an optional attribute.

Parameters:

  • show (Boolean)

    Show or hide the button

Serialize the object to xml

FilterColumn is referenced in 0 repositories