Skip to main content

CalculatedField

One calculated field. Import from @reductoai/xlsx/officejs.

CalculatedField properties

CalculatedField.delete()

Removes the field from the cache and from the values of every table on it.

CalculatedFieldCollection

The cache’s calculated fields; Office.js has none, so the names follow VBA. Import from @reductoai/xlsx/officejs.

CalculatedFieldCollection properties

CalculatedFieldCollection.add()

Adds a field such as add("Margin", "=(Revenue-'Unit Cost')/Revenue"). Each field name in the formula stands for that field’s sum on a cell; a name with a space goes in single quotes. The field starts off every axis: add it with dataHierarchies.add.

CalculatedFieldCollection.getCount()

CalculatedFieldCollection.getItem()

CalculatedFieldCollection.getItemOrNullObject()

ChartPivotOptions

The field buttons a pivot chart shows (c14:pivotOptions). Import from @reductoai/xlsx/officejs.

ChartPivotOptions properties

ChartPivotOptions.set()

DataPivotHierarchyCollection

Excel.DataPivotHierarchyCollection: the value fields. Import from @reductoai/xlsx/officejs.

DataPivotHierarchyCollection properties

DataPivotHierarchyCollection.add()

A value field over hierarchy: Sum when every value is a number, otherwise Count.

DataPivotHierarchyCollection.getCount()

DataPivotHierarchyCollection.getItem()

DataPivotHierarchyCollection.getItemOrNullObject()

DataPivotHierarchyCollection.remove()

FilterPivotHierarchy

A field on the filter axis. Import from @reductoai/xlsx/officejs. Extends PivotHierarchy.

FilterPivotHierarchy properties

FilterPivotHierarchy.set()

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

FilterPivotHierarchy.setToDefault()

FilterPivotHierarchyCollection

Excel.PivotHierarchyCollection (every source field) and the row, column and filter collections, which add a field to their axis and remove it. Import from @reductoai/xlsx/officejs. Extends PivotHierarchyCollection<FilterPivotHierarchy>.

FilterPivotHierarchyCollection properties

FilterPivotHierarchyCollection.add()

Places the field last on this axis, taking it off any other axis it was on.

FilterPivotHierarchyCollection.getCount()

FilterPivotHierarchyCollection.getItem()

FilterPivotHierarchyCollection.getItemOrNullObject()

FilterPivotHierarchyCollection.remove()

PivotFieldCollection

Excel.PivotFieldCollection: a hierarchy’s fields; a source column has one. Import from @reductoai/xlsx/officejs.

PivotFieldCollection properties

PivotFieldCollection.getCount()

PivotFieldCollection.getItem()

PivotFieldCollection.getItemOrNullObject()

PivotHierarchyCollection

Excel.PivotHierarchyCollection (every source field) and the row, column and filter collections, which add a field to their axis and remove it. Import from @reductoai/xlsx/officejs.

PivotHierarchyCollection properties

PivotHierarchyCollection.add()

Places the field last on this axis, taking it off any other axis it was on.

PivotHierarchyCollection.getCount()

PivotHierarchyCollection.getItem()

PivotHierarchyCollection.getItemOrNullObject()

PivotHierarchyCollection.remove()

PivotItem

Excel.PivotItem: shown or hidden by its field’s filter, expanded or collapsed. Import from @reductoai/xlsx/officejs.

PivotItem properties

PivotItem.set()

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

PivotItemCollection

Excel.PivotItemCollection: a row, column or filter field’s items. Import from @reductoai/xlsx/officejs.

PivotItemCollection properties

PivotItemCollection.getCount()

PivotItemCollection.getItem()

PivotItemCollection.getItemOrNullObject()

PivotTableScopedCollection

Excel.PivotTableScopedCollection: the pivot tables that meet a range. Not exported by name. You get it from the API.

PivotTableScopedCollection properties

PivotTableScopedCollection.getCount()

PivotTableScopedCollection.getFirst()

The first in the workbook’s order; throws when none meets the range.

PivotTableScopedCollection.getFirstOrNullObject()

PivotTableScopedCollection.getItem()

PivotTableScopedCollection.getItemOrNullObject()

PivotTableStyle

A table, pivot, slicer or timeline style: built-in ones are read-only. Import from @reductoai/xlsx/officejs.

PivotTableStyle properties

PivotTableStyle.delete()

PivotTableStyle.duplicate()

A copy named “<name> 2”; a built-in table or pivot style copies its formats.

PivotTableStyle.set()

PivotTableStyleCollection

The styles of one kind: built-in ones, then the workbook’s own. Import from @reductoai/xlsx/officejs.

PivotTableStyleCollection properties

PivotTableStyleCollection.add()

A blank style; makeUniqueName numbers a name already in use instead of throwing.

PivotTableStyleCollection.getCount()

PivotTableStyleCollection.getDefault()

PivotTableStyleCollection.getItem()

PivotTableStyleCollection.getItemOrNullObject()

PivotTableStyleCollection.setDefault()

RowColumnPivotHierarchyCollection

Excel.PivotHierarchyCollection (every source field) and the row, column and filter collections, which add a field to their axis and remove it. Import from @reductoai/xlsx/officejs. Extends PivotHierarchyCollection<RowColumnPivotHierarchy>.

RowColumnPivotHierarchyCollection properties

RowColumnPivotHierarchyCollection.add()

Places the field last on this axis, taking it off any other axis it was on.

RowColumnPivotHierarchyCollection.getCount()

RowColumnPivotHierarchyCollection.getItem()

RowColumnPivotHierarchyCollection.getItemOrNullObject()

RowColumnPivotHierarchyCollection.remove()

Slicer

A slicer: a button panel that filters a table column or a pivot field. Import from @reductoai/xlsx/officejs.

Slicer properties

Slicer.clearFilters()

Slicer.delete()

Slicer.getConnectablePivotTables()

Extension: the pivot tables Report Connections offers, those on the slicer’s pivot cache.

Slicer.getPivotTables()

Extension (VBA’s SlicerCache.PivotTables): the pivot tables this slicer filters.

Slicer.getSelectedItems()

Slicer.selectItems()

Shows the named items; no list, or an empty one, shows them all.

Slicer.set()

Slicer.setPivotTables()

Extension (Report Connections): the slicer filters exactly these pivot tables. One it gains takes the slicer’s filter; one it loses keeps its own.

SlicerCollection

The slicers of the workbook, or of one worksheet. Import from @reductoai/xlsx/officejs.

SlicerCollection properties

SlicerCollection.add()

A slicer on a table column or a pivot field, on slicerDestination or this sheet.

SlicerCollection.getCount()

SlicerCollection.getItem()

SlicerCollection.getItemAt()

SlicerCollection.getItemOrNullObject()

SlicerItem

One button of a slicer. Import from @reductoai/xlsx/officejs.

SlicerItem properties

SlicerItem.set()

SlicerItemCollection

Import from @reductoai/xlsx/officejs.

SlicerItemCollection properties

SlicerItemCollection.getCount()

SlicerItemCollection.getItem()

SlicerItemCollection.getItemAt()

SlicerItemCollection.getItemOrNullObject()

SlicerStyle

A table, pivot, slicer or timeline style: built-in ones are read-only. Import from @reductoai/xlsx/officejs.

SlicerStyle properties

SlicerStyle.delete()

SlicerStyle.duplicate()

A copy named “<name> 2”; a built-in table or pivot style copies its formats.

SlicerStyle.set()

SlicerStyleCollection

The styles of one kind: built-in ones, then the workbook’s own. Import from @reductoai/xlsx/officejs.

SlicerStyleCollection properties

SlicerStyleCollection.add()

A blank style; makeUniqueName numbers a name already in use instead of throwing.

SlicerStyleCollection.getCount()

SlicerStyleCollection.getDefault()

SlicerStyleCollection.getItem()

SlicerStyleCollection.getItemOrNullObject()

SlicerStyleCollection.setDefault()

TimelineStyle

A table, pivot, slicer or timeline style: built-in ones are read-only. Import from @reductoai/xlsx/officejs.

TimelineStyle properties

TimelineStyle.delete()

TimelineStyle.duplicate()

A copy named “<name> 2”; a built-in table or pivot style copies its formats.

TimelineStyle.set()

TimelineStyleCollection

The styles of one kind: built-in ones, then the workbook’s own. Import from @reductoai/xlsx/officejs.

TimelineStyleCollection properties

TimelineStyleCollection.add()

A blank style; makeUniqueName numbers a name already in use instead of throwing.

TimelineStyleCollection.getCount()

TimelineStyleCollection.getDefault()

TimelineStyleCollection.getItem()

TimelineStyleCollection.getItemOrNullObject()

TimelineStyleCollection.setDefault()