diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index fd03d834cff1a5..3216dfd320a6ab 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -133419,8 +133419,7 @@ declare namespace PowerPoint { * Returns a collection of bindings that are associated with the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly bindings: PowerPoint.BindingCollection; /** @@ -133576,15 +133575,13 @@ declare namespace PowerPoint { * Represents the possible binding types. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ enum BindingType { /** * Represents a shape binding. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ shape = "Shape", } @@ -133827,148 +133824,127 @@ declare namespace PowerPoint { * Specifies the type of a placeholder. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ enum PlaceholderType { /** * The placeholder is unsupported. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ unsupported = "Unsupported", /** * The placeholder is for a date. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ date = "Date", /** * The placeholder is for a slide number. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ slideNumber = "SlideNumber", /** * The placeholder is for a footer. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ footer = "Footer", /** * The placeholder is for a header. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ header = "Header", /** * The placeholder is for a title. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ title = "Title", /** * The placeholder is for a body. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ body = "Body", /** * The placeholder is for a center title. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ centerTitle = "CenterTitle", /** * The placeholder is for a subtitle. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ subtitle = "Subtitle", /** * The placeholder is for a vertical title. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalTitle = "VerticalTitle", /** * The placeholder is for a vertical body. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalBody = "VerticalBody", /** * The placeholder is for generic content. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ content = "Content", /** * The placeholder is for a chart. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ chart = "Chart", /** * The placeholder is for a table. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ table = "Table", /** * The placeholder is for an online picture. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ onlinePicture = "OnlinePicture", /** * The placeholder is for a SmartArt. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ smartArt = "SmartArt", /** * The placeholder is for media. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ media = "Media", /** * The placeholder is for generic vertical content. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalContent = "VerticalContent", /** * The placeholder is for a picture. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ picture = "Picture", /** * The placeholder is for a cameo. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ cameo = "Cameo", } @@ -134098,8 +134074,7 @@ declare namespace PowerPoint { * Represents the properties of a `placeholder` shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class PlaceholderFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -134109,16 +134084,14 @@ declare namespace PowerPoint { Returns `null` if the placeholder is empty. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null; /** * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; /** @@ -135604,8 +135577,7 @@ declare namespace PowerPoint { * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param base64EncodedImage A string that is a Base64 encoding of the image data. */ @@ -135775,8 +135747,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ allCaps: boolean | null; /** @@ -135809,8 +135780,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ doubleStrikethrough: boolean | null; /** @@ -135850,8 +135820,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ smallCaps: boolean | null; /** @@ -135864,8 +135833,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ strikethrough: boolean | null; /** @@ -135878,8 +135846,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ subscript: boolean | null; /** @@ -135892,8 +135859,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ superscript: boolean | null; /** @@ -135934,104 +135900,91 @@ declare namespace PowerPoint { * Represents the font attributes, such as font name, size, and color. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface FontProperties { /** * Represents whether the font uses all caps, where lowercase letters are shown as capital letters. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ allCaps?: boolean | undefined; /** * Represents the bold status of font. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ bold?: boolean | undefined; /** * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ color?: string | undefined; /** * Represents the double-strikethrough status of the font. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ doubleStrikethrough?: boolean | undefined; /** * Represents the italic status of font. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ italic?: boolean | undefined; /** * Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ name?: string | undefined; /** * Represents the font size in points (e.g., 11). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ size?: number | undefined; /** * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ smallCaps?: boolean | undefined; /** * Represents the strikethrough status of the font. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ strikethrough?: boolean | undefined; /** * Represents the subscript status of the font. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ subscript?: boolean | undefined; /** * Represents the superscript status of the font. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ superscript?: boolean | undefined; /** * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined; } @@ -136039,24 +135992,21 @@ declare namespace PowerPoint { * Represents a sequence of one or more characters with the same font attributes. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TextRun { /** * The font attributes (such as font name, font size, and color) applied to this text run. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ font?: PowerPoint.FontProperties; /** * The text of this text run. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text: string; } @@ -136110,8 +136060,7 @@ declare namespace PowerPoint { * Represents a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class TableCell extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -136121,16 +136070,14 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly columnCount: number; /** * Gets the zero-based column index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly columnIndex: number; /** @@ -136138,24 +136085,21 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly rowCount: number; /** * Gets the zero-based row index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly rowIndex: number; /** * Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text: string; /** @@ -136189,8 +136133,7 @@ declare namespace PowerPoint { * Represents a collection of table cells. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class TableCellCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -136201,8 +136144,7 @@ declare namespace PowerPoint { * Gets the number of table cells in the collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * @returns The number of table cells in the collection. */ getCount(): OfficeExtension.ClientResult; @@ -136210,8 +136152,7 @@ declare namespace PowerPoint { * Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param row Row index value of the table cell to be retrieved, as a zero-based index. * @param column Column index value of the table cell to be retrieved, as a zero-based index. @@ -136246,24 +136187,21 @@ declare namespace PowerPoint { * Represents the fill formatting of a table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface FillProperties { /** * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ color?: string | undefined; /** * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ transparency?: number | undefined; } @@ -136271,40 +136209,35 @@ declare namespace PowerPoint { * Represents the properties for a table cell border. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface BorderProperties { /** * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ color?: string | undefined; /** * Represents the dash style of the line. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined; /** * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ transparency?: number | undefined; /** * Represents the weight of the line, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ weight?: number | undefined; } @@ -136312,56 +136245,49 @@ declare namespace PowerPoint { * Represents the borders of a table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableCellBorders { /** * Represents the bottom border. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ bottom?: PowerPoint.BorderProperties; /** * Represents the diagonal border (top-left to bottom-right). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ diagonalDown?: PowerPoint.BorderProperties; /** * Represents the diagonal border (bottom-left to top-right). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ diagonalUp?: PowerPoint.BorderProperties; /** * Represents the left border. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ left?: PowerPoint.BorderProperties; /** * Represents the right border. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ right?: PowerPoint.BorderProperties; /** * Represents the top border. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ top?: PowerPoint.BorderProperties; } @@ -136369,40 +136295,35 @@ declare namespace PowerPoint { * Represents the margins of a table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableCellMargins { /** * Specifies the bottom margin in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ bottom?: number | undefined; /** * Specifies the left margin in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ left?: number | undefined; /** * Specifies the right margin in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ right?: number | undefined; /** * Specifies the top margin in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ top?: number | undefined; } @@ -136410,56 +136331,49 @@ declare namespace PowerPoint { * Represents the table cell properties to update. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableCellProperties { /** * Specifies the border formatting of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ borders?: PowerPoint.TableCellBorders; /** * Specifies the fill formatting of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ fill?: PowerPoint.FillProperties; /** * Specifies the font formatting of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ font?: PowerPoint.FontProperties; /** * Represents the horizontal alignment of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined; /** * Represents the indent level of the text in the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ indentLevel?: number | undefined; /** * Specifies the margin settings in the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ margins?: PowerPoint.TableCellMargins; /** @@ -136468,8 +136382,7 @@ declare namespace PowerPoint { If a portion of the text requires different formatting, use the `textRuns` property instead. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text?: string; /** @@ -136477,16 +136390,14 @@ declare namespace PowerPoint { Each `TextRun` object represents a sequence of one or more characters that share the same font attributes. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textRuns?: PowerPoint.TextRun[]; /** * Represents the vertical alignment of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined; } @@ -136494,8 +136405,7 @@ declare namespace PowerPoint { * Represents a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class Table extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -136504,32 +136414,28 @@ declare namespace PowerPoint { * Gets the number of columns in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly columnCount: number; /** * Gets the number of rows in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly rowCount: number; /** * Gets all of the values in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly values: string[][]; /** * Gets the cell at the specified `rowIndex` and `columnIndex`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param rowIndex The zero-based row index of the cell. * @param columnIndex The zero-based column index of the cell. @@ -136540,8 +136446,7 @@ declare namespace PowerPoint { * Gets a collection of cells that represent the merged areas of the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * @returns a `TableCellCollection` with cells that represent the merged areas of the table. */ getMergedAreas(): PowerPoint.TableCellCollection; @@ -136549,8 +136454,7 @@ declare namespace PowerPoint { * Gets the shape object for the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ getShape(): PowerPoint.Shape; /** @@ -136584,8 +136488,7 @@ declare namespace PowerPoint { * Provides the table column properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableColumnProperties { /** @@ -136597,8 +136500,7 @@ declare namespace PowerPoint { a default column width will be used. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnWidth?: number | undefined; } @@ -136606,8 +136508,7 @@ declare namespace PowerPoint { * Represents the properties of a merged area of cells in a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableMergedAreaProperties { /** @@ -136615,16 +136516,14 @@ declare namespace PowerPoint { Must be 1 or greater. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnCount: number; /** * Specifies the zero-based index of the column of the top left cell of the merged area. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnIndex: number; /** @@ -136632,16 +136531,14 @@ declare namespace PowerPoint { Must be 1 or greater. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowCount: number; /** * Specifies the zero-based index of the row of the top left cell of the merged area. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowIndex: number; } @@ -136649,8 +136546,7 @@ declare namespace PowerPoint { * Provides the table row properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableRowProperties { /** @@ -136662,8 +136558,7 @@ declare namespace PowerPoint { a default row height will be used. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowHeight?: number | undefined; } @@ -136671,8 +136566,7 @@ declare namespace PowerPoint { * Represents the available options when adding a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableAddOptions { /** @@ -136681,8 +136575,7 @@ declare namespace PowerPoint { Specify an empty object for columns that should use the default formatting. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columns?: PowerPoint.TableColumnProperties[]; /** @@ -136691,8 +136584,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when set with a negative value. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ height?: number | undefined; /** @@ -136700,16 +136592,14 @@ declare namespace PowerPoint { The table is centered horizontally when this parameter is not provided. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ left?: number | undefined; /** * If specified, represents an rectangular area where multiple cells appear as a single cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ mergedAreas?: PowerPoint.TableMergedAreaProperties[]; /** @@ -136718,8 +136608,7 @@ declare namespace PowerPoint { Specify an empty object for rows that should use the default formatting. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rows?: PowerPoint.TableRowProperties[]; /** @@ -136731,8 +136620,7 @@ declare namespace PowerPoint { to the entire merged area. For the other cells in the merged area, an empty object should be provided. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ specificCellProperties?: PowerPoint.TableCellProperties[][]; /** @@ -136740,8 +136628,7 @@ declare namespace PowerPoint { A default value is used when this parameter is not provided. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ top?: number | undefined; /** @@ -136757,8 +136644,7 @@ declare namespace PowerPoint { and do not specify specificCellProperties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ uniformCellProperties?: PowerPoint.TableCellProperties; /** @@ -136770,8 +136656,7 @@ declare namespace PowerPoint { in the merged area must be an empty string. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ values?: string[][]; /** @@ -136780,8 +136665,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when set with a negative value. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ width?: number | undefined; } @@ -136822,8 +136706,7 @@ declare namespace PowerPoint { * Create a shape group for several shapes. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param values An array of shape IDs or `Shape` objects. * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group. @@ -136856,8 +136739,7 @@ declare namespace PowerPoint { Use the `Shape.table` property to get the `Table` object for the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param rowCount Number of rows in the table. Must be 1 or greater. * @param columnCount Number of columns in the table. Must be 1 or greater. @@ -136942,24 +136824,21 @@ declare namespace PowerPoint { * Represents the available options when getting an image of a slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface SlideGetImageOptions { /** * The desired height of the resulting image in pixels. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ height?: number; /** * The desired width of the resulting image in pixels. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ width?: number; } @@ -136967,267 +136846,229 @@ declare namespace PowerPoint { * Specifies the type of a slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ enum SlideLayoutType { /** * Blank layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ blank = "Blank", /** * Chart layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ chart = "Chart", /** * Chart and text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ chartAndText = "ChartAndText", /** * ClipArt and text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ clipArtAndText = "ClipArtAndText", /** * ClipArt and vertical text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ clipArtAndVerticalText = "ClipArtAndVerticalText", /** * Comparison layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ comparison = "Comparison", /** * Content with caption layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ contentWithCaption = "ContentWithCaption", /** * Custom layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ custom = "Custom", /** * Four objects layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ fourObjects = "FourObjects", /** * Large object layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ largeObject = "LargeObject", /** * MediaClip and text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ mediaClipAndText = "MediaClipAndText", /** * Mixed layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ mixed = "Mixed", /** * Object layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ object = "Object", /** * Object and text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ objectAndText = "ObjectAndText", /** * Object and two objects layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ objectAndTwoObjects = "ObjectAndTwoObjects", /** * Object over text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ objectOverText = "ObjectOverText", /** * Organization chart layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ organizationChart = "OrganizationChart", /** * Picture with caption layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ pictureWithCaption = "PictureWithCaption", /** * Section header layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ sectionHeader = "SectionHeader", /** * Table layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ table = "Table", /** * Text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text = "Text", /** * Text and chart layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textAndChart = "TextAndChart", /** * Text and ClipArt layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textAndClipArt = "TextAndClipArt", /** * Text and MediaClip layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textAndMediaClip = "TextAndMediaClip", /** * Text and object layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textAndObject = "TextAndObject", /** * Text and two objects layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textAndTwoObjects = "TextAndTwoObjects", /** * Text over object layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ textOverObject = "TextOverObject", /** * Title layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ title = "Title", /** * Title only layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ titleOnly = "TitleOnly", /** * Two-column text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ twoColumnText = "TwoColumnText", /** * Two objects layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ twoObjects = "TwoObjects", /** * Two objects and object layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ twoObjectsAndObject = "TwoObjectsAndObject", /** * Two objects and text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ twoObjectsAndText = "TwoObjectsAndText", /** * Two objects over text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ twoObjectsOverText = "TwoObjectsOverText", /** * Vertical text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalText = "VerticalText", /** * Vertical title and text layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalTitleAndText = "VerticalTitleAndText", /** * Vertical title and text over chart layout. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart", } @@ -137272,8 +137113,7 @@ declare namespace PowerPoint { * Returns the type of the slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"; /** @@ -137652,16 +137492,14 @@ declare namespace PowerPoint { * Returns the zero-based index of the slide representing its position in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly index: number; /** * Applies the specified layout to the slide, changing its design and structure according to the chosen layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param slideLayout The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master. */ @@ -137677,8 +137515,7 @@ declare namespace PowerPoint { * Exports the slide to its own presentation file, returned as Base64-encoded data. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ exportAsBase64(): OfficeExtension.ClientResult; /** @@ -137687,19 +137524,17 @@ declare namespace PowerPoint { of either width or height is specified, the other will be calculated to preserve aspect ratio. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param options Optional. Options to specify the desired size of the slide image. - * @returns A base64 string of the slide image in PNG format. + * @returns A Base64 string of the slide image in PNG format. */ getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult; /** * Moves the slide to a new position within the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param slideIndex The zero-based index where the slide should be moved. */ @@ -137794,8 +137629,7 @@ declare namespace PowerPoint { If the collection contains fewer than two shapes, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * @returns The newly created grouped shape as a {@link PowerPoint.Shape}. */ group(): PowerPoint.Shape; @@ -137827,8 +137661,7 @@ declare namespace PowerPoint { * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class ShapeGroup extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -137837,32 +137670,28 @@ declare namespace PowerPoint { * Returns the `Shape` object associated with the group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly shape: PowerPoint.Shape; /** * Returns the collection of `Shape` objects in the group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly shapes: PowerPoint.ShapeScopedCollection; /** * Gets the unique ID of the shape group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly id: string; /** * Ungroups any grouped shapes in the specified shape group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ ungroup(): void; /** @@ -138347,36 +138176,31 @@ declare namespace PowerPoint { * Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ enum ShapeZOrder { /** * Brings the shape forward one spot in the z-order. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ bringForward = "BringForward", /** * Brings the shape to the front of the z-order. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ bringToFront = "BringToFront", /** * Sends the shape backward one spot in the z-order. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ sendBackward = "SendBackward", /** * Sends the shape to the back of the z-order. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ sendToBack = "SendToBack", } @@ -138408,8 +138232,7 @@ declare namespace PowerPoint { If the shape type isn't `group`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly group: PowerPoint.ShapeGroup; /** @@ -138424,8 +138247,7 @@ declare namespace PowerPoint { If the shape isn't part of a group, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly parentGroup: PowerPoint.Shape; /** @@ -138433,8 +138255,7 @@ declare namespace PowerPoint { If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly placeholderFormat: PowerPoint.PlaceholderFormat; /** @@ -138482,8 +138303,7 @@ declare namespace PowerPoint { - A level greater than 1 indicates the shape is a nested group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly level: number; /** @@ -138519,8 +138339,7 @@ declare namespace PowerPoint { each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly zOrderPosition: number; /** @@ -138576,16 +138395,14 @@ declare namespace PowerPoint { * Returns the `Table` object if this shape is a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ getTable(): PowerPoint.Table; /** * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum. */ @@ -138594,8 +138411,7 @@ declare namespace PowerPoint { * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum. */ @@ -138631,8 +138447,7 @@ declare namespace PowerPoint { * Represents an Office.js binding that is defined in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class Binding extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -138641,32 +138456,28 @@ declare namespace PowerPoint { * Represents the binding identifier. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly id: string; /** * Returns the type of the binding. See `BindingType` for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ readonly type: PowerPoint.BindingType | "Shape"; /** * Deletes the binding. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ delete(): void; /** * Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ getShape(): PowerPoint.Shape; /** @@ -138700,8 +138511,7 @@ declare namespace PowerPoint { * Represents the collection of all the binding objects that are part of the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ class BindingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -138712,8 +138522,7 @@ declare namespace PowerPoint { * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param shape Shape to which the binding is added. * @param bindingType Type of binding. See `BindingType`. @@ -138724,8 +138533,7 @@ declare namespace PowerPoint { * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param shape Shape to which the binding is added. * @param bindingType Type of binding. See `BindingType`. @@ -138737,8 +138545,7 @@ declare namespace PowerPoint { If the selection has multiple areas, the `InvalidReference` error will be returned. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param bindingType Type of binding. See `BindingType`. * @param id ID of the binding. @@ -138749,8 +138556,7 @@ declare namespace PowerPoint { If the selection has multiple areas, the `InvalidReference` error will be returned. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param bindingType Type of binding. See `BindingType`. * @param id ID of the binding. @@ -138760,16 +138566,14 @@ declare namespace PowerPoint { * Gets the number of bindings in the collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ getCount(): OfficeExtension.ClientResult; /** * Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param key ID of the binding object to be retrieved. */ @@ -138778,8 +138582,7 @@ declare namespace PowerPoint { * Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param index Index value of the object to be retrieved. Zero-indexed. */ @@ -138789,8 +138592,7 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] * * @param id ID of the binding object to be retrieved. */ @@ -139374,7 +139176,7 @@ declare namespace PowerPoint { getItemAt(index: number): PowerPoint.SlideMaster; /** * Gets a Slide Master using its unique ID. If such a Slide Master does not exist, an object with an `isNullObject` property set to true is returned. - For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}." + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: PowerPointApi 1.3] @@ -139482,8 +139284,7 @@ declare namespace PowerPoint { * - `null`: Some, but not all, of the text has the **All Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ allCaps?: boolean | null; /** @@ -139516,8 +139317,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ doubleStrikethrough?: boolean | null; /** @@ -139557,8 +139357,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ smallCaps?: boolean | null; /** @@ -139571,8 +139370,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ strikethrough?: boolean | null; /** @@ -139585,8 +139383,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ subscript?: boolean | null; /** @@ -139599,8 +139396,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ superscript?: boolean | null; /** @@ -139617,8 +139413,7 @@ declare namespace PowerPoint { * Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text?: string; } @@ -139973,16 +139768,14 @@ declare namespace PowerPoint { Returns `null` if the placeholder is empty. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null; /** * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; } @@ -140043,8 +139836,7 @@ declare namespace PowerPoint { * - `null`: Some, but not all, of the text has the **All Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ allCaps?: boolean | null; /** @@ -140077,8 +139869,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ doubleStrikethrough?: boolean | null; /** @@ -140118,8 +139909,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ smallCaps?: boolean | null; /** @@ -140132,8 +139922,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ strikethrough?: boolean | null; /** @@ -140146,8 +139935,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ subscript?: boolean | null; /** @@ -140160,8 +139948,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ superscript?: boolean | null; /** @@ -140179,16 +139966,14 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnCount?: number; /** * Gets the zero-based column index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnIndex?: number; /** @@ -140196,24 +139981,21 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowCount?: number; /** * Gets the zero-based row index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowIndex?: number; /** * Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text?: string; } @@ -140227,24 +140009,21 @@ declare namespace PowerPoint { * Gets the number of columns in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnCount?: number; /** * Gets the number of rows in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowCount?: number; /** * Gets all of the values in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ values?: string[][]; } @@ -140272,8 +140051,7 @@ declare namespace PowerPoint { * Returns the type of the slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"; } @@ -140332,8 +140110,7 @@ declare namespace PowerPoint { * Returns the zero-based index of the slide representing its position in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ index?: number; } @@ -140347,8 +140124,7 @@ declare namespace PowerPoint { * Gets the unique ID of the shape group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ id?: string; } @@ -140535,8 +140311,7 @@ declare namespace PowerPoint { - A level greater than 1 indicates the shape is a nested group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ level?: number; /** @@ -140572,8 +140347,7 @@ declare namespace PowerPoint { each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ zOrderPosition?: number; } @@ -140583,16 +140357,14 @@ declare namespace PowerPoint { * Represents the binding identifier. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ id?: string; /** * Returns the type of the binding. See `BindingType` for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: PowerPoint.BindingType | "Shape"; } @@ -140830,8 +140602,7 @@ declare namespace PowerPoint { * Represents the properties of a `placeholder` shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface PlaceholderFormatLoadOptions { /** @@ -140843,16 +140614,14 @@ declare namespace PowerPoint { Returns `null` if the placeholder is empty. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ containedType?: boolean; /** * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: boolean; } @@ -140962,8 +140731,7 @@ declare namespace PowerPoint { * - `null`: Some, but not all, of the text has the **All Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ allCaps?: boolean; /** @@ -140996,8 +140764,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ doubleStrikethrough?: boolean; /** @@ -141037,8 +140804,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ smallCaps?: boolean; /** @@ -141051,8 +140817,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ strikethrough?: boolean; /** @@ -141065,8 +140830,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ subscript?: boolean; /** @@ -141079,8 +140843,7 @@ declare namespace PowerPoint { * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ superscript?: boolean; /** @@ -141095,8 +140858,7 @@ declare namespace PowerPoint { * Represents a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableCellLoadOptions { /** @@ -141108,16 +140870,14 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnCount?: boolean; /** * Gets the zero-based column index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnIndex?: boolean; /** @@ -141125,24 +140885,21 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowCount?: boolean; /** * Gets the zero-based row index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowIndex?: boolean; /** * Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text?: boolean; } @@ -141150,8 +140907,7 @@ declare namespace PowerPoint { * Represents a collection of table cells. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableCellCollectionLoadOptions { /** @@ -141163,16 +140919,14 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnCount?: boolean; /** * For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnIndex?: boolean; /** @@ -141180,24 +140934,21 @@ declare namespace PowerPoint { Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowCount?: boolean; /** * For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowIndex?: boolean; /** * For EACH ITEM in the collection: Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ text?: boolean; } @@ -141205,8 +140956,7 @@ declare namespace PowerPoint { * Represents a table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface TableLoadOptions { /** @@ -141217,24 +140967,21 @@ declare namespace PowerPoint { * Gets the number of columns in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ columnCount?: boolean; /** * Gets the number of rows in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ rowCount?: boolean; /** * Gets all of the values in the table. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ values?: boolean; } @@ -141261,8 +141008,7 @@ declare namespace PowerPoint { If the shape type isn't `group`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** @@ -141277,8 +141023,7 @@ declare namespace PowerPoint { If the shape isn't part of a group, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; /** @@ -141286,8 +141031,7 @@ declare namespace PowerPoint { If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** @@ -141328,8 +141072,7 @@ declare namespace PowerPoint { - A level greater than 1 indicates the shape is a nested group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ level?: boolean; /** @@ -141365,8 +141108,7 @@ declare namespace PowerPoint { each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ zOrderPosition?: boolean; } @@ -141399,8 +141141,7 @@ declare namespace PowerPoint { * Returns the type of the slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: boolean; } @@ -141433,8 +141174,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Returns the type of the slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: boolean; } @@ -141552,8 +141292,7 @@ declare namespace PowerPoint { * Returns the zero-based index of the slide representing its position in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ index?: boolean; } @@ -141580,8 +141319,7 @@ declare namespace PowerPoint { If the shape type isn't `group`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** @@ -141596,8 +141334,7 @@ declare namespace PowerPoint { If the shape isn't part of a group, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; /** @@ -141605,8 +141342,7 @@ declare namespace PowerPoint { If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** @@ -141647,8 +141383,7 @@ declare namespace PowerPoint { - A level greater than 1 indicates the shape is a nested group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ level?: boolean; /** @@ -141684,8 +141419,7 @@ declare namespace PowerPoint { each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ zOrderPosition?: boolean; } @@ -141693,8 +141427,7 @@ declare namespace PowerPoint { * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface ShapeGroupLoadOptions { /** @@ -141705,16 +141438,14 @@ declare namespace PowerPoint { * Returns the `Shape` object associated with the group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ shape?: PowerPoint.Interfaces.ShapeLoadOptions; /** * Gets the unique ID of the shape group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ id?: boolean; } @@ -141964,8 +141695,7 @@ declare namespace PowerPoint { If the shape type isn't `group`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** @@ -141980,8 +141710,7 @@ declare namespace PowerPoint { If the shape isn't part of a group, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; /** @@ -141989,8 +141718,7 @@ declare namespace PowerPoint { If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** @@ -142031,8 +141759,7 @@ declare namespace PowerPoint { - A level greater than 1 indicates the shape is a nested group. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ level?: boolean; /** @@ -142068,8 +141795,7 @@ declare namespace PowerPoint { each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ zOrderPosition?: boolean; } @@ -142077,8 +141803,7 @@ declare namespace PowerPoint { * Represents an Office.js binding that is defined in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface BindingLoadOptions { /** @@ -142089,16 +141814,14 @@ declare namespace PowerPoint { * Represents the binding identifier. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ id?: boolean; /** * Returns the type of the binding. See `BindingType` for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: boolean; } @@ -142106,8 +141829,7 @@ declare namespace PowerPoint { * Represents the collection of all the binding objects that are part of the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ interface BindingCollectionLoadOptions { /** @@ -142118,16 +141840,14 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Represents the binding identifier. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ id?: boolean; /** * For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ type?: boolean; } @@ -142324,8 +142044,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ index?: boolean; } @@ -142365,8 +142084,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.8] */ index?: boolean; } diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 235607c0525e36..642c55a69772cf 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -125127,6 +125127,13 @@ declare namespace PowerPoint { class Presentation extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Returns a collection of bindings that are associated with the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly bindings: PowerPoint.BindingCollection; /** * Returns a collection of custom XML parts that are associated with the presentation. * @@ -125276,6 +125283,20 @@ declare namespace PowerPoint { */ slideMasterId?: string; } + /** + * Represents the possible binding types. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + enum BindingType { + /** + * Represents a shape binding. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + shape = "Shape", + } /** * Represents a custom XML part object. * @@ -125511,6 +125532,134 @@ declare namespace PowerPoint { */ toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData; } + /** + * Specifies the type of a placeholder. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + enum PlaceholderType { + /** + * The placeholder is unsupported. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + unsupported = "Unsupported", + /** + * The placeholder is for a date. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + date = "Date", + /** + * The placeholder is for a slide number. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + slideNumber = "SlideNumber", + /** + * The placeholder is for a footer. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + footer = "Footer", + /** + * The placeholder is for a header. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + header = "Header", + /** + * The placeholder is for a title. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + title = "Title", + /** + * The placeholder is for a body. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + body = "Body", + /** + * The placeholder is for a center title. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + centerTitle = "CenterTitle", + /** + * The placeholder is for a subtitle. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + subtitle = "Subtitle", + /** + * The placeholder is for a vertical title. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalTitle = "VerticalTitle", + /** + * The placeholder is for a vertical body. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalBody = "VerticalBody", + /** + * The placeholder is for generic content. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + content = "Content", + /** + * The placeholder is for a chart. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + chart = "Chart", + /** + * The placeholder is for a table. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + table = "Table", + /** + * The placeholder is for an online picture. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + onlinePicture = "OnlinePicture", + /** + * The placeholder is for a SmartArt. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + smartArt = "SmartArt", + /** + * The placeholder is for media. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + media = "Media", + /** + * The placeholder is for generic vertical content. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalContent = "VerticalContent", + /** + * The placeholder is for a picture. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + picture = "Picture", + /** + * The placeholder is for a cameo. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + cameo = "Cameo", + } /** * Specifies the type of a shape. * @@ -125633,6 +125782,57 @@ declare namespace PowerPoint { */ textBox = "TextBox", } + /** + * Represents the properties of a `placeholder` shape. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class PlaceholderFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details. + Returns `null` if the placeholder is empty. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null; + /** + * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.PlaceholderFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.PlaceholderFormatData; + } /** * Represents a single hyperlink. * @@ -127085,6 +127285,15 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ clear(): void; + /** + * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param base64EncodedImage A string that is a Base64 encoding of the image data. + */ + setImage(base64EncodedImage: string): void; /** * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`. * @@ -127240,6 +127449,19 @@ declare namespace PowerPoint { class ShapeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **All Caps** attribute. + * + * - `false`: None of the text has the **All Caps** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + allCaps: boolean | null; /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: * @@ -127260,6 +127482,19 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ color: string | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Double strikethrough** attribute. + * + * - `false`: None of the text has the **Double strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + doubleStrikethrough: boolean | null; /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: * @@ -127287,6 +127522,58 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ size: number | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **Small Caps** attribute. + * + * - `false`: None of the text has the **Small Caps** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + smallCaps: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Strikethrough** attribute. + * + * - `false`: None of the text has the **Strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + strikethrough: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Subscript** attribute. + * + * - `false`: None of the text has the **Subscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + subscript: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Superscript** attribute. + * + * - `false`: None of the text has the **Superscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + superscript: boolean | null; /** * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. * @@ -127321,6 +127608,120 @@ declare namespace PowerPoint { */ toJSON(): PowerPoint.Interfaces.ShapeFontData; } + /** + * Represents the font attributes, such as font name, size, and color. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface FontProperties { + /** + * Represents whether the font uses all caps, where lowercase letters are shown as capital letters. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + allCaps?: boolean | undefined; + /** + * Represents the bold status of font. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bold?: boolean | undefined; + /** + * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red"). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + color?: string | undefined; + /** + * Represents the double-strikethrough status of the font. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + doubleStrikethrough?: boolean | undefined; + /** + * Represents the italic status of font. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + italic?: boolean | undefined; + /** + * Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + name?: string | undefined; + /** + * Represents the font size in points (e.g., 11). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + size?: number | undefined; + /** + * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + smallCaps?: boolean | undefined; + /** + * Represents the strikethrough status of the font. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + strikethrough?: boolean | undefined; + /** + * Represents the subscript status of the font. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + subscript?: boolean | undefined; + /** + * Represents the superscript status of the font. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + superscript?: boolean | undefined; + /** + * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined; + } + /** + * Represents a sequence of one or more characters with the same font attributes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TextRun { + /** + * The font attributes (such as font name, font size, and color) applied to this text run. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + font?: PowerPoint.FontProperties; + /** + * The text of this text run. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text: string; + } /** * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}. If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group. @@ -127368,25 +127769,638 @@ declare namespace PowerPoint { bottomCentered = "BottomCentered", } /** - * Represents the collection of shapes. + * Represents a table. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.8] */ - class ShapeCollection extends OfficeExtension.ClientObject { + class TableCell extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: PowerPoint.Shape[]; /** - * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * Gets the number of table columns this cell spans across. + Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi 1.4] - * - * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. - * @param options An optional parameter to specify the additional options such as the position of the shape. - * @returns The newly inserted shape. + * [Api set: PowerPointApi 1.8] + */ + readonly columnCount: number; + /** + * Gets the zero-based column index of the cell within the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly columnIndex: number; + /** + * Gets the number of table rows this cell spans across. + Will be greater than or equal to 1. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly rowCount: number; + /** + * Gets the zero-based row index of the cell within the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly rowIndex: number; + /** + * Specifies the text content of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.TableCell; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TableCell; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableCellData; + } + /** + * Represents a collection of table cells. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class TableCellCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.TableCell[]; + /** + * Gets the number of table cells in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * @returns The number of table cells in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param row Row index value of the table cell to be retrieved, as a zero-based index. + * @param column Column index value of the table cell to be retrieved, as a zero-based index. + * @returns The `TableCell` object. + */ + getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.TableCellCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.TableCellCollectionData; + } + /** + * Represents the fill formatting of a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface FillProperties { + /** + * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + color?: string | undefined; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + transparency?: number | undefined; + } + /** + * Represents the properties for a table cell border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface BorderProperties { + /** + * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + color?: string | undefined; + /** + * Represents the dash style of the line. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined; + /** + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + transparency?: number | undefined; + /** + * Represents the weight of the line, in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + weight?: number | undefined; + } + /** + * Represents the borders of a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableCellBorders { + /** + * Represents the bottom border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bottom?: PowerPoint.BorderProperties; + /** + * Represents the diagonal border (top-left to bottom-right). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + diagonalDown?: PowerPoint.BorderProperties; + /** + * Represents the diagonal border (bottom-left to top-right). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + diagonalUp?: PowerPoint.BorderProperties; + /** + * Represents the left border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + left?: PowerPoint.BorderProperties; + /** + * Represents the right border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + right?: PowerPoint.BorderProperties; + /** + * Represents the top border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + top?: PowerPoint.BorderProperties; + } + /** + * Represents the margins of a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableCellMargins { + /** + * Specifies the bottom margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bottom?: number | undefined; + /** + * Specifies the left margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + left?: number | undefined; + /** + * Specifies the right margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + right?: number | undefined; + /** + * Specifies the top margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + top?: number | undefined; + } + /** + * Represents the table cell properties to update. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableCellProperties { + /** + * Specifies the border formatting of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + borders?: PowerPoint.TableCellBorders; + /** + * Specifies the fill formatting of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + fill?: PowerPoint.FillProperties; + /** + * Specifies the font formatting of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + font?: PowerPoint.FontProperties; + /** + * Represents the horizontal alignment of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined; + /** + * Represents the indent level of the text in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + indentLevel?: number | undefined; + /** + * Specifies the margin settings in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + margins?: PowerPoint.TableCellMargins; + /** + * Specifies the text content of the table cell. + + If a portion of the text requires different formatting, use the `textRuns` property instead. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text?: string; + /** + * Specifies the contents of the table cell as an array of {@link TextRun} objects. + Each `TextRun` object represents a sequence of one or more characters that share the same font attributes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textRuns?: PowerPoint.TextRun[]; + /** + * Represents the vertical alignment of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined; + } + /** + * Represents a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class Table extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the number of columns in the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly columnCount: number; + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly rowCount: number; + /** + * Gets all of the values in the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly values: string[][]; + /** + * Gets the cell at the specified `rowIndex` and `columnIndex`. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param rowIndex The zero-based row index of the cell. + * @param columnIndex The zero-based column index of the cell. + * @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned. + */ + getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell; + /** + * Gets a collection of cells that represent the merged areas of the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * @returns a `TableCellCollection` with cells that represent the merged areas of the table. + */ + getMergedAreas(): PowerPoint.TableCellCollection; + /** + * Gets the shape object for the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + getShape(): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Table; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableData; + } + /** + * Provides the table column properties. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableColumnProperties { + /** + * Represents the desired width of each column in points, or is undefined. + + When a table is being added, for columns whose width is undefined, + the column width will be calculated by evenly dividing the remaining width + of the table amongst those columns. If the table does not have a defined width, + a default column width will be used. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnWidth?: number | undefined; + } + /** + * Represents the properties of a merged area of cells in a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableMergedAreaProperties { + /** + * Specifies the number of columns for the merged cells area. + Must be 1 or greater. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnCount: number; + /** + * Specifies the zero-based index of the column of the top left cell of the merged area. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnIndex: number; + /** + * Specifies the number of rows for the merged cells area. + Must be 1 or greater. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowCount: number; + /** + * Specifies the zero-based index of the row of the top left cell of the merged area. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowIndex: number; + } + /** + * Provides the table row properties. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableRowProperties { + /** + * Represents the desired height of each row in points, or is undefined. + + When a table is being added, for rows whose height is undefined, + the row height will be calculated by evenly dividing the remaining height + of the table amongst those rows. If the table does not have a defined height, + a default row height will be used. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowHeight?: number | undefined; + } + /** + * Represents the available options when adding a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableAddOptions { + /** + * If provided, specifies properties for each column in the table. + The array length must be equal to the number of columns in the table. + Specify an empty object for columns that should use the default formatting. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columns?: PowerPoint.TableColumnProperties[]; + /** + * Specifies the height, in points, of the table. + A default value is used when this parameter is not provided. + Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + height?: number | undefined; + /** + * Specifies the distance, in points, from the left side of the table to the left side of the slide. + The table is centered horizontally when this parameter is not provided. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + left?: number | undefined; + /** + * If specified, represents an rectangular area where multiple cells appear as a single cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + mergedAreas?: PowerPoint.TableMergedAreaProperties[]; + /** + * If provided, specifies properties for each row in the table. + The array length must be equal to the number of rows in the table. + Specify an empty object for rows that should use the default formatting. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rows?: PowerPoint.TableRowProperties[]; + /** + * If provided, specifies properties for each cell in the table. + + This should be an 2D array with the same number of rows and columns as the table. + If a cell does not require specific formatting, specify an empty object for that cell. + Only the top left cell of a merged are can have properties specified, which will be applied + to the entire merged area. For the other cells in the merged area, an empty object should be provided. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + specificCellProperties?: PowerPoint.TableCellProperties[][]; + /** + * Specifies the distance, in points, from the top edge of the table to the top edge of the slide. + A default value is used when this parameter is not provided. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + top?: number | undefined; + /** + * Specifies the formatting which applies uniformly to all of the table cells. + + To apply specific formatting to individual cells, use specificCellProperties. + + If both uniformCellProperties and specificCellProperties are undefined, the default formatting + will be used, and the default table style will be applied. The table will have the same + appearance as when the user adds a table through the PowerPoint UI. + + To provide a plain appearance for the table, set this property to an empty object + and do not specify specificCellProperties. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + uniformCellProperties?: PowerPoint.TableCellProperties; + /** + * If provided, specifies the values for the table. + + When the table contains areas of merged cells, + only the top left cell of each merged area can have a + non-empty string value. The other cells + in the merged area must be an empty string. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + values?: string[][]; + /** + * Specifies the width, in points, of the table. + A default value is used when this parameter is not provided. + Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + width?: number | undefined; + } + /** + * Represents the collection of shapes. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Shape[]; + /** + * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. + * @param options An optional parameter to specify the additional options such as the position of the shape. + * @returns The newly inserted shape. */ addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; /** @@ -127400,6 +128414,16 @@ declare namespace PowerPoint { * @returns The newly inserted shape. */ addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Create a shape group for several shapes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param values An array of shape IDs or `Shape` objects. + * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group. + */ + addGroup(values: Array): PowerPoint.Shape; /** * Adds a line to the slide. Returns a `Shape` object that represents the new line. * @@ -127423,6 +128447,19 @@ declare namespace PowerPoint { */ addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; /** + * Adds a table to the slide. Returns a `Shape` object that represents the new table. + Use the `Shape.table` property to get the `Table` object for the shape. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param rowCount Number of rows in the table. Must be 1 or greater. + * @param columnCount Number of columns in the table. Must be 1 or greater. + * @param options Provides options describing the new table. + * @returns The newly inserted shape. + */ + addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape; + /** * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box. * * @remarks @@ -127495,6 +128532,258 @@ declare namespace PowerPoint { */ toJSON(): PowerPoint.Interfaces.ShapeCollectionData; } + /** + * Represents the available options when getting an image of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface SlideGetImageOptions { + /** + * The desired height of the resulting image in pixels. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + height?: number; + /** + * The desired width of the resulting image in pixels. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + width?: number; + } + /** + * Specifies the type of a slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + enum SlideLayoutType { + /** + * Blank layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + blank = "Blank", + /** + * Chart layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + chart = "Chart", + /** + * Chart and text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + chartAndText = "ChartAndText", + /** + * ClipArt and text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + clipArtAndText = "ClipArtAndText", + /** + * ClipArt and vertical text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + clipArtAndVerticalText = "ClipArtAndVerticalText", + /** + * Comparison layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + comparison = "Comparison", + /** + * Content with caption layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + contentWithCaption = "ContentWithCaption", + /** + * Custom layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + custom = "Custom", + /** + * Four objects layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + fourObjects = "FourObjects", + /** + * Large object layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + largeObject = "LargeObject", + /** + * MediaClip and text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + mediaClipAndText = "MediaClipAndText", + /** + * Mixed layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + mixed = "Mixed", + /** + * Object layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + object = "Object", + /** + * Object and text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + objectAndText = "ObjectAndText", + /** + * Object and two objects layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + objectAndTwoObjects = "ObjectAndTwoObjects", + /** + * Object over text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + objectOverText = "ObjectOverText", + /** + * Organization chart layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + organizationChart = "OrganizationChart", + /** + * Picture with caption layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + pictureWithCaption = "PictureWithCaption", + /** + * Section header layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + sectionHeader = "SectionHeader", + /** + * Table layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + table = "Table", + /** + * Text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text = "Text", + /** + * Text and chart layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textAndChart = "TextAndChart", + /** + * Text and ClipArt layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textAndClipArt = "TextAndClipArt", + /** + * Text and MediaClip layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textAndMediaClip = "TextAndMediaClip", + /** + * Text and object layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textAndObject = "TextAndObject", + /** + * Text and two objects layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textAndTwoObjects = "TextAndTwoObjects", + /** + * Text over object layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textOverObject = "TextOverObject", + /** + * Title layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + title = "Title", + /** + * Title only layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + titleOnly = "TitleOnly", + /** + * Two-column text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + twoColumnText = "TwoColumnText", + /** + * Two objects layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + twoObjects = "TwoObjects", + /** + * Two objects and object layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + twoObjectsAndObject = "TwoObjectsAndObject", + /** + * Two objects and text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + twoObjectsAndText = "TwoObjectsAndText", + /** + * Two objects over text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + twoObjectsOverText = "TwoObjectsOverText", + /** + * Vertical text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalText = "VerticalText", + /** + * Vertical title and text layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalTitleAndText = "VerticalTitleAndText", + /** + * Vertical title and text over chart layout. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart", + } /** * Represents the layout of a slide. * @@ -127532,6 +128821,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ readonly name: string; + /** + * Returns the type of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -127903,14 +129199,58 @@ declare namespace PowerPoint { * @remarks * [Api set: PowerPointApi 1.2] */ - readonly id: string; + readonly id: string; + /** + * Returns the zero-based index of the slide representing its position in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly index: number; + /** + * Applies the specified layout to the slide, changing its design and structure according to the chosen layout. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param slideLayout The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master. + */ + applyLayout(slideLayout: PowerPoint.SlideLayout): void; + /** + * Deletes the slide from the presentation. Does nothing if the slide does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + delete(): void; + /** + * Exports the slide to its own presentation file, returned as Base64-encoded data. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + exportAsBase64(): OfficeExtension.ClientResult; + /** + * Renders an image of the slide. The image is scaled to fit into the desired dimensions. + If width and height aren't specified, the true size of the slide is used. If only one + of either width or height is specified, the other will be calculated to preserve aspect ratio. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param options Optional. Options to specify the desired size of the slide image. + * @returns A Base64 string of the slide image in PNG format. + */ + getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult; /** - * Deletes the slide from the presentation. Does nothing if the slide does not exist. + * Moves the slide to a new position within the presentation. * * @remarks - * [Api set: PowerPointApi 1.2] + * [Api set: PowerPointApi 1.8] + * + * @param slideIndex The zero-based index where the slide should be moved. */ - delete(): void; + moveTo(slideIndex: number): void; /** * Selects the specified shapes. Existing shape selection is replaced with the new selection. * @@ -127996,6 +129336,15 @@ declare namespace PowerPoint { * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned. */ getItemOrNullObject(id: string): PowerPoint.Shape; + /** + * Groups all shapes in this collection into a single shape. + If the collection contains fewer than two shapes, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * @returns The newly created grouped shape as a {@link PowerPoint.Shape}. + */ + group(): PowerPoint.Shape; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -128020,6 +129369,70 @@ declare namespace PowerPoint { */ toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData; } + /** + * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class ShapeGroup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the `Shape` object associated with the group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly shape: PowerPoint.Shape; + /** + * Returns the collection of `Shape` objects in the group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly shapes: PowerPoint.ShapeScopedCollection; + /** + * Gets the unique ID of the shape group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly id: string; + /** + * Ungroups any grouped shapes in the specified shape group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + ungroup(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeGroupLoadOptions): PowerPoint.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ShapeGroup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeGroupData; + } /** * Specifies the style for a line. * @@ -128471,6 +129884,38 @@ declare namespace PowerPoint { */ toJSON(): PowerPoint.Interfaces.TextFrameData; } + /** + * Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + enum ShapeZOrder { + /** + * Brings the shape forward one spot in the z-order. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bringForward = "BringForward", + /** + * Brings the shape to the front of the z-order. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bringToFront = "BringToFront", + /** + * Sends the shape backward one spot in the z-order. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + sendBackward = "SendBackward", + /** + * Sends the shape to the back of the z-order. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + sendToBack = "SendToBack", + } /** * Represents a single shape in the slide. * @@ -128494,6 +129939,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ readonly fill: PowerPoint.ShapeFill; + /** + * Returns the `ShapeGroup` associated with the shape. + If the shape type isn't `group`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly group: PowerPoint.ShapeGroup; /** * Returns the line formatting of this shape. * @@ -128501,6 +129954,22 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ readonly lineFormat: PowerPoint.ShapeLineFormat; + /** + * Returns the parent group of this shape. + If the shape isn't part of a group, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly parentGroup: PowerPoint.Shape; + /** + * Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly placeholderFormat: PowerPoint.PlaceholderFormat; /** * Returns a collection of tags in the shape. * @@ -128509,136 +129978,360 @@ declare namespace PowerPoint { */ readonly tags: PowerPoint.TagCollection; /** - * Returns the text frame object of this shape. + * Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly textFrame: PowerPoint.TextFrame; + /** + * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height: number; + /** + * Gets the unique ID of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly id: string; + /** + * The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left: number; + /** + * Returns the level of the specified shape. + + - A level of 0 means the shape isn't part of a group. + + - A level of 1 means the shape is part of a top-level group. + + - A level greater than 1 indicates the shape is a nested group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly level: number; + /** + * Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name: string; + /** + * The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top: number; + /** + * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"; + /** + * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width: number; + /** + * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but + each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly zOrderPosition: number; + /** + * Deletes the shape from the shape collection. Does nothing if the shape does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + delete(): void; + /** + * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlide(): PowerPoint.Slide; + /** + * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideLayout(): PowerPoint.SlideLayout; + /** + * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout; + /** + * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideMaster(): PowerPoint.SlideMaster; + /** + * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster; + /** + * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideOrNullObject(): PowerPoint.Slide; + /** + * Returns the `Table` object if this shape is a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + getTable(): PowerPoint.Table; + /** + * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum. + */ + setZOrder(position: PowerPoint.ShapeZOrder): void; + /** + * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum. + */ + setZOrder(position: "BringForward" | "BringToFront" | "SendBackward" | "SendToBack"): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Shape; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeData; + } + /** + * Represents an Office.js binding that is defined in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class Binding extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the binding identifier. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - readonly textFrame: PowerPoint.TextFrame; + readonly id: string; /** - * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * Returns the type of the binding. See `BindingType` for details. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - height: number; + readonly type: PowerPoint.BindingType | "Shape"; /** - * Gets the unique ID of the shape. + * Deletes the binding. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.8] */ - readonly id: string; + delete(): void; /** - * The distance, in points, from the left side of the shape to the left side of the slide. + * Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - left: number; + getShape(): PowerPoint.Shape; /** - * Specifies the name of this shape. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.4] + * @param options Provides options for which properties of the object to load. */ - name: string; + load(options?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.Binding; /** - * The distance, in points, from the top edge of the shape to the top edge of the slide. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.4] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - top: number; + load(propertyNames?: string | string[]): PowerPoint.Binding; /** - * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.4] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Binding; /** - * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.BindingData; + } + /** + * Represents the collection of all the binding objects that are part of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class BindingCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Binding[]; + /** + * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] + * + * @param shape Shape to which the binding is added. + * @param bindingType Type of binding. See `BindingType`. + * @param id ID of the binding. */ - width: number; + add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding; /** - * Deletes the shape from the shape collection. Does nothing if the shape does not exist. + * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.8] + * + * @param shape Shape to which the binding is added. + * @param bindingType Type of binding. See `BindingType`. + * @param id ID of the binding. */ - delete(): void; + add(shape: PowerPoint.Shape, bindingType: "Shape", id: string): PowerPoint.Binding; /** - * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`. + * Adds a new binding based on the current selection. + If the selection has multiple areas, the `InvalidReference` error will be returned. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.8] + * + * @param bindingType Type of binding. See `BindingType`. + * @param id ID of the binding. */ - getParentSlide(): PowerPoint.Slide; + addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding; /** - * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`. + * Adds a new binding based on the current selection. + If the selection has multiple areas, the `InvalidReference` error will be returned. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.8] + * + * @param bindingType Type of binding. See `BindingType`. + * @param id ID of the binding. */ - getParentSlideLayout(): PowerPoint.SlideLayout; + addFromSelection(bindingType: "Shape", id: string): PowerPoint.Binding; /** - * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned. + * Gets the number of bindings in the collection. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.8] */ - getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout; + getCount(): OfficeExtension.ClientResult; /** - * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`. + * Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.8] + * + * @param key ID of the binding object to be retrieved. */ - getParentSlideMaster(): PowerPoint.SlideMaster; + getItem(key: string): PowerPoint.Binding; /** - * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned. + * Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.8] + * + * @param index Index value of the object to be retrieved. Zero-indexed. */ - getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster; + getItemAt(index: number): PowerPoint.Binding; /** - * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned. + * Gets a binding object by ID. If the binding object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.8] + * + * @param id ID of the binding object to be retrieved. */ - getParentSlideOrNullObject(): PowerPoint.Slide; + getItemOrNullObject(id: string): PowerPoint.Binding; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape; + load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.Shape; + load(propertyNames?: string | string[]): PowerPoint.BindingCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.Shape; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.BindingCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): PowerPoint.Interfaces.ShapeData; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.BindingCollectionData; } /** * Specifies the document property type for custom properties. @@ -129195,7 +130888,7 @@ declare namespace PowerPoint { getItemAt(index: number): PowerPoint.SlideMaster; /** * Gets a Slide Master using its unique ID. If such a Slide Master does not exist, an object with an `isNullObject` property set to true is returned. - For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}." + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: PowerPointApi 1.3] @@ -129293,6 +130986,19 @@ declare namespace PowerPoint { } /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */ interface ShapeFontUpdateData { + /** + * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **All Caps** attribute. + * + * - `false`: None of the text has the **All Caps**attribute. + * + * - `null`: Some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + allCaps?: boolean | null; /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: * @@ -129313,6 +131019,19 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ color?: string | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Double strikethrough** attribute. + * + * - `false`: None of the text has the **Double strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + doubleStrikethrough?: boolean | null; /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: * @@ -129340,6 +131059,58 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ size?: number | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **Small Caps** attribute. + * + * - `false`: None of the text has the **Small Caps** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + smallCaps?: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Strikethrough** attribute. + * + * - `false`: None of the text has the **Strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + strikethrough?: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Subscript** attribute. + * + * - `false`: None of the text has the **Subscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + subscript?: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Superscript** attribute. + * + * - `false`: None of the text has the **Superscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + superscript?: boolean | null; /** * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. * @@ -129348,6 +131119,20 @@ declare namespace PowerPoint { */ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null; } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + interface TableCellUpdateData { + /** + * Specifies the text content of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text?: string; + } + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + interface TableCellCollectionUpdateData { + items?: PowerPoint.Interfaces.TableCellData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -129555,6 +131340,10 @@ declare namespace PowerPoint { */ width?: number; } + /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */ + interface BindingCollectionUpdateData { + items?: PowerPoint.Interfaces.BindingData[]; + } /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ interface CustomPropertyUpdateData { /** @@ -129684,6 +131473,24 @@ declare namespace PowerPoint { interface CustomXmlPartCollectionData { items?: PowerPoint.Interfaces.CustomXmlPartData[]; } + /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */ + interface PlaceholderFormatData { + /** + * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details. + Returns `null` if the placeholder is empty. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null; + /** + * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; + } /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ interface HyperlinkData { /** @@ -129732,6 +131539,19 @@ declare namespace PowerPoint { /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ interface ShapeFontData { /** + * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **All Caps** attribute. + * + * - `false`: None of the text has the **All Caps**attribute. + * + * - `null`: Some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + allCaps?: boolean | null; + /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: * * - `true`: All the text is bold. @@ -129751,6 +131571,19 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ color?: string | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Double strikethrough** attribute. + * + * - `false`: None of the text has the **Double strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + doubleStrikethrough?: boolean | null; /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: * @@ -129763,28 +131596,148 @@ declare namespace PowerPoint { * @remarks * [Api set: PowerPointApi 1.4] */ - italic?: boolean | null; + italic?: boolean | null; + /** + * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: string | null; + /** + * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + size?: number | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **Small Caps** attribute. + * + * - `false`: None of the text has the **Small Caps** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + smallCaps?: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Strikethrough** attribute. + * + * - `false`: None of the text has the **Strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + strikethrough?: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Subscript** attribute. + * + * - `false`: None of the text has the **Subscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + subscript?: boolean | null; + /** + * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Superscript** attribute. + * + * - `false`: None of the text has the **Superscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + superscript?: boolean | null; + /** + * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null; + } + /** An interface describing the data returned by calling `tableCell.toJSON()`. */ + interface TableCellData { + /** + * Gets the number of table columns this cell spans across. + Will be greater than or equal to 1. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnCount?: number; + /** + * Gets the zero-based column index of the cell within the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnIndex?: number; + /** + * Gets the number of table rows this cell spans across. + Will be greater than or equal to 1. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowCount?: number; + /** + * Gets the zero-based row index of the cell within the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowIndex?: number; + /** + * Specifies the text content of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text?: string; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + interface TableCellCollectionData { + items?: PowerPoint.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `table.toJSON()`. */ + interface TableData { /** - * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names. + * Gets the number of columns in the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - name?: string | null; + columnCount?: number; /** - * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes. + * Gets the number of rows in the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - size?: number | null; + rowCount?: number; /** - * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * Gets all of the values in the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null; + values?: string[][]; } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ interface ShapeCollectionData { @@ -129806,6 +131759,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ name?: string; + /** + * Returns the type of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"; } /** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */ interface SlideLayoutCollectionData { @@ -129858,11 +131818,28 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.2] */ id?: string; + /** + * Returns the zero-based index of the slide representing its position in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + index?: number; } /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */ interface ShapeScopedCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + interface ShapeGroupData { + /** + * Gets the unique ID of the shape group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + id?: string; + } /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */ interface ShapeLineFormatData { /** @@ -130036,6 +132013,19 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ left?: number; + /** + * Returns the level of the specified shape. + + - A level of 0 means the shape isn't part of a group. + + - A level of 1 means the shape is part of a top-level group. + + - A level greater than 1 indicates the shape is a nested group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + level?: number; /** * Specifies the name of this shape. * @@ -130064,6 +132054,35 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ width?: number; + /** + * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but + each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + zOrderPosition?: number; + } + /** An interface describing the data returned by calling `binding.toJSON()`. */ + interface BindingData { + /** + * Represents the binding identifier. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + id?: string; + /** + * Returns the type of the binding. See `BindingType` for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: PowerPoint.BindingType | "Shape"; + } + /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */ + interface BindingCollectionData { + items?: PowerPoint.Interfaces.BindingData[]; } /** An interface describing the data returned by calling `customProperty.toJSON()`. */ interface CustomPropertyData { @@ -130291,6 +132310,33 @@ declare namespace PowerPoint { */ namespaceUri?: boolean; } + /** + * Represents the properties of a `placeholder` shape. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface PlaceholderFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details. + Returns `null` if the placeholder is empty. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + containedType?: boolean; + /** + * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: boolean; + } /** * Represents a single hyperlink. * @@ -130315,132 +132361,341 @@ declare namespace PowerPoint { * @remarks * [Api set: PowerPointApi 1.6] */ - screenTip?: boolean; + screenTip?: boolean; + } + /** + * Represents a collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + interface HyperlinkCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: boolean; + /** + * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: boolean; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + interface ShapeFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + foregroundColor?: boolean; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: boolean; + /** + * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: boolean; + } + /** + * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + interface ShapeFontLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **All Caps** attribute. + * + * - `false`: None of the text has the **All Caps**attribute. + * + * - `null`: Some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + allCaps?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: + * + * - `true`: All the text is bold. + * + * - `false`: None of the text is bold. + * + * - `null`: Returned if some, but not all, of the text is bold. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bold?: boolean; + /** + * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Double strikethrough** attribute. + * + * - `false`: None of the text has the **Double strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + doubleStrikethrough?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: + * + * - `true`: All the text is italicized. + * + * - `false`: None of the text is italicized. + * + * - `null`: Returned if some, but not all, of the text is italicized. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + italic?: boolean; + /** + * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: boolean; + /** + * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + size?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + * + * - `true`: All the text has the **Small Caps** attribute. + * + * - `false`: None of the text has the **Small Caps** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + smallCaps?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Strikethrough** attribute. + * + * - `false`: None of the text has the **Strikethrough** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + strikethrough?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Subscript** attribute. + * + * - `false`: None of the text has the **Subscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + subscript?: boolean; + /** + * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: + * + * - `true`: All the text has the **Superscript** attribute. + * + * - `false`: None of the text has the **Superscript** attribute. + * + * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + superscript?: boolean; + /** + * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + underline?: boolean; } /** - * Represents a collection of hyperlinks. + * Represents a table. * * @remarks - * [Api set: PowerPointApi 1.6] + * [Api set: PowerPointApi 1.8] */ - interface HyperlinkCollectionLoadOptions { + interface TableCellLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the URL target of the hyperlink. + * Gets the number of table columns this cell spans across. + Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi 1.6] + * [Api set: PowerPointApi 1.8] */ - address?: boolean; + columnCount?: boolean; /** - * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. + * Gets the zero-based column index of the cell within the table. * * @remarks - * [Api set: PowerPointApi 1.6] - */ - screenTip?: boolean; - } - /** - * Represents the fill formatting of a shape object. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - interface ShapeFillLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: PowerPointApi 1.8] */ - $all?: boolean; + columnIndex?: boolean; /** - * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * Gets the number of table rows this cell spans across. + Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - foregroundColor?: boolean; + rowCount?: boolean; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets the zero-based row index of the cell within the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - transparency?: boolean; + rowIndex?: boolean; /** - * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. + * Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - type?: boolean; + text?: boolean; } /** - * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. + * Represents a collection of table cells. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - interface ShapeFontLoadOptions { + interface TableCellCollectionLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; /** - * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: - * - * - `true`: All the text is bold. - * - * - `false`: None of the text is bold. - * - * - `null`: Returned if some, but not all, of the text is bold. + * For EACH ITEM in the collection: Gets the number of table columns this cell spans across. + Will be greater than or equal to 1. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - bold?: boolean; + columnCount?: boolean; /** - * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors. + * For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - color?: boolean; + columnIndex?: boolean; /** - * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: - * - * - `true`: All the text is italicized. + * For EACH ITEM in the collection: Gets the number of table rows this cell spans across. + Will be greater than or equal to 1. * - * - `false`: None of the text is italicized. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowCount?: boolean; + /** + * For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table. * - * - `null`: Returned if some, but not all, of the text is italicized. + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowIndex?: boolean; + /** + * For EACH ITEM in the collection: Specifies the text content of the table cell. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - italic?: boolean; + text?: boolean; + } + /** + * Represents a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableLoadOptions { /** - * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names. + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the number of columns in the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - name?: boolean; + columnCount?: boolean; /** - * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes. + * Gets the number of rows in the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - size?: boolean; + rowCount?: boolean; /** - * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * Gets all of the values in the table. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - underline?: boolean; + values?: boolean; } /** * Represents the collection of shapes. @@ -130460,6 +132715,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. + If the shape type isn't `group`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** * For EACH ITEM in the collection: Returns the line formatting of this shape. * @@ -130467,6 +132730,22 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the parent group of this shape. + If the shape isn't part of a group, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** * For EACH ITEM in the collection: Returns the text frame object of this shape. * @@ -130495,6 +132774,19 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ left?: boolean; + /** + * For EACH ITEM in the collection: Returns the level of the specified shape. + + - A level of 0 means the shape isn't part of a group. + + - A level of 1 means the shape is part of a top-level group. + + - A level greater than 1 indicates the shape is a nested group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + level?: boolean; /** * For EACH ITEM in the collection: Specifies the name of this shape. * @@ -130523,6 +132815,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ width?: boolean; + /** + * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but + each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + zOrderPosition?: boolean; } /** * Represents the layout of a slide. @@ -130549,6 +132849,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ name?: boolean; + /** + * Returns the type of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: boolean; } /** * Represents the collection of layouts provided by the Slide Master for slides. @@ -130575,6 +132882,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ name?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: boolean; } /** * Represents the Slide Master of a slide. @@ -130686,6 +133000,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.2] */ id?: boolean; + /** + * Returns the zero-based index of the slide representing its position in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + index?: boolean; } /** * Represents a collection of shapes. @@ -130705,6 +133026,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.5] */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. + If the shape type isn't `group`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** * For EACH ITEM in the collection: Returns the line formatting of this shape. * @@ -130712,6 +133041,22 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.5] */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the parent group of this shape. + If the shape isn't part of a group, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** * For EACH ITEM in the collection: Returns the text frame object of this shape. * @@ -130740,6 +133085,19 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ left?: boolean; + /** + * For EACH ITEM in the collection: Returns the level of the specified shape. + + - A level of 0 means the shape isn't part of a group. + + - A level of 1 means the shape is part of a top-level group. + + - A level greater than 1 indicates the shape is a nested group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + level?: boolean; /** * For EACH ITEM in the collection: Specifies the name of this shape. * @@ -130768,6 +133126,40 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ width?: boolean; + /** + * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but + each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + zOrderPosition?: boolean; + } + /** + * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface ShapeGroupLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the `Shape` object associated with the group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + shape?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * Gets the unique ID of the shape group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + id?: boolean; } /** * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. @@ -131010,6 +133402,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; + /** + * Returns the `ShapeGroup` associated with the shape. + If the shape type isn't `group`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** * Returns the line formatting of this shape. * @@ -131017,6 +133417,22 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; + /** + * Returns the parent group of this shape. + If the shape isn't part of a group, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** * Returns the text frame object of this shape. * @@ -131046,6 +133462,19 @@ declare namespace PowerPoint { */ left?: boolean; /** + * Returns the level of the specified shape. + + - A level of 0 means the shape isn't part of a group. + + - A level of 1 means the shape is part of a top-level group. + + - A level greater than 1 indicates the shape is a nested group. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + level?: boolean; + /** * Specifies the name of this shape. * * @remarks @@ -131073,6 +133502,66 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ width?: boolean; + /** + * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but + each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + zOrderPosition?: boolean; + } + /** + * Represents an Office.js binding that is defined in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface BindingLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the binding identifier. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + id?: boolean; + /** + * Returns the type of the binding. See `BindingType` for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: boolean; + } + /** + * Represents the collection of all the binding objects that are part of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface BindingCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the binding identifier. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + type?: boolean; } /** * Represents a custom property. @@ -131263,6 +133752,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.2] */ id?: boolean; + /** + * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + index?: boolean; } /** * Represents a collection of slides in the presentation. @@ -131296,6 +133792,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.2] */ id?: boolean; + /** + * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + index?: boolean; } /** * Represents the collection of Slide Masters in the presentation.