SheetRangeAndWorkbookIndexFormatter (POI API Documentation)

java.lang.Object
+
- org.apache.poi.ss.formula.SheetRangeAndWorkbookIndexFormatter
+

+
+

public class SheetRangeAndWorkbookIndexFormatter
+extends java.lang.Object

+ +

+ + +

Method Summary

+ + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`format(java.lang.StringBuilder sb, + int workbookIndex, + java.lang.String firstSheetName, + java.lang.String lastSheetName)`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +

Method Detail

+ + + +

format

public static java.lang.String format(java.lang.StringBuilder sb,
+                                      int workbookIndex,
+                                      java.lang.String firstSheetName,
+                                      java.lang.String lastSheetName)

java.lang.Object
+
- org.apache.poi.ss.formula.functions.Fixed2ArgFunction
- +
  - org.apache.poi.ss.formula.functions.Frequency
  +
+

+
+
All Implemented Interfaces:
+
Function, Function2Arg
+
+
+
+
```
public class Frequency
+extends Fixed2ArgFunction
```
+
Implementation of Excel 'Analysis ToolPak' function FREQUENCY()
+ Returns a frequency distribution as a vertical array
+
+ Syntax
+ FREQUENCY(data_array, bins_array)
+
+ data_array Required. An array of or reference to a set of values for which you want to count frequencies. + If data_array contains no values, FREQUENCY returns an array of zeros.
+ bins_array Required. An array of or reference to intervals into which you want to group the values in data_array. + If bins_array contains no values, FREQUENCY returns the number of elements in data_array.
+
+
Author:
+
Yegor Kozlov
+
+

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static Function instance
+

Fields
Modifier and Type	Field and Description
`static Function`	`instance`

+ +

+ + +

Method Summary

+ + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueEval`	`evaluate(int srcRowIndex, + int srcColumnIndex, + ValueEval arg0, + ValueEval arg1)` + see `Function.evaluate(ValueEval[], int, int)` +

+ + +
Methods inherited from class org.apache.poi.ss.formula.functions.Fixed2ArgFunction
+evaluate

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +
Field Detail
+ + + +
- +
  instance
  +
```
public static final Function instance
```
  +
+

+ +

+ + +

Method Detail

+ + + +

evaluate

public ValueEval evaluate(int srcRowIndex,
+                          int srcColumnIndex,
+                          ValueEval arg0,
+                          ValueEval arg1)

Description copied from interface: Function2Arg

see Function.evaluate(ValueEval[], int, int)

java.lang.Object
+
- org.apache.poi.ss.formula.functions.Trend
+

+
+
All Implemented Interfaces:
+
Function
+
+
+
+
```
public final class Trend
+extends java.lang.Object
+implements Function
```
+
Implementation for the Excel function TREND
+ + Syntax:
+ TREND(known_y's, known_x's, new_x's, constant) + + + +
known_y's, known_x's, new_x's typically area references, possibly cell references or scalar values
constant TRUE or FALSE: + determines whether the regression line should include an intercept term

+ If known_x's is not given, it is assumed to be the default array {1, 2, 3, ...} + of the same size as known_y's.
+ If new_x's is not given, it is assumed to be the same as known_x's
+ If constant is omitted, it is assumed to be TRUE +
+

known_y's, known_x's, new_x's	typically area references, possibly cell references or scalar values
constant	TRUE or FALSE: + determines whether the regression line should include an intercept term

+ +
- + + +
  Constructor Summary
  + + + + + + + + +
  Constructors
  Constructor and Description
  Trend()
  +
+ +
- + + +
  Method Summary
  + + + + + + + + + + +
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  ValueEval evaluate(ValueEval[] args, + int srcRowIndex, + int srcColumnIndex)
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

Constructors
Constructor and Description
`Trend()`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueEval`	`evaluate(ValueEval[] args, + int srcRowIndex, + int srcColumnIndex)`

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Trend
    +
```
public Trend()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    evaluate
    +
```
public ValueEval evaluate(ValueEval[] args,
+                          int srcRowIndex,
+                          int srcColumnIndex)
```
    +
    +
    Specified by:
    +
    evaluate in interface Function
    +
    Parameters:
    +
    args - the evaluated function arguments. Empty values are represented with + BlankEval or MissingArgEval, never null.
    +
    srcRowIndex - row index of the cell containing the formula under evaluation
    +
    srcColumnIndex - column index of the cell containing the formula under evaluation
    +
    Returns:
    +
    The evaluated result, possibly an ErrorEval, never null. + Note - Excel uses the error code #NUM! instead of IEEE NaN, so when + numeric functions evaluate to Double.NaN be sure to translate the result to ErrorEval.NUM_ERROR.
    +
    +
  +
+

java.lang.Object
+
- java.lang.Enum<DisplayBlanks>
- +
  - org.apache.poi.xddf.usermodel.chart.DisplayBlanks
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable, java.lang.Comparable<DisplayBlanks>
+
+
+
+
```
public enum DisplayBlanks
+extends java.lang.Enum<DisplayBlanks>
```
+

+ +

+ + +
Enum Constant Summary
+ + + + + + + + + + + + + + +
Enum Constants
Enum Constant and Description
GAP
SPAN
ZERO
+

Enum Constants
Enum Constant and Description
`GAP`
`SPAN`
`ZERO`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DisplayBlanks`	`valueOf(java.lang.String name)` + Returns the enum constant of this type with the specified name. +
`static DisplayBlanks[]`	`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

+ + +
Methods inherited from class java.lang.Enum
+clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

+ + +
Methods inherited from class java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Enum Constant Detail
  + + + +
  - +
    GAP
    +
```
public static final DisplayBlanks GAP
```
    +
  + + + +
  - +
    SPAN
    +
```
public static final DisplayBlanks SPAN
```
    +
  + + + +
  - +
    ZERO
    +
```
public static final DisplayBlanks ZERO
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    values
    +
```
public static DisplayBlanks[] values()
```
    +
    Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
```
+for (DisplayBlanks c : DisplayBlanks.values())
+    System.out.println(c);
+
```
    +
    +
    Returns:
    +
    an array containing the constants of this enum type, in the order they are declared
    +
    +
  + + + +
  - +
    valueOf
    +
```
public static DisplayBlanks valueOf(java.lang.String name)
```
    +
    Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
    +
    +
    Parameters:
    +
    name - the name of the enum constant to be returned.
    +
    Returns:
    +
    the enum constant with the specified name
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    +
    java.lang.NullPointerException - if the argument is null
    +
    +
  +
+

java.lang.Object
+
- org.apache.poi.xddf.usermodel.chart.XDDFTitle
+

+
+

@Beta
+public class XDDFTitle
+extends java.lang.Object

Since:: 4.0.1

+ +
- + + +
  Constructor Summary
  + + + + + + + + +
  Constructors
  Constructor and Description
  XDDFTitle(TextContainer parent, + org.openxmlformats.schemas.drawingml.x2006.chart.CTTitle title)
  +
+ +
- + + +
  Method Summary
  + + + + + + + + + + + + + + + + + + +
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  XDDFTextBody getBody()
  void setOverlay(java.lang.Boolean overlay)
  void setText(java.lang.String text)
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

Constructors
Constructor and Description
`XDDFTitle(TextContainer parent, + org.openxmlformats.schemas.drawingml.x2006.chart.CTTitle title)`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XDDFTextBody`	`getBody()`
`void`	`setOverlay(java.lang.Boolean overlay)`
`void`	`setText(java.lang.String text)`

+ +

+ + +

Constructor Detail

+ + + +

XDDFTitle

public XDDFTitle(TextContainer parent,
+                 org.openxmlformats.schemas.drawingml.x2006.chart.CTTitle title)

+ +

+ + +

Method Detail

+ + + +

+
getBody
+
```
public XDDFTextBody getBody()
```
+

+ + + +

setText

public void setText(java.lang.String text)

+ + + +

setOverlay

public void setOverlay(java.lang.Boolean overlay)

Class SheetRangeAndWorkbookIndexFormatter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

format

Uses of Classorg.apache.poi.ss.formula.SheetRangeAndWorkbookIndexFormatter

Class Frequency

Field Summary

Method Summary

Methods inherited from class org.apache.poi.ss.formula.functions.Fixed2ArgFunction

Methods inherited from class java.lang.Object

Field Detail

instance

Method Detail

evaluate

Class Trend

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Trend

Method Detail

evaluate

Uses of Classorg.apache.poi.ss.formula.functions.Frequency

Uses of Classorg.apache.poi.ss.formula.functions.Trend

Enum DisplayBlanks

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GAP

SPAN

ZERO

Method Detail

values

valueOf

Class XDDFTitle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XDDFTitle

Method Detail

getBody

setText

setOverlay

Uses of Class
org.apache.poi.ss.formula.SheetRangeAndWorkbookIndexFormatter

Uses of Class
org.apache.poi.ss.formula.functions.Frequency

Uses of Class
org.apache.poi.ss.formula.functions.Trend