XlsxWriter API reference

234 public APIs from XlsxWriter (jmcnamara/XlsxWriter) — 57 classes, 7 functions, 170 methods. Signatures extracted by static analysis of the actual source.

Repository: jmcnamara/XlsxWriter

Kind	Count
Classes	57
Functions	7
Methods	170

API list

funcdev.performance.bench_excel_writers.time_openpyxl()

Run OpenPyXL in default mode.

funcdev.performance.bench_excel_writers.time_xlsxwriter()

Run XlsxWriter in default mode.

funcdev.performance.bench_excel_writers.time_xlwt()

Run xlwt in default mode.

funcdev.performance.perf3.time_openpyxl(optimised=False)

Run OpenPyXL in default mode.

classxlsxwriter.app.App

A class for writing the Excel XLSX App file.

classxlsxwriter.chart.Chart

A class for writing the Excel XLSX Chart file.

methodxlsxwriter.chart.Chart.add_series(options:Optional[Dict[str, Any]]=None) -> None

Add a data series to a chart.

methodxlsxwriter.chart.Chart.combine(chart:Optional['Chart']=None) -> None

Create a combination chart with a secondary chart.

methodxlsxwriter.chart.Chart.set_chartarea(options:Dict[str, Any]) -> None

Set the chart area options.

methodxlsxwriter.chart.Chart.set_drop_lines(options:Optional[Dict[str, Any]]=None) -> None

Set properties for the chart drop lines.

methodxlsxwriter.chart.Chart.set_high_low_lines(options:Optional[Dict[str, Any]]=None) -> None

Set properties for the chart high-low lines.

methodxlsxwriter.chart.Chart.set_legend(options:Dict[str, Any]) -> None

Set the chart legend options.

methodxlsxwriter.chart.Chart.set_plotarea(options:Dict[str, Any]) -> None

Set the chart plot area options.

methodxlsxwriter.chart.Chart.set_size(options:Optional[Dict[str, Any]]=None) -> None

Set size or scale of the chart.

methodxlsxwriter.chart.Chart.set_style(style_id:int=2) -> None

Set the chart style type.

methodxlsxwriter.chart.Chart.set_table(options:Optional[Dict[str, Any]]=None) -> None

Set properties for an axis data table.

methodxlsxwriter.chart.Chart.set_title(options:Optional[Dict[str, Any]]=None) -> None

Set the chart title options.

methodxlsxwriter.chart.Chart.set_up_down_bars(options:Optional[Dict[str, Any]]=None) -> None

Set properties for the chart up-down bars.

methodxlsxwriter.chart.Chart.set_x2_axis(options:Dict[str, Any]) -> None

Set the chart secondary X axis options.

methodxlsxwriter.chart.Chart.set_x_axis(options:Dict[str, Any]) -> None

Set the chart X axis options.

methodxlsxwriter.chart.Chart.set_y2_axis(options:Dict[str, Any]) -> None

Set the chart secondary Y axis options.

methodxlsxwriter.chart.Chart.set_y_axis(options:Dict[str, Any]) -> None

Set the chart Y axis options.

methodxlsxwriter.chart.Chart.show_blanks_as(option:str) -> None

Set the option for displaying blank data in a chart.

methodxlsxwriter.chart.Chart.show_hidden_data() -> None

Display data on charts from hidden rows or columns.

methodxlsxwriter.chart.Chart.show_na_as_empty_cell() -> None

Display ``#N/A`` on charts as blank/empty cells.

classxlsxwriter.chart_area.ChartArea

A class for writing the Excel XLSX Area charts.

classxlsxwriter.chart_bar.ChartBar

A class for writing the Excel XLSX Bar charts.

methodxlsxwriter.chart_bar.ChartBar.combine(chart:Optional[chart.Chart]=None) -> None

Create a combination chart with a secondary chart.

classxlsxwriter.chart_column.ChartColumn

A class for writing the Excel XLSX Column charts.

classxlsxwriter.chart_doughnut.ChartDoughnut

A class for writing the Excel XLSX Doughnut charts.

methodxlsxwriter.chart_doughnut.ChartDoughnut.set_hole_size(size:int) -> None

Set the Doughnut chart hole size.

classxlsxwriter.chart_line.ChartLine

A class for writing the Excel XLSX Line charts.

classxlsxwriter.chart_pie.ChartPie

