Skip to content

Commit 804439a

Browse files
roywangasposeroywangaspose
committed
Add new features about cells cloud 25.8.
1 parent c75c7fb commit 804439a

23 files changed

+1640
-17
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ dist
66
.swagger-codegen-ignore
77
package-lock.json
88
reports
9-
.idea
9+
.idea
10+
test

‎docs/api/add-worksheet-to-spreadsheet.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
# **Spreadsheet Cloud API: addWorksheetToSpreadsheet**
3+
4+
The Web API enables users to add a new worksheet to a workbook, specifying the worksheet's type, position, and name. This function provides flexibility in managing workbook structure by allowing detailed control over worksheet addition.
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/add/worksheet
19+
```
20+
### **Function Description**
21+
By using the AddWorksheet API, you can dynamically manage the structure of your workbook, adding new worksheets with specific types, positions, and names, thereby enhancing your productivity and control over spreadsheet management.**Considerations**: Ensure that the provided sheetName is unique to avoid conflicts with existing worksheets. If using a specific sheetType, ensure that it is supported by the workbook.**Error Handling**: If the sheetName is not provided or is invalid, the function may throw an exception or return an error message. If the position is out of range, the function may throw an exception or return an error message.
22+
23+
### The request parameters of **addWorksheetToSpreadsheet** API are:
24+
25+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
26+
| :- | :- | :- |:- |
27+
|Spreadsheet|File|FormData|Upload spreadsheet file.|
28+
|sheetType|String|Query|Specifies the name of the new worksheet.If not provided, a default name will be assigned.|
29+
|position|Integer|Query|Specifies the position at which the new worksheet should be inserted.If not provided, the worksheet will be added at the end of the workbook.|
30+
|sheetName|String|Query|Specifies the type of worksheet to be added.If not provided, a default worksheet type will be used.|
31+
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
32+
|outStorageName|String|Query|Output file Storage Name.|
33+
|regoin|String|Query|The spreadsheet region setting.|
34+
|password|String|Query|The password for opening spreadsheet file.|
35+
36+
### **Response Description**
37+
```json
38+
{
39+
File
40+
}
41+
```
42+
43+
44+
## OpenAPI Specification
45+
46+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/ManagementController/AddWorksheetToSpreadsheet) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

‎docs/api/aggregate-cells-by-color.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
2+
# **Spreadsheet Cloud API: aggregateCellsByColor**
3+
4+
The Aggregate by Color API provides a convenient way to perform calculations on cells that share the same fill or font color. This API supports a range of aggregate operations, including count, sum, maximum value, minimum value, and average value, enabling you to analyze and summarize data based on color distinctions.
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/calculate/aggergate/color
19+
```
20+
### **Function Description**
21+
The Aggregate by Color API is a powerful tool for data analysis, allowing you to perform color-based aggregations efficiently. Whether you need to count, sum, find the max or min value, or calculate the average, this API provides the flexibility to handle various aggregate operations based on cell colors.- Color-Based Aggregation: Perform calculations on cells grouped by their fill or font color.- Aggregate Operations:- Count: Determine the number of cells with the same color.- Sum: Calculate the total value of cells with the same color.- Max Value: Identify the highest value among cells with the same color.- Min Value: Find the lowest value among cells with the same color.- Average Value: Compute the mean value of cells with the same color.**Example Use Case**Suppose you have a spreadsheet where different categories of data are highlighted with different colors. You can use the Aggregate by Color API to quickly summarize the data for each color category. For instance, you can calculate the total sales for cells highlighted in green or the average cost for cells highlighted in red.
22+
23+
### The request parameters of **aggregateCellsByColor** API are:
24+
25+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
26+
| :- | :- | :- |:- |
27+
|Spreadsheet|File|FormData|Upload spreadsheet file.|
28+
|worksheet|String|Query||
29+
|range|String|Query||
30+
|operation|String|Query||
31+
|colorPosition|String|Query||
32+
|regoin|String|Query|The spreadsheet region setting.|
33+
|password|String|Query|The password for opening spreadsheet file.|
34+
35+
### **Response Description**
36+
```json
37+
{
38+
"Name": "AggregateResultByColorResponse",
39+
"Type": "Class",
40+
"ParentName": "CellsCloudResponse",
41+
"IsAbstract": false,
42+
"Properties": [
43+
{
44+
"Name": "AggregateResults",
45+
"Nullable": true,
46+
"ReadOnly": false,
47+
"IsInherit": false,
48+
"DataType": {
49+
"Identifier": "Container",
50+
"Reference": "AggregateResultByColor",
51+
"ElementDataType": {
52+
"Identifier": "Class",
53+
"Reference": "AggregateResultByColor",
54+
"Name": "class:aggregateresultbycolor"
55+
},
56+
"Name": "container"
57+
}
58+
},
59+
{
60+
"Name": "Code",
61+
"Nullable": true,
62+
"ReadOnly": false,
63+
"IsInherit": true,
64+
"DataType": {
65+
"Identifier": "Integer",
66+
"Name": "integer"
67+
}
68+
},
69+
{
70+
"Name": "Status",
71+
"Nullable": true,
72+
"ReadOnly": false,
73+
"IsInherit": true,
74+
"DataType": {
75+
"Identifier": "String",
76+
"Name": "string"
77+
}
78+
}
79+
]
80+
}
81+
```
82+
83+
84+
## OpenAPI Specification
85+
86+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/CalculateController/AggregateCellsByColor) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

