Skip to content

Commit d358d09

Browse files
update API reference for GridJs python
pdfsaveoptions related classes
1 parent 490e752 commit d358d09

File tree

202 files changed

+4513
-445
lines changed

Some content is hidden

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

202 files changed

+4513
-445
lines changed

english/aspose.cellsgridjs/_index.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,51 @@ url: /aspose.cellsgridjs/
88
is_root: false
99
---
1010

11-
The **Aspose.Cells.GridJs** namespace contains all classes of GridJs which provide basic operations for managing spreadsheets without utilizing Microsoft Excel .
11+
The **Aspose.Cells.GridJs** namespace encapsulates all classes of GridJs, providing simple APIs for viewing or editing spreadsheet files through JSON operations.
1212

1313
### Classes
1414
| Class | Description |
1515
| :- | :- |
16-
| [`Config`](/cells/python-net/aspose.cellsgridjs/config) | Represents all the settings for GridJs |
16+
| [`CoWorkUserProvider`](/cells/python-net/aspose.cellsgridjs/coworkuserprovider) | Represents the user provider inerface in collabration mode.only available in java version now, will be available in .net/python version in future.
17+
<br/>Customer application can implement this interface to provide the user information. |
18+
| [`Config`](/cells/python-net/aspose.cellsgridjs/config) | Represents all the static settings for GridJs |
1719
| [`GridAbstractCalculationEngine`](/cells/python-net/aspose.cellsgridjs/gridabstractcalculationengine) | Represents user's custom calculation engine to extend the default calculation engine of Aspose.Cells. |
1820
| [`GridCacheForStream`](/cells/python-net/aspose.cellsgridjs/gridcacheforstream) | This class contains the cache operations for GridJs. User shall implement his own business logic for storage based on it.. |
1921
| [`GridCalculationData`](/cells/python-net/aspose.cellsgridjs/gridcalculationdata) | Represents the required data when calculating one function, such as function name, parameters, ...etc. |
2022
| [`GridCellException`](/cells/python-net/aspose.cellsgridjs/gridcellexception) | The exception that is thrown when GridJs specified error occurs. |
23+
| [`GridJsControllerBase`](/cells/python-net/aspose.cellsgridjs/gridjscontrollerbase) | |
24+
| [`GridJsOptions`](/cells/python-net/aspose.cellsgridjs/gridjsoptions) | Represents all the load options for GridJs |
25+
| [`GridJsPermissionException`](/cells/python-net/aspose.cellsgridjs/gridjspermissionexception) | represents permission exception in collaboration mode.only available in java version now, will be available in .net/python version in future. |
26+
| [`GridJsService`](/cells/python-net/aspose.cellsgridjs/gridjsservice) | Provides the basic operation apis used in controller actions. |
2127
| [`GridJsWorkbook`](/cells/python-net/aspose.cellsgridjs/gridjsworkbook) | Represents the main entry class for GridJs |
2228
| [`GridReferredArea`](/cells/python-net/aspose.cellsgridjs/gridreferredarea) | Represents a referred area by the formula. |
29+
| [`GridUpdateMonitor`](/cells/python-net/aspose.cellsgridjs/gridupdatemonitor) | Monitor for user to track the change of update operation. |
2330
| [`GridWorkbookSettings`](/cells/python-net/aspose.cellsgridjs/gridworkbooksettings) | Represents the settings of the workbook. |
31+
| [`IGridJsService`](/cells/python-net/aspose.cellsgridjs/igridjsservice) | Reprensents the basic operation apis interface used in controller actions. |
32+
| [`ITextTranslator`](/cells/python-net/aspose.cellsgridjs/itexttranslator) | Represents the interface for translate |
33+
| [`OprMessageService`](/cells/python-net/aspose.cellsgridjs/oprmessageservice) | This class provide all the operations for messages sync in Collaborative mode . |
34+
| [`PdfSaveOptions`](/cells/python-net/aspose.cellsgridjs/pdfsaveoptions) | Represents the options for saving pdf file. |
35+
| [`PdfSecurityOptions`](/cells/python-net/aspose.cellsgridjs/pdfsecurityoptions) | Options for encrypting and access permissions for a PDF document.
36+
<br/>PDF/A does not allow security setting. |
37+
| [`SheetSet`](/cells/python-net/aspose.cellsgridjs/sheetset) | Describes a set of sheets. |
2438

2539

