activate()

方法描述

激活當前sheet

調用樣例- rpa.app.wps.excel.Sheet.activate-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 使用此方法并保存excel后，對應sheet頁面會作為默認打開頁，即啟動對應excel文件后，對應sheet頁會作為首頁
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet("非默認頁")

sheet.activate()

excel.close()

read(range, only_visible=False, skip=0, max=1000)

方法描述

從Excel讀取數據，數字的返回均為float，例如：excel中的單元格值為1，則讀出的值為1.0

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

only_visible<bool>只讀可見

skip<int>讀列時跳過多少行后開始讀

max<int>讀列或者范圍時，行數不能超過max的范圍

調用樣例- rpa.app.wps.excel.Sheet.read-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

cell_value = sheet.read('A1')
row_value = sheet.read('1')
column_value = sheet.read('A')
range_value = sheet.read('A1:C3')

excel.close()

write(range, value, start_row=1, start_col='A', max=1000)

方法描述

向Excel寫入數據

參數說明

range<str>支持行、列、單元格、范圍寫入，寫入范圍時僅填寫起始單元格即可。例：'A'為列 '1'為行 'A1'為單元格

value<list>當range為列/行的時候傳入一維數組,寫入單元格則傳入str/int/float ,寫入范圍的時候傳入二維數組

start_row<int>寫入列時表示從哪一行開始寫，此參數僅當寫入列時有效

start_col<str>寫入行時表示從哪一列開始寫，此參數僅當寫入行時有效，可傳入'1'|'A'|'a'

max<int>寫入列時不能超過max的范圍

調用樣例- rpa.app.wps.excel.Sheet.write-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

row_value = ["行數據1","RPA測試"]
cell_value = "RPA單元格值"
column_value = ["列數據1","RPA測試"]
range_value = [["區域數據1","區域數據2"],["區域數據3","區域數據4"]]

sheet.write('1', row_value)
sheet.write('C', column_value)
sheet.write('A2', cell_value)
sheet.write('A4', range_value)

excel.close()

copy(range)

方法描述

復制范圍內的數據

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

調用樣例- rpa.app.wps.excel.Sheet.copy-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.copy('1')
sheet.copy('C')
sheet.copy('A2')
sheet.copy('A4:B5')

paste(range, paste_type='數值', retry=3)

方法描述

向范圍內粘貼數據

參數說明

range<str>粘貼目標位置，支持的格式包含行、列、粘貼范圍的起始單元格，'A'為列 '1'為行 'A1'為單元格

paste_type<str>數據類型

可選項：

• all : 全部

• formula : 公式

• value : 數值

• format : 格式

• annotation : 批注

• verification : 驗證

• sourceUnit : 所有使用源主題的單元

• exceptBorder : 邊框除外

• colWidth : 列寬

• FormulasNumber : 公式和數字格式

• valueNumber : 值和數字格式

• mergeCondition : 所有合并條件格式

retry<int>重試次數

調用樣例- rpa.app.wps.excel.Sheet.paste-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.copy('1')
sheet.paste('2')

sheet.copy('C')
sheet.paste('D')

sheet.copy('A2')
sheet.paste('B2')

sheet.copy('A4:B5')
sheet.paste('C4')

row_count()

方法描述

獲得指定sheet的行數

返回值說明

返回行數<str>

調用樣例- rpa.app.wps.excel.Sheet.row_count-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

count = sheet.row_count()

col_count()

方法描述

獲得指定sheet的列數

返回值說明

返回列數<str>

調用樣例- rpa.app.wps.excel.Sheet.col_count-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

count = sheet.col_count()

sort(sort_fields, range=None, match_case=False, sort_method='pinyin', contains_header=False)

方法描述

排序

參數說明

sort_fields<list>排序字段數組 sort_fields = [(<列名>,<排序類型>,<升降序>)]

• Excel列名，如A，B，AA等

• 排序類型：

  • value：按照單元格值

  • cell_color：按照單元格顏色

  • font_color：按照單元格字體顏色

• 升降序：

  • asc：升序

  • desc：降序

range<str>查找范圍：如'A1:C5', 如果為空則查找整個Sheet（默認整個Sheet）

match_case<bool>是否區分大小寫

• False：默認值， 則執行不區分大小寫的排序。

• True：則執行區分大小寫的排序。

sort_method<str>排序方法

可選項：

• pinyin：默認值。 按字符的漢語拼音順序排序

• stroke：按每個字符中的筆劃數量排序

contains_header<bool>是否不包含標題

