python-pptx

https://python-pptx.readthedocs.io/en/latest/
Admin
python-pptx is a Python library for creating, reading, and updating PowerPoint (.pptx) files without...
Tokens:441,268
Snippets:3,564
Trust Score:8.3
Update:18 hours ago
Show doc for...
Tokens:
Raw
### Create a presentation from the default template

Source: https://python-pptx.readthedocs.io/en/latest/user/concepts.html

Construct a Presentation instance without a path to load the built-in default template. Useful for quick starts; most examples in the documentation use this.

```python
# start with default presentation
prs = Presentation()
```

--------------------------------

### Install behave

Source: https://python-pptx.readthedocs.io/en/latest/dev/development_practices.html

Install the behave package using pip for acceptance testing.

```bash
pip install behave
```

--------------------------------

### Install python-pptx with pip

Source: https://python-pptx.readthedocs.io/en/latest/user/install.html

Use this command to install python-pptx from PyPI. It will automatically handle dependencies like lxml, Pillow, and XlsxWriter.

```bash
pip install python-pptx
```

--------------------------------

### Insert a chart into a chart placeholder using insert_chart()

Source: https://python-pptx.readthedocs.io/en/latest/user/placeholders-using.html

This example assumes a starting presentation named 'having-chart-placeholder.pptx' with a chart placeholder having idx 10 on its second slide layout. It demonstrates creating chart data, inserting a pie chart into the placeholder, and accessing the inserted chart. Note that the return value is a PlaceholderGraphicFrame, not the chart itself, and the original placeholder reference becomes invalid after the call.

```python
>>> from pptx.chart.data import ChartData
>>> from pptx.enum.chart import XL_CHART_TYPE

>>> prs = Presentation('having-chart-placeholder.pptx')
>>> slide = prs.slides.add_slide(prs.slide_layouts[1])

>>> placeholder = slide.placeholders[10]  # idx key, not position
>>> placeholder.name
'Chart Placeholder 9'
>>> placeholder.placeholder_format.type
CHART (12)

>>> chart_data = ChartData()
>>> chart_data.categories = ['Yes', 'No']
>>> chart_data.add_series('Series 1', (42, 24))

>>> graphic_frame = placeholder.insert_chart(XL_CHART_TYPE.PIE, chart_data)
>>> chart = graphic_frame.chart
>>> chart.chart_type
PIE (5)
```

--------------------------------

### ActionSetting.part

Source: https://python-pptx.readthedocs.io/en/latest/api/action.html

Gets the package part containing this object.

```APIDOC
## ActionSetting.part

### Description
Gets the package part containing this object.

### Property
`part`

### Returns
- **Part** - The package part containing this object.
```

--------------------------------

### Hello World! example - create a title slide

Source: https://python-pptx.readthedocs.io/en/latest/user/quickstart.html

Creates a new presentation, adds a title slide using the first layout, and sets the title and subtitle text. Saves the presentation as 'test.pptx'.

```python
from pptx import Presentation

prs = Presentation()
title_slide_layout = prs.slide_layouts[0]
slide = prs.slides.add_slide(title_slide_layout)
title = slide.shapes.title
subtitle = slide.placeholders[1]

title.text = "Hello, World!"
subtitle.text = "python-pptx was here!"

prs.save('test.pptx')
```

--------------------------------

### VBA: BuildFreeform example

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/shp-freeform.html

Example of using the MS API to build a freeform shape in PowerPoint. It starts with BuildFreeform, adds nodes for curve and line segments, and converts to a shape. All points are in slide coordinates.

```vb
Set myDocument = ActivePresentation.Slides(1)

With myDocument.Shapes.BuildFreeform(msoEditingCorner, 360, 200)
    .AddNodes msoSegmentCurve, msoEditingCorner, _
        380, 230, 400, 250, 450, 300
    .AddNodes msoSegmentCurve, msoEditingAuto, 480, 200
    .AddNodes msoSegmentLine, msoEditingAuto, 480, 40
    .AddNodes msoSegmentLine, msoEditingAuto, 360, 200
    .ConvertToShape
End With
```

--------------------------------

### Load a presentation from a file

Source: https://python-pptx.readthedocs.io/en/latest/user/concepts.html

Construct a Presentation instance by passing the path to an existing .pptx file. This loads the presentation for manipulation.

```python
from pptx import Presentation

path = 'slide-deck-foo.pptx'
prs = Presentation(path)
```

--------------------------------

### Open and save using file-like objects

