Skip to content

Commit 9f0b04b

Browse files
committed
ISSUE-CELLSCLOUD-13424: Development of cells cloud sdk 25.9.
1 parent 804439a commit 9f0b04b

File tree

68 files changed

+921
-360
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+921
-360
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Web API enables users to add a new worksheet to a workbook, specifying the w
1818
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/add/worksheet
1919
```
2020
### **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.
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.## **Error Handling**- **400 Bad Request**: Invalid url.- **401 Unauthorized**: Authentication has failed, or no credentials were provided.- **404 Not Found**: Source file not accessible.- **500 Server Error** The spreadsheet has encountered an anomaly in obtaining data.## **Key Features and Benefits**- **Spreadsheet Creation**: Allows users to create a new spreadsheet with a specified name.- **Template Support**: Optionally, users can provide a template to initialize the spreadsheet with predefined content or formatting.- **Flexibility in Workbook Management**: Provides detailed control over the addition of new worksheets, enhancing flexibility in managing workbook structure.
2222

2323
### The request parameters of **addWorksheetToSpreadsheet** API are:
2424

@@ -30,7 +30,7 @@ By using the AddWorksheet API, you can dynamically manage the structure of your
3030
|sheetName|String|Query|Specifies the type of worksheet to be added.If not provided, a default worksheet type will be used.|
3131
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
3232
|outStorageName|String|Query|Output file Storage Name.|
33-
|regoin|String|Query|The spreadsheet region setting.|
33+
|region|String|Query|The spreadsheet region setting.|
3434
|password|String|Query|The password for opening spreadsheet file.|
3535

3636
### **Response Description**

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ The Aggregate by Color API provides a convenient way to perform calculations on
1818
PUT http://api.aspose.cloud/v4.0/cells/calculate/aggergate/color
1919
```
2020
### **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.
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. ## **Error Handling**- **400 Bad Request**: Invalid url.- **401 Unauthorized**: Authentication has failed, or no credentials were provided.- **404 Not Found**: Source file not accessible.- **500 Server Error** The spreadsheet has encountered an anomaly in obtaining calculation data.## **Key Features and Benefits**- **Simplified Data Analysis**: Eliminates manual sorting or filtering of color-coded cells, reducing tedious manual operations and saving time.- **Clear Color-Driven Insights**: Enables users to quickly summarize and understand data rules based on color distinctions(e.g., identifying the total sales value of cells marked with a specific fill color).- **Strong Flexibility**: Adapts to multiple common analysis scenarios(quantity statistics, value summation, extremum search, average calculation) through its diversified aggregate operations, no need for additional custom development.## **Usage Scenarios**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.
2222

2323
### The request parameters of **aggregateCellsByColor** API are:
2424

2525
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
2626
| :- | :- | :- |:- |
2727
|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.|
28+
|worksheet|String|Query|Specified worksheet.|
29+
|range|String|Query|Specified range.|
30+
|operation|String|Query|Specify calculation operation methods, including Sum, Count, Average, Min, and Max.|
31+
|colorPosition|String|Query|Indicates the content to sum and count based on background color and/or font color.|
32+
|region|String|Query|The spreadsheet region setting.|
3333
|password|String|Query|The password for opening spreadsheet file.|
3434

3535
### **Response Description**

docs/api/check-cloud-service-health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Check the Health Status of Aspose.Cells Cloud Service.
1616
GET http://api.aspose.cloud/v4.0/cells/status/check
1717
```
1818
### **Function Description**
19-
This API provides real-time monitoring of Aspose.Cells Cloud service availability and operational status.Returns key health metrics such as service connectivity, response latency, and error rates(if applicable).Use cases:▸ Pre-flight checks before executing critical operations dependent on Aspose.Cells Cloud.▸ Automated service status monitoring for SLA compliance.▸ Diagnostic tooling during integration troubleshooting.Considerations:▸ Requires valid API credentials with read-only health check permissions.▸ Response codes (e.g., 200 OK for healthy, 503 Maintenance for downtime) must be programmatically handled.▸ Implement retry logic with exponential backoff if transient failures are detected.▸ Monitor API rate limits to avoid excessive health check calls.▸ Combine with logging/alerting systems for proactive incident response.
19+
This API provides real-time monitoring of Aspose.Cells Cloud service availability and operational status.Returns key health metrics such as service connectivity, response latency, and error rates(if applicable).Use cases: ▸ Pre-flight checks before executing critical operations dependent on Aspose.Cells Cloud. ▸ Automated service status monitoring for SLA compliance. ▸ Diagnostic tooling during integration troubleshooting.Considerations: ▸ Requires valid API credentials with read-only health check permissions. ▸ Response codes (e.g., 200 OK for healthy, 503 Maintenance for downtime) must be programmatically handled. ▸ Implement retry logic with exponential backoff if transient fa1ilures are detected. ▸ Monitor API rate limits to avoid excessive health check calls. ▸ Combine with logging/alerting systems for proactive incident response.
2020

2121
### The request parameters of **checkCloudServiceHealth** API are:
2222

docs/api/codegen-spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ GET http://api.aspose.cloud/v4.0/cells/codegen/spec
2121

2222
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
2323
| :- | :- | :- |:- |
24-
|regoin|String|Query|The spreadsheet region setting.|
24+
|region|String|Query|The spreadsheet region setting.|
2525
|password|String|Query|The password for opening spreadsheet file.|
2626

2727
### **Response Description**

docs/api/compress-spreadsheet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Web API endpoint allows users to compress a spreadsheet to reduce its file s
1818
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/compress
1919
```
2020
### **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.
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.## **Error Handling**- **400 Bad Request**: Invalid url.- **401 Unauthorized**: Authentication has failed, or no credentials were provided.- **404 Not Found**: Source file not accessible.- **500 Server Error** The spreadsheet has encountered an anomaly in obtaining data.## **Key Features and Benefits**- **Dynamic Compression**: Allows users to compress a spreadsheet to reduce its file size.- **Specified Compression Levels**: Provides the ability to apply different levels of compression based on user requirements.
2222

