pptx API

This reference covers the Office.js-compatible PowerPoint surface exposed by witan pptx exec. TypeScript or JavaScript scripts run headlessly against a PPTX file through PowerPoint.run and the Witan PPTX runtime. Microsoft Office does not need to be installed.

Witan implements an Office.js-compatible PowerPoint superset for headless PPTX automation. It follows Office.js object model semantics where compatible and adds chart APIs that upstream PowerPoint Office.js does not expose. Unsupported members throw explicit Office.js-style errors rather than silently doing nothing.

Call Shape

witan pptx exec deck.pptx --stdin <<'JS'
return await PowerPoint.run(async context => {
  const slide = context.presentation.slides.getItemAt(0);
  const count = context.presentation.slides.getCount();
  await context.sync();
  return { firstSlideId: slide.id, slideCount: count.value };
});
JS

OfficeExtension.ClientResult<T> values, such as getCount(), should be read after await context.sync(). In Witan's headless runtime, load(...) and sync() are compatibility calls rather than network round trips: load(...) records requested properties, and sync() provides the Office.js sequencing point while resolving against the in-memory presentation model.

Runtime Boundaries

• PowerPoint.createPresentation(...) is intentionally not implemented. Use witan pptx exec <file.pptx> --create --save.
• Top-level await is supported.
• Static and dynamic imports are not available.
• Scripts cannot access the filesystem or network.
• --input-json is exposed as the global input; --input-file key=@path adds PNG/JPEG data URIs under input[key].
• The public API surface is witan pptx exec and witan pptx render; the backend RPC operations are implementation details.

Implemented Surface Summary

Runtime

Presentation, slides, layouts, and masters

Backgrounds and themes

Shapes, images, and groups

Text and hyperlinks

Tables

Metadata and custom data

Charts

Witan Chart Extensions

These members are Witan extensions for PowerPoint presentations. They use Excel-style chart semantics adapted to PPTX chart parts and embedded chart workbooks.

Chart Enums

ChartType

Witan PPTX chart type enum object.

area = "Area", areaStacked = "AreaStacked", areaStacked100 = "AreaStacked100", barClustered = "BarClustered", barStacked = "BarStacked", barStacked100 = "BarStacked100", bubble = "Bubble", columnClustered = "ColumnClustered", columnStacked = "ColumnStacked", columnStacked100 = "ColumnStacked100", doughnut = "Doughnut", line = "Line", lineMarkers = "LineMarkers", lineMarkersStacked = "LineMarkersStacked", lineMarkersStacked100 = "LineMarkersStacked100", lineStacked = "LineStacked", lineStacked100 = "LineStacked100", pie = "Pie", xyScatter = "XYScatter", xyScatterLines = "XYScatterLines", xyScatterLinesNoMarkers = "XYScatterLinesNoMarkers", xyScatterSmooth = "XYScatterSmooth", xyScatterSmoothNoMarkers = "XYScatterSmoothNoMarkers"

ChartAxisCategoryType

Witan PPTX chart axis category enum object.

automatic = "Automatic", dateAxis = "DateAxis", textAxis = "TextAxis"

ChartAxisGroup

Witan PPTX chart axis group enum object.

primary = "Primary", secondary = "Secondary"

ChartAxisTimeUnit

Witan PPTX chart axis time unit enum object.

days = "Days", months = "Months", years = "Years"

ChartLineStyle

Witan PPTX chart line style enum object.

automatic = "Automatic", continuous = "Continuous", dash = "Dash", dashDot = "DashDot", dashDotDot = "DashDotDot", dot = "Dot", none = "None", roundDot = "RoundDot"

ChartMarkerStyle

Witan PPTX chart marker style enum object.

automatic = "Automatic", circle = "Circle", dash = "Dash", diamond = "Diamond", dot = "Dot", none = "None", picture = "Picture", plus = "Plus", square = "Square", star = "Star", triangle = "Triangle", x = "X"

ChartUnderlineStyle

Witan PPTX chart underline style enum object.

none = "None", single = "Single"

Chart Types and Interfaces

AddChartOptions

Options for ShapeCollection.addChart.

ChartSetDataOptions

Options for Chart.setData.

ChartSetDataRangeOptions

Options for Chart.setDataRange.

Chart

Embedded-workbook-backed chart hosted inside a PPTX shape.

ChartAxes