Source: https://python-pptx.readthedocs.io/en/latest/user/presentations.html

Shows how to open a presentation from a file-like object (e.g., open file or StringIO) and save to a target stream. Useful for network or database scenarios without direct file system access.

```python
f = open('foobar.pptx')
prs = Presentation(f)
f.close()

# or

with open('foobar.pptx') as f:
    source_stream = StringIO(f.read())
prs = Presentation(source_stream)
source_stream.close()
...
target_stream = StringIO()
prs.save(target_stream)
```

--------------------------------

### Get and set data label position

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Proposed protocol for reading and setting the position of data labels using the XL_DATA_LABEL_POSITION enumeration. The example shows the default OUTSIDE_END and setting to INSIDE_END.

```python
>>> data_labels = plot.data_labels
>>> data_labels.position
OUTSIDE_END (2)
>>> data_labels.position = XL_DATA_LABEL_POSITION.INSIDE_END
>>> data_labels.position
INSIDE_END (3)
```

--------------------------------

### Access a table cell and set its text

Source: https://python-pptx.readthedocs.io/en/latest/user/table.html

Shows how to get a reference to a cell using table.cell(row, col) and read/write its text via the _Cell.text property. The example sets the cell text to 'Unladen Swallow'.

```python
>>> cell = table.cell(0, 0)
>>> cell.text
''
>>> cell.text = 'Unladen Swallow'
```

--------------------------------

### AdjustmentCollection._initialized_adjustments method

Source: https://python-pptx.readthedocs.io/en/latest/_modules/pptx/shapes/autoshape.html

Initializes a list of Adjustment objects based on the contents of a CT_PresetGeometry2D element. Returns an empty list if prstGeom is None, otherwise uses AutoShapeType.default_adjustment_values to get defaults and updates them with actual values from the geometry's guide list.

```python
    def _initialized_adjustments(self, prstGeom: CT_PresetGeometry2D | None) -> list[Adjustment]:
        """Return an initialized list of adjustment values based on the contents of `prstGeom`."""
        if prstGeom is None:
            return []
        davs = AutoShapeType.default_adjustment_values(prstGeom.prst)
        adjustments = [Adjustment(name, def_val) for name, def_val in davs]
        self._update_adjustments_with_actuals(adjustments, prstGeom.gd_lst)
        return adjustments
```

--------------------------------

### Solid fill configuration

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/dml-fill.html

Demonstrates setting a solid fill, accessing fore_color, and adjusting transparency. Note that fore_color is read-only.

```python
>>> fill.solid()
>>> fill.type
1  # MSO_FILL.SOLID

>>> fill.fore_color = 'anything'
AttributeError: can't set attribute  # .fore_color is read-only
>>> fore_color = fill.fore_color
>>> assert(isinstance(fore_color, ColorFormat))

>>> fore_color.rgb = RGBColor(0x3F, 0x2c, 0x36)
>>> fore_color.theme_color = MSO_THEME_COLOR.ACCENT_1
>>> fore_color.brightness = -0.25

>>> fill.transparency
0.0
>>> fill.transparency = 0.25  # sets opacity to 75%

>>> sp.fill = None  # removes any fill, fill is inherited from theme
```

--------------------------------

### pptx.action.ActionSetting (class)

Source: https://python-pptx.readthedocs.io/en/latest/genindex.html

Class in pptx.action module.

```APIDOC
## pptx.action.ActionSetting (class)

### Description
Class in pptx.action module.

### Class
pptx.action.ActionSetting

### Module
pptx.action
```

--------------------------------

### Load presentation, access shape, add picture

Source: https://python-pptx.readthedocs.io/en/latest/api/presentation.html

Example showing how to load a presentation from a file path, get a reference to the first shape in the first slide, and add a picture shape to a slide. The variable 'sld' is used but not defined in the snippet; it is assumed to be a slide object.

```python
# load a presentation
prs = Presentation(path_to_pptx_file)

# get reference to first shape in first slide
sp = prs.slides[0].shapes[0]

# add a picture shape to slide
pic = sld.shapes.add_picture(path, x, y, cx, cy)
```

--------------------------------

### Pattern fill configuration

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/dml-fill.html

Shows how to apply a pattern fill and set its foreground and background colors.

```python
>>> fill = shape.fill
>>> fill.type
None
>>> fill.patterned()
>>> fill.type
2  # MSO_FILL.PATTERNED
>>> fill.fore_color.rgb = RGBColor(79, 129, 189)
>>> fill.back_color.rgb = RGBColor(239, 169, 6)
```

