Aspose.Cells for Java

https://reference.aspose.com/cells/java
Admin
Aspose.Cells for Java is a Java library that enables developers to create, manipulate, convert, and...
Tokens:3,111,890
Snippets:42,081
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create and manipulate equation nodes in Excel

Source: https://reference.aspose.com/cells/java/com.aspose.cells/equationnode

This example shows how to instantiate a Workbook, add an equation TextBox, get the starting equation node, insert a fraction equation, set its numerator and denominator with text runs, and save the workbook. It demonstrates the use of EquationNodeType, FractionEquationNode, EquationComponentNode, and TextRunEquationNode.

```java
         // Instantiate a Workbook object that represents Excel file.
         Workbook workbook = new Workbook();
 
         // Adds an equation object to the worksheet.
         TextBox textBox = workbook.getWorksheets().get(0).getShapes().addEquation(1, 0, 1, 0, 100, 300);
 
         // Gets the starting node of the equation object
         EquationNode mathNode = textBox.getEquationParagraph().getChild(0);
 
         // Inserts a fractional equation.
         FractionEquationNode node = (FractionEquationNode)mathNode.addChild(EquationNodeType.FRACTION);
         node.setFractionType(EquationFractionType.SKEWED);
 
         String str1 = "A";
         EquationComponentNode numerator = (EquationComponentNode)node.addChild(EquationNodeType.NUMERATOR);
         TextRunEquationNode TR = (TextRunEquationNode)(numerator.addChild(EquationNodeType.TEXT));
         TR.setText(str1);
 
         String str2 = "B";
         EquationComponentNode denominator = (EquationComponentNode)node.addChild(EquationNodeType.DENOMINATOR);
         TR = (TextRunEquationNode) (denominator.addChild(EquationNodeType.TEXT));
         TR.setText(str2);
 
         //do your business
 
         //Save the excel file.
         workbook.save("exmaple.xlsx");
```

--------------------------------

### Get Slicer Cache (getParent example)

Source: https://reference.aspose.com/cells/java/com.aspose.cells/slicer

Example code for the getParent() method, which is now obsolete. The example shows getting the slicer cache from a slicer.

```java
SlicerCache slicerCache = slicer.getSlicerCache();
```

--------------------------------

### Set up license and format chart floor in Java

Source: https://reference.aspose.com/cells/java/com.aspose.cells/floor

Use this example to apply a license, create a workbook with a 3-D stacked column chart, and customize the chart's floor border and gradient fill. Requires an Aspose.Cells license file named 'Aspose.Cells.lic' embedded in the assembly. The example saves the workbook as 'dest.xls'.

```java
         //Instantiate the License class
         License license = new License();
 
         //Pass only the name of the license file embedded in the assembly
         license.setLicense("Aspose.Cells.lic");
 
         //Instantiate the workbook object
         Workbook workbook = new Workbook();
 
         //Get cells collection
         Cells cells = workbook.getWorksheets().get(0).getCells();
 
         //Put values in cells
         cells.get("A1").putValue(1);
 
         cells.get("A2").putValue(2);
 
         cells.get("A3").putValue(3);
 
         //get charts colletion
         ChartCollection charts = workbook.getWorksheets().get(0).getCharts();
 
         //add a new chart 
         int index = charts.add(ChartType.COLUMN_3_D_STACKED, 5, 0, 15, 5);
 
         //get the newly added chart
         Chart chart = charts.get(index);
 
         //set charts nseries
         chart.getNSeries().add("A1:A3", true);
 
         //Show data labels
         chart.getNSeries().get(0).getDataLabels().setShowValue(true);
 
         //Get chart's floor
         Floor floor = chart.getFloor();
 
         //set floor's border as red
         floor.getBorder().setColor(com.aspose.cells.Color.getRed());
 
         //set fill format
         floor.getFillFormat().setPresetColorGradient(GradientPresetType.CALM_WATER, GradientStyleType.DIAGONAL_DOWN, 2); 
 
         //save the file
         workbook.save("dest.xls");
```

--------------------------------

### Get shape by index example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/shapecollection

Example usage of get(int index): retrieves the first shape in the collection.

```java
//get the first shape
         Shape shape = shapes.get(0);

```

--------------------------------

### Example: Create and add a CustomCommandButton

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/customcommandbutton

Shows how to instantiate a CustomCommandButton, set its command and image URL, and add it to the GridWeb control's custom command buttons collection.

```java
GridWebBean GridWeb1=ExtPage.getInstance().getBean();
CustomCommandButton button = new CustomCommandButton();
button.setCommand("MyCommand");
button.setImageUrl("images/button1.gif");
GridWeb1.getCustomCommandButtons().add(button);

```

--------------------------------

### getOriginalHeight() Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/picture

Gets the original height of the picture. Example shows adding a picture, retrieving it, and getting its original height.

```java
//Instantiating a Workbook object
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.getWorksheets().get(0);
//Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
//Get the inserted picture object
Picture pic = worksheet.getPictures().get(imgIndex);
//Gets the original height of the picture.
int picHeight = pic.getOriginalHeight();
//Save the excel file.
workbook.save("result.xlsx");

```