‎docs/api/compress-spreadsheet.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
# **Spreadsheet Cloud API: compressSpreadsheet**
3+
4+
The Web API endpoint allows users to compress a spreadsheet to reduce its file size. This function provides a straightforward way to optimize the storage and performance of spreadsheets by applying a specified compression level.
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/compress
19+
```
20+
### **Function Description**
21+
By using the CompressSpreadsheet API, you can dynamically manage the storage and performance of your spreadsheets, applying specified compression levels to reduce file sizes and optimize storage usage. This feature enhances your ability to manage and optimize your spreadsheets efficiently, ensuring minimal storage usage and enhanced performance.
22+
23+
### The request parameters of **compressSpreadsheet** API are:
24+
25+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
26+
| :- | :- | :- |:- |
27+
|Spreadsheet|File|FormData|Upload spreadsheet file.|
28+
|level|Integer|Query|Specifies the compression level to be applied to the spreadsheet. The level should be within a valid range (e.g., 0-9 for most compression algorithms, where 0 is no compression and 9 is maximum compression).|
29+
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
30+
|outStorageName|String|Query|Output file Storage Name.|
31+
|regoin|String|Query|The spreadsheet region setting.|
32+
|password|String|Query|The password for opening spreadsheet file.|
33+
34+
### **Response Description**
35+
```json
36+
{
37+
File
38+
}
39+
```
40+
41+
42+
## OpenAPI Specification
43+
44+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/ManagementController/CompressSpreadsheet) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

‎docs/api/create-spreadsheet.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
# **Spreadsheet Cloud API: createSpreadsheet**
3+
4+
The Web API allows users to create a new spreadsheet with a specified name. Optionally, a template can be provided to initialize the spreadsheet with predefined content or formatting.
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/create
19+
```
20+
### **Function Description**
21+
By using the CreateSpreadsheet function, you can quickly set up new spreadsheets with or without templates, streamlining your workflow and enhancing productivity.**Considerations**: Ensure that the provided name is unique to avoid conflicts with existing spreadsheets. If using a template, ensure that the template file is accessible and correctly formatted.**Error Handling**: If the name is not provided or is invalid, the function may throw an exception or return an error message. If the template file is specified but cannot be found or is corrupted, the function may also throw an exception or return an error message.
22+
23+
### The request parameters of **createSpreadsheet** API are:
24+
25+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
26+
| :- | :- | :- |:- |
27+
|format|String|Query|Specifies the name of the new spreadsheet. This name will be used to identify the spreadsheet in the system.|
28+
|template|String|Query|template: Optional.If provided, the new spreadsheet will be created based on the specified template.This can be useful for applying predefined layouts and styles.|
29+
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
30+
|outStorageName|String|Query|Output file Storage Name.|
31+
|regoin|String|Query|The spreadsheet region setting.|
32+
|password|String|Query|The password for opening spreadsheet file.|
33+
34+
### **Response Description**
35+
```json
36+
{
37+
File
38+
}
39+
```
40+
41+
42+
## OpenAPI Specification
43+
44+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/ManagementController/CreateSpreadsheet) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

