pyosbxl.ListObjects

class documentation

class ListObjects:

ワークシートのテーブル一覧を表すクラスです。テーブルクラスの追加、削除、取得、テーブル範囲変更が可能です。

Method	`addList`	ワークシートにテーブルを追加します。
Method	`addListFromRange`	ワークシートのテーブル作成をデータコピーと共に行います。
Method	`getList`	テーブルクラスを取得します。
Method	`removeList`	ワークシートからのテーブルの削除を行います。

def addList(self, tableName: str, A1C1: str, useFirstRowAsHeader: bool, insertTotals: bool) -> Table: ¶

ワークシートにテーブルを追加します。

useFirstRowAsHeaderがtrueの時、1行目をテーブルのヘッダとして使います。falseの時は、テーブルヘッダを自動生成します。

insertTotalsがtrueの時、末尾に、集計行を自動生成し、追加します。falseの時は、末尾に追加しません。

Parameters
tableName:`str`	テーブル名
A1C1:`str`	追加テーブルのセル範囲(現在のワークシート)
useFirstRowAsHeader:`bool`	true:1行目をテーブルヘッダとする false: 1行目をテーブルヘッダとしない(テーブルヘッダを自動生成しない)
insertTotals:`bool`	true:末尾に集計行を追加する false:末尾に集計行を追加する
Returns
`Table`	追加したテーブルのテーブルクラス

def addListFromRange(self, tableName: str, topA1: str, copyFromA1C1: str, useFirstRowAsHeader: bool, insertTotals: bool) -> Table: ¶

ワークシートのテーブル作成をデータコピーと共に行います。

useFirstRowAsHeaderがtrueの時、1行目をテーブルのヘッダとして使います。falseの時は、テーブルヘッダを自動生成します。（A1C1にテーブル名を設定した場合、常にtrueの扱いとなります)

insertTotalsがtrueの時、末尾に、合計行を自動生成し、追加します。falseの時は、末尾に追加しません。

Parameters
tableName:`str`	テーブル名
topA1:`str`	作成するテーブルの左上のセル(単一セル)
copyFromA1C1:`str`	作成テーブルにコピーするデータのセル範囲またはテーブル名(他シートからも可能です。他シートの場合、Sheet2!A1:C1のようなシート名を付加した表記となります)
useFirstRowAsHeader:`bool`	true:1行目をテーブルヘッダとする false: 1行目をテーブルヘッダとしない(テーブルヘッダを自動生成しない)
insertTotals:`bool`	true:末尾に集計行を追加する false: false:末尾に集計行を追加する
Returns
`Table`	追加したテーブルのテーブルクラス

def getList(self, tableName: str) -> Table: ¶

テーブルクラスを取得します。

def removeList(self, tableName: str, deleteData: bool = True): ¶

ワークシートからのテーブルの削除を行います。