@pptx-editor.dev/editor-api

isPptxEditorErrorfunctionSource ↗

Whether a caught value is one of ours. By name as well as by instanceof: a consumer can end up with two copies of this module, and instanceof fails across them.

declare function isPptxEditorError(value: unknown): value is PptxEditorError;

AdjustmentsclassSource ↗

The adjust values of a shape's preset geometry: the handles that change, for example, the corner radius of a rounded rectangle. A length is a fraction of the shape size (0.5 is half); an angle is in degrees. A write is bounded to the range of the preset's adjust handle.

A shape with no preset geometry (a freeform, a group, a table) refuses with NotSupported.

declare class Adjustments extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Adjustments class.

ApplicationclassSource ↗

The application the presentation is open in. It has no properties or methods.

declare class Application extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Application class.

BindingclassSource ↗

A binding: an id that names one shape for the lifetime of the runtime.

declare class Binding extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Binding class.

BindingCollectionclassSource ↗

The bindings of the runtime, in the order they were added. They live in memory and are never saved with the presentation.

declare class BindingCollection extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BindingCollection class.

```ts
await runtime.run(async (context) => {
  const shape = context.presentation.slides.getItemAt(0).shapes.getItemAt(0);
  context.presentation.bindings.add(shape, 'Shape', 'title');
  await context.sync();
});
```

BorderclassSource ↗

One border of a table cell: an edge or a diagonal. It reads the line the cell shows, its own or the table style's; a cell with no line there reads undefined for each property. A write keeps the properties it does not set, and an outside edge also changes the cell across it.

declare class Border extends CellFormatPart

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Border class.

BordersclassSource ↗

The borders of a table cell (a:tcPr/a:lnL, a:lnR, a:lnT, a:lnB, a:lnTlToBr, a:lnBlToTr).

declare class Borders extends CellFormatPart

BulletFormatclassSource ↗

The bullets of paragraphs (a:buNone, a:buChar, a:buAutoNum).

declare class BulletFormat extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BulletFormat class.

ClientObjectclassSource ↗

The base every presentation proxy extends.

A released proxy still answers what it already knew: a property loaded before the run ended is served from memory. Anything that would talk to the presentation (load, a write, a method) refuses with InvalidObjectPath.

declare abstract class ClientObject implements RuntimeManagedObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ClientObject class.

ClientResultclassSource ↗

A value a queued method promised to produce, readable after the next sync().

Not a Promise: a method call inside a batch has not been sent yet, so there is nothing that could resolve on its own. Reading one early is ValueNotLoaded.

declare class ClientResult<T>

```ts
const count = context.presentation.slides.getCount();
await context.sync();
console.log(count.value);
```

CustomPropertyclassSource ↗

One custom document property: a key, a type, and a value.

declare class CustomProperty extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CustomProperty class.

CustomPropertyCollectionclassSource ↗

The custom document properties of the presentation.

declare class CustomPropertyCollection extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CustomPropertyCollection class.

```ts
await runtime.run(async (context) => {
  const custom = context.presentation.properties.customProperties;
  custom.add('Client', 'Northwind');
  custom.add('Reviewed', new Date());
  await context.sync();
});
```

CustomXmlPartclassSource ↗

One custom XML part.

declare class CustomXmlPart extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CustomXmlPart class.

CustomXmlPartCollectionclassSource ↗

The custom XML parts of a presentation, slide, layout, master, or shape.

declare class CustomXmlPartCollection extends CustomXmlPartList

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CustomXmlPartCollection class.

```ts
await runtime.run(async (context) => {
  const parts = context.presentation.customXmlParts;
  const part = parts.add('<review xmlns="urn:example:review"><status>open</status></review>');
  part.load('id');
  await context.sync();
  console.log(part.id);
});
```

CustomXmlPartScopedCollectionclassSource ↗

The custom XML parts of one namespace, from CustomXmlPartCollection.getByNamespace.

declare class CustomXmlPartScopedCollection extends CustomXmlPartList

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CustomXmlPartScopedCollection class.

DocumentPropertiesclassSource ↗

The core and extended document properties (docProps/core.xml, docProps/app.xml).

