Config class

Config class

Represents all the static settings for GridJs

The Config type exposes the following members:

Constructors

ConstructorDescription
__init__(self)Constructs a new instance of Config

Properties

PropertyDescription
save_html_as_zipGets/Sets whether to save html file as zip archive,the default is false.
skip_invisible_shapesGets/Sets whether to skip shapes that are invisble to UI ,the default value is true.
lazy_loadingGets/Sets whether to load active worksheet only,the default is false.
same_image_detectingGets/Sets whether to check if images have same source,the default is true
the default value is true.
auto_optimize_for_large_cellsGets/Sets whether to automatically optimize the load performance for worksheet with large cells.
it will ignore some style /borders to reduce the load time.
the default value is true.
islimit_shape_or_imageGets/Sets whether to limit the total display shape/image count in one worksheet ,if set to true,
GridJs will limit the total count of the display shapes or images in one worksheet to MaxShapeOrImageCount
the default value is true.
max_shape_or_image_countGets/Sets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true.
the default value is 100.
max_total_shape_or_image_countGets/Sets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true.
the default value is 300.
max_shape_or_image_width_or_heightGets/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.
the default value is 10000.
max_pdf_save_secondsGets/Sets the max timed out seconds when save to PDF.
the default value is 10.
ignore_empty_contentGets/Sets whether to show the max range which includes data ,style, merged cells and shapes.
if the last row or column contains cells with no value and formula but has custom style
then we will not show this row/column when this vlaue is true。
the default value is true .
use_print_areaGets/Sets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea.
the default value is false .
is_collaborativeGets/Sets whether to support collabrative editing,the default is false.
custom_pdf_save_optionsGets/Sets the custom PdfSaveOptions for PDF export. If set, this will be used instead of the default options.
the default value is null.
load_time_outGets/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.
the default value is -1,which means no timeout interrupt is set .
show_chart_sheetGets/Sets whether to show chart worksheet.
the default value is false .
empty_sheet_max_rowGets/Sets default max row for an empty worksheet.
the default value is 12.
empty_sheet_max_colGets/Sets default max column for an empty worksheet.
the default value is 15.
picture_cache_directoryGets/Sets the cache directory for pictures.(this takes effect when GridJsWorkbook.CacheImp is null)
the default path will be “_piccache” inside the FileCacheDirectory.
file_cache_directoryGets/Sets the cache directory for storing spreadsheet file.
We need to set it to a specific path before we use GridJs.
base_route_nameGets/Sets the base route name for GridJs controller URL. the default is “/GridJs2”.
message_topicGets/Sets the websocket destinations prefixed with “/topic”. the default is “/topic/opr”.used in collaborative mode only.
auto_fit_rows_height_on_loadIndicates whether to autofit rows height when loading the file,the default value is false.

Methods

MethodDescription
set_license(, license_name)Licenses the component.
set_license(, stream)Licenses the component.
set_font_folder(, font_folder, recursive)Sets the fonts folder
set_font_folders(, font_folders, recursive)Sets the fonts folders

See Also

GridAbstractCalculationEngine class