--------------------------------

### GridWorkbookSettings usage example

Source: https://reference.aspose.com/cells/java/com.aspose.gridjs/gridworkbooksettings

Shows how to create a GridJsWorkbook, set its settings to a new GridWorkbookSettings instance, and then proceed with business logic.

```java
GridJsWorkbook g = new GridJsWorkbook();
 
         GridWorkbookSettings gsettings = new GridWorkbookSettings();
         g.setSettings(gsettings);
 
         //do your business

```

--------------------------------

### get(String cellName) usage example

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/gridcells

Example showing how to get the cell at 'A1' using the get(String) method. It creates a GridWeb instance, obtains the cells collection, and retrieves the cell by name.

```java
GridWeb GridWeb1 = new GridWeb();
          GridCells cells = GridWeb1.getWorkSheets().get(0).getCells();
          GridCell cell = cells.get("A1");	//Gets the cell at "A1"
```

--------------------------------

### Example: Apply style to columns and save workbook

Source: https://reference.aspose.com/cells/java/com.aspose.cells/columncollection

Demonstrates creating a Workbook, accessing the first worksheet, creating a style with blue background and solid pattern, setting width of first ten columns, applying the style to those columns, and saving the file as book1.xls.

```java
//Instantiating a Workbook object
Workbook workbook = new Workbook();

//Obtaining the reference of the first worksheet
Worksheet worksheet = workbook.getWorksheets().get(0);

//Add new Style to Workbook
Style style = workbook.createStyle();

//Setting the background color to Blue
style.setForegroundColor(Color.getBlue());

//setting Background Pattern
style.setPattern(BackgroundType.SOLID);

//New Style Flag
StyleFlag styleFlag = new StyleFlag();

//Set All Styles
styleFlag.setAll(true);

//Change the default width of first ten columns
for (int i = 0; i ? i++)
{
    worksheet.getCells().getColumns().get(i).setWidth(20);
}

//Get the Column with non default formatting
ColumnCollection columns = worksheet.getCells().getColumns();

for (Column column : (Iterable<Column>) columns)
{
    //Apply Style to first ten Columns
    column.applyStyle(style, styleFlag);
}

//Saving the Excel file
workbook.save("book1.xls");
```

--------------------------------

### Create a CellArea

Source: https://reference.aspose.com/cells/java/com.aspose.cells/cellarea

Example from the documentation showing how to instantiate a CellArea and set its row and column boundaries.

```java
//Create Cell Area
CellArea ca = new CellArea();
ca.StartRow = 0;
ca.EndRow = 0;
ca.StartColumn = 0;
ca.EndColumn = 0;
```

--------------------------------

### get(int index) Method and Example with SlicerCacheItem

Source: https://reference.aspose.com/cells/java/com.aspose.cells/slicercacheitemcollection

Gets the SlicerCacheItem at the specified index. The provided example retrieves the first item from an items collection.

```java
public SlicerCacheItem get(int index)
```

```java
SlicerCacheItem item = items.get(0);
```

--------------------------------

### Get shape by name example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/shapecollection

Example usage of get(String name): adds a rectangle and retrieves it by name 'Rectangle 1', checking for null.

```java
//add a shape
         shapes.addRectangle(2, 0, 2, 0, 130, 130);
         //get the shape by the name.
         Shape shape1 = shapes.get("Rectangle 1");
         if(shape1 != null)
         {
             //Got the shape named 'Rectangle 1'.
         }

```

--------------------------------

### Example usage of GridWorkbookSettings

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/gridworkbooksettings

Creates a GridWeb instance and a GridWorkbookSettings instance, then sets the settings on the GridWeb.

```java
GridWeb gridweb = new GridWeb();
GridWorkbookSettings gsettings = new GridWorkbookSettings();
gridweb.setSettings(gsettings);

//do your business
```

--------------------------------

### Example: Using ColumnCollection to set column widths and styles

Source: https://reference.aspose.com/cells/javascript-cpp/columncollection

Shows how to instantiate a Workbook, create a style, set column widths for the first ten columns, and apply the style to those columns using the ColumnCollection. The example saves the workbook as XLSX.

```javascript
const { Workbook, Color, BackgroundType, StyleFlag, SaveFormat } = AsposeCells;

//Instantiating a Workbook object
var workbook = new Workbook();
//Obtaining the reference of the first worksheet
var worksheet = workbook.worksheets.get(0);
//Add new Style to Workbook
var style = workbook.createStyle();
//Setting the background color to Blue
style.foregroundColor = Color.Blue;
//setting Background Pattern
style.pattern = BackgroundType.Solid;
//New Style Flag
var styleFlag = new StyleFlag();
//Set All Styles
styleFlag.all = true;

//Change the default width of first ten columns
for (var i = 0; i < 10; i++) {
    worksheet.cells.columns.get(i).width = 20;
}

//Get the Column with non default formatting
var columns = worksheet.cells.columns;
var count = columns.count;
for (var i = 0; i < count; i++) {
    var column = columns.getColumnByIndex(i);
    //Apply Style to first ten Columns
    column.applyStyle(style, styleFlag);
}

//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);
```