2640
### Enumerations
2741
| Enumeration | Description |
2842
| :- | :- |
43+
| [`CoWorkOperationType`](/cells/python-net/aspose.cellsgridjs/coworkoperationtype) | Represents the action operation type in collabration mode.only available in java version now, will be available in .net/python version in future. |
44+
| [`CoWorkUserPermission`](/cells/python-net/aspose.cellsgridjs/coworkuserpermission) | represent the user permission in collaboration mode.only available in java version now, will be available in .net/python version in future. |
45+
| [`DefaultEditLanguage`](/cells/python-net/aspose.cellsgridjs/defaulteditlanguage) | Represents the default edit language. |
46+
| [`EmfRenderSetting`](/cells/python-net/aspose.cellsgridjs/emfrendersetting) | Setting for rendering Emf metafile. |
2947
| [`GridExceptionType`](/cells/python-net/aspose.cellsgridjs/gridexceptiontype) | Represents custom exception code for GridJs. |
3048
| [`GridLoadFormat`](/cells/python-net/aspose.cellsgridjs/gridloadformat) | Represents the load file format. |
49+
| [`GridlineType`](/cells/python-net/aspose.cellsgridjs/gridlinetype) | Enumerates grid line Type. |
50+
| [`PdfCompliance`](/cells/python-net/aspose.cellsgridjs/pdfcompliance) | Allowing user to set PDF conversion's Compatibility |
51+
| [`PdfCompressionCore`](/cells/python-net/aspose.cellsgridjs/pdfcompressioncore) | Specifies a type of compression applied to all content in the PDF file except images. |
52+
| [`PdfCustomPropertiesExport`](/cells/python-net/aspose.cellsgridjs/pdfcustompropertiesexport) | Specifies the way of custom document properties are exported to PDF file. |
53+
| [`PdfFontEncoding`](/cells/python-net/aspose.cellsgridjs/pdffontencoding) | Represents pdf embedded font encoding. |
54+
| [`PdfOptimizationType`](/cells/python-net/aspose.cellsgridjs/pdfoptimizationtype) | Specifies a type of optimization. |
55+
| [`PrintingPageType`](/cells/python-net/aspose.cellsgridjs/printingpagetype) | Indicates which pages will not be printed. |
56+
| [`TextCrossType`](/cells/python-net/aspose.cellsgridjs/textcrosstype) | Enumerates displaying text type when the text width is larger than cell width. |
3157

3258

english/aspose.cellsgridjs/config/__init__/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ url: /aspose.cellsgridjs/config/__init__/
88
is_root: false
99
---
1010

11-
## __init__ {#}
11+
## \_\_init\_\_(self) {#}
1212

1313
Constructs a new instance of Config
1414

1515

1616

1717
```python
18+
1819
def __init__(self):
1920
...
2021
```

english/aspose.cellsgridjs/config/_index.md

Lines changed: 58 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,64 @@
1-
---
2-
title: Config class
3-
second_title: Aspose.Cells.GridJs for Python via .NET API References
4-
description:
5-
type: docs
6-
weight: 10
7-
url: /aspose.cellsgridjs/config/
8-
is_root: false
1+
---
2+
title: Config class
3+
second_title: Aspose.Cells.GridJs for Python via .NET API References
4+
description:
5+
type: docs
6+
weight: 20
7+
url: /aspose.cellsgridjs/config/
8+
is_root: false
99
---
10-
10+
1111
## Config class
12-
13-
Represents all the settings for GridJs
14-
12+
13+
Represents all the static settings for GridJs
14+
1515

1616

