xbot.excel.WorkBook
この記事の内容
- メソッド
- get_active_sheet()
- get_sheet_by_index()
- get_sheet_by_name()
- create_sheet()
- active_sheet_by_index()
- active_sheet_by_name()
- save()
- save_as()
- close()
- execute_macro()
- get_all_sheetsZ()
- delete_sheet()
- copy_sheet()
- copy_sheet_to_workbook()
- get_selected_range()
- rename_sheet()
- refresh_data()
- create_pivot_table()
- refresh_pivot_table()
- filter_pivot_table()
- export_to_pdf()
ブックに対して、シートの取得、シートのアクティブ化、シートの作成、Excelファイルとしての保存、Excelファイルとしての名前を付けて保存、マクロの実行、ブックを閉じるなど、さまざまな処理を行います。
メソッド
get_active_sheet()
ブック内のアクティブなシートを取得します。
get_active_sheet(self)
入力パラメータ
なし
戻り値
WorkSheet:シートオブジェクト
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_active_sheet()
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 現在アクティブなシートを取得します
get_sheet_by_index()
ブック内の指定位置にあるシートを取得します。
get_sheet_by_index(self, index)
入力パラメータ
index:ブック内の対象シートのインデックス位置です。1から数えます。
戻り値
WorkSheet:シートオブジェクト
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_sheet_by_index(1)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ブック内の最初のシートを取得します
get_sheet_by_name()
get_sheet_by_name(self, name)
入力パラメータ
name:対象シートの名称
戻り値
WorkSheet:シートオブジェクト
例1
Excelファイル "D:\test.xlsx" 内の 'Sheet1' という名称のシートを取得します。
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.get_sheet_by_name('Sheet1')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> ブック内の指定した名称のシートを取得します
create_sheet()
ブック内に新しいシートを作成します。
create_sheet(self, name, create_way)
入力パラメータ
name:シート名
create_way:追加方法です。'first'(最初のシートとして追加)または 'last'(最後のシートとして追加)の2種類から選択できます。
戻り値
WorkSheet:シートオブジェクト
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
worksheet = workbook.create_sheet('SheetTest', 'last')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 'SheetTest' という名称のシートを末尾に追加します
active_sheet_by_index()
ブック内の指定位置にあるシートをアクティブにします。
active_sheet_by_index(self, index)
入力パラメータ
index:ブック内の対象シートのインデックス位置です。1から数えます。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.active_sheet_by_index(1)
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 最初のシートをアクティブにします
active_sheet_by_name()
ブック内の指定した名称のシートをアクティブにします。
active_sheet_by_name(self, name)
入力パラメータ
name:対象シートの名称
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.active_sheet_by_name('Sheet1')
この例の実行ロジック: Excelワークシート "D:\test.xlsx" を画面に表示して開きます --> 'Sheet1' という名称のシートをアクティブにします
save()
ブックをExcelファイルとして保存します。
save(self)
入力パラメータ
なし
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.save()
この例の実行ロジック: Excelファイル "D:\test.xlsx" を開いた後、保存します
save_as()
ブックをExcelファイルとして名前を付けて保存します。
save_as(self, filename)
入力パラメータ
filename:名前を付けて保存する先のパス
戻り値
なし
例1
Excelファイル "D:\test.xlsx" を開いた後
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.save_as('D:\\test1.xlsx')
この例の実行ロジック: Excelファイル "D:\test.xlsx" を開いた後、'D:\test1.xlsx' という名前を付けて保存します
close()
ブックを閉じます。
close(self)
入力パラメータ
なし
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.close()
この例の実行ロジック: Excelファイル "D:\test.xlsx" を開いた後、閉じます
execute_macro()
マクロを実行します。
execute_macro(self, macro)
入力パラメータ
macro:マクロ名
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.execute_macro('macro1')
この例の実行ロジック: Excelファイル "D:\test.xlsx" を開いた後、'macro1' という名称のマクロを実行します
get_all_sheetsZ()
すべてのシートを取得します。
get_all_sheets(self)
入力パラメータ
なし
戻り値
List[WorkSheet]:シートオブジェクトのリスト
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.get_all_sheets()
この例の実行ロジック: Excelファイル "D:\test.xlsx" 内のすべてのシートオブジェクトを取得します
delete_sheet()
Excelシートを削除します。
delete_sheet(self, name)
入力パラメータ
name:シート名
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.delete_sheet('Sheet1')
この例の実行ロジック: Excelファイル "D:\test.xlsx" のSheet1シートを削除します
copy_sheet()
Excelシートをコピーします。
copy_sheet(self, name, new_name)
入力パラメータ
name:コピーするシート名
new_name:新しいシート名
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.copy_sheet('Sheet1', 'Sheet2')
この例の実行ロジック: Excelファイル "D:\test.xlsx" のSheet1シートを新しいSheet2シートにコピーします
copy_sheet_to_workbook()
シートを指定したWorkbookにコピーします。
copy_sheet_to_workbook(self, name, workbook, new_name)
入力パラメータ
name:コピーするシート名
workbook:コピー先のWorkbook名
new_name:新しいシート名
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook1 = excel.open('D:\\test1.xlsx', kind = 'office', visible = True)
workbook.copy_sheet_to_workbook('Sheet1', workbook1, 'Sheet2')
この例の実行ロジック: Excelファイル "D:\test.xlsx" "D:\test1.xlsx" を画面に表示して開きます --> ファイル "D:\test.xlsx" のSheet1シートをExcelファイル "D:\test1.xlsx" のSheet2シートにコピーします
get_selected_range()
現在のシートで選択されている範囲を取得します。
get_selected_range(self)
入力パラメータ
なし
戻り値
Tuple:タプル型の値(開始セルの行番号, 開始セルの列名, 終了セルの行番号, 終了セルの列名)を返します。
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.get_selected_range()
この例の実行ロジック: Excelファイル "D:\test.xlsx" を画面に表示して開きます --> 現在のシートで選択されている範囲を取得します
rename_sheet()
シート名を変更します。
rename_sheet(self, name, new_name)
入力パラメータ
name:変更するシート名
new_name:変更後のシート名
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.rename_sheet('Sheet1', '测试页面1')
この例の実行ロジック: Excelファイル "D:\test.xlsx" を画面に表示して開きます --> Sheet1シートの名称を '测试页面1' に変更します
refresh_data()
データを更新します。
refresh_data(self)
入力パラメータ
なし
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.refresh_data()
この例の実行ロジック: Excelファイル "D:\test.xlsx" を画面に表示して開きます --> ファイルのデータを更新します
create_pivot_table()
ピボットテーブルを作成します。
create_pivot_table(self, setting, source)
入力パラメータ
setting:ピボットテーブルの設定です。settingのJSON文字列は、Dr.RoboのExcel取得ツールを使用してExcelファイルからピボットテーブルのデータを取得した後に得られるものを使用してください。
source:ピボットテーブルのデータソース
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
pivot_setting = '{"sourceType":1,"sheetName":"Sheet6","tableRange":"A1:B7","name":"数据透视表8","properties":[{"name":"ColumnGrand","value":true},{"name":"RowGrand","value":true},{"name":"SubtotalHiddenPageItems","value":false},{"name":"InGridDropZones","value":false},{"name":"LayoutRowDefault","value":2},{"name":"DisplayFieldCaptions","value":true},{"name":"ShowDrillIndicators","value":true},{"name":"DisplayContextTooltips","value":true},{"name":"SortUsingCustomLists","value":true},r{"name":"DisplayImmediateItems","value":false},{"name":"FieldListSortAscending","value":false},{"name":"ShowValuesRow","value":false}],"fields":[{"name":"职称","index":"1","formula":null,"customName":"职称","subtotals":[true,false,false,false,false,false,false,false,false,false,false,false],"props":[{"name":"Orientation","value":3},{"name":"ShowAllItems","value":false},{"name":"EnableMultiplePageItems","value":false}]},{"name":"姓名","index":"1","formula":null,"customName":"姓名","subtotals":[true,false,false,false,false,false,false,false,false,false,false,false],"props":[{"name":"Orientation","value":1},{"name":"ShowAllItems","value":false},{"name":"EnableItemSelection","value":true}]},{"name":"工号","index":"1","formula":"","customName":"求和项:工号","subtotals":[true,false,false,false,false,false,false,false,false,false,false,false],"props":[{"name":"Orientation","value":4},{"name":"ShowAllItems","value":false},{"name":"Calculation","value":-4143},{"name":"Function","value":-4157},{"name":"NumberFormat","value":"General"}]}]}'
workbook.create_pivot_table(pivot_setting, 'Sheet1!$C$1:$E$4')
この例の実行ロジック: Excelファイル "D:\test.xlsx" 内にピボットテーブルを作成します。データソースは 'Sheet1!1:4' です
refresh_pivot_table()
ピボットテーブルを更新します。
refresh_pivot_table(self, name_or_index, sheet_name=None)
入力パラメータ
name_or_index:ピボットテーブル名または位置(1から数えます)
sheet_name:ピボットテーブルがあるシート名です。デフォルトは現在アクティブなシートです。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.refresh_pivot_table('1')
この例の実行ロジック: Excelファイル "D:\test.xlsx" 内のピボットテーブルを更新します
filter_pivot_table()
ピボットテーブルをフィルター処理します。
filter_pivot_table(self, sheet_name, name_or_index, field_name, select_type, filter_value_list)
入力パラメータ
sheet_name:ピボットテーブルがあるシート名です。デフォルトは現在アクティブなシートです。
name_or_index:ピボットテーブル名または位置(1から数えます)
field_name:ピボットテーブルのフィルターフィールド名
select_type:選択方法です。'all'、'none'、'partial' があります。
filter_value_list:ピボットテーブルのフィルターで選択する項目の内容
戻り値
なし
例1
Excelファイル "D:\test.xlsx" のSheet1シートでピボットテーブルを更新します。
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.filter_pivot_table('Sheet1', '1', '职务', 'partial', ['经理', '文员'])
この例の実行ロジック: Excelファイル "D:\test.xlsx" 内のピボットテーブルをフィルター処理し、「职务」が「经理」または「文员」の項目を抽出します
export_to_pdf()
PDFファイルをエクスポートします。
export_to_pdf(self, pdf_name, sheet_name=None, all_sheets=False, override=True)
入力パラメータ
pdf_name:ピボットテーブルがあるシート名です。デフォルトは現在アクティブなシートです。
sheet_name:エクスポートするシートです。デフォルトは現在アクティブなシート名です。
all_sheets:すべてのシートをエクスポートするかどうかを指定します。デフォルトはFalse(すべてはエクスポートしません)です。
override:エクスポート先のPDFファイルがすでに存在する場合に、上書きするかどうかを指定します。デフォルトはTrue(上書きします)です。
戻り値
なし
例1
from xbot import excel
def main(args):
workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
workbook.export_to_pdf('D:\\test.pdf', 'Sheet1')
この例の実行ロジック: Excelファイル "D:\test.xlsx" を画面に表示して開きます --> Sheet1シートを 'D:\test.pdf' にエクスポートします