asposecloud.cells
index
/cells/__init__.py

 
Package Contents
       

 
Classes
       
ChartEditor
Converter
Extractor
TextEditor
Workbook
Worksheet

 
class ChartEditor
     Methods defined here:
__init__(self, filename)
add_chart(self, worksheet_name, chart_type, upper_left_row, upper_left_column, lower_right_row, lower_right_column, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param chart_type:
:param upper_left_row:
:param upper_left_column:
:param lower_right_row:
:param lower_right_column:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
delete_chart(self, worksheet_name, chart_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param chart_index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_border(self, worksheet_name, chart_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param chart_index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_chart_area(self, worksheet_name, chart_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param chart_index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_fill_format(self, worksheet_name, chart_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param chart_index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
class Converter
     Methods defined here:
__init__(self, filename)
autoshape_to_image(self, shape_index, worksheet_name, save_format, password=None, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param shape_index:
:param worksheet_name:
:param save_format:
:param password:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
chart_to_image(self, chart_index, worksheet_name, save_format, password=None, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param chart_index:
:param worksheet_name:
:param save_format:
:param password:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
convert(self, save_format, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param save_format:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
convert_to_image(self, worksheet_name, save_format, password=None, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param save_format:
:param password:
:param stream_out:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
oleobject_to_image(self, ole_index, worksheet_name, save_format, password=None, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param ole_index:
:param worksheet_name:
:param save_format:
:param password:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
picture_to_image(self, picture_index, worksheet_name, save_format, password=None, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param picture_index:
:param worksheet_name:
:param save_format:
:param password:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

Static methods defined here:
convert_local_file(input_file, save_format, stream_out=False, output_filename=None)
:param input_file:
:param save_format:
:param stream_out:
:param output_filename:
:return:

 
class Extractor
     Methods defined here:
__init__(self, filename)
get_autoshape(self, shape_index, worksheet_name, save_format, password=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param shape_index:
:param worksheet_name:
:param save_format:
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_chart(self, chart_index, worksheet_name, save_format, password=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param chart_index:
:param worksheet_name:
:param save_format:
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_oleobject(self, ole_index, worksheet_name, save_format, password=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param ole_index:
:param worksheet_name:
:param save_format:
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_picture(self, picture_index, worksheet_name, save_format, password=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param picture_index:
:param worksheet_name:
:param save_format:
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
class TextEditor
     Methods defined here:
__init__(self, filename)
find_text(self, text, worksheet_name=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param text:
:param worksheet_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_text_items(self, worksheet_name=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
replace_text(self, old_text, new_text, worksheet_name=None, remote_folder='', storage_type='Aspose', storage_name=None)
:param old_text:
:param new_text:
:param worksheet_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
class Workbook
     Methods defined here:
__init__(self, filename)
add_worksheet(self, worksheet_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
clear_modify_password(self, password, remote_folder='', storage_type='Aspose', storage_name=None)
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
delete_property(self, property_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param property_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
encrypt_workbook(self, encryption_type, password, key_length, remote_folder='', storage_type='Aspose', storage_name=None)
:param encryption_type:
:param password:
:param key_length:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_default_style(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_name_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_properties(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_property(self, property_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param property_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_worksheets_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
protect_workbook(self, protection_type, password, remote_folder='', storage_type='Aspose', storage_name=None)
:param protection_type:
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
remove_worksheet(self, worksheet_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param worksheet_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
set_modify_password(self, password, remote_folder='', storage_type='Aspose', storage_name=None)
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
set_property(self, property_name, property_value, remote_folder='', storage_type='Aspose', storage_name=None)
:param property_name:
:param property_value:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
unprotect_workbook(self, password, remote_folder='', storage_type='Aspose', storage_name=None)
:param password:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

Static methods defined here:
create_empty_workbook(workbook_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param workbook_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
create_from_smart_template(workbook_name, template_filename, data_filename, remote_folder='', storage_type='Aspose', storage_name=None)
:param workbook_name:
:param template_filename:
:param data_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
create_workbook_from_template(workbook_name, template_filename, remote_folder='', storage_type='Aspose', storage_name=None)
:param workbook_name:
:param template_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
process_smart_marker(workbook_name, data_filename, remote_folder='', storage_type='Aspose', storage_name=None)
:param workbook_name:
:param data_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
class Worksheet
     Methods defined here:
__init__(self, filename, worksheet_name)
get_autoshape(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_autoshapes_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_cell(self, cell_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param cell_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_cell_style(self, cell_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param cell_name:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_cells_count(self, offset, count, remote_folder='', storage_type='Aspose', storage_name=None)
:param offset:
:param count:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_cells_list(self, offset, count, remote_folder='', storage_type='Aspose', storage_name=None)
:param offset:
:param count:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_chart(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_charts_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_columns_list(self, offset, count, remote_folder='', storage_type='Aspose', storage_name=None)
:param offset:
:param count:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_comment(self, cell_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param cell_name:
:param remote_folder:
:param storage_type:
:param storage_name:
:return:
get_comments_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_hyperlink(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_hyperlinks_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_max_column(self, offset, count, remote_folder='', storage_type='Aspose', storage_name=None)
:param offset:
:param count:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_max_row(self, offset, count, remote_folder='', storage_type='Aspose', storage_name=None)
:param offset:
:param count:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_merged_cells(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_mergedcells_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_ole_object(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_ole_objects_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_picture(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_pictures_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_row_list(self, offset, count, remote_folder='', storage_type='Aspose', storage_name=None)
:param offset:
:param count:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_validation(self, index, remote_folder='', storage_type='Aspose', storage_name=None)
:param index:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_validations_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
Data
        __author__ = 'AssadMahmood'

 
Author
        AssadMahmood