A class for writing the Excel XLSX Pie charts.

methodxlsxwriter.chart_pie.ChartPie.set_rotation(rotation:int) -> None

Set the Pie/Doughnut chart rotation: the angle of the first slice.

classxlsxwriter.chart_radar.ChartRadar

A class for writing the Excel XLSX Radar charts.

classxlsxwriter.chart_scatter.ChartScatter

A class for writing the Excel XLSX Scatter charts.

methodxlsxwriter.chart_scatter.ChartScatter.combine(chart:Optional[chart.Chart]=None) -> None

Create a combination chart with a secondary chart.

classxlsxwriter.chart_stock.ChartStock

A class for writing the Excel XLSX Stock charts.

classxlsxwriter.chart_title.ChartTitle

A class to represent an Excel chart title.

methodxlsxwriter.chart_title.ChartTitle.has_formatting() -> bool

Check if the title has any formatting properties set.

methodxlsxwriter.chart_title.ChartTitle.has_formula() -> bool

Check if the title has a formula set.

methodxlsxwriter.chart_title.ChartTitle.has_name() -> bool

Check if the title has a text name set.

methodxlsxwriter.chart_title.ChartTitle.is_hidden() -> bool

Check if the title is explicitly hidden.

classxlsxwriter.chartsheet.Chartsheet

A class for writing the Excel XLSX Chartsheet file.

methodxlsxwriter.chartsheet.Chartsheet.protect(password:str='', options:Optional[Dict[str, Any]]=None) -> None

Set the password and protection options of the worksheet.

methodxlsxwriter.chartsheet.Chartsheet.set_chart(chart:Chart) -> Chart

Set the chart object for the chartsheet.

classxlsxwriter.color.Color

A class to represent an Excel color.

methodxlsxwriter.color.Color.automatic() -> 'Color'

Create an Excel color representing an "Automatic" color.

methodxlsxwriter.color.Color.rgb(color:str) -> 'Color'

Create a user-defined RGB color from a Html color string.

methodxlsxwriter.color.Color.rgb_integer(color:int) -> 'Color'

Create a user-defined RGB color from an integer value.

methodxlsxwriter.color.Color.theme(color:int, shade:int) -> 'Color'

Create a theme color.

classxlsxwriter.color.ColorTypes

Enum to represent different types of URLS.

classxlsxwriter.comments.CommentType

A class to represent a comment in an Excel worksheet.

methodxlsxwriter.comments.CommentType.set_offsets(row:int, col:int) -> None

Set the default start cell and offsets for the comment.

classxlsxwriter.comments.Comments

A class for writing the Excel XLSX Comments file.

classxlsxwriter.contenttypes.ContentTypes

A class for writing the Excel XLSX ContentTypes file.

classxlsxwriter.core.Core

A class for writing the Excel XLSX Core file.

classxlsxwriter.drawing.Drawing

A class for writing the Excel XLSX Drawing file.

classxlsxwriter.exceptions.DuplicateTableName

Worksheet table name already exists.

classxlsxwriter.exceptions.DuplicateWorksheetName

Worksheet name already exists.

classxlsxwriter.exceptions.EmptyChartSeries

Chart must contain at least one data series.

classxlsxwriter.exceptions.FileCreateError

IO error when creating xlsx file.

classxlsxwriter.exceptions.FileSizeError

Filesize would require ZIP64 extensions.

classxlsxwriter.exceptions.OverlappingRange

Worksheet merge range or table overlaps previous range.

classxlsxwriter.exceptions.ThemeFileError

Error when processing a custom theme file.

classxlsxwriter.exceptions.UndefinedImageSize

No size data found in image file.

classxlsxwriter.exceptions.UnsupportedImageFormat

Unsupported image file format.

classxlsxwriter.exceptions.XlsxFileError

Base exception for all file related errors.

classxlsxwriter.exceptions.XlsxInputError

Base exception for all input data related errors.

classxlsxwriter.exceptions.XlsxWriterException

Base exception for XlsxWriter.

classxlsxwriter.format.Format

A class for writing the Excel XLSX Format file.

methodxlsxwriter.format.Format.set_bg_color(bg_color:Union[str, Color]) -> None

Set the Format bg_color property.

methodxlsxwriter.format.Format.set_bold(bold:bool=True) -> None

