PivotTableDef

type PivotTableDef = {
  colGrandTotals?: boolean;
  colRoles?: PivotColRole[];
  getOutputBounds?: () => Range | null;
  location: {
     firstDataCol: number;
     firstDataRow: number;
     firstHeaderRow: number;
  };
  name: string;
  pageArea?: PivotPageArea | null;
  ref: string;
  rowGrandTotals?: boolean;
  rowRoles?: PivotRowRole[];
  sheet?: string;
  style?: {
     name?: string | null;
     showColumnHeaders?: boolean;
     showColumnStripes?: boolean;
     showLastColumn?: boolean;
     showRowHeaders?: boolean;
     showRowStripes?: boolean;
  };
};

Properties

Property	Type	Description
colGrandTotals?	boolean	-
colRoles?	PivotColRole[]	Roles of the output columns that style differently from plain data columns (subheading and subtotal columns). When absent, all body columns style as data.
getOutputBounds?	() => Range | null	Computed bounds of the pivot’s materialized output, preferred over ref when present (see Renderer.updatePivotTables). Apiary’s PivotTable provides this; ref (the persisted location/@ref) can lag the true output until a refresh rewrites it.
location	{ firstDataCol: number; firstDataRow: number; firstHeaderRow: number; }	-
location.firstDataCol	number	-
location.firstDataRow	number	-
location.firstHeaderRow	number	-
name	string	-
pageArea?	PivotPageArea | null	Geometry of the page-field (report filter) area above the pivot, when it has page fields. The cells there carry the pageFieldLabels / pageFieldValues style regions. Absent/null when the pivot has no page fields.
ref	string	-
rowGrandTotals?	boolean	-
rowRoles?	PivotRowRole[]	Roles of the output rows that style differently from plain data rows (subheading and subtotal rows). When absent, all body rows style as data.
sheet?	string	-
style?	{ name?: string | null; showColumnHeaders?: boolean; showColumnStripes?: boolean; showLastColumn?: boolean; showRowHeaders?: boolean; showRowStripes?: boolean; }	-
style.name?	string | null	-
style.showColumnHeaders?	boolean	-
style.showColumnStripes?	boolean	-
style.showLastColumn?	boolean	-
style.showRowHeaders?	boolean	-
style.showRowStripes?	boolean	-