Class Offset
- java.lang.Object
-
- org.apache.poi.ss.formula.functions.Offset
-
- All Implemented Interfaces:
FreeRefFunction
public final class Offset extends Object implements FreeRefFunction
Implementation for Excel function OFFSET()OFFSET returns an area reference that is a specified number of rows and columns from a reference cell or area.
Syntax:
OFFSET(reference, rows, cols, height, width)reference is the base reference.
rows is the number of rows up or down from the base reference.
cols is the number of columns left or right from the base reference.
height (default same height as base reference) is the row count for the returned area reference.
width (default same width as base reference) is the column count for the returned area reference.
-
-
Field Summary
Fields Modifier and Type Field Description static FreeRefFunction
instance
-
Constructor Summary
Constructors Constructor Description Offset()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ValueEval
evaluate(ValueEval[] args, OperationEvaluationContext ec)
-
-
-
Field Detail
-
instance
public static final FreeRefFunction instance
-
-
Method Detail
-
evaluate
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)
- Specified by:
evaluate
in interfaceFreeRefFunction
- Parameters:
args
- the pre-evaluated arguments for this function. args is nevernull
, nor are any of its elements.ec
- primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.- Returns:
- never
null
. Possibly an instance ofErrorEval
in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).
-
-