• False：默認值， （應）對整個范圍進行排序。

• True：（不應）對整個范圍進行排序。

調用樣例- rpa.app.wps.excel.Sheet.sort-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()
# 將A列的值進行降序
sort_fields1 = [('A','value','desc')]
sheet.sort(sort_fields)
# 將B列的單元格顏色進行升序
sort_fields2 = [('B','cell_color','asc')]
sheet.sort(sort_fields2)
# 將C列的字體顏色進行升序
sort_fields3 = [('C','font_color','asc')]
sheet.sort(sort_fields3)

filter(col, array, delete=False)

方法描述

對列進行篩選

參數說明

col<str>列號

array<list>篩選值數組

delete<bool>篩選后是否刪除，在3.4.3及以后版本無效

調用樣例- rpa.app.wps.excel.Sheet.filter-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()
# 普通篩選
filter_value = ['rpa_test1','rpa_test2']
# 高級篩選,支持通配符 ？代表單個字符 * 代表任意多個字符
filter_value = ['rpa_test？']
# 篩選空白單元格
filter_value = ['=']

sheet.filter('A',filter_value)

remove_filter()

方法描述

移除篩選

調用樣例- rpa.app.wps.excel.Sheet.remove_filter-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()
filter_value = ['rpa_test1','rpa_test2']

sheet.filter('A',filter_value)
sheet.remove_filter()

merge_cell(range, each_row=False)

方法描述

合并單元格

參數說明

range<str>需要合并的范圍，必須為 A1:B2的格式

each_row<bool>是否行內合并

調用樣例- rpa.app.wps.excel.Sheet.merge_cell-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 此方法通過each_row參數指定合并形式，默認為False，將把指定區域合并為一個完整的單元格
# 若指定each_row = True，則將把指定區域按行合并，每一行作為一個單元格
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.merge_cell('A1:B2',each_row=True)

insert(range, insertDirection=None)

方法描述

插入功能

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

insertDirection<str>插入方向

可選項：

• down : 下移

• right : 右移

調用樣例- rpa.app.wps.excel.Sheet.insert-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 此方法通過insertDirection參數指定插入后相鄰值的移動方向，支持下移和右移
# 代碼調用樣例如下，會向A1單元格插入一個空的單元格，原有數據默認下移：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.insert('A1')

delete(range, insertDirection=None)

方法描述

刪除功能

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

insertDirection<str>插入方向

可選項：

• up : 上移

• left : 左移

調用樣例- rpa.app.wps.excel.Sheet.delete-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下，會刪除A1單元格，原有數據默認上移：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.delete('A1')

remove_duplicated_cols(range, cols)

方法描述

列去重功能

參數說明

range<str>'A'為列 'A1:B2'為范圍

cols<list>去重列號的列表

調用樣例- rpa.app.wps.excel.Sheet.remove_duplicated_cols-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 去重列字段不能超過去重范圍，如去重范圍為A1:C3，則去重列字段只能從A,B,C三個中選取任意個
# 代碼調用樣例如下，此例中指定了在A1:C9區域進行去重操作，一行數據上三個值均相等時，才視為重復值：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.remove_duplicated_cols('A1:C9',['A','B','C'])

set_region_font_pattern_in_sheet (range, font_pattern='general')

方法描述

設置指定區域字體

參數說明

range<str>excel區域,如：'A1:B2'

font_pattern<str>設置區域內字體形態

可選項：

• general：常規

• bold：加粗

• italic：斜體

• boldAndItalic：加粗&斜體

調用樣例- rpa.app.wps.excel.Sheet.set_region_font_pattern_in_sheet-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()
# 設置Excel中A1:B2區域字體加粗
sheet.set_region_font_pattern_in_sheet('A1:B2',font_pattern='bold')

set_region_border (range, border_type, color='000000')

方法描述

設置指定范圍的樣式

參數說明

range<str>excel區域,如：'A1:B2'

border_type<str>樣式

可選項：

• no_border: 無框線（默認）

• all_borders: 所有框線

• bottom_border: 下框線

• top_border: 上框線

• left_border: 左框線

• right_border: 右框線

• outline_borders: 外側框線

• thick_outline_borders: 粗外框線

• double_bottom_borders: 雙底框線

• thick_bottom_borders: 粗底框線

• upper_and_lower_borders: 上下框線

• top_and_thick_bottom_borders: 上框線和粗下框線

• top_and_double_bottom_borders: 上框線和雙下框線

color<str>設置該屬性的hex值，默認為'#000000'

