Reference
Classes
Main classes provided by the package
- Workbook
-
Workbook is the container for all other parts of the document.
- cell.Cell
-
Describes cell associated properties.
- cell.MergedCell
-
Describes the properties of a cell in a merged cell and helps to
- cell.ReadOnlyCell
- chart.AreaChart
- chart.AreaChart3D
- chart.BarChart
- chart.BarChart3D
- chart.BubbleChart
- chart.DoughnutChart
- chart.LineChart
- chart.LineChart3D
- chart.PieChart
- chart.PieChart3D
- chart.ProjectedPieChart
-
From the spec 21.2.2.126
- chart.RadarChart
- chart.Reference
-
Normalise cell range references
- chart.ScatterChart
- chart.StockChart
- chart.SurfaceChart
- chart.SurfaceChart3D
- chartsheet.Chartsheet
- comments.Comment
- drawing.Drawing
-
a drawing object - eg container for shapes or charts
- formatting.Rule
- formula.Tokenizer
-
A tokenizer for Excel worksheet formulae.
- styles.Alignment
-
Alignment options for use in styles.
- styles.Border
-
Border positioning for use in styles.
- styles.Color
-
Named colors for use in styles.
- styles.Fill
-
Base class
- styles.Font
-
Font options used in styles.
- styles.GradientFill
-
Fill areas with gradient
- styles.NamedStyle
-
Named and editable styles
- styles.NumberFormatDescriptor
- styles.PatternFill
-
Area fill patterns for use in styles.
- styles.Protection
-
Protection options for use in styles.
- styles.Side
-
Border options for use in styles.
- typed_serialisable.ElementList
- typed_serialisable.Extension
- typed_serialisable.ExtensionList
- typed_serialisable.MetaSerialisable
- typed_serialisable.NestedValInt
-
Nested integer element with a val attribute.
- typed_serialisable.Serialisable
Dataclasses
Dataclass definitions
Workbook Methods
Methods for the Workbook class
- Workbook.create_sheet()
-
Create a worksheet (at an optional index).
- Workbook.move_sheet()
-
Move a sheet or sheetname
- Workbook.remove()
-
Remove
worksheetfrom this workbook. - Workbook.remove_sheet()
-
Remove
worksheetfrom this workbook. - Workbook.create_chartsheet()
- Workbook.get_sheet_by_name()
-
Returns a worksheet by its name.
- Workbook.__contains__()
- Workbook.index()
-
Return the index of a worksheet.
- Workbook.get_index()
-
Return the index of the worksheet.
- Workbook.__getitem__()
-
Returns a worksheet by its name.
- Workbook.__delitem__()
- Workbook.__iter__()
- Workbook.get_sheet_names()
- Workbook.create_named_range()
-
Create a new named_range on a worksheet
- Workbook.add_named_style()
-
Add a named style
- Workbook.save()
-
Save the current workbook under the given
filename. - Workbook.materialize_pending_style_components()
-
Register shared style parts for styleable from deferred assignments.
- Workbook.copy_worksheet()
-
Copy an existing worksheet in the current workbook
- Workbook.close()
-
Close workbook file if open. Only affects read-only, indexed, and
Functions
Utility functions
- cell.WriteOnlyCell()
- chart.Series()
-
Convenience Factory for creating chart data series.
- compat.deprecated
-
Indicate that a class, function or overload is deprecated.
- compat.safe_string()
-
Safely and consistently format numeric values
- load_workbook()
-
Open the given filename and return the workbook
- open()
-
Open the given filename and return the workbook
- styles.is_builtin()
- styles.is_date_format()
- styles.is_timedelta_format()
- typed_serialisable.AliasField()
- typed_serialisable.explicit_none_element()
-
Serialise explicit none values required by some chart elements.
- xml.defusedxml_available()
- xml.defusedxml_env_set()
- xml.lxml_available()
- xml.lxml_env_set()
Constants
Module-level constants and data
Other
Additional exports