declare class DocumentProperties extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the DocumentProperties class.

HyperlinkclassSource ↗

One hyperlink: on a text range or on a whole shape.

declare class Hyperlink extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Hyperlink class.

HyperlinkCollectionclassSource ↗

The hyperlinks of a slide, in shape order.

declare class HyperlinkCollection extends HyperlinkList

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HyperlinkCollection class.

HyperlinkScopedCollectionclassSource ↗

The hyperlinks of a text range: each text link that overlaps the range, in text order. A link keeps its whole span, so one that starts before the range reads from its own start. An empty range holds the link around its point.

declare class HyperlinkScopedCollection extends HyperlinkList

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HyperlinkScopedCollection class.

MarginsclassSource ↗

The margins of a table cell, in points (a:tcPr/@marL, @marR, @marT, @marB). Writing undefined removes the margin, back to its default (7.2 points left and right, 3.6 points top and bottom).

declare class Margins extends CellFormatPart

PageSetupclassSource ↗

The slide size, in points (p:sldSz, ECMA-376 Part 1, 19.2.1.39).

declare class PageSetup extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PageSetup class.

ParagraphFormatclassSource ↗

The paragraph formatting of the paragraphs a text range touches. A property reads null when they differ.

declare class ParagraphFormat extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ParagraphFormat class.

PlaceholderFormatclassSource ↗

The placeholder properties of a shape (p:ph, ECMA-376 Part 1, 19.3.1.36).

declare class PlaceholderFormat extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PlaceholderFormat class.

PptxEditorErrorclassSource ↗

Every refusal this runtime throws.

Branch on [PptxEditorError.code](PptxEditorError.code), never on the message. Codes are stable public API. Nothing from the engine or the file appears in the message: a consumer gets a stable code, a fixed sentence, and target, the consumer-facing path they wrote themselves.

declare class PptxEditorError extends Error

```ts
try {
  await context.sync();
} catch (error) {
  if (isPptxEditorError(error) && error.code === 'StaleDocument') {
    // Read again: another writer changed the presentation first.
  }
}
```

PresentationclassSource ↗

The presentation: its slides, masters, tags, properties, and page setup.

declare class Presentation extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Presentation class.

```ts
await runtime.run(async (context) => {
  const slides = context.presentation.slides;
  slides.load('items/id');
  await context.sync();
  console.log(slides.items.map((slide) => slide.id));
});
```

RequestContextclassSource ↗

What a run hands its callback: one queue, one presentation, one sync at a time.

sync() sends every queued call as one atomic batch: all of it applies, or none of it. A context that has READ remembers the revision it read at, and a later sync that writes is conditional on it, failing StaleDocument if another writer moved the presentation. A context that has read nothing writes unconditionally.

declare class RequestContext

ShapeclassSource ↗

A shape on a slide, layout, or master: a geometric shape, a text box, a picture, a line, a group, a table, or another graphic frame.

declare class Shape extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Shape class.

ShapeCollectionclassSource ↗

The shapes of a slide, layout, master, or group, in z-order.

declare class ShapeCollection extends ShapeList

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ShapeCollection class.

ShapeFillclassSource ↗

The fill of a shape.

declare class ShapeFill extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ShapeFill class.

ShapeFontclassSource ↗

The character formatting of a text range. A property reads null when the range mixes values.

declare class ShapeFont extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ShapeFont class.

ShapeGroupclassSource ↗

A group shape (p:grpSp).

declare class ShapeGroup extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ShapeGroup class.

ShapeLineFormatclassSource ↗

The outline of a shape, or a line.

declare class ShapeLineFormat extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ShapeLineFormat class.

ShapeScopedCollectionclassSource ↗

A set of shapes: the reader's selection, or the members of a group.

declare class ShapeScopedCollection extends ShapeList

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ShapeScopedCollection class.

SlideclassSource ↗

A slide.

declare class Slide extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Slide class.

SlideBackgroundclassSource ↗

The background of a slide.

declare class SlideBackground extends BackgroundPart

SlideBackgroundFillclassSource ↗

The fill of a background.

