Skip to main content

Book

What every facade handle of one workbook shares. Not exported by name. You get it from the API.

Book properties

Book.theme()

Theme colours in SpreadsheetML slot order.

Book.themeFaces()

The theme’s body and heading faces, which built-in cell styles use.

CustomProperty

Excel.CustomProperty: one user-defined property; keys are matched ignoring case. Import from @reductoai/xlsx/officejs.

CustomProperty properties

CustomProperty.delete()

CustomProperty.set()

Sets several properties at once; a navigation member takes a nested batch.

CustomPropertyCollection

Excel.CustomPropertyCollection: docProps/custom.xml. Import from @reductoai/xlsx/officejs.

CustomPropertyCollection properties

CustomPropertyCollection.add()

Adds a property, or sets the value of the one with this key.

CustomPropertyCollection.deleteAll()

CustomPropertyCollection.getCount()

CustomPropertyCollection.getItem()

CustomPropertyCollection.getItemOrNullObject()

CustomXmlPart

Excel.CustomXmlPart: a customXml/itemN.xml part the workbook relates. Import from @reductoai/xlsx/officejs.

CustomXmlPart properties

CustomXmlPart.delete()

CustomXmlPart.getXml()

CustomXmlPart.setXml()

CustomXmlPartCollection

Excel.CustomXmlPartCollection: customXml/itemN.xml with their itemPropsN.xml. Import from @reductoai/xlsx/officejs.

CustomXmlPartCollection properties

CustomXmlPartCollection.add()

CustomXmlPartCollection.getByNamespace()

CustomXmlPartCollection.getCount()

CustomXmlPartCollection.getItem()

CustomXmlPartCollection.getItemOrNullObject()

CustomXmlPartScopedCollection

Excel.CustomXmlPartScopedCollection: the parts whose root is in one namespace. Import from @reductoai/xlsx/officejs.

CustomXmlPartScopedCollection properties

CustomXmlPartScopedCollection.getCount()

CustomXmlPartScopedCollection.getItem()

CustomXmlPartScopedCollection.getItemOrNullObject()

CustomXmlPartScopedCollection.getOnlyItem()

CustomXmlPartScopedCollection.getOnlyItemOrNullObject()

DocumentProperties

Excel.DocumentProperties: docProps/core.xml and app.xml; a part is added on first write. Import from @reductoai/xlsx/officejs.

DocumentProperties properties

DocumentProperties.set()

Sets several properties at once; a navigation member takes a nested batch.

RangeAreasCollection

Excel.RangeAreasCollection. Import from @reductoai/xlsx/officejs.

RangeAreasCollection properties

RangeAreasCollection.getCount()

RangeAreasCollection.getItemAt()

RangeCollection

Excel.RangeCollection: the rectangles of a RangeAreas, in order. Import from @reductoai/xlsx/officejs.

RangeCollection properties

RangeCollection.getCount()

RangeCollection.getItemAt()

Store

Not exported by name. You get it from the API.

Store properties

Store.edit()

Store.find()

Store.read()

Store.write()

WorkbookRangeAreas

Excel.WorkbookRangeAreas: cells on one or more sheets. Import from @reductoai/xlsx/officejs.

WorkbookRangeAreas properties

WorkbookRangeAreas.getRangeAreasBySheet()

By worksheet name or id.

WorkbookRangeAreas.getRangeAreasOrNullObjectBySheet()

WorksheetCustomProperty

Excel.WorksheetCustomProperty: a key and a text value stored with the sheet. Import from @reductoai/xlsx/officejs.

WorksheetCustomProperty properties

WorksheetCustomProperty.delete()

WorksheetCustomProperty.set()

WorksheetCustomPropertyCollection

Excel.WorksheetCustomPropertyCollection: keys are unique regardless of case. Import from @reductoai/xlsx/officejs.

WorksheetCustomPropertyCollection properties

WorksheetCustomPropertyCollection.add()

Adds key, or sets its value when the sheet already has it.

WorksheetCustomPropertyCollection.getCount()

WorksheetCustomPropertyCollection.getItem()

WorksheetCustomPropertyCollection.getItemOrNullObject()