--------------------------------

### get(int index)

Source: https://reference.aspose.com/cells/java/com.aspose.cells/shapeguidecollection

Gets a shape guide by index.

```APIDOC
## get(int index)

### Description
Gets a shape guide by index.

### Method
get

### Signature
```java
public ShapeGuide get(int index)
```

### Parameters
- **index** (int) - Required - The index of the shape guide.

### Returns
- **ShapeGuide** - The shape guide at the specified index.
```

--------------------------------

### Initialize workbook and add SpinButton ActiveX control

Source: https://reference.aspose.com/cells/java/com.aspose.cells/spinbuttonactivexcontrol

Shows how to create a workbook, add a SpinButton ActiveX control, and save the file.

```java
//Initialize a new workbook.
Workbook book = new Workbook();

//Add a ToggleButtonActiveXControl.
Shape shape = book.getWorksheets().get(0).getShapes().addActiveXControl(ControlType.SPIN_BUTTON, 1, 0, 1, 0, 100, 50);
SpinButtonActiveXControl activeXControl = (SpinButtonActiveXControl)shape.getActiveXControl();

//do your business

//Save the excel file.
book.save("exmaple.xlsx");
```

--------------------------------

### start

Source: https://reference.aspose.com/cells/javascript-cpp/pivotnumericrangegroupsettings

Readonly property that gets the start number of the group.

```APIDOC
## start

### Description
Readonly. Gets the start number of the group.

### Property
`start : number;`
```

--------------------------------

### Label Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/label

Demonstrates how to create a Label, set its text, placement, fill color, and save the workbook.

```APIDOC
## Label Example

### Description
Creates a new Workbook, adds a Label to the first worksheet, sets its caption, placement, fill color, and saves the file.

### Code
```java
//Create a new Workbook.
Workbook workbook = new Workbook();

//Get the first worksheet in the workbook.
Worksheet sheet = workbook.getWorksheets().get(0);

//Add a new label to the worksheet.
Label label = sheet.getShapes().addLabel(2, 0, 2, 0, 60, 120);

//Set the caption of the label.
label.setText("This is a Label");

//Set the Placement Type, the way the
//label is attached to the cells.
label.setPlacement(PlacementType.FREE_FLOATING);

//Set the fill color of the label.
label.getFill().setFillType(FillType.SOLID);
label.getFill().getSolidFill().setColor(Color.getYellow());

//Saves the file.
workbook.save("tstlabel.xls");
```
```

--------------------------------

### start

Source: https://reference.aspose.com/cells/javascript-cpp/pivotdatetimerangegroupsettings

Gets the start date time of the group. This property is read-only.

```APIDOC
## start

### Description
Gets the start date time of the group. This property is read-only.

### Property
start : Date;

```

--------------------------------

### getValue()

Source: https://reference.aspose.com/cells/java/com.aspose.cells/shapeguide

Gets the value of this guide. Returns a double representing the guide value.

```APIDOC
## getValue()

### Description
Gets the value of this guide.

### Method
GET

### Endpoint
ShapeGuide.getValue()

### Parameters
None

### Returns
double - The value of this guide.

### Example
```java
ShapeGuide guide = ...;
double value = guide.getValue();
```
```

--------------------------------

### Create and Configure PivotTable with Timeline Data

Source: https://reference.aspose.com/cells/java/com.aspose.cells/timelinecollection

This example demonstrates how to set up a worksheet with data, create a PivotTable, and prepare it for timeline usage.

```java
         Workbook book = new Workbook();
         Worksheet sheet = book.getWorksheets().get(0);
         Cells cells = sheet.getCells();
         cells.get(0, 0).setValue("fruit");
         cells.get(1, 0).setValue("grape");
         cells.get(2, 0).setValue("blueberry");
         cells.get(3, 0).setValue("kiwi");
         cells.get(4, 0).setValue("cherry");
 
         //Create date style
         Style dateStyle = new CellsFactory().createStyle();
         dateStyle.setCustom("m/d/yyyy");
         cells.get(0, 1).setValue("date");
         cells.get(1, 1).setValue(new DateTime(2021, 2, 5));
         cells.get(2, 1).setValue(new DateTime(2022, 3, 8));
         cells.get(3, 1).setValue(new DateTime(2023, 4, 10));
         cells.get(4, 1).setValue(new DateTime(2024, 5, 16));
         //Set date style
         cells.get(1, 1).setStyle(dateStyle);
         cells.get(2, 1).setStyle(dateStyle);
         cells.get(3, 1).setStyle(dateStyle);
         cells.get(4, 1).setStyle(dateStyle);
 
         cells.get(0, 2).setValue("amount");
         cells.get(1, 2).setValue(50);
         cells.get(2, 2).setValue(60);
         cells.get(3, 2).setValue(70);
         cells.get(4, 2).setValue(80);
 
         PivotTableCollection pivots = sheet.getPivotTables();
         //Add a PivotTable
         int pivotIndex = pivots.add("=Sheet1!A1:C5", "A12", "TestPivotTable");
         PivotTable pivot = pivots.get(pivotIndex);
         pivot.addFieldToArea(PivotFieldType.ROW, "fruit");
         pivot.addFieldToArea(PivotFieldType.COLUMN, "date");
         pivot.addFieldToArea(PivotFieldType.DATA, "amount");
         pivot.setPivotTableStyleType(PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM_10);
 
         //Refresh PivotTable data
         pivot.refreshData();
         pivot.calculateData();
 
         //do your business
         book.save("out.xlsx");
```