Set the Format bold property.

methodxlsxwriter.format.Format.set_border(style:int=1) -> None

Set the Format bottom property.

methodxlsxwriter.format.Format.set_border_color(color:Union[str, Color]) -> None

Set the Format bottom property.

methodxlsxwriter.format.Format.set_bottom(bottom:int=1) -> None

Set the Format bottom property.

methodxlsxwriter.format.Format.set_bottom_color(bottom_color:Union[str, Color]) -> None

Set the Format bottom_color property.

methodxlsxwriter.format.Format.set_center_across(align_type:None=None) -> None

Set the Format center_across property.

methodxlsxwriter.format.Format.set_checkbox(checkbox:bool=True) -> None

Set the Format property to show a checkbox in a cell.

methodxlsxwriter.format.Format.set_color(font_color:Union[Color, str]) -> None

Deprecated: Use set_font_color() instead.

methodxlsxwriter.format.Format.set_color_indexed(color_index:Literal[0, 1]) -> None

Set the color index property.

methodxlsxwriter.format.Format.set_diag_border(diag_border:int=1) -> None

Set the Format diag_border property.

methodxlsxwriter.format.Format.set_diag_color(diag_color:Union[str, Color]) -> None

Set the Format diag_color property.

methodxlsxwriter.format.Format.set_diag_type(diag_type:Literal[1, 2, 3]=1) -> None

Set the Format diag_type property.

methodxlsxwriter.format.Format.set_dxf_index(dxf_index:int) -> None

Set the unique conditional format index property.

methodxlsxwriter.format.Format.set_fg_color(fg_color:Union[str, Color]) -> None

Set the Format fg_color property.

methodxlsxwriter.format.Format.set_font(font_name:str) -> None

Deprecated: Use set_font_name() instead.

methodxlsxwriter.format.Format.set_font_charset(font_charset:int) -> None

Set the font character set property.

methodxlsxwriter.format.Format.set_font_color(font_color:Union[str, Color]) -> None

Set the Format font_color property.

methodxlsxwriter.format.Format.set_font_condense(font_condense:int) -> None

Set the font condense property.

methodxlsxwriter.format.Format.set_font_extend(font_extend:int) -> None

Set the font extend property.

methodxlsxwriter.format.Format.set_font_family(font_family:int) -> None

Set the font family property.

methodxlsxwriter.format.Format.set_font_index(font_index:int) -> None

Set the unique font index property.

methodxlsxwriter.format.Format.set_font_only(font_only:bool=True) -> None

Set property to indicate that the format is used for fonts only.

methodxlsxwriter.format.Format.set_font_outline(font_outline:bool=True) -> None

Set the Format font_outline property.

methodxlsxwriter.format.Format.set_font_script(font_script:Literal[1, 2]=1) -> None

Set the Format font_script property.

methodxlsxwriter.format.Format.set_font_shadow(font_shadow:bool=True) -> None

Set the Format font_shadow property.

methodxlsxwriter.format.Format.set_font_size(font_size:int=11) -> None

Set the Format font_size property.

methodxlsxwriter.format.Format.set_font_strikeout(font_strikeout:bool=True) -> None

Set the Format font_strikeout property.

methodxlsxwriter.format.Format.set_has_fill(has_fill:bool=True) -> None

Set the property to indicate the format has a fill.

methodxlsxwriter.format.Format.set_has_font(has_font:bool=True) -> None

Set the property to indicate the format has a font.

methodxlsxwriter.format.Format.set_hidden(hidden:bool=True) -> None

Set the Format hidden property.

methodxlsxwriter.format.Format.set_hyperlink(hyperlink:bool=True) -> None

Set the properties for the hyperlink style.

methodxlsxwriter.format.Format.set_indent(indent:int=1) -> None

Set the Format indent property.

methodxlsxwriter.format.Format.set_italic(italic:bool=True) -> None

Set the Format italic property.

methodxlsxwriter.format.Format.set_left(left:int=1) -> None

Set the Format left property.

methodxlsxwriter.format.Format.set_left_color(left_color:Union[str, Color]) -> None

Set the Format left_color property.

methodxlsxwriter.format.Format.set_locked(locked:bool=True) -> None

Set the Format locked property.

methodxlsxwriter.format.Format.set_num_format(num_format:str) -> None

Set the Format num_format property such as '#,##0'.

