Struct OffsetFn 

pub struct OffsetFn;

Trait Implementations

impl Debug for OffsetFn

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

Formats the value using the given formatter.

impl Function for OffsetFn

Returns a reference shifted from a starting reference by rows and columns.

OFFSET is volatile and returns a reference that can point to a single cell or a resized range, depending on the optional height and width arguments.

Remarks

• rows and cols shift from the top-left of reference.
• If omitted, height and width default to the original reference size.
• Non-positive target coordinates or dimensions return #REF!.
• Non-numeric offset/size inputs return #VALUE!.
• In value context, a 1x1 result returns a scalar; larger results spill as an array.

Examples

title: "Move one row down and one column right"
grid:
  A1: 10
  B2: 42
formula: '=OFFSET(A1,1,1)'
expected: 42

title: "Offset and resize a range"
grid:
  A1: 1
  A2: 2
  A3: 3
  B1: 4
  B2: 5
  B3: 6
formula: '=SUM(OFFSET(A1,1,0,2,2))'
expected: 16

related:
  - INDEX
  - INDIRECT
  - ADDRESS
faq:
  - q: "What defaults are used when height and width are omitted?"
    a: "OFFSET keeps the source reference size, then applies the row/column shift to that same-sized block."
  - q: "When does OFFSET return #REF!?"
    a: "It returns #REF! if the shifted start goes to row/column <= 0 or if requested height/width are non-positive."

[formualizer-docgen:schema:start] Name: OFFSET Type: OffsetFn Min args: 3 Max args: 5 Variadic: false Signature: OFFSET(arg1: range@range, arg2: number@scalar, arg3: number@scalar, arg4?: number@scalar, arg5?: number@scalar) Arg schema: arg1{kinds=range,required=true,shape=range,by_ref=true,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=false}; arg3{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=false}; arg4{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=false}; arg5{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=false} Caps: PURE, VOLATILE, RETURNS_REFERENCE, DYNAMIC_DEPENDENCY [formualizer-docgen:schema:end]

fn caps(&self) -> FnCaps

Capability flags for this function

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

fn min_args(&self) -> usize

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

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 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 variadic(&self) -> bool

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 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.