--------------------------------

### Add line segments to freeform shape

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/shp-freeform.html

Adds straight line segments to the freeform shape using add_line_segments(). The close parameter (True by default) connects the end point to the start point and creates a smooth perimeter; a non-closed contour gets line end caps and can have arrowheads.

```python
>>> vertices = ((100, 200), (200, 300), (300, 400))
>>> freeform_builder.add_line_segments(vertices, close=True)
```

--------------------------------

### Insert table into table placeholder with insert_table()

Source: https://python-pptx.readthedocs.io/en/latest/user/placeholders-using.html

Assumes a starting presentation 'having-table-placeholder.pptx' with a table placeholder (idx 10) on its second slide layout. The example adds a slide, accesses the placeholder by idx, and inserts a 2x2 table. After insertion, the original placeholder reference becomes invalid and raises AttributeError; use the returned PlaceholderGraphicFrame instead.

```python
>>> prs = Presentation('having-table-placeholder.pptx')
>>> slide = prs.slides.add_slide(prs.slide_layouts[1])
>>> placeholder = slide.placeholders[10]  # idx key, not position
>>> placeholder.name
'Table Placeholder 1'
>>> placeholder.placeholder_format.type
TABLE (12)
>>> graphic_frame = placeholder.insert_table(rows=2, cols=2)
>>> table = graphic_frame.table
>>> len(table.rows), len(table.columns)
(2, 2)
```

--------------------------------

### pptx.Presentation(pptx)

Source: https://python-pptx.readthedocs.io/en/latest/api/presentation.html

Opens a presentation file and returns a Presentation object. The pptx parameter can be a path to a .pptx file or a file-like object. If omitted, the built-in default presentation template is loaded.

```APIDOC
## pptx.Presentation(pptx)

### Description
Opens a presentation file and returns a Presentation object. The pptx parameter can be a path to a .pptx file or a file-like object. If omitted, the built-in default presentation template is loaded.

### Method
Function

### Signature
`pptx.Presentation(pptx: str | IO[bytes] | None = None) -> presentation.Presentation`

### Parameters
- **pptx** (str | IO[bytes] | None) - Optional - Path to a .pptx file (string) or a file-like object. If missing or None, the built-in default presentation template is loaded.

### Returns
- **Presentation** - The root object of the presentation graph, containing slides, shapes, etc.

### Example
```python
from pptx import Presentation

# Load a presentation from a file path
prs = Presentation(path_to_pptx_file)

# Load a presentation from a file-like object
with open('presentation.pptx', 'rb') as f:
    prs = Presentation(f)

# Load the default presentation template
prs = Presentation()
```
```

--------------------------------

### Solid fill API summary

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/dml-fill.html

Summarizes the key calls for configuring a solid fill, including setting RGB, theme color, brightness, transparency, and removing fill.

```python
fill.solid()
fill.fore_color.rgb = RGBColor(0x01, 0x23, 0x45)
fill.fore_color.theme_color = MSO_THEME_COLOR.ACCENT_1
fill.fore_color.brightness = 0.25
fill.transparency = 0.25
shape.fill = None
fill.background()  # is almost free once the rest is in place
```

--------------------------------

### Usage example for AddOLEObject

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/shp-ole-object.html

Example of calling AddOLEObject on a slide's shapes collection to insert an embedded Excel object. Note that this example uses the VBA-style method name AddOLEObject rather than the Python add_ole_object, and passes positional arguments.

```python
>>> shapes = slide.shapes
>>> embedded_xlsx_shape = shapes.AddOLEObject(left, top, width, height, file_name)
```

--------------------------------

### Image class initialization and loading methods

Source: https://python-pptx.readthedocs.io/en/latest/_modules/pptx/parts/image.html

Defines the Image class constructor and class methods from_blob and from_file for creating Image instances from binary data or file paths/file-like objects. from_file handles both string paths and file-like objects, resetting the file cursor if present.