methodxlsxwriter.format.Format.set_num_format_index(num_format_index:int) -> None

Set the number format_index property.

methodxlsxwriter.format.Format.set_pattern(pattern:int=1) -> None

Set the Format pattern property.

methodxlsxwriter.format.Format.set_quote_prefix(quote_prefix:bool=True) -> None

Set the Format quote prefix property.

methodxlsxwriter.format.Format.set_reading_order(direction:int=0) -> None

Set the reading order property.

methodxlsxwriter.format.Format.set_right(right:int=1) -> None

Set the Format right property.

methodxlsxwriter.format.Format.set_right_color(right_color:Union[str, Color]) -> None

Set the Format right_color property.

methodxlsxwriter.format.Format.set_rotation(rotation:int) -> None

Set the Format rotation property.

methodxlsxwriter.format.Format.set_shrink(shrink:bool=True) -> None

Set the Format shrink property.

methodxlsxwriter.format.Format.set_size(font_size:int) -> None

Deprecated: Use set_font_size() instead.

methodxlsxwriter.format.Format.set_text_h_align(text_h_align:int) -> None

Set the horizontal text alignment property.

methodxlsxwriter.format.Format.set_text_justlast(text_justlast:bool=True) -> None

Set the Format text_justlast property.

methodxlsxwriter.format.Format.set_text_v_align(text_v_align:int) -> None

Set the vertical text alignment property.

methodxlsxwriter.format.Format.set_text_wrap(text_wrap:bool=True) -> None

Set the Format text_wrap property.

methodxlsxwriter.format.Format.set_theme(theme:int) -> None

Set the theme property.

methodxlsxwriter.format.Format.set_theme_font_name(font_name) -> None

Set the Format font name use for the theme.

methodxlsxwriter.format.Format.set_top(top:int=1) -> None

Set the Format top property.

methodxlsxwriter.format.Format.set_top_color(top_color:Union[str, Color]) -> None

Set the Format top_color property.

methodxlsxwriter.format.Format.set_underline(underline:Literal[1, 2, 33, 34]=1) -> None

Set the Format underline property.

methodxlsxwriter.format.Format.set_xf_index(xf_index:int) -> None

Set the unique format index property.

classxlsxwriter.image.Image

A class to represent an image in an Excel worksheet.

methodxlsxwriter.image.Image.decorative() -> bool

Get whether the image is decorative.

methodxlsxwriter.image.Image.description() -> Union[str, None]

Get the description/alt-text of the image.

methodxlsxwriter.image.Image.height() -> float

Get the height of the image.

methodxlsxwriter.image.Image.image_type() -> str

Get the image type (e.g., 'PNG', 'JPEG').

methodxlsxwriter.image.Image.url() -> Union[Url, None]

Get the image url.

methodxlsxwriter.image.Image.width() -> float

Get the width of the image.

methodxlsxwriter.image.Image.x_dpi() -> float

Get the horizontal DPI of the image.

methodxlsxwriter.image.Image.y_dpi() -> float

Get the vertical DPI of the image.

classxlsxwriter.metadata.Metadata

A class for writing the Excel XLSX Metadata file.

classxlsxwriter.packager.Packager

A class for writing the Excel XLSX Packager file.

classxlsxwriter.relationships.Relationships

A class for writing the Excel XLSX Relationships file.

classxlsxwriter.rich_value.RichValue

A class for writing the Excel XLSX rdrichvalue.xml file.

classxlsxwriter.rich_value_rel.RichValueRel

A class for writing the Excel XLSX richValueRel.xml file.

classxlsxwriter.shape.Shape

A class for to represent Excel XLSX shape objects.

classxlsxwriter.sharedstrings.SharedStringTable

A class to track Excel shared strings between worksheets.

classxlsxwriter.sharedstrings.SharedStrings

A class for writing the Excel XLSX sharedStrings file.

classxlsxwriter.styles.Styles

A class for writing the Excel XLSX Styles file.

classxlsxwriter.table.Table

A class for writing the Excel XLSX Table file.

classxlsxwriter.theme.Theme

A class for writing the Excel XLSX Theme file.

classxlsxwriter.url.Url

A class to represent URLs in Excel.

methodxlsxwriter.url.Url.text() -> str

Get the alternative, user-friendly, text for the URL.