‎docs/api/delete-worksheet-from-spreadsheet.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
# **Spreadsheet Cloud API: deleteWorksheetFromSpreadsheet**
3+
4+
The Web API endpoint allows users to delete a specified worksheet from a workbook. This function provides a straightforward way to manage workbook structure by removing unnecessary or redundant worksheets.
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/delete/worksheet
19+
```
20+
### **Function Description**
21+
By using the Web API, you can dynamically manage the structure of your workbook, removing specified worksheets to maintain a clean and organized spreadsheet environment. This feature enhances your ability to manage and optimize your workbook efficiently.**Considerations**: Ensure that the provided worksheet name is correct and matches an existing worksheet in the workbook. Be cautious when deleting worksheets, as this action cannot be undone.**Error Handling**: If the worksheet name is not provided or does not match any existing worksheet, the function may throw an exception or return an error message. Ensure proper error handling to manage cases where the worksheet does not exist.
22+
23+
### The request parameters of **deleteWorksheetFromSpreadsheet** API are:
24+
25+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
26+
| :- | :- | :- |:- |
27+
|Spreadsheet|File|FormData|Upload spreadsheet file.|
28+
|sheetName|String|Query|Specifies the name or identifier of the worksheet to be deleted. This parameter is required and must match the name of an existing worksheet in the workbook.|
29+
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
30+
|outStorageName|String|Query|Output file Storage Name.|
31+
|regoin|String|Query|The spreadsheet region setting.|
32+
|password|String|Query|The password for opening spreadsheet file.|
33+
34+
### **Response Description**
35+
```json
36+
{
37+
File
38+
}
39+
```
40+
41+
42+
## OpenAPI Specification
43+
44+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/ManagementController/DeleteWorksheetFromSpreadsheet) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

‎docs/api/get-worksheet-pivot-table-filter.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Retrieve PivotTable filters in the worksheet.
88

99
- **Base URL**: `http://api.aspose.cloud/v3.0`
1010
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11-
- **Example**
12-
1311
## **Interface Details**
1412

1513
### **Endpoint**

‎docs/api/import-data-into-spreadsheet.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
2+
# **Spreadsheet Cloud API: importDataIntoSpreadsheet**
3+
4+
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/import/data
19+
```
20+
### **Function Description**
21+
22+
### The request parameters of **importDataIntoSpreadsheet** API are:
23+
24+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
25+
| :- | :- | :- |:- |
26+
|datafile|File|FormData|Upload data file.|
27+
|Spreadsheet|File|FormData|Upload spreadsheet file.|
28+
|worksheet|String|Query||
29+
|startcell|String|Query||
30+
|insert|Boolean|Query||
31+
|convertNumericData|Boolean|Query||
32+
|splitter|String|Query||
33+
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
34+
|outStorageName|String|Query|Output file Storage Name.|
35+
|fontsLocation|String|Query|Use Custom fonts.|
36+
|regoin|String|Query|The spreadsheet region setting.|
37+
|password|String|Query|The password for opening spreadsheet file.|
38+
39+
### **Response Description**
40+
```json
41+
{
42+
File
43+
}
44+
```
45+
46+
47+
## OpenAPI Specification
48+
49+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/DataProcessingController/ImportDataIntoSpreadsheet) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

‎docs/api/math-calculate.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
# **Spreadsheet Cloud API: mathCalculate**
3+
4+
The Math Calculate API enables you to perform a variety of mathematical operations on a selected range of cells. You can add or subtract a specific number from all selected cells, as well as multiply or divide individual cells and entire columns. This API simplifies complex calculations and enhances data manipulation capabilities.
5+
6+
7+
## **Quick Start**
8+
9+
- **Base URL**: `http://api.aspose.cloud/v4.0`
10+
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
11+
- **Example**
12+
13+
## **Interface Details**
14+
15+
### **Endpoint**
16+
17+
```
18+
PUT http://api.aspose.cloud/v4.0/cells/calculate/math
19+
```
20+
### **Function Description**
21+
The API provides a flexible and efficient solution for performing arithmetic operations on a range of cells. Whether you need to add, subtract, multiply, or divide, this API allows you to apply the same operation uniformly across the selected range, enhancing your data manipulation capabilities.**Key Features**- **Add and Subtract**: Add or subtract a specific number from all selected cells.- **Multiply and Divide**: Multiply or divide individual cells and entire columns.- **Uniform Application**: Apply the same operation uniformly across the selected range.
22+
23+
### The request parameters of **mathCalculate** API are:
24+
25+
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
26+
| :- | :- | :- |:- |
27+
|Spreadsheet|File|FormData|Upload spreadsheet file.|
28+
|operation|String|Query||
29+
|value|String|Query||
30+
|worksheet|String|Query||
31+
|range|String|Query||
32+
|regoin|String|Query|The spreadsheet region setting.|
33+
|password|String|Query|The password for opening spreadsheet file.|
34+
35+
### **Response Description**
36+
```json
37+
{
38+
File
39+
}
40+
```
41+
42+
43+
## OpenAPI Specification
44+
45+
The [OpenAPI Specification](https://reference.aspose.cloud/cells/#/CalculateController/MathCalculate) defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

0 commit comments

Comments
 (0)