declare class SlideBackgroundFill extends BackgroundPart

SlideBackgroundGradientFillclassSource ↗

A gradient background fill.

declare class SlideBackgroundGradientFill extends BackgroundPart

SlideBackgroundPatternFillclassSource ↗

A pattern background fill (a:pattFill).

declare class SlideBackgroundPatternFill extends BackgroundPart

SlideBackgroundPictureOrTextureFillclassSource ↗

A picture background fill (a:blipFill), stretched to the slide.

declare class SlideBackgroundPictureOrTextureFill extends BackgroundPart

SlideBackgroundSolidFillclassSource ↗

A solid background fill.

declare class SlideBackgroundSolidFill extends BackgroundPart

SlideCollectionclassSource ↗

The slides of the presentation, in order.

declare class SlideCollection extends ItemCollection<Slide>

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SlideCollection class.

SlideLayoutclassSource ↗

A slide layout (p:sldLayout).

declare class SlideLayout extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SlideLayout class.

SlideLayoutBackgroundclassSource ↗

The background of a slide layout.

declare class SlideLayoutBackground extends BackgroundPart

SlideLayoutCollectionclassSource ↗

The layouts of a slide master, in p:sldLayoutIdLst order.

declare class SlideLayoutCollection extends ItemCollection<SlideLayout>

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SlideLayoutCollection class.

SlideMasterclassSource ↗

A slide master (p:sldMaster).

declare class SlideMaster extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SlideMaster class.

SlideMasterBackgroundclassSource ↗

The background of a slide master.

declare class SlideMasterBackground extends BackgroundPart

SlideMasterCollectionclassSource ↗

The slide masters of the presentation, in p:sldMasterIdLst order.

declare class SlideMasterCollection extends ItemCollection<SlideMaster>

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SlideMasterCollection class.

SlideScopedCollectionclassSource ↗

A set of slides: the reader's selection.

declare class SlideScopedCollection extends ItemCollection<Slide>

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SlideScopedCollection class.

TableclassSource ↗

The table of a table shape.

declare class Table extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Table class.

TableCellclassSource ↗

One cell of a table.

declare class TableCell extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableCell class.

TableCellCollectionclassSource ↗

The merged areas of a table, from Table.getMergedAreas. Each item is the first cell of one area, and its rowCount and columnCount give the span.

declare class TableCellCollection extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableCellCollection class.

TableColumnclassSource ↗

One column of a table.

declare class TableColumn extends TableLine

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableColumn class.

TableColumnCollectionclassSource ↗

The columns of a table.

declare class TableColumnCollection extends TableLines<TableColumn>

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableColumnCollection class.

TableRowclassSource ↗

One row of a table.

declare class TableRow extends TableLine

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableRow class.

TableRowCollectionclassSource ↗

The rows of a table.

declare class TableRowCollection extends TableLines<TableRow>

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableRowCollection class.

TableStyleSettingsclassSource ↗

The style options and the style of a table (a:tblPr). A style is found by its name in the presentation's ppt/tableStyles.xml: MediumStyle2Accent1 is "Medium Style 2 - Accent 1". The presentation must define the style, except MediumStyle2Accent1, which is built in, and NoStyleNoGrid, which removes the style choice.

declare class TableStyleSettings extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TableStyleSettings class.

TagclassSource ↗

One tag: a key and a value.

declare class Tag extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Tag class.

TagCollectionclassSource ↗

The tags of a presentation, slide, or shape.

declare class TagCollection extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TagCollection class.

TextFrameclassSource ↗

The text frame of a shape (p:txBody and its a:bodyPr).

declare class TextFrame extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TextFrame class.

TextRangeclassSource ↗

A run of text in a text frame.

declare class TextRange extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TextRange class.

ThemeColorSchemeclassSource ↗

The theme colors of a slide, a layout, or a master. Every slide, layout, and master that uses the same theme shares them, so a write changes all of them.

declare class ThemeColorScheme extends ModelObject

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ThemeColorScheme class.

TrackedObjectsclassSource ↗

The objects a context keeps addressable beyond the run that created them.