Chart axes collection.

ChartAxis

A chart axis.

ChartGridlines

Major or minor gridline visibility.

ChartAxisTitle

Axis title.

ChartTitle

Chart title.

ChartLegend

Chart legend.

ChartSeriesCollection

Chart series collection.

ChartSeries

A chart series.

ChartDataLabels

Chart-wide or series-level data labels.

ChartAreaFormat

Chart area formatting.

ChartFill

Solid chart fill formatting.

ChartLineFormat

Chart line formatting.

ChartBorder

Chart border formatting.

ChartFont

Chart font formatting.

Object Reference

PowerPoint

Properties:

• BindingType
• BulletStyle
• BulletType
• ChartAxisCategoryType
• ChartAxisGroup
• ChartAxisTimeUnit
• ChartBinType
• ChartLineStyle
• ChartMarkerStyle
• ChartType
• ChartUnderlineStyle
• ConnectorType
• DocumentPropertyType
• ErrorCodes
• GeometricShapeType
• HyperlinkType
• InsertSlideFormatting
• LabelingCapability
• ParagraphHorizontalAlignment
• PlaceholderType
• RequestContext
• SensitivityLabelProtectionType
• SensitivityLabelUpdateResult
• ShapeAutoSize
• ShapeFillType
• ShapeFontUnderlineStyle
• ShapeGetImageFormatType
• ShapeLineDashStyle
• ShapeLineStyle
• ShapeType
• ShapeZOrder
• SlideBackgroundFillType
• SlideBackgroundGradientFillType
• SlideBackgroundPatternFillType
• SlideLayoutType
• TableStyle
• TextVerticalAlignment
• ThemeColor

Methods:

• createPresentation(...)
• run(...)

RequestContext

Properties:

• application
• debugInfo
• presentation
• requestHeaders
• sensitivityLabelsCatalog
• trackedObjects

Methods:

• add(...)
• loadRecursive(...)
• remove(...)
• sync(...)
• trace(...)

Application

Methods:

• newObject(...)

Presentation

Properties:

• bindings
• customXmlParts
• id
• onSlideSelectionChanged
• pageSetup
• properties
• sensitivityLabel
• slideMasters
• slides
• tags
• title

Methods:

• getActiveSlideOrNullObject(...)
• getSelectedShapes(...)
• getSelectedSlides(...)
• getSelectedTextRange(...)
• getSelectedTextRangeOrNullObject(...)
• insertSlidesFromBase64(...)
• setSelectedSlides(...)

SlideCollection

Properties:

• items

Methods:

• add(...)
• exportAsBase64Presentation(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

Slide

Properties:

• background
• customXmlParts
• hyperlinks
• id
• index
• layout
• shapes
• slideMaster
• tags
• themeColorScheme

Methods:

• applyLayout(...)
• delete(...)
• exportAsBase64(...)
• getImageAsBase64(...)
• moveTo(...)
• setSelectedShapes(...)

SlideScopedCollection

Properties:

• items

Methods:

• exportAsBase64Presentation(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

SlideMasterCollection

Properties:

• items

Methods:

• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

SlideMaster

Properties:

• background
• customXmlParts
• id
• layouts
• name
• shapes
• themeColorScheme

Methods:

• delete(...)

SlideLayoutCollection

Properties:

• items

Methods:

• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

SlideLayout

Properties:

• background
• customXmlParts
• id
• name
• shapes
• themeColorScheme
• type

Methods:

• delete(...)

SlideBackground

Properties:

• fill

Methods:

• reset(...)

SlideBackgroundFill

Properties:

• type

Methods:

• getGradientFillOrNullObject(...)
• getPatternFillOrNullObject(...)
• getPictureOrTextureFillOrNullObject(...)
• getSolidFillOrNullObject(...)
• setGradientFill(...)
• setPatternFill(...)
• setPictureOrTextureFill(...)
• setSolidFill(...)

SlideBackgroundSolidFill

Properties:

• color
• transparency

SlideBackgroundGradientFill

Properties:

• type

SlideBackgroundPatternFill

Properties:

• pattern

SlideBackgroundPictureOrTextureFill

Properties:

• transparency

Methods:

• setImage(...)

SlideMasterBackground

Properties:

• fill

SlideLayoutBackground

Properties:

• fill

Methods:

• reset(...)

ShapeCollection

Properties:

• items

Methods:

• addChart(...)
• addGeometricShape(...)
• addGroup(...)
• addLine(...)
• addPicture(...)
• addTable(...)
• addTextBox(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

ShapeScopedCollection

Properties:

• items

Methods:

• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)
• group(...)

Shape

Properties:

• adjustments
• altTextDescription
• altTextTitle
• creationId
• customXmlParts
• fill
• group
• height
• id
• isDecorative
• left
• level
• lineFormat
• name
• parentGroup
• placeholderFormat
• rotation
• tags
• textFrame
• top
• type
• visible
• width
• zOrderPosition

Methods:

• delete(...)
• getChart(...)
• getChartOrNullObject(...)
• getGraphicOrNullObject(...)
• getImageAsBase64(...)
• getParentSlide(...)
• getParentSlideLayout(...)
• getParentSlideLayoutOrNullObject(...)
• getParentSlideMaster(...)
• getParentSlideMasterOrNullObject(...)
• getParentSlideOrNullObject(...)
• getTable(...)
• getTextFrameOrNullObject(...)
• setHyperlink(...)
• setZOrder(...)

ShapeGroup

Properties:

• creationId
• id
• shape
• shapes

Methods:

• ungroup(...)

Graphic

Properties:

• shape

Methods:

• convertToShape(...)

Adjustments

Properties:

• count

Methods:

• get(...)
• set(...)

ShapeFill

Properties:

• foregroundColor
• transparency
• type

Methods:

• clear(...)
• setImage(...)
• setSolidColor(...)

ShapeLineFormat

Properties:

• color
• dashStyle
• style
• transparency
• visible
• weight

TextFrame

Properties:

• autoSizeSetting
• bottomMargin
• hasText
• leftMargin
• rightMargin
• textRange
• topMargin
• verticalAlignment
• wordWrap

Methods:

• deleteText(...)
• getParentShape(...)

TextRange

Properties:

• font
• hyperlinks
• length
• paragraphFormat
• start
• text

Methods:

• getParentTextFrame(...)
• getSubstring(...)
• setHyperlink(...)
• setSelected(...)

ShapeFont

Properties:

• allCaps
• bold
• color
• doubleStrikethrough
• italic
• name
• size
• smallCaps
• strikethrough
• subscript
• superscript
• underline

ParagraphFormat

Properties:

• bulletFormat
• horizontalAlignment
• indentLevel

BulletFormat

Properties:

• style
• type
• visible

HyperlinkCollection

Properties:

• items

Methods:

• add(...)
• getCount(...)
• getItemAt(...)

HyperlinkScopedCollection

Properties:

• items

Methods:

• getCount(...)
• getItemAt(...)

Hyperlink

Properties:

• address
• screenTip
• type

Methods:

• delete(...)
• getLinkedShapeOrNullObject(...)
• getLinkedTextRangeOrNullObject(...)

Table

Properties:

• columnCount
• columns
• rowCount
• rows
• styleSettings
• values

Methods:

• clear(...)
• getCellOrNullObject(...)
• getMergedAreas(...)
• getShape(...)
• mergeCells(...)

TableRowCollection

Properties:

• items

Methods:

• add(...)
• deleteRows(...)
• getCount(...)
• getItemAt(...)

TableRow

Properties:

• currentHeight
• height
• rowIndex

Methods:

• delete(...)

TableColumnCollection

Properties:

• items

Methods:

• add(...)
• deleteColumns(...)
• getCount(...)
• getItemAt(...)

TableColumn

Properties:

• columnIndex
• width

Methods:

• delete(...)

TableCellCollection

Properties:

• items

Methods:

• getCount(...)
• getItemAtOrNullObject(...)

TableCell

Properties:

• borders
• columnCount
• columnIndex
• fill
• font
• horizontalAlignment
• indentLevel
• margins
• rowCount
• rowIndex
• text
• textRuns
• verticalAlignment

Methods:

• resize(...)
• split(...)

TableStyleSettings

Properties:

• areColumnsBanded
• areRowsBanded
• isFirstColumnHighlighted
• isFirstRowHighlighted
• isLastColumnHighlighted
• isLastRowHighlighted
• style

Borders

Properties:

• bottom
• diagonalDown
• diagonalUp
• left
• right
• top

Border

Properties:

• color
• dashStyle
• transparency
• weight

Margins

Properties:

• bottom
• left
• right
• top

DocumentProperties

Properties:

• author
• category
• comments
• company
• creationDate
• customProperties
• keywords
• lastAuthor
• manager
• revisionNumber
• subject
• title

CustomPropertyCollection

Properties:

• items

Methods:

• add(...)
• deleteAll(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

CustomProperty

Properties:

• key
• type
• value

Methods:

• delete(...)

CustomXmlPartCollection

Properties:

• items

Methods:

• add(...)
• getByNamespace(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

CustomXmlPartScopedCollection

Properties:

• items

Methods:

• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)
• getOnlyItem(...)
• getOnlyItemOrNullObject(...)

CustomXmlPart

Properties:

• id
• namespaceUri

Methods:

• delete(...)
• getXml(...)
• setXml(...)

TagCollection

Properties:

• items

Methods:

• add(...)
• delete(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

Tag

Properties:

• key
• value

BindingCollection

Properties:

• items

Methods:

• add(...)
• addFromSelection(...)
• getCount(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)

Binding

Properties:

• id
• type

Methods:

• delete(...)
• getShape(...)

ThemeColorScheme

Methods:

• getThemeColor(...)
• setThemeColor(...)

PlaceholderFormat

Properties:

• containedType
• type

SensitivityLabel

Properties:

• children
• color
• getLabelingCapability
• id
• isEnabled
• isNullObject
• items
• name
• order
• protectionType
• siteId
• tooltip

Methods:

• getCount(...)
• getCurrentOrNullObject(...)
• getItem(...)
• getItemAt(...)
• getItemOrNullObject(...)
• getLabels(...)
• tryToUpdate(...)

Chart

Properties:

• axes
• dataLabels
• dataSourceKind
• format
• id
• legend
• plotArea
• series
• title

Methods:

• delete(...)
• setData(...)
• setDataRange(...)

ChartAxes

Properties:

• axisGroup
• categoryAxis
• majorGridlines
• minorGridlines
• title
• type
• valueAxis

Methods:

• getItem(...)

ChartSeriesCollection

Properties:

• count
• items

Methods:

• getCount(...)
• getItemAt(...)

ChartSeries

Properties:

• dataLabels
• format

Methods:

• delete(...)
• getBinOptions(...)
• getBoxwhiskerOptions(...)
• getDimensionDataSourceString(...)
• getDimensionDataSourceType(...)
• setBubbleSizes(...)
• setValues(...)
• setXAxisValues(...)

ChartBinOptions

Methods:

• getAllowOverflow(...)
• getAllowUnderflow(...)
• getCount(...)
• getOverflowValue(...)
• getType(...)
• getUnderflowValue(...)
• getWidth(...)
• setAllowOverflow(...)
• setAllowUnderflow(...)
• setCount(...)
• setOverflowValue(...)
• setType(...)
• setUnderflowValue(...)
• setWidth(...)

ChartBoxwhiskerOptions

Methods:

• getQuartileCalculation(...)
• getShowInnerPoints(...)
• getShowMeanLine(...)
• getShowMeanMarker(...)
• getShowOutlierPoints(...)
• setQuartileCalculation(...)
• setShowInnerPoints(...)
• setShowMeanLine(...)
• setShowMeanMarker(...)
• setShowOutlierPoints(...)

ChartDataLabels

Properties:

• format

ChartDataLabelFormat

Properties:

• border
• fill
• font

ChartAreaFormat

Properties:

• border
• fill
• font
• roundedCorners

ChartPlotArea

Properties:

• format

ChartPlotAreaFormat

Properties:

• border
• fill

ChartSeriesFormat

Properties:

• fill
• line

ChartFill

Methods:

• clear(...)
• getSolidColor(...)
• setSolidColor(...)

ChartLineFormat

Properties:

• color
• lineStyle
• weight

Methods:

• clear(...)

ChartBorder

Properties:

• color
• lineStyle
• weight

Methods:

• clear(...)

ChartFont

Properties:

• bold
• color
• italic
• name
• size
• underline

Source

Generated from:

• ../witan-cli/skills/witan-pptx-officejs/SKILL.md
• ../witan-cli/skills/witan-pptx-officejs/references/witan-pptx-chart.d.ts
• ../witan-alfred/PptxCli/Exec/OfficeJs/PowerPoint