2323
### The request parameters of **compressSpreadsheet** API are:
2424

@@ -28,7 +28,7 @@ By using the CompressSpreadsheet API, you can dynamically manage the storage and
2828
|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).|
2929
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
3030
|outStorageName|String|Query|Output file Storage Name.|
31-
|regoin|String|Query|The spreadsheet region setting.|
31+
|region|String|Query|The spreadsheet region setting.|
3232
|password|String|Query|The password for opening spreadsheet file.|
3333

3434
### **Response Description**

docs/api/convert-chart-to-image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Converts a chart of spreadsheet on a local drive to image.
1818
PUT http://api.aspose.cloud/v4.0/cells/convert/chart/image
1919
```
2020
### **Function Description**
21-
This method reads a chart of spreadsheet file from the local file system, converts it into the desired image format (e.g., PNG, SVG, Tiff), and returns the converted result.The source file path and target format must be specified correctly.Ensure that the necessary permissions are in place to read the source file and write the converted file if applicable.The conversion process occurs entirely on the cloud server, eliminating the need for any cloud storage or external downloads.If the source file does not exist, is inaccessible, or if an error occurs during the conversion process, an appropriate exception will be thrown.Supported formats for conversion depend on the available libraries and their capabilities.
21+
This method reads a chart of spreadsheet file from the local file system, converts it into the desired image format (e.g., PNG, SVG, Tiff), and returns the converted result. The source file path and target format must be specified correctly. Ensure that the necessary permissions are in place to read the source file and write the converted file if applicable. The conversion process occurs entirely on the cloud server, eliminating the need for any cloud storage or external downloads. If the source file does not exist, is inaccessible, or if an error occurs during the conversion process, an appropriate exception will be thrown. Supported formats for conversion depend on the available libraries and their capabilities.## **Error Handling**- **400 Bad Request**: Invalid url.- **401 Unauthorized**: Authentication has failed, or no credentials were provided.- **404 Not Found**: Source file not accessible.- **500 Server Error** The spreadsheet has encountered an anomaly in obtaining conversion data.## **Key Features and Benefits**- **Cloud-Native Conversion**: Conversion of local files directly in the cloud, eliminating the need to store them there.- **Reduced Cloud Resource Burden**: No need to upload files to the cloud, saving cloud storage space.- **Simplified Workflow**: Convert local spreadsheets to the image format directly through cloud services, without intermediate steps.
2222

2323
### The request parameters of **convertChartToImage** API are:
2424

@@ -31,7 +31,7 @@ This method reads a chart of spreadsheet file from the local file system, conver
3131
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
3232
|outStorageName|String|Query|Output file Storage Name.|
3333
|fontsLocation|String|Query|Use Custom fonts.|
34-
|regoin|String|Query|The spreadsheet region setting.|
34+
|region|String|Query|The spreadsheet region setting.|
3535
|password|String|Query|The password for opening spreadsheet file.|
3636

3737
### **Response Description**

docs/api/convert-chart-to-pdf.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Converts a chart of spreadsheet on a local drive to pdf.
1818
PUT http://api.aspose.cloud/v4.0/cells/convert/chart/pdf
1919
```
2020
### **Function Description**
21-
This method reads a chart of spreadsheet file from the local file system, converts it into the desired pdf format, and returns the converted result.The source file path and target format must be specified correctly.Ensure that the necessary permissions are in place to read the source file and write the converted file if applicable.The conversion process occurs entirely on the cloud server, eliminating the need for any cloud storage or external downloads.If the source file does not exist, is inaccessible, or if an error occurs during the conversion process, an appropriate exception will be thrown.Supported formats for conversion depend on the available libraries and their capabilities.
21+
This method reads a chart of spreadsheet file from the local file system, converts it into the desired pdf format, and returns the converted result. The source file path and target format must be specified correctly. Ensure that the necessary permissions are in place to read the source file and write the converted file if applicable. The conversion process occurs entirely on the cloud server, eliminating the need for any cloud storage or external downloads. If the source file does not exist, is inaccessible, or if an error occurs during the conversion process, an appropriate exception will be thrown. Supported formats for conversion depend on the available libraries and their capabilities.## **Error Handling**- **400 Bad Request**: Invalid url.- **401 Unauthorized**: Authentication has failed, or no credentials were provided.- **404 Not Found**: Source file not accessible.- **500 Server Error** The spreadsheet has encountered an anomaly in obtaining conversion data.## **Key Features and Benefits**- **Cloud-Native Conversion**: Conversion of local files directly in the cloud, eliminating the need to store them there.- **Reduced Cloud Resource Burden**: No need to upload files to the cloud, saving cloud storage space.- **Simplified Workflow**: Convert local spreadsheets to the pdf format directly through cloud services, without intermediate steps.
2222

