Paper Office
paper-xlsxAPI referenceworksheet.filters

AutoFilter

paper-xlsx 0.2.1 API reference

AutoFilter(ref=None, filterColumn=(), sortState=None, extLst=None)

Attributes

extLst

attributeextLst
= Typed(expected_type=ExtensionList, allow_none=True)

filterColumn

attributefilterColumn
= filterColumn

idx_base

attributeidx_base
= 0

namespace

attributenamespace
= None

ref

attributeref
= ref

sortState

attributesortState
= sortState

tagname

attributetagname
= 'autoFilter'

Functions

__iter__

func__iter__()

add_filter_column

funcadd_filter_column(col_id, vals, blank=False)

Add row filter for specified column.

paramcol_id

Zero-origin column id. 0 means first column.

paramvals

Value list to show.

paramblank
= False

Show rows that have blank cell if True (default=False)

add_sort_condition

funcadd_sort_condition(ref, descending=False)

Add sort condition for cpecified range of cells.

paramref

range of the cells (e.g. 'A2:A150')

paramdescending
= False

Descending sort order (default=False)

from_tree

funcfrom_tree(node)

Create object from XML

paramnode

to_tree

functo_tree(tagname=None, idx=None, namespace=None)
paramtagname
= None
paramidx
= None
paramnamespace
= None

On this page