調用樣例- rpa.app.wps.excel.Sheet.set_region_border-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()
# 設置Excel中A1:B2區域單元格邊框類型為所有框線，且顏色為黑色。
sheet.set_region_border('A1:B2','all_borders',color='000000')

find(text, range=None, count=0)

方法描述

查詢

參數說明

text<str>要查詢的內容

range<str>查找范圍：如'A1:C5', 如果為空則查找整個Sheet（默認整個Sheet）

count<int>0表示查找所有匹配項（默認為0）

返回值說明

返回值：二維數組，每行都是一個返回結果，第一列是行號，第二列是列號，第三列是匹配的單元格值; 返回0表示未找到任何匹配項<list>

調用樣例- rpa.app.wps.excel.Sheet.find-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 可通過制定count參數來設定匹配項數量，默認為0，即返回所有匹配結果，設為1則按從左到右，從上到下的順序返回第一個匹配的單元格
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

result = sheet.find('AA',count=1)

add_picture(file, col, row, width=None, height=None)

方法描述

向指定位置插入圖片

參數說明

file<str>插入圖片的路徑

col<str>左上角單元格的列號

row<str>左上角單元格的行號

width<float>圖片的寬度

height<float>圖片的高度

調用樣例- rpa.app.wps.excel.Sheet.add_picture-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

pic_path = r'D:\2_測試文件歸檔\OCR文字識別.png'
sheet.add_picture(pic_path,'C','2')

get_row_height(row)

方法描述

獲得指定行高度

參數說明

row<str>行號

返回值說明

返回行高<str>

調用樣例- rpa.app.wps.excel.Sheet.get_row_height-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

row_height = sheet.get_row_height('1')

set_row_height(row, height)

方法描述

設置指定行高度

參數說明

row<str>行號

height<str>行高

調用樣例- rpa.app.wps.excel.Sheet.set_row_height-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.set_row_height('1','20')

get_col_width(col)

方法描述

獲得指定列寬度

參數說明

col<str>列號

返回值說明

返回列寬<str>

調用樣例- rpa.app.wps.excel.Sheet.get_col_width-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

col_width = sheet.get_col_width('A')

set_col_width(col, width)

方法描述

設置指定列寬度

參數說明

col<str>列號

width<str>列寬

調用樣例- rpa.app.wps.excel.Sheet.set_col_width-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.set_col_width('A','20')

get_formula(range)

方法描述

獲取指定范圍的公式

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

返回值說明

返回指定范圍的公式<str>

調用樣例- rpa.app.wps.excel.Sheet.get_formula-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

formula = sheet.get_formula("A1")

set_formula(range, formula)

方法描述

設置指定范圍的公式

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

formula<str>公式

調用樣例- rpa.app.wps.excel.Sheet.set_formula-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

formula = "=TODAY()"
sheet.set_formula("E2:F3",formula)

get_style(range, style, color_format='RGB')

方法描述

獲取指定范圍的樣式

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

style<str>樣式

可選項：

• fontsize : 字體大小

• fontcolor : 字體顏色

• fontname : 字體名稱

• bgcolor : 背景色

color_format<str>顏色類型，當style為fontcolor/bgcolor時有效，可傳入'HEX'|'RGB'

調用樣例- rpa.app.wps.excel.Sheet.get_style-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

style = sheet.get_style("A1:B2","fontsize")

set_style(range, style, value, color_format='RGB')

方法描述

設置指定范圍的樣式

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

style<str>樣式

可選項：

• fontsize : 字體大小

• fontcolor : 字體顏色

• fontname : 字體名稱

• bgcolor : 背景色

value<str>設置該屬性的值，如果style為fontcolor/bgcolor，則value可以為'#FFFFFF'或者'255,255,255'

color_format<str>顏色類型，如果style為fontcolor/bgcolor，需設置format為'HEX'或者'RGB'

調用樣例- rpa.app.wps.excel.Sheet.set_style-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.set_style("A3","bgcolor","#FF0000","HEX")

get_comment(range)

方法描述

獲取單元格的注釋

參數說明

range<str>'A1'為單元格

返回值說明

返回單元格的注釋，當單元格沒有注釋時，返回None<str>

調用樣例- rpa.app.wps.excel.Sheet.get_comment-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 當目標單元格本身并無注釋時，此方法將返回None
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

comment = sheet.get_comment("A1")

set_comment(range, comment)

方法描述

往單元格插入注釋

參數說明

range<str>'A1'為單元格