--------------------------------

### constructor()

Source: https://reference.aspose.com/cells/javascript-cpp/xpssaveoptions

Creates options for saving xps file.

```APIDOC
## constructor()

### Description
Creates options for saving xps file.

### Method
constructor

### Signature
```
constructor();
```

### Parameters
None.

### Returns
No return value.
```

--------------------------------

### get(int row, int column) usage example

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/gridcells

Example showing how to get the cell at 'A1' using the get(int, int) method. It creates a GridWeb instance, obtains the cells collection, and retrieves the cell at row 0, column 0.

```java
GridWeb GridWeb1 = new GridWeb();
         GridCells cells = GridWeb1.getWorkSheets().get(0).getCells();
         //Gets the cell at "A1"
         GridCell cell = cells.get(0, 0);
```

--------------------------------

### Example: Using FindOptions to find a cell

Source: https://reference.aspose.com/cells/javascript-cpp/findoptions

Demonstrates how to instantiate FindOptions, set a search range, configure search properties, and find a cell with value 0.

```javascript
const { Workbook, FindOptions, CellArea, LookInType } = AsposeCells;

//Instantiate the workbook object
var workbook = new Workbook(data);
//Get Cells collection 
var cells = workbook.worksheets.get(0).cells;
//Instantiate FindOptions Object
var findOptions = new FindOptions();
//Create a Cells Area
var ca = new CellArea();
ca.startRow = 8;
ca.startColumn = 2;
ca.endRow = 17;
ca.endColumn = 13;

//Set cells area for find options
findOptions.setRange(ca);
//Set searching properties
findOptions.searchBackward = false;
findOptions.searchOrderByRows = true;
findOptions.lookInType = LookInType.Values;
//Find the cell with 0 value
var cell = cells.find(0, null, findOptions);
```

--------------------------------

### Get a picture by index

Source: https://reference.aspose.com/cells/java/com.aspose.cells/picturecollection

Example usage of the get method to retrieve a picture by index.

```java
//get picture collection
//PictureCollection pictures = workbook.Worksheets[0].Pictures;
//add a picture
int index = pictures.add(1, 1, "image.png");
//get the picture
Picture pic = pictures.get(index);
```

--------------------------------

### Floor Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/floor

Demonstrates how to obtain the Floor object from a chart, set its border color, and apply a gradient fill.

```APIDOC
## Floor

### Description
Encapsulates the object that represents the floor of a 3-D chart.

### Inheritance
- java.lang.Object
- com.aspose.cells.Area

### Example
```java
//Instantiate the License class
License license = new License();

//Pass only the name of the license file embedded in the assembly
license.setLicense("Aspose.Cells.lic");

//Instantiate the workbook object
Workbook workbook = new Workbook();

//Get cells collection
Cells cells = workbook.getWorksheets().get(0).getCells();

//Put values in cells
cells.get("A1").putValue(1);

cells.get("A2").putValue(2);

cells.get("A3").putValue(3);

//get charts colletion
ChartCollection charts = workbook.getWorksheets().get(0).getCharts();

//add a new chart 
int index = charts.add(ChartType.COLUMN_3_D_STACKED, 5, 0, 15, 5);

//get the newly added chart
Chart chart = charts.get(index);

//set charts nseries
chart.getNSeries().add("A1:A3", true);

//Show data labels
chart.getNSeries().get(0).getDataLabels().setShowValue(true);

//Get chart's floor
Floor floor = chart.getFloor();

//set floor's border as red
floor.getBorder().setColor(com.aspose.cells.Color.getRed());

//set fill format
floor.getFillFormat().setPresetColorGradient(GradientPresetType.CALM_WATER, GradientStyleType.DIAGONAL_DOWN, 2); 

//save the file
workbook.save("dest.xls");
```

### Methods
- **getBorder()** - Returns the border object of the floor. Used to set the border color.
- **getFillFormat()** - Returns the fill format object of the floor. Used to set gradient fill.
```

--------------------------------

### getActualLowerRightRow() usage example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/arcshape

Example usage of getActualLowerRightRow() to get the actual bottom row.

```java
int rRow = shape.getActualLowerRightRow();
```

--------------------------------

### Create workbook and add hyperlink example

Source: https://reference.aspose.com/cells/javascript-cpp/hyperlink

Shows how to instantiate a Workbook, add a worksheet, add a hyperlink to a URL at cell A1, and save the file as XLSX. Requires the AsposeCells library.

