Skip to main content

Changelog

The list of changes for Office JavaScript API.

Version 10.0​

Breaking changes​

  • Renamed the ApiChart/SetAxieNumFormat method to ApiChart/SetAxisNumFormat in Document API, Spreadsheet API, Presentation API, and PDF API. The old name still works as an alias.
  • Removed the ApiTextWidget class from PDF API, which had no effect. Text field widgets are ApiBaseWidget objects. For more information, see PDF API.
  • Removed the ApiRun/SetPosition method from Spreadsheet API, Presentation API, and PDF API. The method had no effect in these editors.
  • Removed the ApiRun/SetHighlight method from Spreadsheet API.
  • Replaced the Shd type with the ApiShd class in Document API. The GetShd methods (for example, ApiParagraph/GetShd) now return an ApiShd object, and Api/CreateShd creates one.
  • Replaced the Spreadsheet API ApiColor class with the common ApiColor class shared with the other editors. ApiColor/GetRGB now returns an {r, g, b} object instead of a 0xRRGGBB number. Methods that return a color no longer convert theme colors to RGB, so ApiColor/IsThemeColor and ApiColor/GetThemeName work on the returned color.

Changed methods​

Document methods​

Api methods​

ApiBlockLvlSdt methods​

ApiChart methods​

ApiChartSeries methods​

ApiCheckBoxForm methods​

ApiColor methods​

ApiComboBoxForm methods​

ApiComplexForm methods​

ApiDateForm methods​

ApiDocument methods​

ApiDocumentContent methods​

ApiDocumentVisitor class​

ApiDrawing methods​

ApiDropCap class​

ApiFill methods​

ApiFormBase methods​

ApiGeometry methods​

ApiGroup methods​

ApiImage methods​

ApiInlineLvlSdt methods​

ApiMath class​

ApiOleObject methods​

ApiParagraph methods​

ApiPictureForm methods​

ApiRange methods​

ApiRun methods​

ApiShadow class​

ApiShape methods​

ApiShd class​

ApiSignatureForm methods​

ApiSmartArt methods​

ApiStroke methods​

ApiTable methods​

ApiTableOfContents class​

ApiTableOfFigures class​

ApiTableRow methods​

ApiTablesOfContents class​

ApiTablesOfFigures class​

ApiTextForm methods​

Document types​

Form methods​

ApiCheckBoxForm methods​

ApiComboBoxForm methods​

ApiComplexForm methods​

ApiDateForm methods​

ApiFormBase methods​

ApiPictureForm methods​

ApiSignatureForm methods​

ApiTextForm methods​

Form types​

Spreadsheet methods​

Api methods​

ApiAboveAverage methods​

ApiBullet methods​

ApiChart methods​

ApiChartSeries methods​

ApiColor methods​

ApiColorScale methods​

ApiDatabar methods​

ApiDocumentContent methods​

ApiDrawing methods​

ApiFill methods​

ApiFormatCondition methods​

ApiGeometry methods​

ApiGroup methods​

ApiHeaderFooter class​

ApiIconSetCondition methods​

ApiImage methods​

ApiMath class​

ApiOleObject methods​

ApiPage class​

ApiPageSetup class​

ApiParagraph methods​

ApiPivotDataField methods​

ApiPivotField methods​

ApiPivotTable methods​

ApiRange methods​

ApiRun methods​

ApiShadow class​

ApiShape methods​

ApiShd class​

ApiSmartArt methods​

ApiStroke methods​

ApiTextPr methods​

ApiTextRange class​

ApiTop10 methods​

ApiUniqueValues methods​

ApiWorkbook methods​

ApiWorksheet methods​

Spreadsheet types​

Presentation methods​

Api methods​

ApiBullet methods​

ApiChart methods​

ApiChartSeries methods​

ApiColor methods​

ApiDocumentContent methods​

ApiDrawing methods​

ApiFill methods​

ApiGeometry methods​

ApiGroup methods​

ApiImage methods​

ApiLayout methods​

ApiMaster methods​

ApiMath class​

ApiNotesPage methods​

ApiOleObject methods​

ApiParagraph methods​

ApiPresentation methods​

ApiPresentationVisitor class​

ApiRun methods​

ApiSelection methods​

ApiShadow class​

ApiShape methods​

ApiShd class​

ApiSlide methods​

ApiSmartArt methods​

ApiStroke methods​

ApiStyle class​

ApiTable methods​

ApiTableCell methods​

ApiTablePr class​

ApiTableRow methods​

ApiTableRowPr class​

ApiTableStylePr class​

ApiTextPr methods​

ApiTextRange class​

ApiThemeColorScheme methods​

ApiThemeFontScheme methods​

Presentation types​

PDF methods​

Api methods​

ApiActionCollection class​

ApiBaseAction class​

ApiBaseWidget methods​

ApiBullet methods​

ApiButtonWidget methods​

ApiChart methods​

ApiChartSeries methods​

ApiCheckboxWidget methods​

ApiColor methods​

ApiComboboxField methods​

ApiDocument methods​

ApiDocumentContent methods​

ApiDrawing methods​

ApiFill methods​

ApiFreeTextAnnotation methods​

ApiGeometry methods​

ApiGoToAction class​

ApiGroup methods​

ApiHideShowFormsAction class​

ApiImage methods​

ApiJsAction class​

ApiLinkAnnotation methods​

ApiMath class​

ApiNamedAction class​

ApiPage methods​

ApiParagraph methods​

ApiResetFormsAction class​

ApiRichContent methods​

ApiRichParaPr methods​

ApiRichParagraph methods​

ApiRichRun methods​

ApiRichTextPr methods​

ApiRun methods​

ApiShadow class​