comment<str>注釋

調用樣例- rpa.app.wps.excel.Sheet.set_comment-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

comment = "RPA測試"
sheet.set_comment("A1",comment)

replace(text, replacement, range=None, match_case=False)

方法描述

替換

參數說明

text<str>要替換的內容

replacement<str>替換成的內容

range<str>查找范圍：如'A1:C5', 如果為空則查找整個Sheet（默認整個Sheet）

match_case<bool>是否大小寫匹配

調用樣例- rpa.app.wps.excel.Sheet.replace-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.replace("test","RPA_TEST")

to_pdf(file)

方法描述

轉化成pdf

參數說明

file<str>保存的pdf路徑

調用樣例- rpa.app.wps.excel.Sheet.to_pdf-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

path = r"D:\2_測試文件歸檔\sheet轉pdf.pdf"
sheet.to_pdf(path)

select_pivot_field_items(name, array, index=1, select=True)

方法描述

選擇/取消選擇一組透視表篩選項

參數說明

index<int>數據透視表編號,如果有多張透視表需指定第幾張

name<str>字段名

array<list>待選擇的值列表

select<bool>選擇或取消

調用樣例- rpa.app.wps.excel.Sheet.select_pivot_field_items-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下，此例中會取消勾選"購買者"這個字段下，值為"AA"或"BB"的相關數據，對應數據不顯現：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet('數據透視表')

sheet.select_pivot_field_items('購買者', ['AA','BB'], select=False)

clear_range (range, clear_format=True)

方法描述

清除Excel中區域數據

參數說明

range<str>excel區域,如：'A1:B2'

clear_format<bool>是否清除格式

調用樣例- rpa.app.wps.excel.Sheet.clear_range-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

sheet.clear_range('A1:B2')

calculate_sum_of_col(col, start_row=1, condition='<>')

方法描述

計算列和

參數說明

col<str>列號

start_row<int>起始行號

condition<str>定義哪些單元格將被相加求和的條件,其形式可以為數字,表達式或文本,例如, :<>（僅對數字加和）,>32（對大于32的數字加和）

返回值說明

返回列和 <float>

調用樣例- rpa.app.wps.excel.Sheet.calculate_sum_of_col-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

col_sum = sheet.calculate_sum_of_col('A', start_row=1)
print(col_sum)

calculate_sum_of_range (range, condition='<>')

方法描述

計算區域和

參數說明

range<str>excel區域,如：'A1:B2'

condition<str>定義哪些單元格將被相加求和的條件,其形式可以為數字,表達式或文本,例如, :<>（僅對數字加和）,>32（對大于32的數字加和）

返回值說明

返回列和 <float>

調用樣例- rpa.app.wps.excel.Sheet.calculate_sum_of_range-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

range_sum = sheet.calculate_sum_of_range('A1:C5')
print(range_sum)

hide_region(hide_region_type='row', start_row=None, end_row=None, start_col=None, end_col=None)

方法描述

隱藏區域

參數說明

hide_region_type<str> 隱藏區域類型

可選項：

• row: 隱藏一行或多行

• col: 隱藏一列或多列

start_row<str>區域起始行號，僅隱藏區域類型為row時有效，可傳入'1'

end_row<str>區域結束行號，僅隱藏區域類型為row時有效，可傳入'3'

start_col<str>區域起始列號，僅隱藏區域類型為col時有效，可傳入'A'|'a'

end_col<str>區域結束列號，僅隱藏區域類型為col時有效，可傳入'D'|'d'

調用樣例- rpa.app.wps.excel.Sheet.hide_region-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

sheet.hide_region(hide_region_type='row', start_row='1', end_row='4', start_col=None, end_col=None)
sheet.hide_region(hide_region_type='col', start_row=None, end_row=None, start_col="a", end_col="f")

show_region(show_region_type='row', start_row=None, end_row=None, start_col=None, end_col=None)

方法描述

顯示區域

參數說明

show_region_type<str> 顯示區域類型

可選項：

• row: 顯示一行或多行

• col: 顯示一列或多列

start_row<str>區域起始行號，僅顯示區域類型為row時有效，可傳入'1'

end_row<str>區域結束行號，僅顯示區域類型為row時有效，可傳入'3'

start_col<str>區域起始列號，僅顯示區域類型為col時有效，可傳入'A'|'a'

end_col<str>區域結束列號，僅顯示區域類型為col時有效，可傳入'D'|'d'

調用樣例- rpa.app.wps.excel.Sheet.show_region-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

