piper.xl.WorkBook.add_sheet

WorkBook.add_sheet(dataframe=None, sheet_name='**auto', table=True, header=True, index=False, startrow=0, startcol=0, options=None, zoom=100, freeze_panes='A2', tab_color=None, theme='Medium 2', sql=None)[source]

Add DataFrame to WorkBook object

Parameters

  • dataframe – Pandas dataframe reference.

  • sheet_name – ‘**auto’. Auto generate sheetx where x is next available index.

  • table – True. Generate Excel Table format.

  • header – True. DataFrame contains header row.

  • index – False. When writing DataFrame in sheet, do not include index.

  • startrow – default 0 Upper left cell row to dump data frame.

  • startcol – default 0 Upper left cell column to dump data frame.

  • options – Default None. Pass additional Excel format options through this argument.

  • zoom – Default 100. Percentage sheet zoom

  • freeze_panes – Default ‘A2’. Freeze the first row using A1 notation

  • tab_color – Default None. Tab colour

  • theme – ‘Medium2’. Use ‘Medium2’ Excel table theme as default

Examples

file_name = 'outputs/test.xlsx'
wb = WorkBook(file_name, ts_prefix=False)

sheet_name = 'sheet_test1'
ws = wb.add_sheet(df_concat, sheet_name)

c = {'type': 'text', 'criteria': 'containing', 'value': 'A103',
     'format': 'accent2', 'range': 'A'}
wb.add_condition(ws, c)

ws = wb.add_sheet(df2, sheet_name='sheet2')

wb.close()
piper.xl.WorkBook.add_format piper.xl.WorkBook.add_sql_sheet