ApiShape methods​

ApiShd class​

ApiSignatureField class​

ApiSmartArt methods​

ApiStroke methods​

ApiTable methods​

ApiTableCell methods​

ApiTableRow methods​

ApiTableRowPr class​

ApiTextField methods​

ApiTextPr methods​

ApiTextRange class​

ApiUriAction class​

PdfFile class​

PDF types​

Version 9.4.1​

Document methods​

Version 9.4​

Breaking changes​

  • Updated the Api/CreateTable method in Document API - changed the parameter order from Api.CreateTable(cols, rows) to Api.CreateTable(rows, cols).
  • Updated the Api/CreateTable method in Presentation API - changed the parameter order from Api.CreateTable(cols, rows) to Api.CreateTable(rows, cols).

Document methods​

Color methods​

Signature form​

Form methods​

Highlight methods​

List object methods​

Spreadsheet methods​

Text form methods​

Paragraph properties methods​

Content control methods​

Version 9.3​

Autofilter methods​

Filter methods​

Validation methods​

Color methods​

Footnote/endnote methods​

Transition methods​

Fill and Stroke methods​

Animation methods​

Form methods​

Changed methods​

Drawing methods​

ApiTable methods​

ApiChart methods​

PDF methods​

  • Added the PDF API.

Api methods​

ApiBaseAnnotation methods​

ApiBaseField methods​

ApiBaseListField methods​

ApiBaseMarkupAnnotation methods​

ApiBaseWidget methods​

ApiBullet methods​

ApiButtonField methods​

ApiButtonWidget methods​

ApiCaretAnnotation methods​

ApiChart methods​

ApiChartSeries methods​

ApiCheckboxField methods​

ApiCheckboxWidget methods​

ApiCircleAnnotation methods​

ApiColor methods​

ApiComboboxField methods​

ApiDocument methods​

ApiDocumentContent methods​

ApiDrawing methods​

ApiFill methods​

ApiFreeTextAnnotation methods​

ApiGeometry methods​

ApiGradientStop methods​

ApiGroup methods​

ApiHighlightAnnotation methods​

ApiImage methods​

ApiInkAnnotation methods​

ApiLineAnnotation methods​

ApiListboxField methods​

ApiPage methods​

ApiParaPr methods​

ApiParagraph methods​

ApiPath methods​

ApiPathCommand methods​

ApiPolyLineAnnotation methods​

ApiPolygonAnnotation methods​

ApiPresetColor methods​

ApiRGBColor methods​

ApiRadiobuttonField methods​

ApiRedactAnnotation methods​

ApiRichContent methods​

ApiRichParaPr methods​

ApiRichParagraph methods​

ApiRichRun methods​

ApiRichTextPr methods​

ApiRun methods​

ApiSchemeColor methods​

ApiShape methods​

ApiSmartArt methods​

ApiSquareAnnotation methods​

ApiStampAnnotation methods​

ApiStrikeoutAnnotation methods​

ApiStroke methods​

ApiTable methods​

ApiTableCell methods​

ApiTableRow methods​

ApiTextAnnotation methods​

ApiTextField methods​

ApiTextPr methods​

ApiUnderlineAnnotation methods​

ApiUniColor methods​

ApiUnsupported methods​

Version 9.2​

CheckBoxForm methods​

Form methods​

Paragraph methods​

Presentation methods​

Spreadsheet methods​

Document methods​

Version 9.1​

Conditional formatting methods​

Above average methods​

Color scale methods​

Databar methods​

Icon set methods​

Top 10 methods​

Unique values methods​

Geometry methods​

Path methods​

Path command methods​

Custom XML methods​

Conversion methods​

Methods for managing properties​

Section methods​

Workbook methods​

Pivot tables methods​

Range methods​

Presentation methods​

Other methods​

Version 9.0​

Content control methods​

Custom XML methods​

Form methods​

Custom properties methods​

Core methods​

Range methods​

Document methods​

Drawing methods​

Comment methods​

Presentation methods​

Layout methods​

Notes page methods​

Other methods​

Version 8.3​

Bookmark methods​

Group methods​

Content control methods​

Document methods​

Section methods​

Autofilter methods​

Selection methods​

Slide methods​

Other methods​

Version 8.2​

Range methods​

Document methods​

Pivot tables methods​

Placeholder methods​

Other methods​

Version 8.1​

Date form methods​

Methods for setting text properties​

Worksheet function methods​

Protected range methods​

Reference style methods​

Methods for pasting / cutting ranges​

Methods for moving a cursor​

Custom function methods​

RGB color methods​

Chart series methods​

Other methods​

Version 8.0​

Form methods​

Freeze panes methods​

Comment methods​

Section methods​

Simple types​

Other methods​

Version 7.5​

Methods of combo box / dropdown list content control​

Watermark methods​

Simple types​

  • Added the SearchData object to the simple type definitions.
  • Added the ReplaceData object to the simple type definitions.

Slide methods​

Version 7.4​

Characters methods​

Font methods​

Range methods​

Other methods​

Version 7.3​

Comment methods​

Table of contents/figures methods​

Other methods​

Version 7.2​

Events​

Form methods​

Methods for converting to/from JSON​

Word Art methods​

Table of contents/figures methods​

Footnote/endnote methods​

Chart methods​

Drawing methods​

OLE object methods​

Table methods​

Run methods​

Methods for setting text properties​

Other methods​

Version 7.1​

Form methods​

Cross-reference methods​

Review methods​

Table background methods​

Areas methods​

Range methods​

Layout methods​

Master methods​

Placeholder methods​

Theme methods​

Drawing methods​

Slide methods​

Presentation methods​

Other methods​

Version 7.0​

Version 6.4​