sheet.show_region(show_region_type='row', start_row='1', end_row='3', start_col=None, end_col=None)
sheet.show_region(show_region_type='col', start_row=None, end_row=None, start_col="b", end_col="c")

multi_filter(filters_val, range=None, delete=False)

方法描述

對多列進行篩選

參數說明

filters_val<dic>按以下格式書寫 {'A':['testA1','testA2','testA3'],'B':['testB1','testB2']'...}

range<str>篩選列范圍： 如'A1:C5', 如果為空則篩選整個Sheet（默認整個Sheet）

delete<bool>篩選后是否刪除，在3.4.3及以后版本無效

調用樣例- rpa.app.wps.excel.Sheet.multi_filter-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下，運行后，會開啟篩選并選擇A列值為test01或test02且B列值為1或2的行：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()
filter_exp = {
    'A':['test01','test02'],
    'B':['1','2']
}
sheet.multi_filter(filter_exp)

create_pivot_table(data_sheet, data_range, pivot_sheet, pivot_range, pivot_settings)

方法描述

創建透視表

參數說明

data_sheet<str>透視表源數據所在Sheet名稱，如'Sheet1'

data_range<str>透視表源數據范圍，如'A1:C10'

pivot_sheet<str>透視表插入的Sheet名稱，如'Sheet2'

pivot_range<str>透視表插入的位置，如'A1'

pivot_settings<PivotTableSettings>透視表設置

調用樣例- rpa.app.wps.excel.Sheet.create_pivot_table-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下，此例中將以日期為篩選條件，以"購買者"作為行標題，以"類型"作為列標題，將"金額"進行求和計算
# 最終得到按日期篩選，每個購買者每種類型的總成交金額統計透視表：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet('消費數據')

pivot_settings = rpa.app.wps.excel.PivotTableSettings('數據透視表設置')
pivot_settings.filters['日期'] = {} # 添加"篩選字段"
pivot_settings.rows['購買者'] = {} # 添加"行標簽"
pivot_settings.columns['類型'] = {} # 添加"列標簽"
pivot_settings.values['金額'] = {"Function": "xlSum"} # 添加"數值"

sheet.create_pivot_table('消費數據', 'A:D', '數據透視表', 'A1', pivot_settings)

excel.save()
excel.close()

說明

此例中的pivot_setings.values用于設定透視表字段值處理形式，其中Function可選的內容如下表所示：

|--------------|--------||Function|說明|| xlSum | 求和 || xlCount | 計數 || xlAverage | 平均值 || xlMax | 最大值 || xlMin | 最小值 || xlProduct | 乘積 || xlCountNums | 數值計數 || xlStDev | 標準偏差 || xlStDevP | 總體標準偏差 || xlVar | 方差 || xlVarP | 總體方差 |

refresh_pivot_table(index=1)

方法描述

刷新透視表

參數說明

index<int>數據透視表編號,如果有多張透視表需指定第幾張

調用樣例- rpa.app.wps.excel.Sheet.refresh_pivot_table-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下，此例會根據數據源更新數據透視表的值：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet('數據透視表')

sheet.refresh_pivot_table(index=1)

get_all_pivot_field_items(name, index=1)

方法描述

獲取透視表篩選列的所有項

參數說明

index<int>數據透視表編號,如果有多張透視表需指定第幾張

name<str>字段名

返回值說明

返回篩選結果<list>

調用樣例- rpa.app.wps.excel.Sheet.get_all_pivot_field_items-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下，本例會獲取數據透視表中"購買者"這個字段下所有的不重復的值：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet('數據透視表')

options_of_field = sheet.get_all_pivot_field_items('購買者')

get_number_format(range, format)

方法描述

獲取指定范圍的數字格式

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

調用樣例- rpa.app.wps.excel.Sheet.get_number_format-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

sheet.get_number_format("D2")

set_number_format(range, format)

方法描述

設置指定范圍的數值格式

參數說明

range<str>'A'為列 '1'為行 'A1'為單元格 'A1:B2'為范圍

format<str>如'@'，參見Excel中的單元格格式的自定義

調用樣例- rpa.app.wps.excel.Sheet.set_number_format-

# 注意事項：使用前需確認已安裝WPS相關軟件
# 代碼調用樣例如下：
excel_file_path = r"D:\2_測試文件歸檔\測試Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path, visible=True)
sheet = excel.get_sheet()

sheet.set_number_format("D2","0.00")

說明

format參數可選值請參考Excel中的標準寫法（單元格設置-數字-自定義）