```javascript
const { Workbook, SaveFormat } = AsposeCells;

//Instantiating a Workbook object
var workbook = new Workbook();
//Adding a new worksheet to the Workbook object
workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(0);
//Adding a hyperlink to a URL at "A1" cell
worksheet.hyperlinks.add("A1", 1, 1, "https://www.aspose.com");
//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);
```

--------------------------------

### getId()

Source: https://reference.aspose.com/cells/java/com.aspose.cells/digitalsignature

Gets a GUID which can be cross-referenced with the GUID of the signature line stored in the document content. Default value is Empty (all zeroes) Guid.

```APIDOC
## getId()

### Description
Gets a GUID which can be cross-referenced with the GUID of the signature line stored in the document content. Default value is Empty (all zeroes) Guid.

### Remarks
When set, it associates SignatureLine with corresponding DigitalSignature.

### Method
GET

### Returns
java.util.UUID - The GUID.
```

--------------------------------

### characters() usage example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/arcshape

Example usage of characters() to get a FontSetting object for a range of characters.

```java
FontSetting fontSetting = shape.characters(0, 4);
```

--------------------------------

### Example: Create chart and add series using AsposeCells

Source: https://reference.aspose.com/cells/javascript-cpp/seriescollection

Shows how to instantiate a Workbook, add data, create a column chart, add series (nSeries) with data source A1:B4, set category data C1:C4, and save as Xlsx.

```javascript
const { Workbook, ChartType, SaveFormat } = AsposeCells;

//Instantiating a Workbook object
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "A4" cell
worksheet.cells.get("A4").putValue(200);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(60);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(32);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a sample value to "B4" cell
worksheet.cells.get("B4").putValue(40);
//Adding a sample value to "C1" cell as category data
worksheet.cells.get("C1").putValue("Q1");
//Adding a sample value to "C2" cell as category data
worksheet.cells.get("C2").putValue("Q2");
//Adding a sample value to "C3" cell as category data
worksheet.cells.get("C3").putValue("Y1");
//Adding a sample value to "C4" cell as category data
worksheet.cells.get("C4").putValue("Y2");
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
chart.nSeries.add("A1:B4", true);
//Setting the data source for the category data of NSeries
chart.nSeries.categoryData = "C1:C4";
//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);
```

--------------------------------

### getStartId()

Source: https://reference.aspose.com/cells/java/com.aspose.cells/sqlscriptsaveoptions

Gets the start id.

```APIDOC
## getStartId()

### Description
Gets the start id.

### Method
Getter

### Signature
`public int getStartId()`

### Parameters
None

### Returns
`int` - The start id.
```

--------------------------------

### Create and configure a PivotTable in Java

Source: https://reference.aspose.com/cells/java/com.aspose.cells/pivottable

Shows how to create a workbook, fill cells with sample data, add a pivot table, set row/column/data fields, apply a style, modify a row field's display name, add a top-10 filter, add a format condition, calculate data, and save the workbook.

```java
Workbook book = new Workbook();
         Worksheet sheet = book.getWorksheets().get(0);
         Cells cells = sheet.getCells();
         cells.get(0, 0).setValue("fruit");
         cells.get(1, 0).setValue("grape");
         cells.get(2, 0).setValue("blueberry");
         cells.get(3, 0).setValue("kiwi");
         cells.get(4, 0).setValue("cherry");
         cells.get(5, 0).setValue("grape");
         cells.get(6, 0).setValue("blueberry");
         cells.get(7, 0).setValue("kiwi");
         cells.get(8, 0).setValue("cherry");
 
         cells.get(0, 1).setValue("year");
         cells.get(1, 1).setValue(2020);
         cells.get(2, 1).setValue(2020);
         cells.get(3, 1).setValue(2020);
         cells.get(4, 1).setValue(2020);
         cells.get(5, 1).setValue(2021);
         cells.get(6, 1).setValue(2021);
         cells.get(7, 1).setValue(2021);
         cells.get(8, 1).setValue(2021);
 
         cells.get(0, 2).setValue("amount");
         cells.get(1, 2).setValue(50);
         cells.get(2, 2).setValue(60);
         cells.get(3, 2).setValue(70);
         cells.get(4, 2).setValue(80);
         cells.get(5, 2).setValue(90);
         cells.get(6, 2).setValue(100);
         cells.get(7, 2).setValue(110);
         cells.get(8, 2).setValue(120);
 
         PivotTableCollection pivots = sheet.getPivotTables();
 
         int pivotIndex = pivots.add("=Sheet1!A1:C9", "A12", "TestPivotTable");
         PivotTable pivot = pivots.get(pivotIndex);
         pivot.addFieldToArea(PivotFieldType.ROW, "fruit");
         pivot.addFieldToArea(PivotFieldType.COLUMN, "year");
         pivot.addFieldToArea(PivotFieldType.DATA, "amount");
 
         pivot.setPivotTableStyleType(PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM_10);
 
         //Change PivotField's attributes
         PivotField rowField = pivot.getRowFields().get(0);
         rowField.setDisplayName("custom display name");
 
         //Add PivotFilter
         int index = pivot.getPivotFilters().add(0, PivotFilterType.COUNT);
         PivotFilter filter = pivot.getPivotFilters().get(index);
         filter.getAutoFilter().filterTop10(0, false, false, 2);
 
         //Add PivotFormatCondition
         int formatIndex = pivot.getPivotFormatConditions().add();
         PivotFormatCondition pfc = pivot.getPivotFormatConditions().get(formatIndex);
         FormatConditionCollection fcc = pfc.getFormatConditions();
         fcc.addArea(pivot.getDataBodyRange());
         int idx = fcc.addCondition(FormatConditionType.CELL_VALUE);
         FormatCondition fc = fcc.get(idx);
         fc.setFormula1("100");
         fc.setOperator(OperatorType.GREATER_OR_EQUAL);
         fc.getStyle().setBackgroundColor(Color.getRed());
 
         PivotTableCalculateOption calculateOption = new PivotTableCalculateOption();
         calculateOption.setRefreshData(true);
         calculateOption.setRefreshCharts(true);
         pivot.calculateData(calculateOption);
 
         //do your business
 
         book.save("out.xlsx");
```