An ordinary proxy stops being usable when its run ends. Tracking one keeps its address alive so a later run(object, callback) can adopt it, and untracking releases it — which matters for long-lived callers, since a tracked object is a presentation reference that will not be collected on its own.

declare class TrackedObjects

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TrackedObjects class.

AddSlideOptionsinterfaceSource ↗

Options for SlideCollection.add.

interface AddSlideOptions

BorderPropertiesinterfaceSource ↗

One line of a cell, for TableCellBorders.

interface BorderProperties

CreateServerOptionsinterfaceSource ↗

How PptxEditor.createServer opens a presentation.

Opening PPTX bytes is a bounded parse: zip entry, size, and ratio caps, part name checks, and XML with no DTD. Malformed input refuses with InvalidArgument; a zip over a cap refuses with ResourceLimitExceeded. No message carries file content.

interface CreateServerOptions

FillPropertiesinterfaceSource ↗

A solid fill, for TableCellProperties.

interface FillProperties

FontPropertiesinterfaceSource ↗

Character formatting for one run of TableCell.textRuns. In a write, an absent property keeps the cell's format. A read gives every property, except color when the text has no solid fill.

interface FontProperties

HyperlinkAddOptionsinterfaceSource ↗

Options for a new hyperlink.

interface HyperlinkAddOptions

InsertSlideOptionsinterfaceSource ↗

Options for Presentation.insertSlidesFromBase64.

interface InsertSlideOptions

LoadPropertyOptionsinterfaceSource ↗

The property-tree form of load(...), as the Office.js *LoadOptions interfaces give it.

true loads a property. An object loads a navigation property with the properties it names; an empty object loads its default set. $all: true loads every scalar property of that object. On a collection, the keys name properties of each item, and $top and $skip limit the items. items is accepted as a key too, so { shapes: { items: { name: true } } } and { shapes: { name: true } } load the same thing.

interface LoadPropertyOptions

LoadQueryOptionsinterfaceSource ↗

The object form of load(...): which properties, and how much of a collection.

An unknown key, a non-integer top, a property name that is not an identifier, or a value of the wrong type is refused as InvalidArgument here, naming the option — a misspelled key is the difference between "load selected properties" and "load nothing", which would otherwise surface as a PropertyNotLoaded much later at a call that looks correct.

interface LoadQueryOptions

PptxEditorDebugInfointerfaceSource ↗

Debug details in the shape of Office.js OfficeExtension.DebugInfo.

interface PptxEditorDebugInfo

PptxEditorErrorInitinterfaceSource ↗

The fields a [PptxEditorError](PptxEditorError) is constructed from.

interface PptxEditorErrorInit

PptxEditorInnerErrorinterfaceSource ↗

Why the engine refused, as a public diagnostic code with its fixed hint.

interface PptxEditorInnerError

PptxEditorNamespaceinterfaceSource ↗

The entry point, as much of it as works without an editor. Import from @pptx-editor.dev/editor-api/browser for the same object plus createBrowser.

interface PptxEditorNamespace

PptxEditorRuntimeinterfaceSource ↗

A runtime: one presentation host, many runs.

Disposal is final: [PptxEditorRuntime.dispose](PptxEditorRuntime.dispose) releases the host once and is safe to call again, and every later run fails with RuntimeDisposed.

interface PptxEditorRuntime

PptxEditorServerRuntimeinterfaceSource ↗

A runtime over PPTX bytes rather than a live editor: what PptxEditor.createServer answers.

interface PptxEditorServerRuntime extends PptxEditorRuntime

PresentationCapabilitiesinterfaceSource ↗

Capabilities of a runtime, frozen for its lifetime.

interface PresentationCapabilities

RequestContextDebugInfointerfaceSource ↗

Debug information about a request context, as Office.js OfficeExtension.RequestContextDebugInfo.

interface RequestContextDebugInfo

ShapeAddOptionsinterfaceSource ↗

Where a new shape goes, in points from the top left of the slide.

interface ShapeAddOptions

ShapeGetImageOptionsinterfaceSource ↗

Options for Shape.getImageAsBase64. The picture keeps the shape's aspect ratio and fits into the box, as for a slide.