```python
    def __init__(self, blob: bytes, filename: str | None):
        super(Image, self).__init__()
        self._blob = blob
        self._filename = filename

    @classmethod
    def from_blob(cls, blob: bytes, filename: str | None = None) -> Image:
        """Return a new |Image| object loaded from the image binary in `blob`."""
        return cls(blob, filename)

    @classmethod
    def from_file(cls, image_file: str | IO[bytes]) -> Image:
        """Return a new |Image| object loaded from `image_file`.

        `image_file` can be either a path (str) or a file-like object.
        """
        if isinstance(image_file, str):
            # treat image_file as a path
            with open(image_file, "rb") as f:
                blob = f.read()
            filename = os.path.basename(image_file)
        else:
            # assume image_file is a file-like object
            # ---reposition file cursor if it has one---
            if callable(getattr(image_file, "seek")):
                image_file.seek(0)
            blob = image_file.read()
            filename = None

        return cls.from_blob(blob, filename)
```

--------------------------------

### MSO_ANCHOR Usage Example

Source: https://python-pptx.readthedocs.io/en/latest/api/enum/MsoVerticalAnchor.html

Example showing how to set the vertical anchor of a table cell to bottom using the MSO_ANCHOR alias.

```APIDOC
## MSO_VERTICAL_ANCHOR Enumeration

### Description
Specifies the vertical alignment of text in a text frame. Used with the `.vertical_anchor` property of the `TextFrame` object. The `vertical_anchor` property can also have the value `None`, indicating no directly specified setting and inheritance from placeholder or theme. `None` may also be assigned to remove an explicitly specified setting.

### Alias
`MSO_ANCHOR`

### Values
- **TOP** - Aligns text to top of text frame and inherits its value from its layout placeholder or theme.
- **MIDDLE** - Centers text vertically.
- **BOTTOM** - Aligns text to bottom of text frame.
- **MIXED** - Return value only; indicates a combination of the other states.

### Example
```python
from pptx.enum.text import MSO_ANCHOR

cell = table.cell(row_idx=2, col_idx=3)
cell.vertical_anchor = MSO_ANCHOR.BOTTOM
```
```

--------------------------------

### Create and save a new presentation

Source: https://python-pptx.readthedocs.io/en/latest/user/presentations.html

Creates a new presentation from the built-in default template and saves it to 'test.pptx'. The default template is a PowerPoint file with no slides, based on the 'White' template with 4x3 aspect ratio.

```python
from pptx import Presentation

prs = Presentation()
prs.save('test.pptx')
```

--------------------------------

### Font color protocol example

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/txt-font-color.html

Shows the intended usage of Font.color, ColorFormat, and RGBColor. Includes assertions and assignments that demonstrate the API behavior, including an AttributeError for setting color to a string.

```python
>>> assert isinstance(font.color, ColorFormat)

>>> font.color = 'anything'
AttributeError: can't set attribute

>>> assert font.color.type in MSO_COLOR_TYPE_INDEX
wouldn't actually work, but conceptually true

>>> font.color.rgb = RGB(0x3F, 0x2c, 0x36)

>>> font.color.theme_color = MSO_THEME_COLOR.ACCENT_1

>>> font.color.brightness = -0.25
```

--------------------------------

### AdjustmentCollection._rewrite_guides method

Source: https://python-pptx.readthedocs.io/en/latest/_modules/pptx/shapes/autoshape.html

Writes a:gd elements to the XML, one for each adjustment value, overwriting any existing guide elements. Uses the current adjustment values to build the guides list.

```python
    def _rewrite_guides(self):
        """Write `a:gd` elements to the XML, one for each adjustment value.

        Any existing guide elements are overwritten.
        """
        guides = [(adj.name, adj.val) for adj in self._adjustments_]
        self._prstGeom.rewrite_guides(guides)
```

--------------------------------

### Set shape size and text before calling fit_text()

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/txt-fit-text.html

Shows the setup steps before calling TextFrame.fit_text(): setting shape dimensions and text, then checking the initial auto_size and word_wrap values.

```python
>>> shape.width, shape.height = cx, cy
>>> shape.text = 'Lorem ipsum .. post facto.'
>>> text_frame = shape.text_frame
>>> text_frame.auto_size, text_frame.word_wrap
(None, False)
```

--------------------------------

### XySeriesData.name

Source: https://python-pptx.readthedocs.io/en/latest/api/chart-data.html

Gets the name of this series.

```APIDOC
## XySeriesData.name

### Description
The name of this series, e.g. 'Series 1'. This name is used as the column heading for the y-values of this series and may also appear in the chart legend and perhaps other chart locations.

### Property
name

### Type
str
```

--------------------------------

### Add pictures using add_picture()

Source: https://python-pptx.readthedocs.io/en/latest/user/quickstart.html