2323
### The request parameters of **convertChartToPdf** API are:
2424

@@ -30,7 +30,7 @@ This method reads a chart of spreadsheet file from the local file system, conver
3030
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
3131
|outStorageName|String|Query|Output file Storage Name.|
3232
|fontsLocation|String|Query|Use Custom fonts.|
33-
|regoin|String|Query|The spreadsheet region setting.|
33+
|region|String|Query|The spreadsheet region setting.|
3434
|password|String|Query|The password for opening spreadsheet file.|
3535

3636
### **Response Description**

docs/api/convert-range-to-csv.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Converts a range of spreadsheet on a local drive to the csv file.
88

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

1315
### **Endpoint**
@@ -16,7 +18,7 @@ Converts a range of spreadsheet on a local drive to the csv file.
1618
PUT http://api.aspose.cloud/v4.0/cells/convert/range/csv
1719
```
1820
### **Function Description**
19-
This method reads a spreadsheet file from the local file system, converts it's range to the desired csv file, and returns the converted result.The source file path and target format must be specified correctly.Ensure that the necessary permissions are in place to read the source file and write the converted file if applicable.The conversion process occurs entirely on the cloud server, eliminating the need for any cloud storage or external downloads.If the source file does not exist, is inaccessible, or if an error occurs during the conversion process, an appropriate exception will be thrown.Supported formats for conversion depend on the available libraries and their capabilities.
21+
This method reads a spreadsheet file from the local file system, converts it's range to the desired csv file, and returns the converted result. The source file path and target format must be specified correctly. Ensure that the necessary permissions are in place to read the source file and write the converted file if applicable. The conversion process occurs entirely on the cloud server, eliminating the need for any cloud storage or external downloads. If the source file does not exist, is inaccessible, or if an error occurs during the conversion process, an appropriate exception will be thrown. Supported formats for conversion depend on the available libraries and their capabilities.## **Error Handling**- **400 Bad Request**: Invalid url.- **401 Unauthorized**: Authentication has failed, or no credentials were provided.- **404 Not Found**: Source file not accessible.- **500 Server Error** The spreadsheet has encountered an anomaly in obtaining conversion data.## **Key Features and Benefits**- **Cloud-Native Conversion**: Conversion of local files directly in the cloud, eliminating the need to store them there.- **Reduced Cloud Resource Burden**: No need to upload files to the cloud, saving cloud storage space.- **Simplified Workflow**: Convert local spreadsheets to the csv format directly through cloud services, without intermediate steps.
2022

2123
### The request parameters of **convertRangeToCsv** API are:
2224

@@ -28,7 +30,7 @@ This method reads a spreadsheet file from the local file system, converts it's r
2830
|outPath|String|Query|(Optional) The folder path where the workbook is stored. The default is null.|
2931
|outStorageName|String|Query|Output file Storage Name.|
3032
|fontsLocation|String|Query|Use Custom fonts.|
31-
|regoin|String|Query|The spreadsheet region setting.|
33+
|region|String|Query|The spreadsheet region setting.|
3234
|password|String|Query|The password for opening spreadsheet file.|
3335

3436
### **Response Description**

0 commit comments

Comments
 (0)