GridJsWorkbook class

Represents the main entry class for GridJs

The GridJsWorkbook type exposes the following members:

Constructors

Constructor	Description
`__init__(self)`	Constructs a new instance of GridJsWorkbook

Properties

Property	Description
settings	Represents the workbook settings.
cache_imp	Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it.
calculate_engine	Custom implemention for calculation engine ,If you want to do custom calculation, you need to set and implement it.
update_monitor	Gets/Sets the update monitor to track update operation
PICTURE_TYPE	const value for the type of the image

Methods

Method	Description
`import_excel_file(self, uid, file_name, password)`	Imports the excel file from file path and open password.
`import_excel_file(self, uid, file_name)`	Imports the excel file from the file path.
`import_excel_file(self, file_name)`	Imports the excel file from the file path.
`import_excel_file(self, uid, filestream, format, password)`	Imports the excel file from file stream with load format and open password.
`import_excel_file(self, uid, filestream, format)`	Imports the excel file from file stream.
`import_excel_file(self, filestream, format, password)`	Imports the excel file from file stream with load format and open password.
`import_excel_file(self, filestream, format)`	Imports the excel file from file stream with load format.
`export_to_json(self, filename)`	Gets JSON string from memory data,set the output filename in the JSON.
`export_to_json(self)`	Gets JSON string from memory data, the default filename in the JSON is: book1.
`save_to_excel_file(self, stream)`	Saves the memory data to the sream, baseed on the origin file format.
`save_to_excel_file(self, path)`	Saves the memory data to the file path,if the file has extension ,save format is baseed on the file extension .
`save_to_pdf(self, path)`	Saves the memory data to the file path,the save format is pdf.
`save_to_pdf(self, stream)`	Saves the memory data to the sream,the save format is pdf.
`save_to_xlsx(self, path)`	Saves the memory data to the file path,the save format is xlsx.
`save_to_xlsx(self, stream)`	Saves the memory data to the sream,the save format is xlsx.
`save_to_html(self, path)`	Saves the memory data to the file path,the save format is html.
`save_to_html(self, stream)`	Saves the memory data to the sream,the save format is html
`json_to_stream_by_uid(self, stream, uid, filename)`	Retrieve the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON,and write it to the stream.
`json_to_stream(self, stream, filename)`	Retrieve the JSON string from memory data,set the output filename in the JSON, and write it to the stream.
`lazy_loading_stream(self, stream, uid, sheet_name)`	Retrieve the JSON string of the specified sheet in the file from the cache using the specified unique id, and write it to the stream.
`get_json_str_by_uid(self, uid, filename)`	Gets the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON.
`lazy_loading_json_str(self, uid, sheet_name)`	Gets the JSON string of the specified sheet in the file from the cache using the specified unique id.
`get_uid_for_file(, file_name)`	Generates a new unique id for the file cache using the given file name.
`import_excel_file_from_json(self, json)`	Imports the excel file from JSON format string.
`merge_excel_file_from_json(self, uid, json)`	Applies a batch update to the memory data.
`save_to_cache_with_file_name(self, uid, filename, password)`	Saves the memory data to the cache file with the specified filename and also set the open password, the save format is baseed on the file extension of the filename .
`get_image_stream(, uid, picid)`	Get Stream of image.
`get_ole(self, uid, sheetname, oleid, label)`	Gets the byte array data of the embedded ole object .
`check_in_cache_for_collaborative(self, uid)`	Check wether workbook instance is in memory cache .this method is apply for Collaborative mode only.
`update_cell(self, p, uid)`	Applies the update operation.
`insert_image(self, uid, p, s, image_url)`	Inserts image in the worksheet from file stream or the URL,(either the file stream or the URL shall be provided) or Inserts shape ,when the p.type is one of AutoShapeType
`copy_image_or_shape(self, uid, p)`	Copys image or shape.
`error_json(self, msg)`	Gets the error message string in JSON format.
`get_grid_load_format(, extension)`	Gets the load format by file extension
`get_image_url(, uid, picid, delimiter)`	Gets the image URL.
`set_image_url_base(, base_image_url)`	Set the base image get action URL from controller .

GridJsWorkbook class

GridJsWorkbook class

Constructors

Properties

Methods

See Also