interface ShapeGetImageOptions

SlideBackgroundGradientFillOptionsinterfaceSource ↗

Options for SlideBackgroundFill.setGradientFill.

interface SlideBackgroundGradientFillOptions

SlideBackgroundPatternFillOptionsinterfaceSource ↗

Options for SlideBackgroundFill.setPatternFill.

interface SlideBackgroundPatternFillOptions

SlideBackgroundPictureOrTextureFillOptionsinterfaceSource ↗

Options for SlideBackgroundFill.setPictureOrTextureFill.

interface SlideBackgroundPictureOrTextureFillOptions

SlideBackgroundSolidFillOptionsinterfaceSource ↗

Options for SlideBackgroundFill.setSolidFill.

interface SlideBackgroundSolidFillOptions

SlideGetImageOptionsinterfaceSource ↗

Options for Slide.getImageAsBase64. The picture keeps the slide's aspect ratio and fits into the box: with both sizes it fits into both, with one size it takes that size, and with neither it has the slide's own size at 96 pixels per inch.

interface SlideGetImageOptions

TableAddOptionsinterfaceSource ↗

Options for ShapeCollection.addTable. They apply in this order: values, style, the column widths and row heights, mergedAreas, uniformCellProperties, then specificCellProperties.

interface TableAddOptions

TableCellBordersinterfaceSource ↗

The lines of a cell, for TableCellProperties.

interface TableCellBorders

TableCellMarginsinterfaceSource ↗

The margins of a cell in points, for TableCellProperties.

interface TableCellMargins

TableCellPropertiesinterfaceSource ↗

The format and content of a cell, for TableAddOptions.

interface TableCellProperties

TableClearOptionsinterfaceSource ↗

Options for Table.clear.

interface TableClearOptions

TableColumnPropertiesinterfaceSource ↗

One column of a new table, for TableAddOptions.

interface TableColumnProperties

TableMergedAreaPropertiesinterfaceSource ↗

One merged area of a new table, for TableAddOptions.

interface TableMergedAreaProperties

TableRowPropertiesinterfaceSource ↗

One row of a new table, for TableAddOptions.

interface TableRowProperties

TextRuninterfaceSource ↗

One run of text with its own format, for TableCell.textRuns.

interface TextRun

ClientRequestContexttypeSource ↗

The Office.js OfficeExtension.ClientRequestContext: here the same class as [RequestContext](RequestContext), under the name that code written for Office.js uses for the base of every request context.

type ClientRequestContext = RequestContext;

LoadOptiontypeSource ↗

Everything load(...) accepts: one property name or path, several, a [LoadQueryOptions](LoadQueryOptions) object, or a [LoadPropertyOptions](LoadPropertyOptions) tree.

type LoadOption = string | readonly string[] | LoadQueryOptions | LoadPropertyOptions;

```ts
shape.load('name');
shape.load(['name', 'left', 'fill/foregroundColor']);
slide.load('shapes/items/textFrame/textRange/text');
slide.load({ shapes: { items: { name: true, fill: { type: true } } } });
shapes.load({ select: 'items/name', top: 5 });
shapes.load('$all');
```


 A path names a property through navigation properties, for example `fill/type` on a shape. On a collection, `items/<path>` loads `items` and that path on each item in the same `context.sync()`. A path without the `items/` prefix means the same thing on a collection, so `shapes.load('name')` equals `shapes.load('items/name')`. `$all` loads every scalar property of the object it ends on, and `items/$all` of each item. `load()` and `load('items')` on a collection load every scalar property of each item, in one more round trip.  

A name that is not a property of the object it reaches is refused as `InvalidArgument`, with the object and the name as the error's `target`.

PptxEditorErrorCodetypeSource ↗

What went wrong, as a value a consumer may branch on.

type PptxEditorErrorCode = 
/** A property was read before a `load(...)` for it completed in a `sync()`. */
'PropertyNotLoaded'
/** A `ClientResult` value was read before the sync that fills it. */
 | 'ValueNotLoaded'
/**
 * The object cannot be addressed: its run ended and nothing tracked it, the call that would
 * have created it was in a refused sync, or the presentation no longer holds it (an edit
 * removed it). A lookup from a refused sync is sent again, so its proxy stays usable.
 */
 | 'InvalidObjectPath'