methodxlsxwriter.url.Url.tip() -> str

Get the screen tip for the URL.

classxlsxwriter.url.UrlTypes

Enum to represent different types of URLS.

funcxlsxwriter.utility.cell_autofit_width(string:str) -> int

Calculate the width required to auto-fit a string in a cell.

funcxlsxwriter.utility.xl_col_to_name(col:int, col_abs:bool=False) -> str

Convert a zero indexed column cell reference to a string.

funcxlsxwriter.utility.xl_rowcol_to_cell_fast(row:int, col:int) -> str

Optimized version of the xl_rowcol_to_cell function.

classxlsxwriter.vml.ButtonType

A class to represent a button in an Excel worksheet.

classxlsxwriter.vml.Vml

A class for writing the Excel XLSX Vml file.

methodxlsxwriter.workbook.EmbeddedImages.get_image_index(image:Image)

Get the index of an embedded image.

classxlsxwriter.workbook.Workbook

A class for writing the Excel XLSX Workbook file.

method

xlsxwriter.workbook.Workbook.add_chart(options:Dict[str, Any]) -> Optional[Union[ChartArea, ChartBar, ChartColumn, ChartDoughnut, ChartLine, ChartPie, ChartRadar, ChartScatter, ChartStock]]

Create a chart object.

methodxlsxwriter.workbook.Workbook.add_chartsheet(name:Optional[str]=None, chartsheet_class=None) -> Chartsheet

Add a new chartsheet to the Excel workbook.

methodxlsxwriter.workbook.Workbook.add_format(properties=None) -> Format

Add a new Format to the Excel Workbook.

methodxlsxwriter.workbook.Workbook.add_vba_project(vba_project:str, is_stream:bool=False) -> int

Add a vbaProject binary to the Excel workbook.

methodxlsxwriter.workbook.Workbook.add_worksheet(name:Optional[str]=None, worksheet_class=None) -> Worksheet

Add a new worksheet to the Excel workbook.

methodxlsxwriter.workbook.Workbook.close() -> None

Call finalization code and close file.

methodxlsxwriter.workbook.Workbook.define_name(name:str, formula:str) -> Literal[0, -1]

Create a defined name in the workbook.

methodxlsxwriter.workbook.Workbook.set_calc_mode(mode:Literal['manual', 'auto_except_tables', 'auto'], calc_id=None) -> None

Set the Excel calculation mode for the workbook.

methodxlsxwriter.workbook.Workbook.set_size(width:int, height:int) -> None

Set the size of a workbook window.

methodxlsxwriter.workbook.Workbook.set_vba_name(name:Optional[str]=None) -> None

Set the VBA name for the workbook.

methodxlsxwriter.workbook.Workbook.use_custom_theme(theme:Union[str, os.PathLike, IO[AnyStr]]) -> None

Add a custom theme to the Excel workbook.

methodxlsxwriter.workbook.Workbook.worksheets() -> List[Worksheet]

Return a list of the worksheet objects in the workbook.

classxlsxwriter.worksheet.CellMethod

Overloads to support cell notation.

classxlsxwriter.worksheet.ColumnInfo

Type to hold user modified properties for a column.

classxlsxwriter.worksheet.ColumnMethod

Overloads to support column range notation.

classxlsxwriter.worksheet.RangeMethod

Overloads to support range notation.

classxlsxwriter.worksheet.RowInfo

Type to hold user modified properties for a row.

classxlsxwriter.worksheet.Worksheet

A class for writing the Excel XLSX Worksheet file.

methodxlsxwriter.worksheet.Worksheet.activate() -> None

Set this worksheet as the active worksheet, i.e.

method

xlsxwriter.worksheet.Worksheet.add_sparkline(row:int, col:int, options:Optional[Dict[str, Any]]=None) -> Literal[0, -1, -2]

Add sparklines to the worksheet.

method

xlsxwriter.worksheet.Worksheet.add_table(first_row:int, first_col:int, last_row:int, last_col:int, options:Optional[Dict[str, Any]]=None) -> Literal[0, -1, -2, -3]

Add an Excel table to a worksheet.

methodxlsxwriter.worksheet.Worksheet.autofilter(first_row:int, first_col:int, last_row:int, last_col:int) -> None

Set the autofilter area in the worksheet.

methodxlsxwriter.worksheet.Worksheet.autofit(max_width:int=None) -> None

