Struct PivotByFn 

pub struct PivotByFn;

Trait Implementations

impl Debug for PivotByFn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Function for PivotByFn

Builds a pivot-style summary matrix from row fields, column fields, and values.

PIVOTBY aggregates intersections of row keys and column keys into a dynamic result grid.

Remarks

• row_fields, col_fields, and values must have matching row counts.
• Aggregation accepts text names (for example "SUM") or numeric codes.
• Optional controls include header handling, row/column totals, and sort order.
• Current implementation uses the first column of col_fields and values for aggregation.
• Invalid setup returns #VALUE!.

Examples

title: "Pivot sales by region and quarter"
grid:
  A1: "Region"
  A2: "East"
  A3: "East"
  A4: "West"
  B1: "Quarter"
  B2: "Q1"
  B3: "Q2"
  B4: "Q1"
  C1: "Sales"
  C2: 100
  C3: 150
  C4: 120
formula: '=PIVOTBY(A1:A4,B1:B4,C1:C4,"SUM",3,0,1,0,1)'
expected: "Pivot table with regions as rows and quarters as columns"

title: "Pivot with totals enabled"
grid:
  A1: "Dept"
  A2: "Ops"
  A3: "Ops"
  A4: "Sales"
  B1: "Month"
  B2: "Jan"
  B3: "Feb"
  B4: "Jan"
  C1: "Cost"
  C2: 40
  C3: 35
  C4: 55
formula: '=PIVOTBY(A1:A4,B1:B4,C1:C4,"SUM",3,1,1,1,1)'
expected: "Pivot table including row and column totals"

related:
  - GROUPBY
  - SORTBY
  - UNIQUE
faq:
  - q: "What rows must align in PIVOTBY inputs?"
    a: "row_fields, col_fields, and values must share the same row count; otherwise PIVOTBY returns #VALUE!."
  - q: "What value range is currently aggregated?"
    a: "Current implementation aggregates using the first value column (and first col_fields column for keys), so extra columns are not yet summarized independently."

[formualizer-docgen:schema:start] Name: PIVOTBY Type: PivotByFn Min args: 4 Max args: variadic Variadic: true Signature: PIVOTBY(arg1: range@range, arg2: range@range, arg3: range@range, arg4: any@scalar, arg5?: number@scalar, arg6?: number@scalar, arg7?: number@scalar, arg8?: number@scalar, arg9?…: number@scalar) Arg schema: arg1{kinds=range,required=true,shape=range,by_ref=true,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=range,required=true,shape=range,by_ref=true,coercion=None,max=None,repeating=None,default=false}; arg3{kinds=range,required=true,shape=range,by_ref=true,coercion=None,max=None,repeating=None,default=false}; arg4{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg5{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg6{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg7{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg8{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg9{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true} Caps: PURE [formualizer-docgen:schema:end]

fn caps(&self) -> FnCaps

Capability flags for this function

fn name(&self) -> &'static str

fn min_args(&self) -> usize

fn variadic(&self) -> bool

fn arg_schema(&self) -> &'static [ArgSchema]

fn eval<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

The unified evaluation path.

fn namespace(&self) -> &'static str

fn volatile(&self) -> bool

fn aliases(&self) -> &'static [&'static str]

Optional list of additional alias names (case-insensitive) that should resolve to this function. Default: empty slice. Implementors can override to expose legacy names. Returned slice must have ’static lifetime (typically a static array reference).

fn function_salt(&self) -> u64

fn eval_reference<'a, 'b, 'c>( &self, _args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Option<Result<ReferenceType, ExcelError>>

Optional reference result path. Only called by the interpreter/engine when the callsite expects a reference (e.g., range combinators, by-ref argument positions, or spill sources).

fn dispatch<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

Dispatch to the unified evaluation path with automatic argument validation.