/** The object still belongs to a run that has not finished, so it cannot be handed over. */
 | 'ObjectInUse'
/** An argument or load option this API does not accept. */
 | 'InvalidArgument'
/** Opening the presentation exceeded a bounded reader limit. */
 | 'ResourceLimitExceeded'
/** The collection has no such item: `getItem` with an unknown id, `getItemAt` out of range. */
 | 'ItemNotFound'
/**
 * The call is outside the supported subset for this host or content, and nothing changed.
 * Examples: a server runtime has no selection; a shape has no text frame.
 */
 | 'NotSupported'
/** The member is one this API does not implement, and nothing changed. */
 | 'NotImplemented'
/** The request context's `run` has finished, so it can no longer be used. */
 | 'InvalidRequestContext'
/** The runtime was disposed. Every later operation fails this way. */
 | 'RuntimeDisposed'
/**
 * The batch was built from an older read, so nothing was applied: another writer changed the
 * presentation after this context read it. Read again before retrying.
 */
 | 'StaleDocument'
/** The host is live but holds no presentation right now: an editor between documents. */
 | 'DocumentUnavailable'
/** The presentation refused the change, or answered something this runtime cannot use. */
 | 'GeneralException';

RunCallbacktypeSource ↗

What a run callback is given, and what it may answer with.

type RunCallback<T> = (context: RequestContext) => Promise<T>;

BindingTypeenumSource ↗

declare enum BindingType

BulletStyleenumSource ↗

declare enum BulletStyle

BulletTypeenumSource ↗

declare enum BulletType

ConnectorTypeenumSource ↗

declare enum ConnectorType

DocumentPropertyTypeenumSource ↗

The type of a custom document property value.

declare enum DocumentPropertyType

GeometricShapeTypeenumSource ↗

A preset geometry for ShapeCollection.addGeometricShape.

declare enum GeometricShapeType

HyperlinkTypeenumSource ↗

declare enum HyperlinkType

InsertSlideFormattingenumSource ↗

declare enum InsertSlideFormatting

ParagraphHorizontalAlignmentenumSource ↗

declare enum ParagraphHorizontalAlignment

PlaceholderTypeenumSource ↗

declare enum PlaceholderType

ShapeAutoSizeenumSource ↗

declare enum ShapeAutoSize

ShapeFillTypeenumSource ↗

declare enum ShapeFillType

ShapeFontUnderlineStyleenumSource ↗

declare enum ShapeFontUnderlineStyle

ShapeGetImageFormatTypeenumSource ↗

The format of a shape picture from Shape.getImageAsBase64.

declare enum ShapeGetImageFormatType

ShapeLineDashStyleenumSource ↗

declare enum ShapeLineDashStyle

ShapeLineStyleenumSource ↗

declare enum ShapeLineStyle

ShapeTypeenumSource ↗

declare enum ShapeType

ShapeZOrderenumSource ↗

declare enum ShapeZOrder

SlideBackgroundFillTypeenumSource ↗

declare enum SlideBackgroundFillType

SlideBackgroundGradientFillTypeenumSource ↗

declare enum SlideBackgroundGradientFillType

SlideBackgroundPatternFillTypeenumSource ↗

declare enum SlideBackgroundPatternFillType

SlideLayoutTypeenumSource ↗

declare enum SlideLayoutType

TableStyleenumSource ↗

declare enum TableStyle

TextVerticalAlignmentenumSource ↗

declare enum TextVerticalAlignment

ThemeColorenumSource ↗

declare enum ThemeColor

PptxEditorconstSource ↗

The entry point: open a presentation and get a runtime to work against.

PptxEditor: PptxEditorNamespace

```ts
const runtime = await PptxEditor.createServer(bytes);
const titles = await runtime.run(async (context) => {
  const slides = context.presentation.slides;
  slides.load('items');
  await context.sync();
  const shapes = slides.items.map((slide) => slide.shapes.getItemAt(0).load('name'));
  await context.sync();
  return shapes.map((shape) => shape.name);
});
```