Simulate autofit based on the data, and datatypes in each column.

methodxlsxwriter.worksheet.Worksheet.center_horizontally() -> None

Center the page horizontally.

methodxlsxwriter.worksheet.Worksheet.center_vertically() -> None

Center the page vertically.

method

xlsxwriter.worksheet.Worksheet.conditional_format(first_row:int, first_col:int, last_row:int, last_col:int, options:Optional[Dict[str, Any]]=None) -> Literal[0, -1, -2]

Add a conditional format to a worksheet.

method

xlsxwriter.worksheet.Worksheet.data_validation(first_row:int, first_col:int, last_row:int, last_col:int, options:Optional[Dict[str, Any]]=None) -> Literal[0, -1, -2]

Add a data validation to a worksheet.

method

xlsxwriter.worksheet.Worksheet.embed_image(row:int, col:int, source:Union[str, BytesIO, Image], options:Optional[Dict[str, Any]]=None) -> Literal[0, -1]

Embed an image in a worksheet cell.

methodxlsxwriter.worksheet.Worksheet.filter_column(col:int, criteria:str) -> None

Set the column filter criteria.

methodxlsxwriter.worksheet.Worksheet.filter_column_list(col:int, filters:List[str]) -> None

Set the column filter criteria in Excel 2007 list style.

method

xlsxwriter.worksheet.Worksheet.freeze_panes(row:int, col:int, top_row:Optional[int]=None, left_col:Optional[int]=None, pane_type:int=0) -> None

Create worksheet panes and mark them as frozen.

methodxlsxwriter.worksheet.Worksheet.get_name()

Retrieve the worksheet name.

methodxlsxwriter.worksheet.Worksheet.hide() -> None

Hide the current worksheet.

methodxlsxwriter.worksheet.Worksheet.hide_zero() -> None

Hide zero values in worksheet cells.

methodxlsxwriter.worksheet.Worksheet.insert_button(row:int, col:int, options:Optional[Dict[str, Any]]=None) -> Literal[0, -1]

Insert a button form object into the worksheet.

method

xlsxwriter.worksheet.Worksheet.merge_range(first_row:int, first_col:int, last_row:int, last_col:int, data:Any, cell_format:Optional[Format]=None) -> int

Merge a range of cells.

method

xlsxwriter.worksheet.Worksheet.outline_settings(visible:bool=1, symbols_below:bool=1, symbols_right:bool=1, auto_style:bool=0) -> None

Control outline settings.

methodxlsxwriter.worksheet.Worksheet.print_across() -> None

Set the order in which pages are printed.

methodxlsxwriter.worksheet.Worksheet.print_area(first_row:int, first_col:int, last_row:int, last_col:int) -> Literal[0, -1]

Set the print area in the current worksheet.

methodxlsxwriter.worksheet.Worksheet.protect(password:str='', options:Optional[Dict[str, Any]]=None) -> None

Set the password and protection options of the worksheet.

methodxlsxwriter.worksheet.Worksheet.repeat_rows(first_row:int, last_row:Optional[int]=None) -> None

Set the rows to repeat at the top of each printed page.

methodxlsxwriter.worksheet.Worksheet.select() -> None

Set current worksheet as a selected worksheet, i.e.

method

xlsxwriter.worksheet.Worksheet.set_background(source:Union[str, BytesIO, Image], is_byte_stream:bool=False) -> Literal[0]

Set a background image for a worksheet.

methodxlsxwriter.worksheet.Worksheet.set_comments_author(author) -> None

Set the default author of the cell comments.

methodxlsxwriter.worksheet.Worksheet.set_default_row(height:Optional[float]=None, hide_unused_rows:bool=False) -> None

Set the default row properties.

methodxlsxwriter.worksheet.Worksheet.set_first_sheet() -> None

Set current worksheet as the first visible sheet.

methodxlsxwriter.worksheet.Worksheet.set_footer(footer:str='', options:Optional[Dict[str, Any]]=None, margin=None) -> None

Set the page footer caption and optional margin.

methodxlsxwriter.worksheet.Worksheet.set_h_pagebreaks(breaks:List[int]) -> None

Set the horizontal page breaks on a worksheet.

methodxlsxwriter.worksheet.Worksheet.set_header(header:str='', options:Optional[Dict[str, Any]]=None, margin=None) -> None