--------------------------------

### getStartCell()

Source: https://reference.aspose.com/cells/java/com.aspose.cells/jsonloadoptions

Gets the start cell.

```APIDOC
## getStartCell()

### Description
Gets the start cell.

### Method
String getStartCell()

### Parameters
None

### Returns
String - the start cell.
```

--------------------------------

### Create a 4x4 display window example

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/gridwebbean

Sets the display window by configuring min/max row and column indices.

```java
// Creates a 4x4 "display window".
GridWeb1.setMinRow(2);
GridWeb1.setMaxRow(5);
GridWeb1.setMinColumn(3);
GridWeb1.setMaxColumn(6);
```

--------------------------------

### getFormula Method and Example

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/gridcell

Gets the formula of the GridCell. The example shows how to set a formula for a specific cell.

```java
public String getFormula()
```

```java
         GridWeb GridWeb1 = new GridWeb();
         GridWorksheet sheet = GridWeb1.getActiveSheet();
         sheet.getCells().get("B6").setFormula("=SUM(B2:B5, E1) + sheet1!A1");
```

--------------------------------

### Chart Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/chart

Demonstrates how to create a chart using the Chart class.

```APIDOC
## Chart Example

### Description
Creates a column chart from worksheet data and sets its data range, legend, and title.

### Code
```java
Workbook workbook = new Workbook();
Worksheet sheet = workbook.getWorksheets().get(0);

Cells cells = sheet.getCells();
cells.get(0,1).putValue("Income");
cells.get(1,0).putValue("Company A");
cells.get(2,0).putValue("Company B");
cells.get(3,0).putValue("Company C");
cells.get(1,1).putValue(10000);
cells.get(2,1).putValue(20000);
cells.get(3,1).putValue(30000);

int chartIndex = sheet.getCharts().add(ChartType.COLUMN, 9, 9, 21, 15);

Chart chart = sheet.getCharts().get(chartIndex);
chart.setChartDataRange("A1:B4", true);
chart.setShowLegend(true);
chart.getTitle().setText("Income Analysis");
```
```

--------------------------------

### constructor()

Source: https://reference.aspose.com/cells/javascript-cpp/loadoptions

Creates an options of loading the file with default settings.

```APIDOC
## constructor()

### Description
Creates an options of loading the file.

### Method
constructor

### Signature
constructor();

### Parameters
None

### Returns
LoadOptions instance

```

--------------------------------

### getType() example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/oleobject

Gets the auto shape type of the OleObject. The example assigns the result to an int variable.

```java
         /*Aspose.Cells.Drawing.AutoShapeType*/int autoShapeType = shape.getType();

```

--------------------------------

### Instantiate Workbook and retrieve custom document properties

Source: https://reference.aspose.com/cells/java/com.aspose.cells/customdocumentpropertycollection

Example from the documentation showing how to create a Workbook and get the custom document properties collection.

```java
//Instantiate a Workbook object
Workbook workbook = new Workbook("book1.xls");

//Retrieve a list of all custom document properties of the Excel file
CustomDocumentPropertyCollection customProperties = workbook.getWorksheets().getCustomDocumentProperties();
```

--------------------------------

### getName() Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/button

Gets the name of the shape. The example sets the shape name to "shape1".

```java
public String getName()

```

```java
shape.setName("shape1");

```

--------------------------------

### getMacroName() Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/button

Gets the name of the macro. The example sets the macro name to "DoWork()".

```java
public String getMacroName()

```

```java
//Sets the name of macro.
         shape.setMacroName("DoWork()");

```

--------------------------------

### Example: Setting font properties and saving workbook

Source: https://reference.aspose.com/cells/javascript-cpp/font

Shows how to instantiate a Workbook, access a cell, set font name, size, and color, and save the file as XLSX.

```javascript
const { Workbook, Color, SaveFormat } = AsposeCells;

//Instantiating a Workbook object
var workbook = new Workbook();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(0);
//Accessing the "A1" cell from the worksheet
var cell = worksheet.cells.get("A1");
//Adding some value to the "A1" cell
cell.putValue("Hello Aspose!");
var style = cell.getStyle();
var font = style.font;
//Setting the font name to "Times New Roman"
font.setName("Times New Roman");
//Setting font size to 14
font.setSize(14);
//setting font color as Red
font.color = Color.Red;
cell.setStyle(style);
//Saving the Excel file
var uint8Array = workbook.save(SaveFormat.Xlsx);
```

