python-pptx の API リファレンス
python-pptx (scanny/python-pptx) の公開 API 400 件 —— クラス 256、関数 6、メソッド 138。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: scanny/python-pptx
| 種別 | 件数 |
|---|---|
| クラス | 256 |
| 関数 | 6 |
| メソッド | 138 |
API 一覧
class
src.pptx.action.ActionSettingProperties specifying how a shape or run reacts to mouse actions.
class
src.pptx.action.HyperlinkRepresents a hyperlink action on a shape or text run.
method
src.pptx.action.Hyperlink.address() -> str | NoneRead/write.
class
src.pptx.chart.axis.AxisTitleProvides properties for manipulating axis title.
class
src.pptx.chart.axis.CategoryAxisA category axis of a chart.
class
src.pptx.chart.axis.DateAxisA category axis with dates as its category labels.
method
src.pptx.chart.axis.TickLabels.number_format()Read/write string (e.g.
class
src.pptx.chart.axis.ValueAxisAn axis having continuous (as opposed to discrete) values.
class
src.pptx.chart.chart.ChartA chart object.
method
src.pptx.chart.chart.Chart.category_axis()The category axis of this chart.
method
src.pptx.chart.chart.Chart.plots()The sequence of plots in this chart.
class
src.pptx.chart.chart.ChartTitleProvides properties for manipulating a chart title.
class
src.pptx.chart.data.BubbleDataPointA data point in a bubble chart series.
class
src.pptx.chart.data.BubbleSeriesDataThe data specific to a particular Bubble chart series.
class
src.pptx.chart.data.CategoryDataPointA data point in a category chart series.
class
src.pptx.chart.data.CategorySeriesDataThe data specific to a particular category chart series.
class
src.pptx.chart.data.XyDataPointA data point in an XY chart series.
method
src.pptx.chart.data.XyDataPoint.x()The X value for this XY data point.
method
src.pptx.chart.data.XyDataPoint.y()The Y value for this XY data point.
class
src.pptx.chart.data.XySeriesDataThe data specific to a particular XY chart series.
class
src.pptx.chart.datalabel.DataLabelThe data label associated with an individual data point.
class
src.pptx.chart.legend.LegendRepresents the legend in a chart.
class
src.pptx.chart.plot.Area3DPlotA 3-dimensional area plot.
class
src.pptx.chart.plot.AreaPlotAn area plot.
class
src.pptx.chart.plot.BarPlotA bar chart-style plot.
class
src.pptx.chart.plot.BubblePlotA bubble chart plot.
class
src.pptx.chart.plot.DoughnutPlotAn doughnut plot.
class
src.pptx.chart.plot.LinePlotA line chart-style plot.
class
src.pptx.chart.plot.PiePlotA pie chart-style plot.
class
src.pptx.chart.plot.RadarPlotA radar-style plot.
class
src.pptx.chart.plot.XyPlotAn XY (scatter) plot.
class
src.pptx.chart.series.AreaSeriesA data point series belonging to an area plot.
class
src.pptx.chart.series.BarSeriesA data point series belonging to a bar plot.
class
src.pptx.chart.series.BubbleSeriesA data point series belonging to a bubble plot.
class
src.pptx.chart.series.LineSeriesA data point series belonging to a line plot.
class
src.pptx.chart.series.PieSeriesA data point series belonging to a pie plot.
class
src.pptx.chart.series.RadarSeriesA data point series belonging to a radar plot.
class
src.pptx.chart.series.SeriesCollectionA sequence of |Series| objects.
class
src.pptx.chart.series.XySeriesA data point series belonging to an XY (scatter) plot.
method
src.pptx.chart.series.XySeries.values()Read-only.
class
src.pptx.dml.color.RGBColorImmutable value object defining a particular RGB color.
class
src.pptx.dml.effect.ShadowFormatProvides access to shadow effect on a shape.
class
src.pptx.dml.fill.FillFormatProvides access to the current fill properties.
method
src.pptx.dml.fill.FillFormat.background()Sets the fill type to noFill, i.e.
method
src.pptx.dml.fill.FillFormat.gradient()Sets the fill type to gradient.
method
src.pptx.dml.fill.FillFormat.patterned()Selects the pattern fill type.
method
src.pptx.dml.fill.FillFormat.solid()Sets the fill type to solid, i.e.
method
src.pptx.dml.fill.FillFormat.type() -> MSO_FILL_TYPEThe type of this fill, e.g.
method
src.pptx.dml.line.LineFormat.dash_style()Return value indicating line style.
class
src.pptx.enum.base.BaseEnumBase class for Enums that do not map XML attr values.
class
src.pptx.enum.base.BaseXmlEnumBase class for Enums that also map XML attr values.
method
src.pptx.enum.base.BaseXmlEnum.to_xml(value:int | _T) -> strXML value of this enum member, generally an XML attribute value.
class
src.pptx.enum.chart.XL_CATEGORY_TYPESpecifies the type of the category axis.
class
src.pptx.enum.chart.XL_CHART_TYPESpecifies the type of a chart.
class
src.pptx.enum.chart.XL_DATA_LABEL_POSITIONSpecifies where the data label is positioned.
class
src.pptx.enum.chart.XL_LEGEND_POSITIONSpecifies the position of the legend on a chart.
class
src.pptx.enum.chart.XL_TICK_MARKSpecifies a type of axis tick for a chart.
class
src.pptx.enum.dml.MSO_FILL_TYPESpecifies the type of bitmap used for the fill of a shape.
class
src.pptx.enum.dml.MSO_LINE_DASH_STYLESpecifies the dash style for a line.
class
src.pptx.enum.dml.MSO_PATTERN_TYPESpecifies the fill pattern used in a shape.
class
src.pptx.enum.lang.MSO_LANGUAGE_IDSpecifies the language identifier.
class
src.pptx.enum.shapes.MSO_AUTO_SHAPE_TYPESpecifies a type of AutoShape, e.g.
class
src.pptx.enum.shapes.MSO_CONNECTOR_TYPESpecifies a type of connector.
class
src.pptx.enum.shapes.PP_MEDIA_TYPEIndicates the OLE media type.
class
src.pptx.enum.shapes.PP_PLACEHOLDER_TYPESpecifies one of the 18 distinct types of placeholder.
class
src.pptx.enum.shapes.PROG_IDOne-off Enum-like object for progId values.
class
src.pptx.enum.text.MSO_AUTO_SIZEDetermines the type of automatic sizing allowed.
class
src.pptx.enum.text.MSO_TEXT_UNDERLINE_TYPEIndicates the type of underline for text.
class
src.pptx.enum.text.MSO_VERTICAL_ANCHORSpecifies the vertical alignment of text in a text frame.
class
src.pptx.exc.PackageNotFoundErrorRaised when a package cannot be found at the specified path.
class
src.pptx.exc.PythonPptxErrorGeneric error class.
class
src.pptx.media.VideoImmutable value object representing a video such as MP4.
method
src.pptx.media.Video.blob()The bytestream of the media "file".
method
src.pptx.media.Video.content_type()MIME-type of this media, e.g.
method
src.pptx.media.Video.filename() -> strReturn a filename.ext string appropriate to this video.
class
src.pptx.opc.constants.NAMESPACEConstant values for OPC XML namespaces
class
src.pptx.opc.constants.RELATIONSHIP_TARGET_MODEOpen XML relationship target modes
class
src.pptx.opc.oxml.CT_Default`<Default>` element.
class
src.pptx.opc.oxml.CT_Override`<Override>` element.
class
src.pptx.opc.oxml.CT_Relationship`<Relationship>` element.
method
src.pptx.opc.oxml.CT_Relationship.new(rId:str, reltype:str, target_ref:str, target_mode:str=RTM.INTERNAL) -> CT_RelationshipReturn a new `<Relationship>` element.
class
src.pptx.opc.oxml.CT_Relationships`<Relationships>` element, the root element in a .rels file.
method
src.pptx.opc.oxml.CT_Relationships.new() -> CT_RelationshipsReturn a new `<Relationships>` element.
class
src.pptx.opc.oxml.CT_Types`<Types>` element.
method
src.pptx.opc.oxml.CT_Types.new() -> CT_TypesReturn a new `<Types>` element.
class
src.pptx.opc.package.OpcPackageMain API class for |python-opc|.
method
src.pptx.opc.package.OpcPackage.drop_rel(rId:str) -> NoneRemove relationship identified by `rId`.
method
src.pptx.opc.package.OpcPackage.iter_parts() -> Iterator[Part]Generate exactly one reference to each part in the package.
method
src.pptx.opc.package.OpcPackage.next_partname(tmpl:str) -> PackURIReturn |PackURI| next available partname matching `tmpl`.
method
src.pptx.opc.package.OpcPackage.open(pkg_file:str | IO[bytes]) -> SelfReturn an |OpcPackage| instance loaded with the contents of `pkg_file`.
method
src.pptx.opc.package.OpcPackage.save(pkg_file:str | IO[bytes]) -> NoneSave this package to `pkg_file`.
class
src.pptx.opc.package.PartBase class for package parts.
method
src.pptx.opc.package.Part.blob() -> bytesContents of this package part as a sequence of bytes.
method
src.pptx.opc.package.Part.content_type() -> strContent-type (MIME-type) of this part.
method
src.pptx.opc.package.Part.load(partname:PackURI, content_type:str, package:Package, blob:bytes) -> SelfReturn `cls` instance loaded from arguments.
method
src.pptx.opc.package.Part.load_rels_from_xml(xml_rels:CT_Relationships, parts:dict[PackURI, Part]) -> Noneload _Relationships for this part from `xml_rels`.
method
src.pptx.opc.package.Part.package() -> PackagePackage this part belongs to.
method
src.pptx.opc.package.Part.partname() -> PackURI|PackURI| partname for this part, e.g.
class
src.pptx.opc.package.PartFactoryConstructs a registered subtype of |Part|.
class
src.pptx.opc.packuri.PackURIProxy for a pack URI (partname).
method
src.pptx.opc.packuri.PackURI.ext() -> strThe extension portion of this pack URI.
method
src.pptx.opc.packuri.PackURI.filename() -> strThe "filename" portion of this pack URI.
method
src.pptx.opc.packuri.PackURI.idx() -> int | NoneOptional int partname index.
method
src.pptx.opc.packuri.PackURI.membername() -> strThe pack URI with the leading slash stripped off.
class
src.pptx.opc.serialized.PackageWriterWrites a zip-format OPC package to `pkg_file`.
method
src.pptx.opc.serialized.PackageWriter.write(pkg_file:str | IO[bytes], pkg_rels:_Relationships, parts:Sequence[Part]) -> NoneWrite a physical package (.pptx file) to `pkg_file`.
class
src.pptx.oxml.action.CT_HyperlinkCustom element class for <a:hlinkClick> elements.
method
src.pptx.oxml.action.CT_Hyperlink.action_fields() -> dict[str, str]Query portion of the `ppaction://` URL as dict.
class
src.pptx.oxml.chart.axis.CT_CatAx`c:catAx` element, defining a category axis.
class
src.pptx.oxml.chart.axis.CT_ChartLinesUsed for `c:majorGridlines` and `c:minorGridlines`.
class
src.pptx.oxml.chart.axis.CT_DateAx`c:dateAx` element, defining a date (category) axis.
class
src.pptx.oxml.chart.axis.CT_LblOffset`c:lblOffset` custom element class.
class
src.pptx.oxml.chart.axis.CT_Scaling`c:scaling` element.
class
src.pptx.oxml.chart.axis.CT_TickLblPos`c:tickLblPos` element.
class
src.pptx.oxml.chart.axis.CT_TickMarkUsed for `c:minorTickMark` and `c:majorTickMark`.
class
src.pptx.oxml.chart.axis.CT_ValAx`c:valAx` element, defining a value axis.
class
src.pptx.oxml.chart.chart.CT_Chart`c:chart` custom element class.
method
src.pptx.oxml.chart.chart.CT_Chart.new_chart(rId:str) -> CT_ChartReturn a new `c:chart` element.
class
src.pptx.oxml.chart.chart.CT_ChartSpace`c:chartSpace` root element of a chart part.
class
src.pptx.oxml.chart.chart.CT_PlotArea``<c:plotArea>`` element.
class
src.pptx.oxml.chart.chart.CT_Style``<c:style>`` element; defines the chart style.
class
src.pptx.oxml.chart.legend.CT_Legend``<c:legend>`` custom element class
class
src.pptx.oxml.chart.plot.BaseChartElementBase class for barChart, lineChart, and other plot elements.
class
src.pptx.oxml.chart.plot.CT_Area3DChart``<c:area3DChart>`` element.
class
src.pptx.oxml.chart.plot.CT_AreaChart``<c:areaChart>`` element.
class
src.pptx.oxml.chart.plot.CT_BarChart``<c:barChart>`` element.
class
src.pptx.oxml.chart.plot.CT_BubbleChart``<c:bubbleChart>`` custom element class
class
src.pptx.oxml.chart.plot.CT_BubbleScale``<c:bubbleScale>`` custom element class
class
src.pptx.oxml.chart.plot.CT_DoughnutChart``<c:doughnutChart>`` element.
class
src.pptx.oxml.chart.plot.CT_LineChart``<c:lineChart>`` custom element class
class
src.pptx.oxml.chart.plot.CT_PieChart``<c:pieChart>`` custom element class
class
src.pptx.oxml.chart.plot.CT_RadarChart``<c:radarChart>`` custom element class
class
src.pptx.oxml.chart.plot.CT_ScatterChart``<c:scatterChart>`` custom element class
class
src.pptx.oxml.chart.series.CT_SeriesComposite``<c:ser>`` custom element class.
class
src.pptx.oxml.chart.shared.CT_Boolean_ExplicitAlways spells out the `val` attribute, e.g.
class
src.pptx.oxml.chart.shared.CT_DoubleUsed for floating point values.
class
src.pptx.oxml.chart.shared.CT_Layout``<c:layout>`` custom element class
class
src.pptx.oxml.chart.shared.CT_ManualLayout``<c:manualLayout>`` custom element class
class
src.pptx.oxml.chart.shared.CT_Title`c:title` custom element class.
class
src.pptx.oxml.chart.shared.CT_UnsignedInt``<c:idx>`` element and others.
class
src.pptx.oxml.coreprops.CT_CoreProperties`cp:coreProperties` element.
method
src.pptx.oxml.coreprops.CT_CoreProperties.new_coreProperties() -> CT_CorePropertiesReturn a new `cp:coreProperties` element
method
src.pptx.oxml.coreprops.CT_CoreProperties.revision_number() -> intInteger value of revision property.
class
src.pptx.oxml.dml.color.CT_HslColorCustom element class for <a:hslClr> element.
class
src.pptx.oxml.dml.color.CT_PresetColorCustom element class for <a:prstClr> element.
class
src.pptx.oxml.dml.color.CT_SRgbColorCustom element class for <a:srgbClr> element.
class
src.pptx.oxml.dml.color.CT_ScRgbColorCustom element class for <a:scrgbClr> element.
class
src.pptx.oxml.dml.color.CT_SchemeColorCustom element class for <a:schemeClr> element.
class
src.pptx.oxml.dml.color.CT_SystemColorCustom element class for <a:sysClr> element.
class
src.pptx.oxml.dml.fill.CT_Blip<a:blip> element
class
src.pptx.oxml.dml.fill.CT_BlipFillPropertiesCustom element class for <a:blipFill> element.
class
src.pptx.oxml.dml.fill.CT_GradientFillProperties`a:gradFill` custom element class.
class
src.pptx.oxml.dml.fill.CT_GradientStop`a:gs` custom element class.
class
src.pptx.oxml.dml.fill.CT_GradientStopList`a:gsLst` custom element class.
class
src.pptx.oxml.dml.fill.CT_GroupFillProperties`a:grpFill` custom element class
class
src.pptx.oxml.dml.fill.CT_LinearShadeProperties`a:lin` custom element class
class
src.pptx.oxml.dml.fill.CT_NoFillProperties`a:noFill` custom element class
class
src.pptx.oxml.dml.fill.CT_PatternFillProperties`a:pattFill` custom element class
class
src.pptx.oxml.dml.fill.CT_RelativeRect`a:srcRect` element and perhaps others.
class
src.pptx.oxml.dml.fill.CT_SolidColorFillProperties`a:solidFill` custom element class.
class
src.pptx.oxml.dml.line.CT_PresetLineDashProperties`a:prstDash` custom element class
class
src.pptx.oxml.ns.NamespacePrefixedTagValue object that knows the semantics of an XML tag having a namespace prefix.
func
src.pptx.oxml.ns.nsuri(nspfx:str)Return the namespace URI corresponding to `nspfx`.
func
src.pptx.oxml.ns.qn(namespace_prefixed_tag:str) -> strReturn a Clark-notation qualified tag name corresponding to `namespace_prefixed_tag`.
func
src.pptx.oxml.parse_xml(xml:str | bytes)Return root lxml element obtained by parsing XML character string in `xml`.
class
src.pptx.oxml.presentation.CT_SlideId`p:sldId` element.
class
src.pptx.oxml.presentation.CT_SlideIdList`p:sldIdLst` element.
method
src.pptx.oxml.presentation.CT_SlideIdList.add_sldId(rId:str) -> CT_SlideIdCreate and return a reference to a new `p:sldId` child element.
class
src.pptx.oxml.presentation.CT_SlideMasterIdList`p:sldMasterIdLst` element.
class
src.pptx.oxml.presentation.CT_SlideSize`p:sldSz` element.
class
src.pptx.oxml.shapes.autoshape.CT_AdjPoint2D`a:pt` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_CustomGeometry2D`a:custGeom` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_GeomGuide`a:gd` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_GeomGuideList`a:avLst` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_NonVisualDrawingShapeProps`p:cNvSpPr` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_Path2D`a:path` custom element class.
method
src.pptx.oxml.shapes.autoshape.CT_Path2D.add_close() -> CT_Path2DCloseReturn a newly created `a:close` element.
class
src.pptx.oxml.shapes.autoshape.CT_Path2DClose`a:close` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_Path2DLineTo`a:lnTo` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_Path2DList`a:pathLst` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_Path2DMoveTo`a:moveTo` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_PresetGeometry2D`a:prstGeom` custom element class.
class
src.pptx.oxml.shapes.autoshape.CT_Shape`p:sp` custom element class.
method
src.pptx.oxml.shapes.autoshape.CT_Shape.is_textbox()True if this shape is a text box.
method
src.pptx.oxml.shapes.autoshape.CT_Shape.prstGeom() -> CT_PresetGeometry2DReference to `a:prstGeom` child element.
class
src.pptx.oxml.shapes.autoshape.CT_ShapeNonVisual`p:nvSpPr` custom element class.
class
src.pptx.oxml.shapes.connector.CT_ConnectionA `a:stCxn` or `a:endCxn` element.
class
src.pptx.oxml.shapes.connector.CT_ConnectorA line/connector shape `p:cxnSp` element
class
src.pptx.oxml.shapes.graphfrm.CT_GraphicalObject`a:graphic` element.
class
src.pptx.oxml.shapes.graphfrm.CT_GraphicalObjectData`p:graphicData` element.
class
src.pptx.oxml.shapes.graphfrm.CT_GraphicalObjectFrame`p:graphicFrame` element.
method
src.pptx.oxml.shapes.graphfrm.CT_GraphicalObjectFrame.get_or_add_xfrm() -> CT_Transform2DReturn the required `p:xfrm` child element.
class
src.pptx.oxml.shapes.graphfrm.CT_GraphicalObjectFrameNonVisual`p:nvGraphicFramePr` element.
class
src.pptx.oxml.shapes.graphfrm.CT_OleObject`p:oleObj` element, container for an OLE object (e.g.
class
src.pptx.oxml.shapes.groupshape.CT_GroupShapeNonVisual`p:nvGrpSpPr` element.
class
src.pptx.oxml.shapes.groupshape.CT_GroupShapePropertiesp:grpSpPr element
class
src.pptx.oxml.shapes.picture.CT_Picture`p:pic` element.
method
src.pptx.oxml.shapes.picture.CT_Picture.blip_rId() -> str | NoneValue of `p:blipFill/a:blip/@r:embed`.
class
src.pptx.oxml.shapes.shared.CT_ApplicationNonVisualDrawingProps`p:nvPr` element.
class
src.pptx.oxml.shapes.shared.CT_LinePropertiesCustom element class for <a:ln> element
class
src.pptx.oxml.shapes.shared.CT_NonVisualDrawingProps`p:cNvPr` custom element class.
class
src.pptx.oxml.shapes.shared.CT_Placeholder`p:ph` custom element class.
class
src.pptx.oxml.shapes.shared.CT_Point2DCustom element class for <a:off> element.
class
src.pptx.oxml.shapes.shared.CT_PositiveSize2DCustom element class for <a:ext> element.
class
src.pptx.oxml.shapes.shared.CT_ShapePropertiesCustom element class for `p:spPr` element.
class
src.pptx.oxml.shapes.shared.CT_Transform2D`a:xfrm` custom element class.
method
src.pptx.oxml.simpletypes.BaseSimpleType.validate_float(value:Any)Note that int values are accepted.
class
src.pptx.oxml.simpletypes.ST_AngleValid values for `rot` attribute on `<a:xfrm>` element.
class
src.pptx.oxml.simpletypes.ST_AxisUnitValid values for val attribute on c:majorUnit and others.
class
src.pptx.oxml.simpletypes.ST_BarDirValid values for <c:barDir val="?"> attribute
class
src.pptx.oxml.simpletypes.ST_DirectionValid values for `<p:ph orient="...">` attribute.
class
src.pptx.oxml.simpletypes.ST_GroupingValid values for <c:grouping val=""> attribute.
class
src.pptx.oxml.simpletypes.ST_PlaceholderSizeValid values for <p:ph> sz (size) attribute
class
src.pptx.oxml.simpletypes.ST_PositiveFixedAngleValid values for `a:lin@ang`.
class
src.pptx.oxml.simpletypes.ST_TextWrappingTypeValid values for <a:bodyPr wrap=""> attribute
class
src.pptx.oxml.simpletypes.XsdStringEnumerationSet of enumerated xsd:string values.
class
src.pptx.oxml.simpletypes.XsdTokenxsd:string with whitespace collapsing, e.g.
class
src.pptx.oxml.simpletypes.XsdTokenEnumerationxsd:string with whitespace collapsing, e.g.
class
src.pptx.oxml.slide.CT_Background`p:bg` element.
class
src.pptx.oxml.slide.CT_BackgroundProperties`p:bgPr` element.
class
src.pptx.oxml.slide.CT_CommonSlideData`p:cSld` element.
method
src.pptx.oxml.slide.CT_CommonSlideData.get_or_add_bgPr() -> CT_BackgroundPropertiesReturn `p:bg/p:bgPr` grandchild.
class
src.pptx.oxml.slide.CT_NotesMaster`p:notesMaster` element, root of a notes master part.
class
src.pptx.oxml.slide.CT_NotesSlide`p:notes` element, root of a notes slide part.
class
src.pptx.oxml.slide.CT_Slide`p:sld` element, root element of a slide part (XML document).
method
src.pptx.oxml.slide.CT_Slide.new() -> CT_SlideReturn new `p:sld` element configured as base slide shape.
class
src.pptx.oxml.slide.CT_SlideLayout`p:sldLayout` element, root of a slide layout part.
class
src.pptx.oxml.slide.CT_SlideLayoutIdList`p:sldLayoutIdLst` element, child of `p:sldMaster`.
class
src.pptx.oxml.slide.CT_SlideLayoutIdListEntry`p:sldLayoutId` element, child of `p:sldLayoutIdLst`.
class
src.pptx.oxml.slide.CT_SlideMaster`p:sldMaster` element, root of a slide master part.
class
src.pptx.oxml.slide.CT_TLMediaNodeVideo`p:video` element, specifying video media details.
class
src.pptx.oxml.slide.CT_TimeNodeList`p:tnLst` or `p:childTnList` element.
class
src.pptx.oxml.table.CT_Table`a:tbl` custom element class
method
src.pptx.oxml.table.CT_Table.iter_tcs() -> Iterator[CT_TableCell]Generate each `a:tc` element in this tbl.
method
src.pptx.oxml.table.CT_Table.new_tbl(rows:int, cols:int, width:int, height:int, tableStyleId:str | None=None) -> CT_TableReturn a new `p:tbl` element tree.
method
src.pptx.oxml.table.CT_Table.tc(row_idx:int, col_idx:int) -> CT_TableCellReturn `a:tc` element at `row_idx`, `col_idx`.
class
src.pptx.oxml.table.CT_TableCell`a:tc` custom element class
method
src.pptx.oxml.table.CT_TableCell.col_idx() -> intOffset of this cell's column in its table.
method
src.pptx.oxml.table.CT_TableCell.is_merge_origin() -> boolTrue if cell is top-left in merged cell range.
method
src.pptx.oxml.table.CT_TableCell.marB() -> LengthBottom margin value represented in `marB` attribute.
method
src.pptx.oxml.table.CT_TableCell.marL() -> LengthLeft margin value represented in `marL` attribute.
method
src.pptx.oxml.table.CT_TableCell.marR() -> LengthRight margin value represented in `marR` attribute.
method
src.pptx.oxml.table.CT_TableCell.marT() -> LengthTop margin for this cell.
method
src.pptx.oxml.table.CT_TableCell.new() -> CT_TableCellReturn a new `a:tc` element subtree.
method
src.pptx.oxml.table.CT_TableCell.row_idx() -> intOffset of this cell's row in its table.
method
src.pptx.oxml.table.CT_TableCell.tbl() -> CT_TableTable element this cell belongs to.
method
src.pptx.oxml.table.CT_TableCell.text() -> strstr text contained in cell
class
src.pptx.oxml.table.CT_TableCellProperties`a:tcPr` custom element class
class
src.pptx.oxml.table.CT_TableCol`a:gridCol` custom element class.
class
src.pptx.oxml.table.CT_TableGrid`a:tblGrid` custom element class.
class
src.pptx.oxml.table.CT_TableProperties`a:tblPr` custom element class.
class
src.pptx.oxml.table.CT_TableRow`a:tr` custom element class.
method
src.pptx.oxml.table.CT_TableRow.add_tc() -> CT_TableCellA newly added minimal valid `a:tc` child element.
method
src.pptx.oxml.table.CT_TableRow.row_idx() -> intOffset of this row in its table.
class
src.pptx.oxml.table.TcRangeA 2D block of `a:tc` cell elements in a table.
method
src.pptx.oxml.table.TcRange.dimensions() -> tuple[int, int](row_count, col_count) pair describing size of range.
func
src.pptx.oxml.table.TcRange.start_and_size(idx:int, other_idx:int) -> tuple[int, int]Return beginning and length of range based on two indexes.
class
src.pptx.oxml.text.CT_RegularTextRun`a:r` custom element class
method
src.pptx.oxml.text.CT_RegularTextRun.text() -> strAll text of (required) `a:t` child.
class
src.pptx.oxml.text.CT_TextBody`p:txBody` custom element class.
method
src.pptx.oxml.text.CT_TextBody.is_empty() -> boolTrue if only a single empty `a:p` element is present.
method
src.pptx.oxml.text.CT_TextBody.new()Return a new `p:txBody` element tree.
method
src.pptx.oxml.text.CT_TextBody.new_a_txBody() -> CT_TextBodyReturn a new `a:txBody` element tree.
method
src.pptx.oxml.text.CT_TextBody.new_txPr()Return a `c:txPr` element tree.
class
src.pptx.oxml.text.CT_TextBodyProperties`a:bodyPr` custom element class.
method
src.pptx.oxml.text.CT_TextField.text() -> strThe text of the `a:t` child element.
class
src.pptx.oxml.text.CT_TextLineBreak`a:br` line break element
class
src.pptx.oxml.text.CT_TextParagraph`a:p` custom element class
method
src.pptx.oxml.text.CT_TextParagraph.add_br() -> CT_TextLineBreakReturn a newly appended `a:br` element.
method
src.pptx.oxml.text.CT_TextParagraph.add_r(text:str | None=None) -> CT_RegularTextRunReturn a newly appended `a:r` element.
method
src.pptx.oxml.text.CT_TextParagraph.text() -> strstr text contained in this paragraph.
class
src.pptx.oxml.text.CT_TextParagraphProperties`a:pPr` custom element class.
class
src.pptx.oxml.text.CT_TextSpacingUsed for `a:lnSpc`, `a:spcBef`, and `a:spcAft` elements.
method
src.pptx.oxml.text.CT_TextSpacing.set_spcPct(value:float)Set spacing to `value` lines, e.g.
method
src.pptx.oxml.text.CT_TextSpacing.set_spcPts(value:Length)Set spacing to `value` points.
class
src.pptx.oxml.theme.CT_OfficeStyleSheet``<a:theme>`` element, root of a theme part
class
src.pptx.oxml.xmlchemy.AttributeTypeInterface for an object that can act as an attribute type.
method
src.pptx.oxml.xmlchemy.AttributeType.from_xml(xml_value:str) -> AnyTransform an attribute value to a Python value.
class
src.pptx.oxml.xmlchemy.BaseOxmlElementEffective base class for all custom element classes.
method
src.pptx.oxml.xmlchemy.BaseOxmlElement.first_child_found_in(*tagnames:str) -> _Element | NoneFirst child with tag in `tagnames`, or None if not found.
method
src.pptx.oxml.xmlchemy.BaseOxmlElement.remove_all(*tagnames:str) -> NoneRemove child elements with tagname (e.g.
method
src.pptx.oxml.xmlchemy.BaseOxmlElement.xpath(xpath_str:str) -> AnyOverride of `lxml` _Element.xpath() method.
class
src.pptx.oxml.xmlchemy.MetaOxmlElementMetaclass for BaseOxmlElement.
class
src.pptx.oxml.xmlchemy.OneAndOnlyOneDefines a required child element for MetaOxmlElement.
class
src.pptx.oxml.xmlchemy.OptionalAttributeDefines an optional attribute on a custom element class.
class
src.pptx.oxml.xmlchemy.RequiredAttributeDefines a required attribute on a custom element class.
class
src.pptx.oxml.xmlchemy.ZeroOrOneDefines an optional child element for MetaOxmlElement.
func
src.pptx.oxml.xmlchemy.serialize_for_reading(element:ElementBase)Serialize *element* to human-readable XML suitable for tests.
class
src.pptx.package.PackageAn overall .pptx package.
class
src.pptx.parts.chart.ChartPartA chart part.
class
src.pptx.parts.coreprops.CorePropertiesPartCorresponds to part named `/docProps/core.xml`.
class
src.pptx.parts.embeddedpackage.EmbeddedDocxPartA Word .docx file stored in a part.
class
src.pptx.parts.embeddedpackage.EmbeddedPackagePartA distinct OPC package, e.g.
class
src.pptx.parts.embeddedpackage.EmbeddedPptxPartA PowerPoint file stored in a part.
class
src.pptx.parts.embeddedpackage.EmbeddedXlsxPartAn Excel file stored in a part.
method
src.pptx.parts.image.Image.blob() -> bytesThe binary image bytestream of this image.
method
src.pptx.parts.image.Image.content_type() -> strMIME-type of this image, e.g.
method
src.pptx.parts.image.Image.ext() -> strCanonical file extension for this image e.g.
method
src.pptx.parts.image.Image.from_file(image_file:str | IO[bytes]) -> ImageReturn a new |Image| object loaded from `image_file`.
method
src.pptx.parts.image.Image.sha1() -> strSHA1 hash digest of the image blob.
class
src.pptx.parts.image.ImagePartAn image part.
method
src.pptx.parts.image.ImagePart.desc() -> strThe filename associated with this image.
method
src.pptx.parts.image.ImagePart.ext() -> strFile-name extension for this image e.g.
method
src.pptx.parts.image.ImagePart.image() -> ImageAn |Image| object containing the image in this image part.
method
src.pptx.parts.image.ImagePart.new(package:Package, image:Image) -> ImagePartReturn new |ImagePart| instance containing `image`.
class
src.pptx.parts.media.MediaPartA media part, containing an audio or video resource.
class
src.pptx.parts.presentation.PresentationPartTop level class in object model.
method
src.pptx.parts.presentation.PresentationPart.related_slide(rId:str) -> SlideReturn |Slide| object for related |SlidePart| related by `rId`.
class
src.pptx.parts.slide.BaseSlidePartBase class for slide parts.
method
src.pptx.parts.slide.BaseSlidePart.name() -> strInternal name of this slide.
class
src.pptx.parts.slide.NotesMasterPartNotes master part.
class
src.pptx.parts.slide.NotesSlidePartNotes slide part.
class
src.pptx.parts.slide.SlideLayoutPartSlide layout part.
class
src.pptx.parts.slide.SlideMasterPartSlide master part.
class
src.pptx.parts.slide.SlidePartSlide part.
method
src.pptx.parts.slide.SlidePart.notes_slide() -> NotesSlideThe |NotesSlide| instance associated with this slide.
class
src.pptx.presentation.PresentationPresentationML (PML) presentation.
method
src.pptx.presentation.Presentation.notes_master() -> NotesMasterInstance of |NotesMaster| for this presentation.
method
src.pptx.presentation.Presentation.save(file:str | IO[bytes])Writes this presentation to `file`.
class
src.pptx.shapes.autoshape.AdjustmentAn adjustment value for an autoshape.
method
src.pptx.shapes.autoshape.Adjustment.val() -> intDenormalized effective value.
class
src.pptx.shapes.autoshape.AdjustmentCollectionSequence of |Adjustment| instances for an auto shape.
class
src.pptx.shapes.autoshape.ShapeA shape that can appear on a slide.
method
src.pptx.shapes.autoshape.Shape.fill()|FillFormat| instance for this shape.
method
src.pptx.shapes.autoshape.Shape.has_text_frame() -> bool|True| if this shape can contain text.
method
src.pptx.shapes.autoshape.Shape.line()|LineFormat| instance for this shape.
method
src.pptx.shapes.autoshape.Shape.text() -> strRead/write.
method
src.pptx.shapes.autoshape.Shape.text_frame()|TextFrame| instance for this shape.
class
src.pptx.shapes.base.BaseShapeBase class for shape objects.
method
src.pptx.shapes.base.BaseShape.element() -> ShapeElement`lxml` element for this shape, e.g.
method
src.pptx.shapes.base.BaseShape.has_text_frame() -> bool|True| if this shape can contain text.
method
src.pptx.shapes.base.BaseShape.height() -> LengthRead/write.
method
src.pptx.shapes.base.BaseShape.is_placeholder() -> boolTrue if this shape is a placeholder.
method
src.pptx.shapes.base.BaseShape.name() -> strName of this shape, e.g.
method
src.pptx.shapes.base.BaseShape.part() -> BaseSlidePartThe package part containing this shape.
method
src.pptx.shapes.base.BaseShape.rotation() -> floatDegrees of clockwise rotation.
method
src.pptx.shapes.base.BaseShape.shape_id() -> intRead-only positive integer identifying this shape.
method
src.pptx.shapes.base.BaseShape.width() -> LengthDistance between left and right extents of this shape.
class
src.pptx.shapes.connector.ConnectorConnector (line) shape.
class
src.pptx.shapes.freeform.FreeformBuilderAllows a freeform shape to be specified and created.
method
src.pptx.shapes.graphfrm.GraphicFrame.has_chart() -> bool|True| if this graphic frame contains a chart object.
method
src.pptx.shapes.graphfrm.GraphicFrame.ole_format() -> _OleFormat_OleFormat object for this graphic-frame shape.
method
src.pptx.shapes.graphfrm.GraphicFrame.shadow() -> ShadowFormatUnconditionally raises |NotImplementedError|.
method
src.pptx.shapes.graphfrm.GraphicFrame.table() -> TableThe |Table| object contained in this graphic frame.
class
src.pptx.shapes.group.GroupShapeA shape that acts as a container for other shapes.
method
src.pptx.shapes.group.GroupShape.click_action() -> ActionSettingUnconditionally raises `TypeError`.
method
src.pptx.shapes.group.GroupShape.has_text_frame() -> boolUnconditionally |False|.
method
src.pptx.shapes.group.GroupShape.shapes() -> GroupShapes|GroupShapes| object for this group.
class
src.pptx.shapes.picture.MovieA movie shape, one that places a video on a slide.
method
src.pptx.shapes.picture.Movie.media_format() -> _MediaFormatThe |_MediaFormat| object for this movie.
method
src.pptx.shapes.picture.Movie.media_type() -> PP_MEDIA_TYPEMember of :ref:`PpMediaType` describing this shape.
class
src.pptx.shapes.picture.PictureA picture shape, one that places an image on a slide.
method
src.pptx.shapes.picture.Picture.auto_shape_type() -> MSO_SHAPE | NoneMember of MSO_SHAPE indicating masking shape.
method
src.pptx.shapes.picture.Picture.image()The |Image| object for this picture.
class
src.pptx.shapes.placeholder.ChartPlaceholderPlaceholder shape that can only accept a chart.
class
src.pptx.shapes.placeholder.LayoutPlaceholderPlaceholder shape on a slide layout.
class
src.pptx.shapes.placeholder.MasterPlaceholderPlaceholder shape on a slide master.
class
src.pptx.shapes.placeholder.NotesSlidePlaceholderPlaceholder shape on a notes slide.
class
src.pptx.shapes.placeholder.PicturePlaceholderPlaceholder shape that can only accept a picture.
class
src.pptx.shapes.placeholder.PlaceholderPicturePlaceholder shape populated with a picture.
class
src.pptx.shapes.placeholder.SlidePlaceholderPlaceholder shape on a slide.
class
src.pptx.shapes.placeholder.TablePlaceholderPlaceholder shape that can only accept a table.
class
src.pptx.shapes.shapetree.BasePlaceholdersBase class for placeholder collections.
class
src.pptx.shapes.shapetree.GroupShapesThe sequence of child shapes belonging to a group shape.
class
src.pptx.shapes.shapetree.LayoutShapesSequence of shapes appearing on a slide layout.
class
src.pptx.shapes.shapetree.MasterShapesSequence of shapes appearing on a slide master.
class
src.pptx.shapes.shapetree.NotesSlidePlaceholdersSequence of placeholder shapes on a notes slide.
class
src.pptx.shapes.shapetree.NotesSlideShapesSequence of shapes appearing on a notes slide.
class
src.pptx.shapes.shapetree.SlidePlaceholdersCollection of placeholder shapes on a slide.
func
src.pptx.shapes.shapetree.SlideShapeFactory(shape_elm:ShapeElement, parent:ProvidesPart) -> BaseShapeReturn appropriate shape object for `shape_elm` on a slide.
class
src.pptx.shapes.shapetree.SlideShapesSequence of shapes appearing on a slide.
method
src.pptx.shapes.shapetree.SlideShapes.add_table(rows:int, cols:int, left:Length, top:Length, width:Length, height:Length) -> GraphicFrameAdd a |GraphicFrame| object containing a table.
method
src.pptx.shapes.shapetree.SlideShapes.clone_layout_placeholders(slide_layout:SlideLayout) -> NoneAdd placeholder shapes based on those in `slide_layout`.
method
src.pptx.shapes.shapetree.SlideShapes.placeholders() -> SlidePlaceholdersSequence of placeholder shapes in this slide.
method
src.pptx.shapes.shapetree.SlideShapes.title() -> Shape | NoneThe title placeholder shape on the slide.
class
src.pptx.shared.ElementProxyBase class for lxml element proxy classes.
class
src.pptx.shared.ParentedElementProxyProvides access to ancestor objects and part.
method
src.pptx.shared.ParentedElementProxy.part() -> XmlPartThe package part containing this object.
class
src.pptx.slide.NotesMasterProxy for the notes master XML document.
class
src.pptx.slide.NotesSlideNotes slide object.
method
src.pptx.slide.NotesSlide.shapes() -> NotesSlideShapesSequence of shape objects appearing on this notes slide.
class
src.pptx.slide.SlideSlide object.
method
src.pptx.slide.Slide.has_notes_slide() -> bool`True` if this slide has a notes slide, `False` otherwise.
method
src.pptx.slide.Slide.notes_slide() -> NotesSlideThe |NotesSlide| instance for this slide.
method
src.pptx.slide.Slide.placeholders() -> SlidePlaceholdersSequence of placeholder shapes in this slide.
method
src.pptx.slide.Slide.shapes() -> SlideShapesSequence of shape objects appearing on this slide.
method
src.pptx.slide.Slide.slide_layout() -> SlideLayout|SlideLayout| object this slide inherits appearance from.
class
src.pptx.slide.SlideLayoutSlide layout object.
method
src.pptx.slide.SlideLayout.placeholders() -> LayoutPlaceholdersSequence of placeholder shapes in this slide layout.
method
src.pptx.slide.SlideLayout.shapes() -> LayoutShapesSequence of shapes appearing on this slide layout.
class
src.pptx.slide.SlideLayoutsSequence of slide layouts belonging to a slide-master.
method
src.pptx.slide.SlideLayouts.index(slide_layout:SlideLayout) -> intReturn zero-based index of `slide_layout` in this collection.
method
src.pptx.slide.SlideLayouts.remove(slide_layout:SlideLayout) -> NoneRemove `slide_layout` from the collection.
class
src.pptx.slide.SlideMasterSlide master object.
class
src.pptx.slide.SlideMastersSequence of |SlideMaster| objects belonging to a presentation.
class
src.pptx.slide.SlidesSequence of slides belonging to an instance of |Presentation|.
method
src.pptx.slide.Slides.index(slide:Slide) -> intMap `slide` to its zero-based position in this slide sequence.
class
src.pptx.table.TableA DrawingML table object.
method
src.pptx.table.Table.cell(row_idx:int, col_idx:int) -> _CellReturn cell at `row_idx`, `col_idx`.
method
src.pptx.table.Table.columns() -> _ColumnCollection|_ColumnCollection| instance for this table.
この情報について
掲載しているシグネチャは scanny/python-pptx の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。