Set the page header caption and optional margin.

methodxlsxwriter.worksheet.Worksheet.set_landscape() -> None

Set the page orientation as landscape.

methodxlsxwriter.worksheet.Worksheet.set_margins(left:float=0.7, right:float=0.7, top:float=0.75, bottom:float=0.75) -> None

Set all the page margins in inches.

methodxlsxwriter.worksheet.Worksheet.set_page_view(view:Literal[0, 1, 2]=1) -> None

Set the page view mode.

methodxlsxwriter.worksheet.Worksheet.set_pagebreak_view() -> None

Set the page view mode.

methodxlsxwriter.worksheet.Worksheet.set_paper(paper_size:Union[Literal[1, 9], int]) -> None

Set the paper type.

methodxlsxwriter.worksheet.Worksheet.set_portrait() -> None

Set the page orientation as portrait.

methodxlsxwriter.worksheet.Worksheet.set_print_scale(scale:int) -> None

Set the scale factor for the printed page.

methodxlsxwriter.worksheet.Worksheet.set_start_page(start_page:int) -> None

Set the start page number when printing.

methodxlsxwriter.worksheet.Worksheet.set_tab_color(color:Union[str, Color]) -> None

Set the color of the worksheet tab.

methodxlsxwriter.worksheet.Worksheet.set_top_left_cell(row:int=0, col:int=0) -> None

Set the first visible cell at the top left of a worksheet.

methodxlsxwriter.worksheet.Worksheet.set_v_pagebreaks(breaks:List[int]) -> None

Set the horizontal page breaks on a worksheet.

methodxlsxwriter.worksheet.Worksheet.set_vba_name(name:Optional[str]=None) -> None

Set the VBA name for the worksheet.

methodxlsxwriter.worksheet.Worksheet.set_zoom(zoom:int=100) -> None

Set the worksheet zoom factor.

methodxlsxwriter.worksheet.Worksheet.set_zoom_to_fit() -> None

Set the worksheet zoom to selection/fit.

methodxlsxwriter.worksheet.Worksheet.show_comments() -> None

Make any comments in the worksheet visible.

method

xlsxwriter.worksheet.Worksheet.split_panes(x:float, y:float, top_row:Optional[int]=None, left_col:Optional[int]=None) -> None

Create worksheet panes and mark them as split.

method

xlsxwriter.worksheet.Worksheet.unprotect_range(cell_range:str, range_name:Optional[str]=None, password:Optional[str]=None) -> int

Unprotect ranges within a protected worksheet.

methodxlsxwriter.worksheet.Worksheet.very_hidden() -> None

Hide the current worksheet.

method

xlsxwriter.worksheet.Worksheet.write_column(row:int, col:int, data, cell_format:Optional[Format]=None) -> Union[Literal[0], Any]

Write a column of data starting from (row, col).

method

xlsxwriter.worksheet.Worksheet.write_comment(row:int, col:int, comment:str, options:Optional[Dict[str, Any]]=None) -> Literal[0, -1, -2]

Write a comment to a worksheet cell.

method

xlsxwriter.worksheet.Worksheet.write_datetime(row:int, col:int, date:datetime.datetime, cell_format:Optional[Format]=None) -> Literal[0, -1]

Write a date or time to a worksheet cell.

method

xlsxwriter.worksheet.Worksheet.write_formula(row:int, col:int, formula:str, cell_format:Optional[Format]=None, value=0) -> Literal[0, -1, -2]

Write a formula to a worksheet cell.

method

xlsxwriter.worksheet.Worksheet.write_number(row:int, col:int, number:Union[int, float, Fraction], cell_format:Optional[Format]=None) -> Literal[0, -1]

Write a number to a worksheet cell.

method

xlsxwriter.worksheet.Worksheet.write_row(row:int, col:int, data, cell_format:Optional[Format]=None) -> Union[Literal[0], Any]

Write a row of data starting from (row, col).

method

xlsxwriter.worksheet.Worksheet.write_string(row:int, col:int, string:str, cell_format:Optional[Format]=None) -> Literal[0, -1, -2]

Write a string to a worksheet cell.

classxlsxwriter.xmlwriter.XMLwriter

Simple XML writer class.

About this data

These signatures were extracted from the public source of jmcnamara/XlsxWriter using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries