[]
void
activate()
addComment(String text)
addCommentThreaded(String text)
addCommentThreaded(String text,
String author)
void
void
autoFilter(boolean isFirstRowData)
void
autoFilter(boolean isFirstRowData,
int field)
void
autoFilter(boolean isFirstRowData,
int field,
Object criteria1)
void
autoFilter(boolean isFirstRowData,
int field,
Object criteria1,
AutoFilterOperator op)
void
autoFilter(boolean isFirstRowData,
int field,
Object criteria1,
AutoFilterOperator op,
Object criteria2)
void
autoFilter(boolean isFirstRowData,
int field,
Object criteria1,
AutoFilterOperator op,
Object criteria2,
boolean visibleDropDown)
void
autoFilter(int field)
void
autoFilter(int field,
Object criteria1)
void
autoFilter(int field,
Object criteria1,
AutoFilterOperator op)
void
autoFilter(int field,
Object criteria1,
AutoFilterOperator op,
Object criteria2)
void
autoFilter(int field,
Object criteria1,
AutoFilterOperator op,
Object criteria2,
boolean visibleDropDown)
void
autoFit()
void
autoFit(boolean considerMergedCell)
void
characters(int startIndex,
int length)
void
clear()
void
void
void
void
void
void
void
void
copy(IRange destination,
PasteOption pasteOption)
void
void
void
delete()
void
delete(DeleteShiftDirection shiftDirection)
void
dirty()
find(Object what,
FindOptions options)
find(Object what,
IRange after,
FindOptions options)
void
generateGetPivotDataFunction(IRange destination)
get(int index)
IRange
by index which represents a cell.get(int rowOffset,
int columnOffset)
IRange
which is offset from this range.boolean
getAddress(boolean rowAbsolute,
boolean columnAbsolute)
getAddress(boolean rowAbsolute,
boolean columnAbsolute,
ReferenceStyle referenceStyle)
getAddress(boolean rowAbsolute,
boolean columnAbsolute,
ReferenceStyle referenceStyle,
IRange relativeTo)
getAreas()
IAreas
which represents an array of rangeswhere each range returned by areas represents one cell or range.byte[]
IBorders
which represents the cell borders ofthe cell or range represented by this IRange.getCells()
IRange
object that represents the cells in the specifiedrange.int
int
IRange
object that represents the columns in thespecified range.double
double
IComment
which may be used to get and setComment properties of the cells.int
getCount()
IRange
object that represents the entire array.getDependents(boolean includeIndirect)
IRange
which represents the same range ofcells, but expanded to include all rows.IRange
representing the area of the current range which isiteratively grown as needed until it includes no partial merged cells.IRange
which represents the same range ofcells, but expanded to include all columns.getFont()
IFont
which may be used to get and set fontproperties of the cells represented by this IRange.boolean
boolean
boolean
boolean
double
double
boolean
HorizontalAlignment
of a cell or range.IValidation
which may be used to get and setHyperLinks properties.int
IInterior
which represents the interior (background)color and pattern of the specified cell(s).int
int
boolean
IRange
representing the merged range containing thespecified cell.boolean
int
int
getPrecedents(boolean includeInDirect)
int
getRow()
int
double
double
getRows()
IRange
object that represents the rows in the specifiedrange.boolean
boolean
ISparklineGroups
which may be used to get andset SparklineGroups properties of the cellsgetStyle()
IStyle
associated with the cells represented bythis IRange.boolean
getTag()
getText()
IRange
representing the used range in the current range.getUsedRange(EnumSet<UsedRangeType> type)
IRange
representing the used range in the current range.boolean
IRange
object equals the standardheight of the sheet.boolean
IRange
object equals thestandard width of the sheet.IValidation
which may be used to get and setvalidation properties of the cells represented by this IRange.boolean
IRange
are the same; otherwise, false is returned.getValue()
Date
, Object[][] or null;VerticalAlignment
of a cell or range.double
getWidth()
double
IWorksheet
of this range.boolean
boolean
void
group()
importData(Object items)
importData(Object items,
DataImportOptions options)
void
insert()
void
insert(InsertShiftDirection shiftDirection)
boolean
void
merge()
void
merge(boolean isAcross)
offset(int rowOffset,
int columnOffset)
void
int
int
replace(Object what,
Object replacement,
ReplaceOptions options)
void
select()
void
setAddIndent(boolean value)
void
setBackgroundImage(byte[] backgroundImage)
void
setBackgroundImageLayout(BackgroundImageLayout backgroundImageLayout)
void
setBindingPath(String value)
void
setCellPadding(ICellPadding cellPadding)
void
setCellType(BaseCellType cellType)
void
setColumnWidth(double value)
void
setColumnWidthInPixel(double value)
void
setDecoration(ICellDecoration value)
void
setDefaultValue(Object value)
void
setFormula(String value)
void
setFormula2(String value)
void
setFormula2Local(String value)
void
setFormula2R1C1(String value)
void
setFormula2R1C1Local(String value)
void
setFormulaArray(String value)
void
setFormulaArrayR1C1(String value)
void
setFormulaHidden(boolean value)
void
setFormulaLocal(String value)
void
setFormulaR1C1(String value)
void
setFormulaR1C1Local(String value)
void
setHidden(boolean value)
void
HorizontalAlignment
of a cell or range.void
setIgnoredError(EnumSet<IgnoredErrorType> value)
void
setIndentLevel(int value)
void
setLocked(boolean value)
void
setMergeCells(boolean value)
void
setNumberFormat(String value)
void
setOrientation(int value)
void
setOutlineLevel(int value)
void
setReadingOrder(ReadingOrder value)
void
setRowHeight(double value)
void
setRowHeightInPixel(double value)
void
setShowDetail(boolean value)
void
setShrinkToFit(boolean value)
void
IStyle
associated with the cells represented bythis IRange.void
void
setUseStandardHeight(boolean value)
IRange
object equals the standardheight of the sheet.void
setUseStandardWidth(boolean value)
IRange
object equals thestandard width of the sheet.void
void
VerticalAlignment
of a cell or range.void
setWatermark(String watermark)
void
setWrapText(boolean value)
void
sort(IRange key,
SortOrder order,
SortOrientation orientation)
void
sort(IRange key,
SortOrder order,
SortOrientation orientation,
boolean caseSensitive)
void
sort(SortOrientation orientation,
boolean caseSensitive,
IValueSortField... keys)
specialCells(SpecialCellType type)
specialCells(SpecialCellType type,
SpecialCellsValue value)
void
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList)
void
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace)
void
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace,
boolean pageBreaks)
void
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
boolean replace,
boolean pageBreaks,
SummaryRow summaryRowLocation)
void
subtotal(int groupBy,
ConsolidationFunction subtotalFunction,
int[] totalList,
SummaryRow summaryRowLocation)
void
toImage(OutputStream stream,
ImageType imageType)
void
toImage(OutputStream stream,
ImageType imageType,
ImageSaveOptions options)
void
void
toImage(String imageFile,
ImageSaveOptions options)
toJson()
void
ungroup()
void
unmerge()
IRange
object that represents the rows in the specifiedrange.IRange
object that represents the columns in thespecified range.IRange
object that represents the cells in the specifiedrange.IFont
which may be used to get and set fontproperties of the cells represented by this IRange.IBorders
which represents the cell borders ofthe cell or range represented by this IRange.IInterior
which represents the interior (background)color and pattern of the specified cell(s).HorizontalAlignment
of a cell or range.HorizontalAlignment
of a cell or range.VerticalAlignment
of a cell or range.VerticalAlignment
of a cell or range.IStyle
associated with the cells represented bythis IRange.IStyle
associated with the cells represented bythis IRange.IValidation
which may be used to get and setvalidation properties of the cells represented by this IRange.IValidation
which may be used to get and setHyperLinks properties.IComment
which may be used to get and setComment properties of the cells.ISparklineGroups
which may be used to get andset SparklineGroups properties of the cellsIWorksheet
of this range.IRange
which represents the same range ofcells, but expanded to include all columns.IRange
which represents the same range ofcells, but expanded to include all rows.IRange
representing the area of the current range which isiteratively grown as needed until it includes no partial merged cells.IRange
representing the merged range containing thespecified cell. If the specified cell isn't in a merged range, this property returns the specified cell.IRange
object that represents the entire array.Date
, Object[][] or null;value
- The EnumSet of IgnoredErrorType
.IgnoredErrorType
.IAreas
which represents an array of rangeswhere each range returned by areas represents one cell or range.IRange
representing the used range in the current range.IRange
representing the used range in the current range.type
- The feature type.IRange
which is offset from this range.rowOffset
- The row offset.columnOffset
- The column offset.IRange
by index which represents a cell.index
- The index of the range.isAcross
- Optional Object. True to merge cells in each row of thespecified range as separate merged cells. The default value is False.shiftDirection
- Specifies which way to shift the cells.shiftDirection
- Specifies which way to shift the cells.text
- The text you want to add.orientation
- The orientation.caseSensitive
- if set to true, case sensitive.keys
- The IValueSortField
array.key
- The key of the sort column.order
- The sort order, ascending or dscendingorientation
- The orientation.caseSensitive
- if set to true, case sensitive.key
- The key of the sort column.order
- The sort order, ascending or dscendingorientation
- The orientation.field
- Optional Object. The integer offset of the field onwhich you want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").op
- Optional AutoFilterOperatorcriteria2
- Optional Object. The second criteria (a string). Usedwith Criteria1 and Operator to construct compound criteria.visibleDropDown
- Optional Object. True to display the AutoFilterdrop-down arrow for the filtered field; False to hide the AutoFilter drop-down arrow for the filtered field. True by default.field
- Optional Object. The integer offset of the field on which youwant to base the filter (from the left of the list; the leftmost field is field zero).field
- Optional Object. The integer offset of the field on whichyou want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").field
- Optional Object. The integer offset of the field on whichyou want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").op
- Optional AutoFilterOperatorfield
- Optional Object. The integer offset of the field on whichyou want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").op
- Optional AutoFilterOperatorcriteria2
- Optional Object. The second criteria (a string). Used withCriteria1 and Operator to construct compound criteria.isFirstRowData
- Indicates whether the first row of the selection area participates in filtering.When set to true, the behavior is consistent with SpreadJS; when false, it is consistent with Microsoft Excel.field
- Optional Object. The integer offset of the field onwhich you want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").op
- Optional AutoFilterOperatorcriteria2
- Optional Object. The second criteria (a string). Usedwith Criteria1 and Operator to construct compound criteria.visibleDropDown
- Optional Object. True to display the AutoFilterdrop-down arrow for the filtered field; False to hide the AutoFilter drop-down arrow for the filtered field. True by default.isFirstRowData
- Indicates whether the first row of the selection area participates in filtering.When set to true, the behavior is consistent with SpreadJS; when false, it is consistent with Microsoft Excel.isFirstRowData
- Indicates whether the first row of the selection area participates in filtering.When set to true, the behavior is consistent with SpreadJS; when false, it is consistent with Microsoft Excel.field
- Optional Object. The integer offset of the field on which youwant to base the filter (from the left of the list; the leftmost field is field zero).isFirstRowData
- Indicates whether the first row of the selection area participates in filtering.When set to true, the behavior is consistent with SpreadJS; when false, it is consistent with Microsoft Excel.field
- Optional Object. The integer offset of the field on whichyou want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").isFirstRowData
- Indicates whether the first row of the selection area participates in filtering.When set to true, the behavior is consistent with SpreadJS; when false, it is consistent with Microsoft Excel.field
- Optional Object. The integer offset of the field on whichyou want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").op
- Optional AutoFilterOperatorisFirstRowData
- Indicates whether the first row of the selection area participates in filtering.When set to true, the behavior is consistent with SpreadJS; when false, it is consistent with Microsoft Excel.field
- Optional Object. The integer offset of the field on whichyou want to base the filter (from the left of the list; the leftmost field is field zero).criteria1
- Optional Object. The criteria (a string; for example,"101"). Use "=" to find blank fields, or use " <>" to find nonblank fields. If this argument is omitted, the criteria is All. If Operator is xlTop10Items, Criteria1 specifies the number of items (for example, "10").op
- Optional AutoFilterOperatorcriteria2
- Optional Object. The second criteria (a string). Used withCriteria1 and Operator to construct compound criteria.
The following statements are true: 1.The range must be in a single summary row or column. 2.This property returns False if any of the children of the row or column are hidden. 3.Setting this property to True is equivalent to unhiding all the children of the summary row or column. 4.Setting this property to False is equivalent to hiding all the children of the summary row or column.
The following statements are true: 1.The range must be in a single summary row or column. 2.This property returns False if any of the children of the row or column are hidden. 3.Setting this property to True is equivalent to unhiding all the children of the summary row or column. 4.Setting this property to False is equivalent to hiding all the children of the summary row or column.
Use copy(IRange,PasteOption)
instead.
destination
- Specifies the new range to which the specified range willbe pasted. It can be the range of the same or another workbook.pasteType
- Specifies the part of the range to be pasted.destination
- Specifies the new range to which the specified range willbe pasted. It can be the range of the same or another workbook.pasteOption
- Specifies the part of the range to be pasted andwhether to include hidden range.destination
- Specifies the new range to which the specified range willbe pasted. It can be the range of the same or another workbook.IRange
are the same; otherwise, false is returned.IRange
object equals the standardheight of the sheet.IRange
object equals the standardheight of the sheet.IRange
object equals thestandard width of the sheet.IRange
object equals thestandard width of the sheet.what
- The data to search for. Can be a String, double, Date,Calendar, boolean or int.after
- The cell after which you want the search to begin. Thiscorresponds to the position of the active cell when a search is done from the user interface. Notice that After must be a single cell in the range. Remember that the search begins after this cell; the specified cell isn't searched until the method wraps back around to this cell. If you do not specify this argument, the search starts at the cell in the upper-left corner of the range when FindOptions.SearchDirection is SearchDirection.Next, or at the cell in the bottom-right corner of the range when FindOptions.SearchDirection is SearchDirection.Previous.options
- The find optionswhat
- The data to search for. Can be a String, double, Date,LocalDateTime, Calendar, boolean or int.after
- The cell after which you want the search to begin. Thiscorresponds to the position of the active cell when a search is done from the user interface. Notice that After must be a single cell in the range. Remember that the search begins after this cell; the specified cell isn't searched until the method wraps back around to this cell. If you do not specify this argument, the search starts at the cell in the upper-left corner of the range when FindOptions.SearchDirection is SearchDirection.Next, or at the cell in the bottom-right corner of the range when FindOptions.SearchDirection is SearchDirection.Previous.what
- The data to search for. Can be a String, double, Date,LocalDateTime, Calendar, boolean or int.what
- The data to search for. Can be a String, double, Date,LocalDateTime, Calendar, boolean or int.options
- The find optionswhat
- The string you want to search for.replacement
- The replacement string.what
- The string you want to search for.replacement
- The replacement string.options
- The replace options.considerMergedCell
- Indicates whether to consider merged cells in a single row.groupBy
- The field to group by, as a one-based integer offset.subtotalFunction
- The subtotal function.totalList
- An array of 1-based field offsets, indicating the fields to which the subtotals are added.groupBy
- The field to group by, as a one-based integer offset.subtotalFunction
- The subtotal function.totalList
- An array of 1-based field offsets, indicating the fields to which the subtotals are added.replace
- True to replace existing subtotals. The default value is True.groupBy
- The field to group by, as a one-based integer offset.subtotalFunction
- The subtotal function.totalList
- An array of 1-based field offsets, indicating the fields to which the subtotals are added.replace
- True to replace existing subtotals. The default value is True.pageBreaks
- True to add page breaks after each group. The default value is False.groupBy
- The field to group by, as a one-based integer offset.subtotalFunction
- The subtotal function.totalList
- An array of 1-based field offsets, indicating the fields to which the subtotals are added.summaryRowLocation
- Places the summary data relative to the subtotal. The default value is Below.groupBy
- The field to group by, as a one-based integer offset.subtotalFunction
- The subtotal function.totalList
- An array of 1-based field offsets, indicating the fields to which the subtotals are added.replace
- True to replace existing subtotals. The default value is True.pageBreaks
- True to add page breaks after each group. The default value is False.summaryRowLocation
- Places the summary data relative to the subtotal. The default value is Below.includeInDirect
- Indicates whether to include indirect precedents.includeIndirect
- Include the indirect dependent cells.imageFile
- The output image file.imageFile
- The output image file.options
- The options for output image.stream
- The output image stream.imageType
- Specifies the type of image to create.stream
- The output image stream.imageType
- Specifies the type of image to create.options
- The options for output image.columnAbsolute
- True to return the column part of the reference as an absolute reference.The default value is true.rowAbsolute
- True to return the row part of the reference as an absolute reference.The default value is true.columnAbsolute
- True to return the column part of the reference as an absolute reference.The default value is true.rowAbsolute
- True to return the row part of the reference as an absolute reference.The default value is true.referenceStyle
- The reference style. The default value is A1.columnAbsolute
- True to return the column part of the reference as an absolute reference.The default value is true.rowAbsolute
- True to return the row part of the reference as an absolute reference.The default value is true.referenceStyle
- The reference style. The default value is A1.relativeTo
- If RowAbsolute and ColumnAbsolute are false,and ReferenceStyle is R1C1, defines a starting point for the relative reference. The default reference is $A$1.ICellPadding
objectSpreadJS only.cellPadding
- SpreadJS only.watermark
- The watermark stringvalue
- The cell decoration.ILabelOptions
objectSpreadJS only.json
- the json string that contains range info.text
- The string is content of the threaded comment.text
- The string is content of the threaded comment.author
- Author name of the threaded comment.destination
- Indicates for which area the "GETPIVOTDATA" function is generated.range2
- The range to intersect with this range.ranges
- The intersecting ranges.range2
- The range to union with this range.ranges
- Other ranges to union with this range.rowOffset
- Row offset.columnOffset
- Column offset.goal
- Specifies the desired goal value.changingCell
- Specifies the cell to change.backgroundImage
- Cell background image byte array.backgroundImageLayout
- Background image layout of cell.items
- The items to import. The element type can be:byte
, short
, int
, long
, float
, double
, boolean
.Byte
, Short
, Integer
, Long
, Float
, Double
, Boolean
, String
, CalcError
, Classic date and time types: Date
, Calendar
, JSR310 date and time types: LocalDate
, LocalTime
, LocalDateTime
, OffsetTime
, OffsetDateTime
, ZonedDateTime
, Instant
, YearMonth
, Year
, MonthDay
. (Note: Duration
and Period
are not supported at this time)Map
where the key is String
: It will be treated as a collection of property names and values.Iterable
or array. ClassCastException
- The data type of column is inconsistent. Use DataImportOptions.setItemTypeProvider(java.util.function.Function<java.lang.Object, java.lang.Class<?>>)
to fix it.IllegalArgumentException
- An item is of an unsupported type or options
contains incorrect information.items
- The items to import. The element type can be:byte
, short
, int
, long
, float
, double
, boolean
.Byte
, Short
, Integer
, Long
, Float
, Double
, Boolean
, String
, CalcError
, Classic date and time types: Date
, Calendar
, JSR310 date and time types: LocalDate
, LocalTime
, LocalDateTime
, OffsetTime
, OffsetDateTime
, ZonedDateTime
, Instant
, YearMonth
, Year
, MonthDay
. (Note: Duration
and Period
are not supported at this time)Map
where the key is String
: It will be treated as a collection of property names and values.Iterable
or array. options
- The import options.ClassCastException
- The data type of column is inconsistent. Use DataImportOptions.setItemTypeProvider(java.util.function.Function<java.lang.Object, java.lang.Class<?>>)
to fix it.IllegalArgumentException
- An item is of an unsupported type or options
contains incorrect information.