Creates a presentation, adds a blank slide, and inserts a picture from 'monty-truth.png' at (1,1) inches. A second picture is added at (5,1) inches with a height of 5.5 inches. Saves the presentation as 'test.pptx'.

```python
from pptx import Presentation
from pptx.util import Inches

img_path = 'monty-truth.png'

prs = Presentation()
blank_slide_layout = prs.slide_layouts[6]
slide = prs.slides.add_slide(blank_slide_layout)

left = top = Inches(1)
pic = slide.shapes.add_picture(img_path, left, top)

left = Inches(5)
height = Inches(5.5)
pic = slide.shapes.add_picture(img_path, left, top, height=height)

prs.save('test.pptx')
```

--------------------------------

### Get and set space before/after

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/txt-para-spacing.html

Shows how to get and set the space before a paragraph using the space_before property. The default is 0, and setting it to Pt(6) returns a Length value of 76200 EMU, with .pt returning 6.0.

```python
>>> paragraph = TextFrame.add_paragraph()
>>> paragraph.space_before
0
>>> paragraph.space_before = Pt(6)
>>> paragraph.space_before
76200
>>> paragraph.space_before.pt
6.0
```

--------------------------------

### Add text using .text shortcut and equivalent run-based approach

Source: https://python-pptx.readthedocs.io/en/latest/user/text.html

These two snippets produce the same result. The first uses the .text shortcut on a shape. The second shows the equivalent manual process: clear the text frame, get the first paragraph, add a run, and set its text.

```python
shape.text = 'foobar'
```

```python
# is equivalent to ...

text_frame = shape.text_frame
text_frame.clear()
p = text_frame.paragraphs[0]
run = p.add_run()
run.text = 'foobar'
```

--------------------------------

### ChartPlaceholder.text

Source: https://python-pptx.readthedocs.io/en/latest/api/placeholders.html

Gets the text content of the placeholder.

```APIDOC
## ChartPlaceholder.text

### Description
Text content of the placeholder.

### Returns
- **str** - The text.
```

--------------------------------

### Add a straight connector using MSO_CONNECTOR.STRAIGHT

Source: https://python-pptx.readthedocs.io/en/latest/api/enum/MsoConnectorType.html

Shows how to add a straight connector to the first slide of a presentation. The example imports MSO_CONNECTOR from pptx.enum.shapes and Cm from pptx.util, then adds a connector with begin and end points in centimeters. The assertion verifies the connector's left position is 2 cm.

```python
from pptx.enum.shapes import MSO_CONNECTOR
from pptx.util import Cm

shapes = prs.slides[0].shapes
connector = shapes.add_connector(
    MSO_CONNECTOR.STRAIGHT, Cm(2), Cm(2), Cm(10), Cm(10)
)
assert connector.left.cm == 2
```

--------------------------------

### Text

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Gets or sets the text for the specified object.

```APIDOC
## Text

### Description
Returns or sets the text for the specified object. Read/write String.

### Property
Text

### Type
String

### Access
Read/write
```

--------------------------------

### add_table() example

Source: https://python-pptx.readthedocs.io/en/latest/user/quickstart.html

Creates a presentation, adds a slide with the title-only layout, and inserts a 2x2 table. Sets column widths, writes headings and body cells, then saves the presentation as 'test.pptx'.

```python
from pptx import Presentation
from pptx.util import Inches

prs = Presentation()
title_only_slide_layout = prs.slide_layouts[5]
slide = prs.slides.add_slide(title_only_slide_layout)
shapes = slide.shapes

shapes.title.text = 'Adding a Table'

rows = cols = 2
left = top = Inches(2.0)
width = Inches(6.0)
height = Inches(0.8)

table = shapes.add_table(rows, cols, left, top, width, height).table

# set column widths
table.columns[0].width = Inches(2.0)
table.columns[1].width = Inches(4.0)

# write column headings
table.cell(0, 0).text = 'Foo'
table.cell(0, 1).text = 'Bar'

# write body cells
table.cell(1, 0).text = 'Baz'
table.cell(1, 1).text = 'Qux'

prs.save('test.pptx')
```

--------------------------------

### Shadow

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Gets or sets whether the object has a shadow.

```APIDOC
## Shadow

### Description
Returns or sets a value that indicates whether the object has a shadow. Read/write Boolean.

### Property
Shadow

### Type
Boolean

### Access
Read/write
```

--------------------------------

### Run acceptance tests with behave

Source: https://python-pptx.readthedocs.io/en/latest/dev/runtests.html

