view release on metacpan or search on metacpan
docs/DeveloperGuide.md view on Meta::CPAN
| [PostAutofitWorksheetColumns](api/PostAutofitWorksheetColumns.md) | Autofit columns in the worksheet. |
| [PutWorksheetBackground](api/PutWorksheetBackground.md) | Set background image in the worksheet. |
| [DeleteWorksheetBackground](api/DeleteWorksheetBackground.md) | Delete background image in the worksheet. |
| [PutWorksheetFreezePanes](api/PutWorksheetFreezePanes.md) | Set freeze panes in the worksheet. |
| [DeleteWorksheetFreezePanes](api/DeleteWorksheetFreezePanes.md) | Unfreeze panes in worksheet. |
| [PostCopyWorksheet](api/PostCopyWorksheet.md) | Copy contents and formats from another worksheet. |
| [PostRenameWorksheet](api/PostRenameWorksheet.md) | Rename worksheet in the workbook. |
| [PostUpdateWorksheetProperty](api/PostUpdateWorksheetProperty.md) | Update worksheet properties in the workbook. |
| [GetNamedRanges](api/GetNamedRanges.md) | Retrieve descriptions of ranges in the worksheets. |
| [GetNamedRangeValue](api/GetNamedRangeValue.md) | Retrieve values in range. |
| [PostUpdateWorksheetZoom](api/PostUpdateWorksheetZoom.md) | Update the scaling percentage in the worksheet. It should be between 10 and 400. |
| [GetWorksheetPageCount](api/GetWorksheetPageCount.md) | Get page count in the worksheet. |
| [GetWorksheetValidations](api/GetWorksheetValidations.md) | Retrieve descriptions of validations in the worksheet. |
| [GetWorksheetValidation](api/GetWorksheetValidation.md) | Retrieve a validation by its index in the worksheet. |
| [PutWorksheetValidation](api/PutWorksheetValidation.md) | Add a validation at index in the worksheet. |
| [PostWorksheetValidation](api/PostWorksheetValidation.md) | Update a validation by index in the worksheet. |
| [DeleteWorksheetValidation](api/DeleteWorksheetValidation.md) | Delete a validation by index in worksheet. |
| [DeleteWorksheetValidations](api/DeleteWorksheetValidations.md) | Delete all validations in the worksheet. |
## **Model Reference**
docs/api/PostUpdateWorksheetZoom.md view on Meta::CPAN
# **Spreadsheet Cloud API: postUpdateWorksheetZoom**
Update the scaling percentage in the worksheet. It should be between 10 and 400.
## **Quick Start**
- **Base URL**: `http://api.aspose.cloud/v3.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
- **Example**
## **Interface Details**
### **Endpoint**
```
POST http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/zoom
```
### **Function Description**
PageTitle: Update the scaling percentage in the worksheet.PageDescription: Aspose.Cells Cloud provides robust support for updating the scaling percentage in the worksheet, a process known for its intricacy.HeadTitle: Update the scaling percentage in...
### The request parameters of **postUpdateWorksheetZoom** API are:
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
| :- | :- | :- |:- |
|name|String|Path|The file name.|
|sheetName|String|Path|The worksheet name.|
|value|Integer|Query|Represents the scaling factor in percentage. It should be between 10 and 400.|
|folder|String|Query|The folder where the file is situated.|
|storageName|String|Query|The storage name where the file is situated.|
### **Response Description**
```json
{
"Name": "CellsCloudResponse",
"Type": "Class",
"IsAbstract": false,
"Properties": [
docs/api/PutWorksheetFilterTop10.md view on Meta::CPAN
### The request parameters of **putWorksheetFilterTop10** API are:
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
| :- | :- | :- |:- |
|name|String|Path|The workbook name.|
|sheetName|String|Path|The worksheet name.|
|range|String|Query|Represents the range to which the specified AutoFilter applies.|
|fieldIndex|Integer|Query|The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).|
|isTop|Boolean|Query|Indicates whether filter from top or bottom|
|isPercent|Boolean|Query|Indicates whether the items is percent or count|
|itemCount|Integer|Query|The item count|
|matchBlanks|Boolean|Query|Match all blank cell in the list.|
|refresh|Boolean|Query|Refresh auto filters to hide or unhide the rows.|
|folder|String|Query|The folder where the file is situated.|
|storageName|String|Query|The storage name where the file is situated.|
### **Response Description**
```json
{
"Name": "CellsCloudResponse",
docs/model/Chart.md view on Meta::CPAN
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AutoScaling** | **boolean** | True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The RightAngleAxes property must be True. |
**BackWall** | **Walls** | Returns a object that represents the back wall of a 3-D chart. |
**CategoryAxis** | **Axis** | Gets the chart's X axis. |
**ChartArea** | **ChartArea** | Gets the chart area in the worksheet. |
**ChartDataTable** | **ChartDataTable** | Represents the chart data table. |
**ChartObject** | **LinkElement** | Represents the chartShape; |
**DepthPercent** | **int** | Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). |
**Elevation** | **int** | Represents the elevation of the 3-D chart view, in degrees. |
**FirstSliceAngle** | **int** | Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360. |
**Floor** | **Floor** | Returns a object that represents the walls of a 3-D chart. |
**GapDepth** | **int** | Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width. The value of this property must be between 0 and 500. |
**GapWidth** | **int** | Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500. |
**HeightPercent** | **int** | Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). |
**HidePivotFieldButtons** | **boolean** | Indicates whether hide the pivot chart field buttons only when the chart is PivotChart. |
**Is3D** | **boolean** | Indicates whether the chart is a 3d chart. |
**IsRectangularCornered** | **boolean** | Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true. |
**Legend** | **Legend** | Gets the chart legend. |
**Name** | **string** | Represents chart name. |
**NSeries** | **SeriesItems** | Gets a collection representing the data series in the chart. |
**PageSetup** | **LinkElement** | Represents the page setup description in this chart. |
**Perspective** | **int** | Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100. This property is ignored if the RightAngleAxes property is True. |
**PivotSource** | **string** | The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart. |
**Placement** | **string** | Represents the way the chart is attached to the cells below it. |
docs/model/ChartPoint.md view on Meta::CPAN
```perl
use AsposeCellsCloud::Object::ChartPoint;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Area** | **Area** | Gets the area. |
**Border** | **Line** | Gets the border. |
**DataLabels** | **DataLabels** | Returns a DataLabels object that represents the data label associated with the point. |
**Explosion** | **int** | The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter. |
**Marker** | **Marker** | Gets the marker. |
**Shadow** | **boolean** | True if the chartpoint has a shadow. |
**XValue** | **string** | Gets or sets the X value of the chart point. |
**YValue** | **string** | Gets or sets the Y value of the chart point. |
**IsInSecondaryPlot** | **boolean** | Gets or sets a value indicates whether this data points is in the second pie or bar on a pie of pie or bar of pie chart. |
**link** | **Link** | |
[[Back to Model list]](../DeveloperGuide.md#model-reference)
[[Back to README]](../../README.md)
docs/model/DataLabels.md view on Meta::CPAN
------------ | ------------- | ------------- | -------------
**IsAutoText** | **boolean** | Indicates the text is auto generated. |
**IsDeleted** | **boolean** | A nullable boolean property "IsDeleted" indicating whether an object has been deleted. |
**LinkedSource** | **string** | |
**Number** | **int** | Gets and sets the built-in number format. |
**NumberFormat** | **string** | Represents the format string for the DataLabels object. |
**NumberFormatLinked** | **boolean** | True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
**Position** | **string** | Represents the position of the data label. |
**RotationAngle** | **int** | |
**Separator** | **string** | Gets or sets the separator type used for the data labels on a chart. |
**ShowBubbleSize** | **boolean** | Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. |
**ShowCategoryName** | **boolean** | Represents a specified chart's data label category name display behavior.True to display the category name for the data labels on a chart. False to hide. |
**ShowLegendKey** | **boolean** | Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible. |
**ShowPercentage** | **boolean** | Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. |
**ShowSeriesName** | **boolean** | Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart. True to show the series name. False to hide. |
**ShowValue** | **boolean** | Represents a specified chart's data label values display behavior. True displays the values. False to hide. |
**Text** | **string** | Gets or sets the text of data label. |
**TextDirection** | **string** | |
**TextHorizontalAlignment** | **string** | |
**TextVerticalAlignment** | **string** | |
**Area** | **Area** | |
**AutoScaleFont** | **boolean** | |
**BackgroundMode** | **string** | |
**Border** | **Line** | |
docs/model/PageSetup.md view on Meta::CPAN
**PrintCopies** | **int** | Get and sets number of copies to print. |
**PrintDraft** | **boolean** | Represents if the sheet will be printed without graphics. |
**PrintErrors** | **string** | Specifies the type of print error displayed. |
**PrintGridlines** | **boolean** | Represents if cell gridlines are printed on the page. |
**PrintHeadings** | **boolean** | Represents if row and column headings are printed with this page. |
**PrintQuality** | **int** | Represents the print quality. |
**PrintTitleColumns** | **string** | Represents the columns that contain the cells to be repeated on the left side of each page. |
**PrintTitleRows** | **string** | Represents the rows that contain the cells to be repeated at the top of each page. |
**RightMargin** | **double** | Represents the size of the right margin, in unit of centimeters. |
**TopMargin** | **double** | Represents the size of the top margin, in unit of centimeters. |
**Zoom** | **int** | Represents the scaling factor in percent. It should be between 10 and 400. |
**Header** | **ARRAY[PageSection]** | Represents the page header. |
**Footer** | **ARRAY[PageSection]** | Represents the page footor. |
[[Back to Model list]](../DeveloperGuide.md#model-reference)
[[Back to README]](../../README.md)
docs/model/Series.md view on Meta::CPAN
```perl
use AsposeCellsCloud::Object::Series;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Area** | **Area** | Represents the background area of Series object. |
**Bar3DShapeType** | **string** | Gets or sets the 3D shape type used with the 3-D bar or column chart. |
**Border** | **Line** | Represents border of Series object. |
**BubbleScale** | **int** | Gets or sets the scale factor for bubbles in the specified chart group. It can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. ...
**BubbleSizes** | **string** | Gets or sets the bubble sizes values of the chart series. |
**CountOfDataValues** | **int** | Gets the number of the data values. |
**DataLabels** | **DataLabels** | Represents the DataLabels object for the specified ASeries. |
**DisplayName** | **string** | Gets the series's name that displays on the chart graph. |
**DoughnutHoleSize** | **int** | Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent. |
**DownBars** | **DropBars** | Returns a object that represents the down bars on a line chart. Applies only to line charts. |
**DropLines** | **Line** | Returns a object that represents the drop lines for a series on the line chart or area chart. Applies only to line chart or area charts. |
**Explosion** | **int** | The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter. |
**FirstSliceAngle** | **int** | Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360. |
**GapWidth** | **int** | Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500. |
**Has3DEffect** | **boolean** | True if the series has a three-dimensional appearance. Applies only to bubble charts. |
**HasDropLines** | **boolean** | True if the chart has drop lines. Applies only to line chart or area charts. |
**HasHiLoLines** | **boolean** | True if the line chart has high-low lines. Applies only to line charts. |
**HasLeaderLines** | **boolean** | True if the series has leader lines. |
**HasRadarAxisLabels** | **boolean** | True if a radar chart has category axis labels. Applies only to radar charts. |
**HasSeriesLines** | **boolean** | True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. Applies only to ...
**HasUpDownBars** | **boolean** | True if a line chart has up and down bars. Applies only to line charts. |
**HiLoLines** | **Line** | Returns a HiLoLines object that represents the high-low lines for a series on a line chart. Applies only to line charts. |
**IsAutoSplit** | **boolean** | Indicates whether the threshold value is automatic. |
**IsColorVaried** | **boolean** | Represents if the color of points is varied. The chart must contain only one series. |
**LeaderLines** | **Line** | Represents leader lines on a chart. Leader lines connect data labels to data points. This object isnât a collection; thereâs no object that represents a single leader line. |
**LegendEntry** | **LegendEntry** | Gets the legend entry according to this series. |
**Marker** | **Marker** | Gets the marker. |
**Name** | **string** | Gets or sets the name of the data series. |
**Overlap** | **int** | Specifies how bars and columns are positioned. Can be a value between â 100 and 100. Applies only to 2-D bar and 2-D column charts. |
**PlotOnSecondAxis** | **boolean** | Indicates if this series is plotted on second value axis. |
**Points** | **LinkElement** | Gets the collection of points in a series in a chart. |
**SecondPlotSize** | **int** | Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 ...
**SeriesLines** | **Line** | Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart. Applies only to stacked bar and stacked column charts. |
**Shadow** | **boolean** | True if the series has a shadow. |
**ShowNegativeBubbles** | **boolean** | True if negative bubbles are shown for the chart group. Valid only for bubble charts. |
**SizeRepresents** | **string** | Gets or sets what the bubble size represents on a bubble chart. |
**Smooth** | **boolean** | Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts. |
**SplitType** | **string** | Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart. |
**SplitValue** | **double** | Returns or sets a value that shall be used to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart. |
**TrendLines** | **Trendlines** | Returns an object that represents a collection of all the trendlines for the series. |
**Type** | **string** | Gets or sets a data series' type. |
**UpBars** | **DropBars** | Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts. |
docs/model/Style.md view on Meta::CPAN
**Name** | **string** | Gets or sets the name of the style. |
**CultureCustom** | **string** | Gets and sets the culture-dependent pattern string for number format. If no number format has been set for this object, null will be returned. If number format is builtin, the pattern string corr...
**Custom** | **string** | Represents the custom number format string of this style object. If the custom number format is not set(For example, the number format is builtin), "" will be returned. |
**BackgroundColor** | **Color** | Gets or sets a style's background color. |
**ForegroundColor** | **Color** | Gets or sets a style's foreground color. |
**IsFormulaHidden** | **boolean** | Represents if the formula will be hidden when the worksheet is protected. |
**IsDateTime** | **boolean** | Indicates whether the number format is a date format. |
**IsTextWrapped** | **boolean** | Gets or sets a value indicating whether the text within a cell is wrapped. |
**IsGradient** | **boolean** | Indicates whether the cell shading is a gradient pattern. |
**IsLocked** | **boolean** | Gets or sets a value indicating whether a cell can be modified or not. |
**IsPercent** | **boolean** | Indicates whether the number format is a percent format. |
**ShrinkToFit** | **boolean** | Represents if text automatically shrinks to fit in the available column width. |
**IndentLevel** | **int** | Represents the indent level for the cell or range. Can only be an integer from 0 to 250. |
**Number** | **int** | Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions. |
**RotationAngle** | **int** | Represents text rotation angle. |
**Pattern** | **string** | Gets or sets the cell background pattern type. |
**TextDirection** | **string** | Represents text reading order. |
**VerticalAlignment** | **string** | Gets or sets the vertical alignment type of the text in a cell. |
**HorizontalAlignment** | **string** | Gets or sets the horizontal alignment type of the text in a cell. |
**BorderCollection** | **ARRAY[Border]** | A public property named `BorderCollection` that is a list of `Border` objects. |
**BackgroundThemeColor** | **ThemeColor** | Gets and sets the background theme color. |
docs/model/Top10.md view on Meta::CPAN
## Load the model package
```perl
use AsposeCellsCloud::Object::Top10;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IsBottom** | **boolean** | Get or set whether a "top/bottom n" rule is a "bottom n" rule. Default value is false. |
**IsPercent** | **boolean** | Get or set whether a "top/bottom n" rule is a "top/bottom n percent" rule. Default value is false. |
**Rank** | **int** | Get or set the value of "n" in a "top/bottom n" conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10. | ...
[[Back to Model list]](../DeveloperGuide.md#model-reference)
[[Back to README]](../../README.md)
docs/model/Top10Filter.md view on Meta::CPAN
## Load the model package
```perl
use AsposeCellsCloud::Object::Top10Filter;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**FieldIndex** | **int** | An integer property named FieldIndex that can be accessed and modified. |
**Criteria** | **string** | |
**IsPercent** | **boolean** | Indicates whether the items is percent. |
**IsTop** | **boolean** | Indicates whether it's top filter. |
**Items** | **int** | Gets and sets the items of the filter. |
[[Back to Model list]](../DeveloperGuide.md#model-reference)
[[Back to README]](../../README.md)
docs/model/Worksheet.md view on Meta::CPAN
**IsProtected** | **boolean** | Indicates if the worksheet is protected. |
**IsRowColumnHeadersVisible** | **boolean** | Gets or sets a value indicating whether the worksheet will display row and column headers. Default is true. |
**IsRulerVisible** | **boolean** | Indicates whether the ruler is visible. This property is only applied for page break preview. |
**IsSelected** | **boolean** | Indicates whether this worksheet is selected when the workbook is opened. |
**TabColor** | **Color** | Represents worksheet tab color. |
**TransitionEntry** | **boolean** | Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. |
**TransitionEvaluation** | **boolean** | Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. |
**Type** | **string** | Represents worksheet type. |
**ViewType** | **string** | Gets and sets the view type. |
**VisibilityType** | **string** | Indicates the visible state for this sheet. |
**Zoom** | **int** | Represents the scaling factor in percentage. It should be between 10 and 400. |
**Cells** | **LinkElement** | Gets the collection. |
**Charts** | **LinkElement** | Gets a collection |
**AutoShapes** | **LinkElement** | |
**OleObjects** | **LinkElement** | Represents a collection of in a worksheet. |
**Comments** | **LinkElement** | Gets the collection. |
**Pictures** | **LinkElement** | Gets a collection. |
**MergedCells** | **LinkElement** | |
**Validations** | **LinkElement** | Gets the data validation setting collection in the worksheet. |
**ConditionalFormattings** | **LinkElement** | Gets the ConditionalFormattings in the worksheet. |
**Hyperlinks** | **LinkElement** | Gets the collection. |
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
#
# PutWorksheetFilterTop10Request
#
# Filter the top 10 items in the list in the worksheet.
#
# @name string (required) The workbook name.
# @sheetName string (required) The worksheet name.
# @range string (required) Represents the range to which the specified AutoFilter applies.
# @fieldIndex int (required) The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
# @isTop boolean (required) Indicates whether filter from top or bottom
# @isPercent boolean (required) Indicates whether the items is percent or count
# @itemCount int (required) The item count
# @matchBlanks boolean Match all blank cell in the list.
# @refresh boolean Refresh auto filters to hide or unhide the rows.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PutWorksheetFilterTop10Request',
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
if (!$response) {
return;
}
my $_response_object = $self->{api_client}->deserialize('RangeValueResponse', $response);
return $_response_object;
}
#
# PostUpdateWorksheetZoomRequest
#
# Update the scaling percentage in the worksheet. It should be between 10 and 400.
#
# @name string (required) The file name.
# @sheetName string (required) The worksheet name.
# @value int (required) Represents the scaling factor in percentage. It should be between 10 and 400.
# @folder string The folder where the file is situated.
# @storageName string The storage name where the file is situated.
#
{
my $params = {
'request' =>{
data_type => 'PostUpdateWorksheetZoomRequest',
description => 'PostUpdateWorksheetZoom Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_update_worksheet_zoom' } = {
summary => 'Update the scaling percentage in the worksheet. It should be between 10 and 400.',
params => $params,
returns => 'CellsCloudResponse',
};
}
#
# @return CellsCloudResponse
#
sub post_update_worksheet_zoom{
my ($self, %args) = @_;
my $request = $args{'request'};
lib/AsposeCellsCloud/Object/Chart.pm view on Meta::CPAN
format => '',
read_only => '',
},
'chart_object' => {
datatype => 'LinkElement',
base_name => 'ChartObject',
description => 'Represents the chartShape;',
format => '',
read_only => '',
},
'depth_percent' => {
datatype => 'int',
base_name => 'DepthPercent',
description => 'Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).',
format => '',
read_only => '',
},
'elevation' => {
datatype => 'int',
base_name => 'Elevation',
description => 'Represents the elevation of the 3-D chart view, in degrees.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Chart.pm view on Meta::CPAN
'floor' => {
datatype => 'Floor',
base_name => 'Floor',
description => 'Returns a object that represents the walls of a 3-D chart.',
format => '',
read_only => '',
},
'gap_depth' => {
datatype => 'int',
base_name => 'GapDepth',
description => 'Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width. The value of this property must be between 0 and 500.',
format => '',
read_only => '',
},
'gap_width' => {
datatype => 'int',
base_name => 'GapWidth',
description => 'Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500.',
format => '',
read_only => '',
},
'height_percent' => {
datatype => 'int',
base_name => 'HeightPercent',
description => 'Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).',
format => '',
read_only => '',
},
'hide_pivot_field_buttons' => {
datatype => 'boolean',
base_name => 'HidePivotFieldButtons',
description => 'Indicates whether hide the pivot chart field buttons only when the chart is PivotChart.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Chart.pm view on Meta::CPAN
},
});
__PACKAGE__->swagger_types( {
'auto_scaling' => 'boolean',
'back_wall' => 'Walls',
'category_axis' => 'Axis',
'chart_area' => 'ChartArea',
'chart_data_table' => 'ChartDataTable',
'chart_object' => 'LinkElement',
'depth_percent' => 'int',
'elevation' => 'int',
'first_slice_angle' => 'int',
'floor' => 'Floor',
'gap_depth' => 'int',
'gap_width' => 'int',
'height_percent' => 'int',
'hide_pivot_field_buttons' => 'boolean',
'is3_d' => 'boolean',
'is_rectangular_cornered' => 'boolean',
'legend' => 'Legend',
'name' => 'string',
'n_series' => 'SeriesItems',
'page_setup' => 'LinkElement',
'perspective' => 'int',
'pivot_source' => 'string',
'placement' => 'string',
lib/AsposeCellsCloud/Object/Chart.pm view on Meta::CPAN
'link' => 'Link'
} );
__PACKAGE__->attribute_map( {
'auto_scaling' => 'AutoScaling',
'back_wall' => 'BackWall',
'category_axis' => 'CategoryAxis',
'chart_area' => 'ChartArea',
'chart_data_table' => 'ChartDataTable',
'chart_object' => 'ChartObject',
'depth_percent' => 'DepthPercent',
'elevation' => 'Elevation',
'first_slice_angle' => 'FirstSliceAngle',
'floor' => 'Floor',
'gap_depth' => 'GapDepth',
'gap_width' => 'GapWidth',
'height_percent' => 'HeightPercent',
'hide_pivot_field_buttons' => 'HidePivotFieldButtons',
'is3_d' => 'Is3D',
'is_rectangular_cornered' => 'IsRectangularCornered',
'legend' => 'Legend',
'name' => 'Name',
'n_series' => 'NSeries',
'page_setup' => 'PageSetup',
'perspective' => 'Perspective',
'pivot_source' => 'PivotSource',
'placement' => 'Placement',
lib/AsposeCellsCloud/Object/ChartPoint.pm view on Meta::CPAN
'data_labels' => {
datatype => 'DataLabels',
base_name => 'DataLabels',
description => 'Returns a DataLabels object that represents the data label associated with the point.',
format => '',
read_only => '',
},
'explosion' => {
datatype => 'int',
base_name => 'Explosion',
description => 'The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.',
format => '',
read_only => '',
},
'marker' => {
datatype => 'Marker',
base_name => 'Marker',
description => 'Gets the marker.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/DataLabels.pm view on Meta::CPAN
'separator' => {
datatype => 'string',
base_name => 'Separator',
description => 'Gets or sets the separator type used for the data labels on a chart.',
format => '',
read_only => '',
},
'show_bubble_size' => {
datatype => 'boolean',
base_name => 'ShowBubbleSize',
description => 'Represents a specified chart`s data label percentage value display behavior. True displays the percentage value. False to hide.',
format => '',
read_only => '',
},
'show_category_name' => {
datatype => 'boolean',
base_name => 'ShowCategoryName',
description => 'Represents a specified chart`s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.',
format => '',
read_only => '',
},
'show_legend_key' => {
datatype => 'boolean',
base_name => 'ShowLegendKey',
description => 'Represents a specified chart`s data label legend key display behavior. True if the data label legend key is visible.',
format => '',
read_only => '',
},
'show_percentage' => {
datatype => 'boolean',
base_name => 'ShowPercentage',
description => 'Represents a specified chart`s data label percentage value display behavior. True displays the percentage value. False to hide.',
format => '',
read_only => '',
},
'show_series_name' => {
datatype => 'boolean',
base_name => 'ShowSeriesName',
description => 'Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart. True to show the series name. False to hide.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/DataLabels.pm view on Meta::CPAN
'linked_source' => 'string',
'number' => 'int',
'number_format' => 'string',
'number_format_linked' => 'boolean',
'position' => 'string',
'rotation_angle' => 'int',
'separator' => 'string',
'show_bubble_size' => 'boolean',
'show_category_name' => 'boolean',
'show_legend_key' => 'boolean',
'show_percentage' => 'boolean',
'show_series_name' => 'boolean',
'show_value' => 'boolean',
'text' => 'string',
'text_direction' => 'string',
'text_horizontal_alignment' => 'string',
'text_vertical_alignment' => 'string',
'area' => 'Area',
'auto_scale_font' => 'boolean',
'background_mode' => 'string',
'border' => 'Line',
lib/AsposeCellsCloud/Object/DataLabels.pm view on Meta::CPAN
'linked_source' => 'LinkedSource',
'number' => 'Number',
'number_format' => 'NumberFormat',
'number_format_linked' => 'NumberFormatLinked',
'position' => 'Position',
'rotation_angle' => 'RotationAngle',
'separator' => 'Separator',
'show_bubble_size' => 'ShowBubbleSize',
'show_category_name' => 'ShowCategoryName',
'show_legend_key' => 'ShowLegendKey',
'show_percentage' => 'ShowPercentage',
'show_series_name' => 'ShowSeriesName',
'show_value' => 'ShowValue',
'text' => 'Text',
'text_direction' => 'TextDirection',
'text_horizontal_alignment' => 'TextHorizontalAlignment',
'text_vertical_alignment' => 'TextVerticalAlignment',
'area' => 'Area',
'auto_scale_font' => 'AutoScaleFont',
'background_mode' => 'BackgroundMode',
'border' => 'Border',
lib/AsposeCellsCloud/Object/PageSetup.pm view on Meta::CPAN
format => '',
read_only => '',
},
'is_hf_scale_with_doc' => {
datatype => 'boolean',
base_name => 'IsHFScaleWithDoc',
description => 'Indicates whether header and footer are scaled with document scaling. Only applies for Excel 2007. ',
format => '',
read_only => '',
},
'is_percent_scale' => {
datatype => 'boolean',
base_name => 'IsPercentScale',
description => 'If this property is False, the FitToPagesWide and FitToPagesTall properties control how the worksheet is scaled. ',
format => '',
read_only => '',
},
'left_margin' => {
datatype => 'double',
base_name => 'LeftMargin',
description => 'Represents the size of the left margin, in unit of centimeters. ',
lib/AsposeCellsCloud/Object/PageSetup.pm view on Meta::CPAN
'top_margin' => {
datatype => 'double',
base_name => 'TopMargin',
description => 'Represents the size of the top margin, in unit of centimeters. ',
format => '',
read_only => '',
},
'zoom' => {
datatype => 'int',
base_name => 'Zoom',
description => 'Represents the scaling factor in percent. It should be between 10 and 400. ',
format => '',
read_only => '',
},
'header' => {
datatype => 'ARRAY[PageSection]',
base_name => 'Header',
description => 'Represents the page header.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/PageSetup.pm view on Meta::CPAN
'first_page_number' => 'int',
'fit_to_pages_tall' => 'int',
'fit_to_pages_wide' => 'int',
'footer_margin' => 'double',
'header_margin' => 'double',
'is_auto_first_page_number' => 'boolean',
'is_hf_align_margins' => 'boolean',
'is_hf_diff_first' => 'boolean',
'is_hf_diff_odd_even' => 'boolean',
'is_hf_scale_with_doc' => 'boolean',
'is_percent_scale' => 'boolean',
'left_margin' => 'double',
'order' => 'string',
'orientation' => 'string',
'paper_size' => 'string',
'print_area' => 'string',
'print_comments' => 'string',
'print_copies' => 'int',
'print_draft' => 'boolean',
'print_errors' => 'string',
'print_gridlines' => 'boolean',
lib/AsposeCellsCloud/Object/PageSetup.pm view on Meta::CPAN
'first_page_number' => 'FirstPageNumber',
'fit_to_pages_tall' => 'FitToPagesTall',
'fit_to_pages_wide' => 'FitToPagesWide',
'footer_margin' => 'FooterMargin',
'header_margin' => 'HeaderMargin',
'is_auto_first_page_number' => 'IsAutoFirstPageNumber',
'is_hf_align_margins' => 'IsHFAlignMargins',
'is_hf_diff_first' => 'IsHFDiffFirst',
'is_hf_diff_odd_even' => 'IsHFDiffOddEven',
'is_hf_scale_with_doc' => 'IsHFScaleWithDoc',
'is_percent_scale' => 'IsPercentScale',
'left_margin' => 'LeftMargin',
'order' => 'Order',
'orientation' => 'Orientation',
'paper_size' => 'PaperSize',
'print_area' => 'PrintArea',
'print_comments' => 'PrintComments',
'print_copies' => 'PrintCopies',
'print_draft' => 'PrintDraft',
'print_errors' => 'PrintErrors',
'print_gridlines' => 'PrintGridlines',
lib/AsposeCellsCloud/Object/RenderingWatermark.pm view on Meta::CPAN
__PACKAGE__->method_documentation({
'rotation' => {
datatype => 'double',
base_name => 'Rotation',
description => '',
format => '',
read_only => '',
},
'scale_to_page_percent' => {
datatype => 'int',
base_name => 'ScaleToPagePercent',
description => '',
format => '',
read_only => '',
},
'opacity' => {
datatype => 'double',
base_name => 'Opacity',
description => '',
lib/AsposeCellsCloud/Object/RenderingWatermark.pm view on Meta::CPAN
datatype => 'double',
base_name => 'OffsetY',
description => '',
format => '',
read_only => '',
},
});
__PACKAGE__->swagger_types( {
'rotation' => 'double',
'scale_to_page_percent' => 'int',
'opacity' => 'double',
'is_background' => 'boolean',
'text' => 'string',
'font' => 'RenderingFont',
'image' => 'ARRAY[byte?]',
'h_alignment' => 'string',
'v_alignment' => 'string',
'offset_x' => 'double',
'offset_y' => 'double'
} );
__PACKAGE__->attribute_map( {
'rotation' => 'Rotation',
'scale_to_page_percent' => 'ScaleToPagePercent',
'opacity' => 'Opacity',
'is_background' => 'IsBackground',
'text' => 'Text',
'font' => 'Font',
'image' => 'Image',
'h_alignment' => 'HAlignment',
'v_alignment' => 'VAlignment',
'offset_x' => 'OffsetX',
'offset_y' => 'OffsetY'
} );
lib/AsposeCellsCloud/Object/Series.pm view on Meta::CPAN
'border' => {
datatype => 'Line',
base_name => 'Border',
description => 'Represents border of Series object.',
format => '',
read_only => '',
},
'bubble_scale' => {
datatype => 'int',
base_name => 'BubbleScale',
description => 'Gets or sets the scale factor for bubbles in the specified chart group. It can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. ...
format => '',
read_only => '',
},
'bubble_sizes' => {
datatype => 'string',
base_name => 'BubbleSizes',
description => 'Gets or sets the bubble sizes values of the chart series.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Series.pm view on Meta::CPAN
'display_name' => {
datatype => 'string',
base_name => 'DisplayName',
description => 'Gets the series`s name that displays on the chart graph.',
format => '',
read_only => '',
},
'doughnut_hole_size' => {
datatype => 'int',
base_name => 'DoughnutHoleSize',
description => 'Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.',
format => '',
read_only => '',
},
'down_bars' => {
datatype => 'DropBars',
base_name => 'DownBars',
description => 'Returns a object that represents the down bars on a line chart. Applies only to line charts.',
format => '',
read_only => '',
},
'drop_lines' => {
datatype => 'Line',
base_name => 'DropLines',
description => 'Returns a object that represents the drop lines for a series on the line chart or area chart. Applies only to line chart or area charts.',
format => '',
read_only => '',
},
'explosion' => {
datatype => 'int',
base_name => 'Explosion',
description => 'The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.',
format => '',
read_only => '',
},
'first_slice_angle' => {
datatype => 'int',
base_name => 'FirstSliceAngle',
description => 'Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.',
format => '',
read_only => '',
},
'gap_width' => {
datatype => 'int',
base_name => 'GapWidth',
description => 'Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500.',
format => '',
read_only => '',
},
'has3_d_effect' => {
datatype => 'boolean',
base_name => 'Has3DEffect',
description => 'True if the series has a three-dimensional appearance. Applies only to bubble charts.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Series.pm view on Meta::CPAN
'points' => {
datatype => 'LinkElement',
base_name => 'Points',
description => 'Gets the collection of points in a series in a chart.',
format => '',
read_only => '',
},
'second_plot_size' => {
datatype => 'int',
base_name => 'SecondPlotSize',
description => 'Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.',...
format => '',
read_only => '',
},
'series_lines' => {
datatype => 'Line',
base_name => 'SeriesLines',
description => 'Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart. Applies only to stacked bar and stacked column charts.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Style.pm view on Meta::CPAN
format => '',
read_only => '',
},
'is_locked' => {
datatype => 'boolean',
base_name => 'IsLocked',
description => 'Gets or sets a value indicating whether a cell can be modified or not. ',
format => '',
read_only => '',
},
'is_percent' => {
datatype => 'boolean',
base_name => 'IsPercent',
description => 'Indicates whether the number format is a percent format. ',
format => '',
read_only => '',
},
'shrink_to_fit' => {
datatype => 'boolean',
base_name => 'ShrinkToFit',
description => 'Represents if text automatically shrinks to fit in the available column width. ',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Style.pm view on Meta::CPAN
'name' => 'string',
'culture_custom' => 'string',
'custom' => 'string',
'background_color' => 'Color',
'foreground_color' => 'Color',
'is_formula_hidden' => 'boolean',
'is_date_time' => 'boolean',
'is_text_wrapped' => 'boolean',
'is_gradient' => 'boolean',
'is_locked' => 'boolean',
'is_percent' => 'boolean',
'shrink_to_fit' => 'boolean',
'indent_level' => 'int',
'number' => 'int',
'rotation_angle' => 'int',
'pattern' => 'string',
'text_direction' => 'string',
'vertical_alignment' => 'string',
'horizontal_alignment' => 'string',
'border_collection' => 'ARRAY[Border]',
'background_theme_color' => 'ThemeColor',
lib/AsposeCellsCloud/Object/Style.pm view on Meta::CPAN
'name' => 'Name',
'culture_custom' => 'CultureCustom',
'custom' => 'Custom',
'background_color' => 'BackgroundColor',
'foreground_color' => 'ForegroundColor',
'is_formula_hidden' => 'IsFormulaHidden',
'is_date_time' => 'IsDateTime',
'is_text_wrapped' => 'IsTextWrapped',
'is_gradient' => 'IsGradient',
'is_locked' => 'IsLocked',
'is_percent' => 'IsPercent',
'shrink_to_fit' => 'ShrinkToFit',
'indent_level' => 'IndentLevel',
'number' => 'Number',
'rotation_angle' => 'RotationAngle',
'pattern' => 'Pattern',
'text_direction' => 'TextDirection',
'vertical_alignment' => 'VerticalAlignment',
'horizontal_alignment' => 'HorizontalAlignment',
'border_collection' => 'BorderCollection',
'background_theme_color' => 'BackgroundThemeColor',
lib/AsposeCellsCloud/Object/Top10.pm view on Meta::CPAN
__PACKAGE__->method_documentation({
'is_bottom' => {
datatype => 'boolean',
base_name => 'IsBottom',
description => 'Get or set whether a "top/bottom n" rule is a "bottom n" rule. Default value is false. ',
format => '',
read_only => '',
},
'is_percent' => {
datatype => 'boolean',
base_name => 'IsPercent',
description => 'Get or set whether a "top/bottom n" rule is a "top/bottom n percent" rule. Default value is false. ',
format => '',
read_only => '',
},
'rank' => {
datatype => 'int',
base_name => 'Rank',
description => 'Get or set the value of "n" in a "top/bottom n" conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10. ',
format => '',
read_only => '',
},
});
__PACKAGE__->swagger_types( {
'is_bottom' => 'boolean',
'is_percent' => 'boolean',
'rank' => 'int'
} );
__PACKAGE__->attribute_map( {
'is_bottom' => 'IsBottom',
'is_percent' => 'IsPercent',
'rank' => 'Rank'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
1;
lib/AsposeCellsCloud/Object/Top10Filter.pm view on Meta::CPAN
format => '',
read_only => '',
},
'criteria' => {
datatype => 'string',
base_name => 'Criteria',
description => ' ',
format => '',
read_only => '',
},
'is_percent' => {
datatype => 'boolean',
base_name => 'IsPercent',
description => 'Indicates whether the items is percent. ',
format => '',
read_only => '',
},
'is_top' => {
datatype => 'boolean',
base_name => 'IsTop',
description => 'Indicates whether it`s top filter. ',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Object/Top10Filter.pm view on Meta::CPAN
base_name => 'Items',
description => 'Gets and sets the items of the filter. ',
format => '',
read_only => '',
},
});
__PACKAGE__->swagger_types( {
'field_index' => 'int',
'criteria' => 'string',
'is_percent' => 'boolean',
'is_top' => 'boolean',
'items' => 'int'
} );
__PACKAGE__->attribute_map( {
'field_index' => 'FieldIndex',
'criteria' => 'Criteria',
'is_percent' => 'IsPercent',
'is_top' => 'IsTop',
'items' => 'Items'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
1;
lib/AsposeCellsCloud/Object/Worksheet.pm view on Meta::CPAN
'visibility_type' => {
datatype => 'string',
base_name => 'VisibilityType',
description => 'Indicates the visible state for this sheet. ',
format => '',
read_only => '',
},
'zoom' => {
datatype => 'int',
base_name => 'Zoom',
description => 'Represents the scaling factor in percentage. It should be between 10 and 400. ',
format => '',
read_only => '',
},
'cells' => {
datatype => 'LinkElement',
base_name => 'Cells',
description => 'Gets the collection. ',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Request/PostUpdateWorksheetZoomRequest.pm view on Meta::CPAN
$self->$attribute( $args{ $args_key } );
}
return $self;
}
# Run Operation Request
# PostUpdateWorksheetZoomRequest.name : The file name. ,
# PostUpdateWorksheetZoomRequest.sheetName : The worksheet name. ,
# PostUpdateWorksheetZoomRequest.value : Represents the scaling factor in percentage. It should be between 10 and 400. ,
# PostUpdateWorksheetZoomRequest.folder : The folder where the file is situated. ,
# PostUpdateWorksheetZoomRequest.storageName : The storage name where the file is situated.
{
my $params = {
'client' =>{
data_type => 'ApiClient',
description => 'API Client.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_update_worksheet_zoom' } = {
summary => 'Update the scaling percentage in the worksheet. It should be between 10 and 400.',
params => $params,
returns => 'CellsCloudResponse',
};
}
sub run_http_request {
my ($self, %args) = @_;
my $client = $args{'client'};
lib/AsposeCellsCloud/Request/PostUpdateWorksheetZoomRequest.pm view on Meta::CPAN
'sheet_name' => {
datatype => 'string',
base_name => 'sheetName',
description => 'The worksheet name.',
format => '',
read_only => '',
},
'value' => {
datatype => 'int',
base_name => 'value',
description => 'Represents the scaling factor in percentage. It should be between 10 and 400.',
format => '',
read_only => '',
},
'folder' => {
datatype => 'string',
base_name => 'folder',
description => 'The folder where the file is situated.',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Request/PutWorksheetFilterTop10Request.pm view on Meta::CPAN
return $self;
}
# Run Operation Request
# PutWorksheetFilterTop10Request.name : The workbook name. ,
# PutWorksheetFilterTop10Request.sheetName : The worksheet name. ,
# PutWorksheetFilterTop10Request.range : Represents the range to which the specified AutoFilter applies. ,
# PutWorksheetFilterTop10Request.fieldIndex : The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0). ,
# PutWorksheetFilterTop10Request.isTop : Indicates whether filter from top or bottom ,
# PutWorksheetFilterTop10Request.isPercent : Indicates whether the items is percent or count ,
# PutWorksheetFilterTop10Request.itemCount : The item count ,
# PutWorksheetFilterTop10Request.matchBlanks : Match all blank cell in the list. ,
# PutWorksheetFilterTop10Request.refresh : Refresh auto filters to hide or unhide the rows. ,
# PutWorksheetFilterTop10Request.folder : The folder where the file is situated. ,
# PutWorksheetFilterTop10Request.storageName : The storage name where the file is situated.
{
my $params = {
'client' =>{
data_type => 'ApiClient',
lib/AsposeCellsCloud/Request/PutWorksheetFilterTop10Request.pm view on Meta::CPAN
}
if(defined $self->field_index){
$query_params->{'fieldIndex'} = $client->to_query_value($self->field_index);
}
if(defined $self->is_top){
$query_params->{'isTop'} = $client->to_query_value($self->is_top);
}
if(defined $self->is_percent){
$query_params->{'isPercent'} = $client->to_query_value($self->is_percent);
}
if(defined $self->item_count){
$query_params->{'itemCount'} = $client->to_query_value($self->item_count);
}
if(defined $self->match_blanks){
$query_params->{'matchBlanks'} = $client->to_query_value($self->match_blanks);
}
lib/AsposeCellsCloud/Request/PutWorksheetFilterTop10Request.pm view on Meta::CPAN
format => '',
read_only => '',
},
'is_top' => {
datatype => 'string',
base_name => 'isTop',
description => 'Indicates whether filter from top or bottom',
format => '',
read_only => '',
},
'is_percent' => {
datatype => 'string',
base_name => 'isPercent',
description => 'Indicates whether the items is percent or count',
format => '',
read_only => '',
},
'item_count' => {
datatype => 'int',
base_name => 'itemCount',
description => 'The item count',
format => '',
read_only => '',
},
lib/AsposeCellsCloud/Request/PutWorksheetFilterTop10Request.pm view on Meta::CPAN
},
});
__PACKAGE__->attribute_map( {
'name' => 'name',
'sheet_name' => 'sheetName',
'range' => 'range',
'field_index' => 'fieldIndex',
'is_top' => 'isTop',
'is_percent' => 'isPercent',
'item_count' => 'itemCount',
'match_blanks' => 'matchBlanks',
'refresh' => 'refresh',
'folder' => 'folder',
'storage_name' => 'storageName'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});