Excel.Interfaces.WorksheetData interface

を呼び出 worksheet.toJSON()して返されるデータを記述するインターフェイス。

プロパティ

autoFilter

ワークシートの AutoFilter オブジェクトを表します。

charts

ワークシートの一部であるグラフのコレクションを返します。

comments

ワークシート上のすべての Comments オブジェクトの集まりを返します。

customProperties

ワークシート レベルのカスタム プロパティのコレクションを取得します。

enableCalculation

Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。

horizontalPageBreaks

ワークシートの水平改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

id

指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。

name

ワークシートの表示名。

names

現在のワークシートにスコープされている名前のコレクション。

pageLayout

ワークシートの PageLayout オブジェクトを取得します。

pivotTables

ワークシートの一部になっているピボットテーブルのコレクション。

position

0 を起点とした、ブック内のワークシートの位置。

protection

ワークシートのシート保護オブジェクトを返します。

shapes

ワークシート上のすべての Shape オブジェクトをまとめて返します。

showGridlines

グリッド線をユーザーに表示するかどうかを指定します。

showHeadings

見出しをユーザーに表示するかどうかを指定します。

slicers

ワークシートの一部であるスライサーのコレクションを返します。

standardHeight

ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。

standardWidth

ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。

tabColor

ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は になります null。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは#RRGGBB形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "auto" カラーを設定するか、それ以外の場合は実際の色を設定します。

tabId

Open Office XML で読み取ることができるこのワークシートを表す値を返します。 これは整数値で、(グローバルに一意の識別子を返す) と worksheet.name ("Sheet1" などの値を返す) とは異なりますworksheet.id

tables

ワークシートの一部になっているグラフのコレクション。

verticalPageBreaks

ワークシートの垂直改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

visibility

ワークシートの可視性。

プロパティの詳細

autoFilter

ワークシートの AutoFilter オブジェクトを表します。

autoFilter?: Excel.Interfaces.AutoFilterData;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

charts

ワークシートの一部であるグラフのコレクションを返します。

charts?: Excel.Interfaces.ChartData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

comments

ワークシート上のすべての Comments オブジェクトの集まりを返します。

comments?: Excel.Interfaces.CommentData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

customProperties

ワークシート レベルのカスタム プロパティのコレクションを取得します。

customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.12 ]

enableCalculation

Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。

enableCalculation?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

horizontalPageBreaks

ワークシートの水平改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

id

指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。

id?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

name

ワークシートの表示名。

name?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

names

現在のワークシートにスコープされている名前のコレクション。

names?: Excel.Interfaces.NamedItemData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.4 ]

pageLayout

ワークシートの PageLayout オブジェクトを取得します。

pageLayout?: Excel.Interfaces.PageLayoutData;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

pivotTables

ワークシートの一部になっているピボットテーブルのコレクション。

pivotTables?: Excel.Interfaces.PivotTableData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.3 ]

position

0 を起点とした、ブック内のワークシートの位置。

position?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.1 ]

protection

ワークシートのシート保護オブジェクトを返します。

protection?: Excel.Interfaces.WorksheetProtectionData;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

shapes

ワークシート上のすべての Shape オブジェクトをまとめて返します。

shapes?: Excel.Interfaces.ShapeData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

showGridlines

グリッド線をユーザーに表示するかどうかを指定します。

showGridlines?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

showHeadings

見出しをユーザーに表示するかどうかを指定します。

showHeadings?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

slicers

ワークシートの一部であるスライサーのコレクションを返します。

slicers?: Excel.Interfaces.SlicerData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

standardHeight

ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。

standardHeight?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

standardWidth

ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。

standardWidth?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

tabColor

ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は になります null。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは#RRGGBB形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "auto" カラーを設定するか、それ以外の場合は実際の色を設定します。

tabColor?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

tabId

Open Office XML で読み取ることができるこのワークシートを表す値を返します。 これは整数値で、(グローバルに一意の識別子を返す) と worksheet.name ("Sheet1" などの値を返す) とは異なりますworksheet.id

tabId?: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.14 ]

tables

ワークシートの一部になっているグラフのコレクション。

tables?: Excel.Interfaces.TableData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

verticalPageBreaks

ワークシートの垂直改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

visibility

ワークシートの可視性。

visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

プロパティ値

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

注釈

[ API セット: 読み取り可視性用の ExcelApi 1.1、設定用の 1.2。 ]