--------------------------------

### getLine() usage example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/button

Gets the line style of the shape. The example assigns the result to a LineFormat variable.

```java
LineFormat lineFmt = shape.getLine();
```

--------------------------------

### constructor(BaseShapeGuide)

Source: https://reference.aspose.com/cells/javascript-cpp/vmlshapeguide

Constructs a VmlShapeGuide instance from a parent BaseShapeGuide object.

```APIDOC
## constructor(BaseShapeGuide)

### Description
Constructs a VmlShapeGuide instance from a parent BaseShapeGuide object.

### Method
constructor

### Signature
constructor(obj: BaseShapeGuide);

### Parameters
- **obj** (BaseShapeGuide) - Required - The parent object.

```

--------------------------------

### MainWeb usage example

Source: https://reference.aspose.com/cells/java/com.aspose.gridweb/mainweb

Example of creating a GridWeb instance and performing business logic. This is a basic usage of the MainWeb control.

```java
GridWeb GridWeb1 = new GridWeb();
         //do your business
```

--------------------------------

### hasLine() example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/oleobject

Gets whether the line border of the shape is visible. The example checks if it is false and sets it to true.

```java
         if(shape.hasLine() == false)
             shape.setHasLine(true);

```

--------------------------------

### Instantiate Workbook and add textbox

Source: https://reference.aspose.com/cells/java/com.aspose.cells/textboxcollection

Shows how to create a Workbook, get the TextBoxCollection from the first worksheet, add a textbox, and iterate over the collection.

```java
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //get collection object
         TextBoxCollection textBoxCollection = workbook.getWorksheets().get(0).getTextBoxes();
         //add a textbox
         textBoxCollection.add(1, 1, 50, 100);
         for(TextBox tbox : (Iterable<TextBox>) textBoxCollection)
         {
             //do what you want
         }
 
         //do your business
```

--------------------------------

### Create and configure a chart data series in Java

Source: https://reference.aspose.com/cells/java/com.aspose.cells/series

Shows how to instantiate a Workbook, add a worksheet, populate cells with sample data, add a column chart, add a data series (NSeries) from a cell range, set category data, set series values, change the series type to LINE, and configure marker properties. Ends by saving the workbook to 'book1.xls'.

```java
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //Adding a new worksheet to the Excel object
         int sheetIndex = workbook.getWorksheets().add();
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
         //Adding a sample value to "A1" cell
         worksheet.getCells().get("A1").putValue(50);
         //Adding a sample value to "A2" cell
         worksheet.getCells().get("A2").putValue(100);
         //Adding a sample value to "A3" cell
         worksheet.getCells().get("A3").putValue(150);
         //Adding a sample value to "A4" cell
         worksheet.getCells().get("A4").putValue(200);
         //Adding a sample value to "B1" cell
         worksheet.getCells().get("B1").putValue(60);
         //Adding a sample value to "B2" cell
         worksheet.getCells().get("B2").putValue(32);
         //Adding a sample value to "B3" cell
         worksheet.getCells().get("B3").putValue(50);
         //Adding a sample value to "B4" cell
         worksheet.getCells().get("B4").putValue(40);
         //Adding a sample value to "C1" cell as category data
         worksheet.getCells().get("C1").putValue("Q1");
         //Adding a sample value to "C2" cell as category data
         worksheet.getCells().get("C2").putValue("Q2");
         //Adding a sample value to "C3" cell as category data
         worksheet.getCells().get("C3").putValue("Y1");
         //Adding a sample value to "C4" cell as category data
         worksheet.getCells().get("C4").putValue("Y2");
         //Adding a chart to the worksheet
         int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);
         //Accessing the instance of the newly added chart
         Chart chart = worksheet.getCharts().get(chartIndex);
         //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
         int seriesIndex = chart.getNSeries().add("A1:B4", true);
         //Setting the data source for the category data of NSeries
         chart.getNSeries().setCategoryData("C1:C4");
         Series series = chart.getNSeries().get(seriesIndex);
         //Setting the values of the series.
         series.setValues("=B1:B4");
         //Changing the chart type of the series.
         series.setType(ChartType.LINE);
         //Setting marker properties.
         series.getMarker().setMarkerStyle(ChartMarkerType.CIRCLE);
         series.getMarker().setForegroundColorSetType(FormattingType.AUTOMATIC);
         series.getMarker().setForegroundColor(com.aspose.cells.Color.getBlack());
         series.getMarker().setBackgroundColorSetType(FormattingType.AUTOMATIC);
 
         //do your business
 
         //Saving the Excel file
         workbook.save("book1.xls");
```

--------------------------------

### getGeometry() example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/dialogbox

Gets the geometry of the shape.

```java
public Geometry getGeometry()

```

