|
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 |
9 | 9 | --- |
10 | | - |
| 10 | + |
11 | 11 | ## Config class |
12 | | - |
13 | | -Represents all the settings for GridJs |
14 | | - |
| 12 | + |
| 13 | +Represents all the static settings for GridJs |
| 14 | + |
15 | 15 |
|
16 | 16 |
|
17 | 17 | 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 | + |
18 | 62 |
|
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`](..) |
|
0 commit comments