Excel JavaScript API 要件セット 1.1

  • [アーティクル]

Excel JavaScript API 1.1 は、API の最初のバージョンです。 これは、Excel 2016でサポートされている唯一の Excel 固有の要件セットです。

API リスト

次の表に、Excel JavaScript API 要件セット 1.1 の API を示します。 Excel JavaScript API 要件セット 1.1 でサポートされているすべての API の API リファレンス ドキュメントを表示するには、「 要件セット 1.1 の Excel API」を参照してください。

クラス フィールド 説明
Application calculate(calculationType: Excel.CalculationType) Excel で現在開いているすべてのブックを再計算します。
calculationMode の定数で定義されているブックで使用される計算モードを返します Excel.CalculationMode。
Binding getRange() バインディングによって表される範囲を返します。
getTable() バインドによって表されるテーブルを返します。
getText() バインドによって表されるテキストを返します。
id バインド識別子を表します。
type バインドの型を返します。
BindingCollection count コレクション内にあるバインドの数を取得します。
getItem(id: string) ID によってバインド オブジェクトを取得します。
getItemAt(index: number) 項目の配列内の位置に基づいて、バインド オブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
グラフ 軸 グラフの軸を表します。
dataLabels グラフのデータ ラベルを表します。
delete() グラフ オブジェクトを削除します。
format グラフ領域の書式設定プロパティをカプセル化します。
height グラフ オブジェクトの高さをポイント単位で指定します。
left グラフの左側からワークシートの原点までの距離 (ポイント単位)。
伝説 グラフの凡例を表します。
name グラフ オブジェクトの名前を指定します。
series グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy) グラフの元データをリセットします。
setPosition(startCell: Range | string, endCell?: Range | string) ワークシート上のセルを基準にしてグラフを配置します。
title 指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。
top オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。
width グラフ オブジェクトの幅をポイント単位で指定します。
ChartAreaFormat fill 背景の書式設定情報を含む、オブジェクトの塗りつぶしの書式を表します。
font 現在のオブジェクトのフォント属性 (フォント名、フォント サイズ、色など) を表します。
ChartAxes categoryAxis グラフの項目軸を表します。
seriesAxis 3-D グラフの系列軸を表します。
valueAxis 軸の数値軸を表します。
ChartAxis format 線とフォントの書式設定を含むグラフ オブジェクトの書式設定を表します。
majorGridlines 指定した軸の目盛線を表す オブジェクトを返します。
majorUnit 2 つの大きい目盛の間隔を表します。
maximum 数値軸の最大値を表します。
minimum 数値軸の最小値を表します。
minorGridlines 指定した軸の補助目盛線を表す オブジェクトを返します。
minorUnit 2 つの小さい目盛の間隔を表します。
title 軸タイトルを表します。
ChartAxisFormat font グラフ軸要素のフォント属性 (フォント名、フォント サイズ、色など) を指定します。
line グラフの折れ線の書式設定を指定します。
ChartAxisTitle format グラフ軸のタイトルの書式設定を指定します。
text 軸のタイトルを指定します。
visible 軸のタイトルが表示されるかどうかを指定します。
ChartAxisTitleFormat font グラフ軸タイトル オブジェクトのフォント名、フォント サイズ、色など、グラフ軸タイトルのフォント属性を指定します。
ChartCollection add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy) 新しいグラフを作成します。
count ワークシート上のグラフの数を返します。
getItem(name: string) グラフ名を使用してグラフを取得します。
getItemAt(index: number) コレクション内での位置を基にグラフを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ChartDataLabelFormat fill 現在のグラフのデータ ラベルの塗りつぶしの書式を表します。
font グラフ データ ラベルのフォント属性 (フォント名、フォント サイズ、色など) を表します。
ChartDataLabels format 塗りつぶしとフォントの書式設定を含むグラフ データ ラベルの形式を指定します。
position データ ラベルの位置を表す値。
区切り 記号 グラフのデータ ラベルに使用される区切り文字を表す文字列を設定します。
showBubbleSize データ ラベルのバブル サイズを表示するかどうかを指定します。
showCategoryName データ ラベル カテゴリ名を表示するかどうかを指定します。
showLegendKey データ ラベルの凡例キーを表示するかどうかを指定します。
showPercentage データ ラベルの割合を表示するかどうかを指定します。
showSeriesName データ ラベル系列名を表示するかどうかを指定します。
showValue データ ラベルの値を表示するかどうかを指定します。
ChartFill clear() グラフ要素の塗りつぶしの色をクリアします。
setSolidColor(color: string) グラフ要素の塗りつぶしの書式設定を均一な色に設定します。
ChartFont bold フォントの太字の状態を表します。
color テキストの色の HTML カラー コード表現 (たとえば、#FF0000 は赤を表します)。
italic フォントの斜体の状態を表します。
name フォント名 ("Calibri" など)
size フォントのサイズ (例: 11)
underline フォントに適用する下線の種類。
ChartGridlines format グラフの目盛線の書式設定を表します。
visible 軸の目盛線を表示するかどうかを指定します。
ChartGridlinesFormat line グラフの線の書式設定を表します。
ChartLegend format 塗りつぶしとフォントの書式設定を含むグラフの凡例の書式設定を表します。
overlay グラフの凡例がグラフのメイン本文と重複するかどうかを指定します。
position グラフ上の凡例の位置を指定します。
visible グラフの凡例を表示するかどうかを指定します。
ChartLegendFormat fill 背景の書式設定情報を含む、オブジェクトの塗りつぶしの書式を表します。
font グラフの凡例のフォント名、フォント サイズ、色などのフォント属性を表します。
ChartLineFormat clear() グラフ要素の折れ線の書式をクリアします。
color グラフの線の色を表す HTML カラー コード。
ChartPoint format グラフのポイントの書式設定プロパティをカプセル化します。
value グラフのポイントの値を返します。
ChartPointFormat fill 背景の書式設定情報を含むグラフの塗りつぶしの形式を表します。
ChartPointsCollection count 系列に含まれるグラフのポイントの数を返します。
getItemAt(index: number) データ系列内の位置に基づくポイントを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ChartSeries format 塗りつぶしと線の書式設定を含むグラフ系列の書式設定を表します。
name グラフ内の系列の名前を指定します。
ポイント 系列内のすべてのポイントのコレクションを返します。
ChartSeriesCollection count コレクションに含まれるデータ系列の数を返します。
getItemAt(index: number) コレクション内の位置に基づいてデータ系列を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ChartSeriesFormat fill 背景の書式設定情報を含むグラフ系列の塗りつぶし形式を表します。
line 線の書式設定を表します。
ChartTitle format 塗りつぶしとフォントの書式設定を含むグラフ タイトルの書式設定を表します。
overlay グラフタイトルがグラフをオーバーレイするかどうかを指定します。
text グラフのタイトル テキストを指定します。
visible グラフのタイトルを表示するかどうかを指定します。
ChartTitleFormat fill 背景の書式設定情報を含む、オブジェクトの塗りつぶしの書式を表します。
font オブジェクトのフォント属性 (フォント名、フォント サイズ、色など) を表します。
NamedItem getRange() 名前に関連付けられている範囲オブジェクトを返します。
name オブジェクトの名前。
type 名前の数式によって返される値の型を指定します。
value 名前の数式で計算された値を表します。
visible オブジェクトが表示されるかどうかを指定します。
NamedItemCollection getItem(name: string) 名前を NamedItem 使用してオブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
Range address 範囲参照を A1 スタイルで指定します。
addressLocal ユーザーの言語で指定した範囲の範囲参照を表します。
cellCount 範囲内のセルの数を指定します。
clear(applyTo?: Excel.ClearApplyTo) 範囲の値、書式、塗りつぶし、罫線などをクリアします。
columnCount 範囲内の列の合計数を指定します。
columnIndex 範囲内の最初のセルの列番号を指定します。
delete(shift: Excel.DeleteShiftDirection) 範囲に関連付けられているセルを削除します。
format Format オブジェクト (範囲のフォント、塗りつぶし、罫線、配置などのプロパティをカプセル化するオブジェクト) を返します。
formulas A1 スタイル表記の数式を表します。
formulasLocal ユーザーの言語と数値書式ロケールで、A1 スタイル表記の数式を表します。
getBoundingRect(anotherRange: Range | string) 指定した範囲を包含する、最小の Range オブジェクトを取得します。
getCell(row: number, column: number) 行と列の番号に基づいて、1 つのセルを含んだ範囲オブジェクトを取得します。
getColumn(column: number) 範囲に含まれる列を 1 つ取得します。
getEntireColumn() 範囲の列全体を表すオブジェクトを取得します (たとえば、現在の範囲がセル "B4:E11" を表す場合、その getEntireColumn 範囲は列 "B:E" を表す範囲です)。
getEntireRow() 範囲の行全体を表すオブジェクトを取得します (たとえば、現在の範囲がセル "B4:E11" を表す場合、その GetEntireRow 範囲は行 "4:11" を表す範囲です)。
getIntersection(anotherRange: Range | string) 指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。
getLastCell() 範囲内の最後のセルを取得します。
getLastColumn() 範囲内の最後の列を取得します。
getLastRow() 範囲内の最後の行を取得します。
getOffsetRange(rowOffset: number, columnOffset: number) 指定した範囲からのオフセットで範囲を表すオブジェクトを取得します。
getRow(row: number) 範囲に含まれている行を 1 つ取得します。
insert(shift: Excel.InsertShiftDirection) この範囲を占めるセルまたはセルの範囲をワークシートに挿入し、領域を空けるために他のセルをシフトします。
numberFormat 指定した範囲の Excel の数値書式コードを表します。
行数 範囲に含まれる行の合計数を返します。
rowIndex 範囲に含まれる最初のセルの行番号を返します。
select() Excel UI で指定した範囲を選択します。
text 指定した範囲のテキスト値。
valueTypes 各セル内のデータの種類を指定します。
values 指定した範囲の Raw 値を表します。
worksheet 現在の範囲を含んでいるワークシート。
RangeBorder color 境界線の色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML の色 (例: "オレンジ") として表されます。
sideIndex 罫線の特定の辺を表す定数値。
style 罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。
weight 範囲周辺の罫線の太さを指定します。
RangeBorderCollection count コレクションに含まれる境界線オブジェクトの数。
getItem(index: Excel.BorderIndex) オブジェクトの名前を使用して、境界線オブジェクトを取得します。
getItemAt(index: number) オブジェクトのインデックスを使用して、境界線オブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
RangeFill clear() 範囲の背景をリセットします。
color 背景の色を表す HTML カラー コード(例: "FFA500")、または名前付き HTML カラー (例: "オレンジ") の形式で #RRGGBB
RangeFont bold フォントの太字の状態を表します。
color テキストの色の HTML カラー コード表現 (たとえば、#FF0000 は赤を表します)。
italic フォントの斜体の状態を指定します。
name フォント名 ("Calibri" など)。
size フォント サイズ。
underline フォントに適用する下線の種類。
範囲の形式 borders 選択した範囲全体に適用する境界線オブジェクトのコレクション。
fill 範囲全体に定義された塗りつぶしオブジェクトを返します。
font 範囲全体に定義されたフォント オブジェクトを返します。
horizontalAlignment 指定したオブジェクトの水平方向の配置を表します。
verticalAlignment 指定したオブジェクトの垂直方向の配置を表します。
wrapText Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
表 列 テーブルに含まれるすべての列のコレクションを表します。
delete() テーブルを削除します。
getDataBodyRange() テーブルのデータ本体に関連付けられた範囲オブジェクトを取得します。
getHeaderRowRange() 表のヘッダー行に関連付けられた範囲オブジェクトを取得します。
getRange() テーブル全体に関連付けられた範囲オブジェクトを取得します。
getTotalRowRange() 表の集計行に関連付けられた範囲オブジェクトを取得します。
id 指定されたブックのテーブルを一意に識別する値を返します。
name テーブルの名前。
rows テーブルに含まれるすべての行のコレクションを表します。
showHeaders ヘッダー行を表示するかどうかを指定します。
showTotals 合計行を表示するかどうかを指定します。
style テーブル スタイルを表す定数値。
TableCollection add(address: Range | string, hasHeaders: boolean) 新しいテーブルを作成します。
count ブックに含まれるテーブルの数を返します。
getItem(key: string) 名前または ID でテーブルを取得します。
getItemAt(index: number) コレクション内の位置に基づいてテーブルを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
TableColumn delete() テーブルから列を削除します。
getDataBodyRange() 列のデータ本体に関連付けられた範囲オブジェクトを取得します。
getHeaderRowRange() 列のヘッダー行に関連付けられた範囲オブジェクトを取得します。
getRange() 列全体に関連付けられた範囲オブジェクトを取得します。
getTotalRowRange() 列の集計行に関連付けられた範囲オブジェクトを取得します。
id テーブル内の列を識別する一意のキーを返します。
index テーブルの列コレクション内の列のインデックス番号を返します。
name テーブル列の名前を指定します。
values 指定した範囲の Raw 値を表します。
TableColumnCollection add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string) テーブルに新しい列を追加します。
count テーブルの列数を返します。
getItem(key: number | string) 名前または ID によって、列オブジェクトを取得します。
getItemAt(index: number) コレクション内の位置に基づいて列を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
TableRow delete() テーブルから行を削除します。
getRange() 行全体に関連付けられた範囲オブジェクトを返します。
index テーブルの行コレクション内の行のインデックス番号を返します。
values 指定した範囲の Raw 値を表します。
TableRowCollection add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean) テーブルに 1 つ以上の行を追加します。
count テーブルの行数を返します。
getItemAt(index: number) コレクション内の位置を基に行を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ブック application このブックを含む Excel アプリケーション インスタンスを表します。
bindings ブックの一部であるバインドのコレクションを表します。
getSelectedRange() ブックから現在選択されている 1 つの範囲を取得します。
名 ブックスコープの名前付き項目 (名前付き範囲と定数) のコレクションを表します。
テーブル ブックに関連付けられているテーブルのコレクションを表します。
ワークシート ブックに関連付けられているワークシートのコレクションを表します。
ワークシート activate() Excel UI でワークシートをアクティブにします。
グラフ ワークシートの一部であるグラフのコレクションを返します。
delete() ブックからワークシートを削除します。
getCell(row: number, column: number) Range行番号と列番号に基づいて、1 つのセルを含むオブジェクトを取得します。
getRange(address?: string) Rangeアドレスまたは名前で指定された単一の四角形のセル ブロックを表す オブジェクトを取得します。
id 指定されたブックのワークシートを一意に識別する値を返します。
name ワークシートの表示名。
position 0 を起点とした、ブック内のワークシートの位置。
テーブル ワークシートの一部になっているグラフのコレクション。
可視 性 ワークシートの可視性。
WorksheetCollection add(name?: string) 新しいワークシートをブックに追加します。
getActiveWorksheet() ブックの、現在作業中のワークシートを取得します。
getItem(key: string) 名前または ID を使用して、ワークシート オブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。

関連項目