```java
if (shape.getGeometry() != null &&shape.getGeometry().getShapeAdjustValues().getCount() == 0)
    System.out.println("No geometry path.");

```

--------------------------------

### getControlData() example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/commentshape

Gets the data of control.

```java
if(shape.getControlData() == null)
             System.out.println("No data.");

```

--------------------------------

### Create a table with totals and save as XLSX

Source: https://reference.aspose.com/cells/javascript-cpp/listobject

Demonstrates creating a workbook, populating cells, adding a ListObject, enabling totals, setting sum calculation, and saving as XLSX.

```javascript
const { Workbook, CellsHelper, TotalsCalculation, SaveFormat } = AsposeCells;

var workbook = new Workbook();
var cells = workbook.worksheets.get(0).cells;
for (var i = 0; i < 5; i++) {
    cells.get(0, i).putValue(CellsHelper.columnIndexToName(i));
}
for (var row = 1; row < 10; row++) {
    for (var column = 0; column < 5; column++) {
        cells.get(row, column).putValue(row * column);
    }
}
var tables = workbook.worksheets.get(0).getListObjects();
var index = tables.add(0, 0, 9, 4, true);
var table = tables.get(0);
table.showTotals = true;
table.listColumns.get(4).totalsCalculation = TotalsCalculation.Sum;
var uint8Array = workbook.save(SaveFormat.Xlsx);
```

--------------------------------

### ChartArea Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/chartarea

Demonstrates how to create a chart, access its chart area, set the foreground color, enable shadow, and save the workbook.

```APIDOC
## ChartArea

### Description
Encapsulates the object that represents the chart area in the worksheet.

### Inheritance
java.lang.Object, com.aspose.cells.ChartFrame

### Example
```java
//Instantiating a Workbook object
Workbook workbook = new Workbook();

//Obtaining the reference of the first worksheet
Worksheet worksheet = workbook.getWorksheets().get(0);

//Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50);

//Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100);

//Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150);

//Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(60);

//Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(32);

//Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50);

//Adding a chart to the worksheet
int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);

//Accessing the instance of the newly added chart
Chart chart = worksheet.getCharts().get(chartIndex);

//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
chart.getNSeries().add("A1:B3", true);

//Getting Chart Area
ChartArea chartArea = chart.getChartArea();

//Setting the foreground color of the chart area
chartArea.getArea().setForegroundColor(Color.getYellow());

//Setting Chart Area Shadow
chartArea.setShadow(true);

//Saving the Excel file
workbook.save("book1.xls");
```
```

--------------------------------

### getComment() example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/commentshape

Gets the comment object.

```java
Comment comment = commentShape.getComment();

```

--------------------------------

### startId

Source: https://reference.aspose.com/cells/javascript-cpp/sqlscriptsaveoptions

Gets and sets the start id.

```APIDOC
## startId

### Description
Gets and sets the start id.

### Property
```typescript
startId : number;
```

### Type
number

### Remarks
Only works when IdName is set.

```

--------------------------------

### GroupBox Example

Source: https://reference.aspose.com/cells/java/com.aspose.cells/groupbox

Demonstrates how to create a GroupBox, set its caption, placement, shadow, and save the workbook.

```APIDOC
## GroupBox Example

### Description
Creates a new Workbook, adds a group box to the first worksheet, sets its caption and placement, makes it 2-D, and saves the file.

### Code
```java
//Instantiate a new Workbook.
Workbook excelbook = new Workbook();

//Add a group box to the first worksheet.
GroupBox box = excelbook.getWorksheets().get(0).getShapes().addGroupBox(1, 0, 1, 0, 300, 250);

//Set the caption of the group box.
box.setText("Age Groups");
box.setPlacement(PlacementType.FREE_FLOATING);

//Make it 2-D box.
box.setShadow(false);

//Save the excel file.
excelbook.save("groupbox.xls");
```
```

--------------------------------

### Browser usage with license and fonts

Source: https://reference.aspose.com/cells/javascript-cpp/onready

Browser example that configures a license, font path, and font list before creating a Workbook. The onReady promise ensures the module is initialized before use.

```html
<script src="aspose.cells.js.min.js"></script>
<script>
    const { Workbook } = AsposeCells;
    AsposeCells.onReady({
        license: "/lic/aspose.cells.enc",
        fontPath: "/fonts/",
        fontList: [
            "arial.ttf",
            "NotoSansSC-Regular.ttf"
        ]
    }).then(() => {
        var workbook = new Workbook();
    });
</script>
```

--------------------------------

### getStartRow()

Source: https://reference.aspose.com/cells/java/com.aspose.cells/referredarea

Gets the start row of the area.

```APIDOC
## getStartRow()

### Description
Gets the start row of the area.

### Method
`public int getStartRow()`

### Returns
- **int** - The start row index.
```

--------------------------------

### getStartColumn()

Source: https://reference.aspose.com/cells/java/com.aspose.cells/referredarea

Gets the start column of the area.

```APIDOC
## getStartColumn()

### Description
Gets the start column of the area.

### Method
`public int getStartColumn()`

### Returns
- **int** - The start column index.
```
Tokens:
Raw