Executes the acceptance test suite using behave. The output shows a feature and scenario for adding a text box, followed by a summary of 13 features, 30 scenarios, and 120 steps all passing.

```bash
$ behave
Feature: Add a text box to a slide
  In order to accommodate a requirement for free-form text on a slide
  As a presentation developer
  I need the ability to place a text box on a slide

  Scenario: Add a text box to a slide
    Given I have a reference to a blank slide
    When I add a text box to the slide's shape collection
    And I save the presentation
    Then the text box appears in the slide

# ... more output ...

13 features passed, 0 failed, 0 skipped
30 scenarios passed, 0 failed, 0 skipped
120 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m1.3s
```

--------------------------------

### Position

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Gets or sets the position of the data label.

```APIDOC
## Position

### Description
Returns or sets the position of the data label. Read/write XlDataLabelPosition.

### Property
Position

### Type
XlDataLabelPosition

### Access
Read/write
```

--------------------------------

### Orientation

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Gets or sets the text orientation in degrees.

```APIDOC
## Orientation

### Description
Returns or sets the text orientation. Read/write Long in range -90 to 90 (degrees).

### Property
Orientation

### Type
Long

### Range
-90 to 90 degrees

### Access
Read/write
```

--------------------------------

### Connector Creation Protocol

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/shp-connector.html

Demonstrates how to create a connector using the add_connector method in python-pptx.

```APIDOC
## Connector Creation Protocol

### Description
Create a new connector shape using the add_connector method.

### Method
add_connector

### Parameters
- **connector_type** (MSO_CONNECTOR) - The type of connector (e.g., MSO_CONNECTOR.STRAIGHT).
- **start_x** (int) - The x-coordinate of the start point in EMU.
- **start_y** (int) - The y-coordinate of the start point in EMU.
- **end_x** (int) - The x-coordinate of the end point in EMU.
- **end_y** (int) - The y-coordinate of the end point in EMU.

### Example
```
>>> line = shapes.add_connector(
...     MSO_CONNECTOR.STRAIGHT, start_x, start_y, end_x, end_y
... )
```
```

--------------------------------

### NumberFormat

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Gets or sets the format code for the object.

```APIDOC
## NumberFormat

### Description
Returns or sets the format code for the object. Read/write String.

### Property
NumberFormat

### Type
String

### Access
Read/write
```

--------------------------------

### Caption

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/cht-data-labels.html

Gets or sets the data label text.

```APIDOC
## Caption

### Description
Returns or sets the data label text. Read/write String.

### Property
Caption

### Type
String

### Access
Read/write
```

--------------------------------

### Candidate Protocol: Setting and Reading font.underline

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/txt-font-underline.html

Shows the interactive Python session for setting and reading the underline property of a font. Demonstrates that setting to True yields SINGLE_LINE (2), setting to MSO_UNDERLINE.WAVY_DOUBLE_LINE yields WAVY_DOUBLE_LINE (17), and setting to False resets to False.

```python
>>> font.underline
False
>>> font.underline = True
>>> font.underline
SINGLE_LINE (2)
>>> font.underline = MSO_UNDERLINE.WAVY_DOUBLE_LINE
>>> font.underline
WAVY_DOUBLE_LINE (17)
>>> font.underline = False
>>> font.underline
False
```

--------------------------------

### Add a connector

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/shp-connector.html

Shows how to add a straight connector using the add_connector method with MSO_CONNECTOR.STRAIGHT and start/end coordinates.

```python
>>> line = shapes.add_connector(
...     MSO_CONNECTOR.STRAIGHT, start_x, start_y, end_x, end_y
... )
```

--------------------------------

### NotesSlide.part

Source: https://python-pptx.readthedocs.io/en/latest/api/slides.html

Gets the package part containing this object.

```APIDOC
## NotesSlide.part

### Description
Gets the package part containing this object.

### Property
`part`

### Returns
- **XmlPart** - The package part containing this object.
```

--------------------------------

### Inspect connector properties

Source: https://python-pptx.readthedocs.io/en/latest/dev/analysis/shp-connector.html

Shows how to inspect a connector's properties: is_connector, type, start_x, end_y, and adjustments. The output shows expected values for a connector.

```python
>>> connector.is_connector
True
>>> connector.type
MSO_SHAPE_TYPE.LINE
>>> connector.start_x
914400
>>> connector.end_y
914400
>>> connector.adjustments
<pptx.shapes.shared.Adjustments instance at 0x123456789>
```
Tokens:
Raw