1717
The Config type exposes the following members:
18+
19+
### Constructors
20+
| Constructor | Description |
21+
| :- | :- |
22+
| [`__init__(self)`](/cells/python-net/aspose.cellsgridjs/config/__init__/#) | Constructs a new instance of Config |
23+
24+
25+
### Properties
26+
| Property | Description |
27+
| :- | :- |
28+
| [save_html_as_zip](/cells/python-net/aspose.cellsgridjs/config/save_html_as_zip) | Gets/Sets whether to save html file as zip archive,the default is false. |
29+
| [skip_invisible_shapes](/cells/python-net/aspose.cellsgridjs/config/skip_invisible_shapes) | Gets/Sets whether to skip shapes that are invisble to UI ,the default value is true. |
30+
| [lazy_loading](/cells/python-net/aspose.cellsgridjs/config/lazy_loading) | Gets/Sets whether to load active worksheet only,the default is false. |
31+
| [same_image_detecting](/cells/python-net/aspose.cellsgridjs/config/same_image_detecting) | Gets/Sets whether to check if images have same source,the default is true<br/>the default value is true. |
32+
| [auto_optimize_for_large_cells](/cells/python-net/aspose.cellsgridjs/config/auto_optimize_for_large_cells) | Gets/Sets whether to automatically optimize the load performance for worksheet with large cells.<br/>it will ignore some style /borders to reduce the load time.<br/>the default value is true. |
33+
| [islimit_shape_or_image](/cells/python-net/aspose.cellsgridjs/config/islimit_shape_or_image) | Gets/Sets whether to limit the total display shape/image count in one worksheet ,if set to true,<br/>GridJs will limit the total count of the display shapes or images in one worksheet to MaxShapeOrImageCount<br/>the default value is true. |
34+
| [max_shape_or_image_count](/cells/python-net/aspose.cellsgridjs/config/max_shape_or_image_count) | Gets/Sets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true.<br/>the default value is 100. |
35+
| [max_total_shape_or_image_count](/cells/python-net/aspose.cellsgridjs/config/max_total_shape_or_image_count) | Gets/Sets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true.<br/>the default value is 300. |
36+
| [max_shape_or_image_width_or_height](/cells/python-net/aspose.cellsgridjs/config/max_shape_or_image_width_or_height) | Gets/Sets the max width or height for a shape or an image ,GridJs will ignore the shape or image with the width or height larger than this, it takes effect when IslimitShapeOrImage=true.<br/>the default value is 10000. |
37+
| [max_pdf_save_seconds](/cells/python-net/aspose.cellsgridjs/config/max_pdf_save_seconds) | Gets/Sets the max timed out seconds when save to PDF.<br/>the default value is 10. |
38+
| [ignore_empty_content](/cells/python-net/aspose.cellsgridjs/config/ignore_empty_content) | Gets/Sets whether to show the max range which includes data ,style, merged cells and shapes.<br/>if the last row or column contains cells with no value and formula but has custom style <br/>then we will not show this row/column when this vlaue is true。<br/>the default value is true . |
39+
| [use_print_area](/cells/python-net/aspose.cellsgridjs/config/use_print_area) | Gets/Sets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea.<br/>the default value is false . |
40+
| [is_collaborative](/cells/python-net/aspose.cellsgridjs/config/is_collaborative) | Gets/Sets whether to support collabrative editing,the default is false. |
41+
| [custom_pdf_save_options](/cells/python-net/aspose.cellsgridjs/config/custom_pdf_save_options) | Gets/Sets the custom PdfSaveOptions for PDF export. If set, this will be used instead of the default options.<br/>the default value is null. |
42+
| [load_time_out](/cells/python-net/aspose.cellsgridjs/config/load_time_out) | Gets/Sets a timeout interrupt in milliseconds in loading file, when the cost time period of loading file is longer than the expectation ,it will raise exception.<br/>the default value is -1,which means no timeout interrupt is set . |
43+
| [show_chart_sheet](/cells/python-net/aspose.cellsgridjs/config/show_chart_sheet) | Gets/Sets whether to show chart worksheet.<br/>the default value is false . |
44+
| [empty_sheet_max_row](/cells/python-net/aspose.cellsgridjs/config/empty_sheet_max_row) | Gets/Sets default max row for an empty worksheet.<br/>the default value is 12. |
45+
| [empty_sheet_max_col](/cells/python-net/aspose.cellsgridjs/config/empty_sheet_max_col) | Gets/Sets default max column for an empty worksheet.<br/>the default value is 15. |
46+
| [picture_cache_directory](/cells/python-net/aspose.cellsgridjs/config/picture_cache_directory) | Gets/Sets the cache directory for pictures.(this takes effect when GridJsWorkbook.CacheImp is null)<br/>the default path will be "_piccache" inside the FileCacheDirectory. |
47+
| [file_cache_directory](/cells/python-net/aspose.cellsgridjs/config/file_cache_directory) | Gets/Sets the cache directory for storing spreadsheet file.<br/>We need to set it to a specific path before we use GridJs. |
48+
| [base_route_name](/cells/python-net/aspose.cellsgridjs/config/base_route_name) | Gets/Sets the base route name for GridJs controller URL. the default is "/GridJs2". |
49+
| [message_topic](/cells/python-net/aspose.cellsgridjs/config/message_topic) | Gets/Sets the websocket destinations prefixed with "/topic". the default is "/topic/opr".used in collaborative mode only. |
50+
| [auto_fit_rows_height_on_load](/cells/python-net/aspose.cellsgridjs/config/auto_fit_rows_height_on_load) | Indicates whether to autofit rows height when loading the file,the default value is false. |
51+
52+
53+
### Methods
54+
| Method | Description |
55+
| :- | :- |
56+
| [`set_license(, license_name)`](/cells/python-net/aspose.cellsgridjs/config/set_license/#system.string) | Licenses the component. |
57+
| [`set_license(, stream)`](/cells/python-net/aspose.cellsgridjs/config/set_license/#io.rawiobase) | Licenses the component. |
58+
| [`set_font_folder(, font_folder, recursive)`](/cells/python-net/aspose.cellsgridjs/config/set_font_folder/#system.string-bool) | Sets the fonts folder |
59+
| [`set_font_folders(, font_folders, recursive)`](/cells/python-net/aspose.cellsgridjs/config/set_font_folders/#list-bool) | Sets the fonts folders |
60+
61+
1862

19-
### Constructors
20-
| Constructor | Description |
21-
| :- | :- |
22-
| [__init__](/cells/python-net/aspose.cellsgridjs/config/__init__/#) | Constructs a new instance of Config |
23-
24-
25-
### Properties
26-
| Property | Description |
27-
| :- | :- |
28-
| [save_html_as_zip](/cells/python-net/aspose.cellsgridjs/config/save_html_as_zip) | Sets/Gets whether to save html file as zip archive,the default is false. |
29-
| [same_image_detecting](/cells/python-net/aspose.cellsgridjs/config/same_image_detecting) | Sets/Gets whether to check if picture has same source,the default is true<br/>the default value is true. |
30-
| [auto_optimize_for_large_cells](/cells/python-net/aspose.cellsgridjs/config/auto_optimize_for_large_cells) | Sets/Gets whether to automatically optimize the load performance for worksheet with large cells<br/>ignore some style /borders to reduce the load time <br/>the default value is true. |
31-
| [islimit_shape_or_image](/cells/python-net/aspose.cellsgridjs/config/islimit_shape_or_image) | Sets/Gets whether to limit the total display shape/image count inside one worksheet ,if set to true, <br/>GridJs will limit the total display shape/image size inside one worksheet to MaxShapeOrImageCount <br/>the default value is true. |
32-
| [max_shape_or_image_count](/cells/python-net/aspose.cellsgridjs/config/max_shape_or_image_count) | Sets/Gets the total display shape/image count inside the active sheet,it will take affec when IslimitShapes=true. <br/>the default value is 100. |
33-
| [max_total_shape_or_image_count](/cells/python-net/aspose.cellsgridjs/config/max_total_shape_or_image_count) | Sets/Gets the total display shape/image count inside the whole workbook,it will take affec when IslimitShapes=true. <br/>the default value is 300. |
34-
| [max_shape_or_image_width_or_height](/cells/python-net/aspose.cellsgridjs/config/max_shape_or_image_width_or_height) | Sets/Gets the max width or height for a shape/image ,GridJs will ignore the shape/image with the width or height larger than this, it will take affec when IslimitShapes=true. <br/>the default value is 10000. |
35-
| [max_pdf_save_seconds](/cells/python-net/aspose.cellsgridjs/config/max_pdf_save_seconds) | Sets/Gets the max timed out seconds when save to pdf. <br/>the default value is 10. |
36-
| [ignore_empty_content](/cells/python-net/aspose.cellsgridjs/config/ignore_empty_content) | Sets/Gets whether to show the max range which includes data ,style, merged cells and shapes. <br/>if the last row or column contains cells with no value and formula but has custom style <br/>then we will not show this row/column when this vlaue is true。<br/>the default value is true . |
37-
| [use_print_area](/cells/python-net/aspose.cellsgridjs/config/use_print_area) | Sets/Gets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea. <br/>the default value is false . |
38-
| [load_time_out](/cells/python-net/aspose.cellsgridjs/config/load_time_out) | Sets/Gets a timeout interrupt in milliseconds in loading file, when the cost time period of loading file is longer than the expectation,it will raise exception. <br/>the default value is -1,which means no timeout interrupt is set . |
39-
| [show_chart_sheet](/cells/python-net/aspose.cellsgridjs/config/show_chart_sheet) | Sets/Gets whether to show chart worksheet. <br/>the default value is false . |
40-
| [page_size](/cells/python-net/aspose.cellsgridjs/config/page_size) | Sets/Gets whether to do pagination <br/>GridJs will limit the row size based on the PageSize,if PageSize is -1,it will not do pagination <br/>the default value is -1 |
41-
| [empty_sheet_max_row](/cells/python-net/aspose.cellsgridjs/config/empty_sheet_max_row) | Sets/Gets default max row for an empty worksheet. <br/>the default value is 12. |
42-
| [empty_sheet_max_col](/cells/python-net/aspose.cellsgridjs/config/empty_sheet_max_col) | Sets/Gets default max column for an empty worksheet. <br/>the default value is 15. |
43-
| [picture_cache_directory](/cells/python-net/aspose.cellsgridjs/config/picture_cache_directory) | Sets/Gets the cache directory for pictures.(this will take affect when GridJsWorkbook.CacheImp is null) <br/>the default path will be "_piccache" inside the FileCacheDirectory. |
44-
| [file_cache_directory](/cells/python-net/aspose.cellsgridjs/config/file_cache_directory) | Sets/Gets the cache directory for spreadsheet file. <br/>We need to set it to a specific path before we use GridJs. |
45-
46-
47-
### Methods
48-
| Method | Description |
49-
| :- | :- |
50-
| [set_license](/cells/python-net/aspose.cellsgridjs/config/set_license/#str) | |
51-
| [set_license](/cells/python-net/aspose.cellsgridjs/config/set_license/#io.RawIOBase) | Licenses the component. |
52-
| [set_font_folder](/cells/python-net/aspose.cellsgridjs/config/set_font_folder/#str-bool) | Sets the fonts folder |
53-
| [set_font_folders](/cells/python-net/aspose.cellsgridjs/config/set_font_folders/#list-bool) | Sets the fonts folders |
54-
55-
56-
57-
### See Also
58-
* module [`aspose.cellsgridjs`](..)
63+
### See Also
64+
* module [`aspose.cellsgridjs`](..)

english/aspose.cellsgridjs/config/auto_optimize_for_large_cells/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,24 @@ title: auto_optimize_for_large_cells property
33
second_title: Aspose.Cells.GridJs for Python via .NET API References
44
description:
55
type: docs
6-
weight: 60
6+
weight: 70
77
url: /aspose.cellsgridjs/config/auto_optimize_for_large_cells/
88
is_root: false
99
---
1010

1111
## auto_optimize_for_large_cells property
1212

1313

14-
Sets/Gets whether to automatically optimize the load performance for worksheet with large cells
15-
ignore some style /borders to reduce the load time
14+
Gets/Sets whether to automatically optimize the load performance for worksheet with large cells.
15+
it will ignore some style /borders to reduce the load time.
1616
the default value is true.
1717
### Definition:
1818
```python
1919
@property
2020
def auto_optimize_for_large_cells(self):
2121
...
22-
@auto_optimize_for_large_cells.setter
23-
def auto_optimize_for_large_cells(self, value):
22+
@staticmethod
23+
def set_auto_optimize_for_large_cells(value):
2424
...
2525
```
2626

english/aspose.cellsgridjs/config/empty_sheet_max_col/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ title: empty_sheet_max_col property
33
second_title: Aspose.Cells.GridJs for Python via .NET API References
44
description:
55
type: docs
6-
weight: 70
6+
weight: 100
77
url: /aspose.cellsgridjs/config/empty_sheet_max_col/
88
is_root: false
99
---
1010

1111
## empty_sheet_max_col property
1212

1313

14-
Sets/Gets default max column for an empty worksheet.
14+
Gets/Sets default max column for an empty worksheet.
1515
the default value is 15.
1616
### Definition:
1717
```python
1818
@property
1919
def empty_sheet_max_col(self):
2020
...
21-
@empty_sheet_max_col.setter
22-
def empty_sheet_max_col(self, value):
21+
@staticmethod
22+
def set_empty_sheet_max_col(value):
2323
...
2424
```
2525

english/aspose.cellsgridjs/config/empty_sheet_max_row/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ title: empty_sheet_max_row property
33
second_title: Aspose.Cells.GridJs for Python via .NET API References
44
description:
55
type: docs
6-
weight: 80
6+
weight: 110
77
url: /aspose.cellsgridjs/config/empty_sheet_max_row/
88
is_root: false
99
---
1010

1111
## empty_sheet_max_row property
1212

1313

14-
Sets/Gets default max row for an empty worksheet.
14+
Gets/Sets default max row for an empty worksheet.
1515
the default value is 12.
1616
### Definition:
1717
```python
1818
@property
1919
def empty_sheet_max_row(self):
2020
...
21-
@empty_sheet_max_row.setter
22-
def empty_sheet_max_row(self, value):
21+
@staticmethod
22+
def set_empty_sheet_max_row(value):
2323
...
2424
```
2525

0 commit comments

Comments
 (0)