Excel JavaScript API 1.8 の新機能

Excel JavaScript API 要件セット 1.8 の機能には、ピボットテーブル、データの入力規則、グラフ、グラフのイベント、パフォーマンス オプション、ブック作成に対応する API が含まれます。

ピボットテーブル

ピボットテーブル API の Wave 2 では、アドインでピボットテーブルの階層を設定できます。 データとデータの集計方法を制御できるようになりました。 新しいピボットテーブルの機能について詳しくは、ピボットテーブルの記事を参照してください。

データの入力規則

データの入力規則により、ユーザーがワークシートに入力する内容を制御できます。 定義済みの回答セットにセルを制限したり、望ましくない入力に関する警告をポップアップ表示したりできます。 詳細については、データの入力規則を範囲に追加する方法を参照してください。

グラフ

グラフ要素をより詳細にプログラムで制御できる、一連のグラフ API がさらに追加されました。 凡例、軸、近似曲線、プロット エリアがより使いやすくなっています。

イベント

グラフのイベントがさらに追加されました。 グラフを操作するユーザーに対し、アドインで対応できます。 ブック全体にわたり、起動するイベントの切り替えもできます。

API リスト

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

クラス フィールド 説明
グローバル createWorkbook(base64?: string) 新しいブックを作成し、開きます。
BasicDataValidation 数式 1 演算子プロパティが GreaterThan などの二項演算子に設定されている場合は、右オペランドを指定します (左側のオペランドは、ユーザーがセルに入力しようとする値です)。
数式 2 三項演算子 Between および NotBetween を使用して、上限オペランドを指定します。
operator データの検証に使用する演算子。
グラフ categoryLabelLevel ソース カテゴリ ラベルのレベルを参照する、グラフ カテゴリ ラベル レベルの列挙定数を指定します。
displayBlanksAs グラフ上に空白セルをプロットする方法を指定します。
onActivated グラフがアクティブ化されたときに発生します。
onDeactivated グラフが非アクティブ化されたときに発生します。
plotArea グラフのプロット エリアを表します。
plotBy 列や行がグラフのデータ系列として使用される方法を指定します。
plotVisibleOnly true の場合、可視セルだけがプロットされます。
seriesNameLevel ソース系列名のレベルを参照するグラフ系列名レベルの列挙定数を指定します。
showDataLabelsOverMaximum 値が数値軸の最大値より大きい場合に、データ ラベルを表示するかどうかを指定します。
style グラフのグラフ スタイルを指定します。
ChartActivatedEventArgs chartId アクティブ化されたグラフの ID を取得します。
type イベントの種類を取得します。
worksheetId グラフがアクティブになっているワークシートの ID を取得します。
ChartAddedEventArgs chartId ワークシートに追加されたグラフの ID を取得します。
source イベントのソースを取得します。
type イベントの種類を取得します。
worksheetId グラフが追加されるワークシートの ID を取得します。
ChartAxis 配置 指定した軸目盛ラベルの配置を指定します。
isBetweenCategories 数値軸がカテゴリ間でカテゴリ軸と交差するかどうかを指定します。
マルチレベル 軸がマルチレベルかどうかを指定します。
numberFormat 軸目盛ラベルの書式コードを指定します。
オフセット ラベルのレベル間の距離、および最初のレベルと軸線の間の距離を指定します。
position 他の軸と交差する指定した軸の位置を指定します。
positionAt 他の軸と交差する軸の位置を指定します。
setPositionAt(value: number) 他の軸と交差する位置の指定した軸位置を設定します。
textOrientation グラフ軸の目盛ラベルに対してテキストを向く角度を指定します。
ChartAxisFormat fill グラフの塗りつぶしの書式を指定します。
ChartAxisTitle setFormula(formula: string) A1 スタイルの表記法を使用するグラフの軸タイトルの数式を表す文字列値。
ChartAxisTitleFormat 罫線 グラフ軸タイトルの枠線形式を指定します。これには、色、線のスタイル、および太さが含まれます。
fill グラフ軸タイトルの塗りつぶしの書式設定を指定します。
ChartBorder clear() グラフ要素の罫線の書式設定をクリアします。
ChartCollection onActivated グラフがアクティブ化されたときに発生します。
onAdded ワークシートに新しいグラフが追加されたときに発生します。
onDeactivated グラフが非アクティブになっているときに発生します。
onDeleted グラフが削除されたときに発生します。
ChartDataLabel 定型句 データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。
format グラフのデータ ラベルの書式設定を表します。
formula A1 スタイルの表記法を使用するグラフのデータ ラベルの数式を表す文字列値。
height グラフのデータ ラベルの高さ (ポイント数) を返します。
horizontalAlignment グラフのデータ ラベルの水平方向の配置を表します。
left グラフのデータ ラベルの左端からグラフ エリアの左端までの距離 (ポイント数) を表します。
numberFormat データ ラベルのフォーマット コードを指定します。
text グラフのデータ ラベルのテキストを表す文字列。
textOrientation グラフのデータ ラベルに対してテキストが配置される角度を表します。
top グラフのデータ ラベルの上端からグラフ エリアの上端までの距離 (ポイント数) を表します。
verticalAlignment グラフのデータ ラベルの垂直方向の配置を表します。
width グラフのデータ ラベルの幅 (ポイント数) を返します。
ChartDataLabelFormat 罫線 グラフの罫線の書式設定 (色、線のスタイル、線の太さなど) を表します。
ChartDataLabels 定型句 データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。
horizontalAlignment グラフのデータ ラベルの水平方向の配置を指定します。
numberFormat データ ラベルの書式コードを指定します。
textOrientation テキストがデータ ラベルの向きになる角度を表します。
verticalAlignment グラフのデータ ラベルの垂直方向の配置を表します。
ChartDeactivatedEventArgs chartId 非アクティブ化されているグラフの ID を取得します。
type イベントの種類を取得します。
worksheetId グラフが非アクティブ化されているワークシートの ID を取得します。
ChartDeletedEventArgs chartId ワークシートから削除されたグラフの ID を取得します。
source イベントのソースを取得します。
type イベントの種類を取得します。
worksheetId グラフが削除されるワークシートの ID を取得します。
ChartLegendEntry height グラフ凡例の凡例エントリの高さを指定します。
index グラフの凡例の凡例エントリのインデックスを指定します。
left グラフの凡例エントリの左の値を指定します。
top グラフの凡例エントリの先頭を指定します。
width グラフの凡例の凡例エントリの幅を表します。
ChartLegendFormat 罫線 グラフの罫線の書式設定 (色、線のスタイル、線の太さなど) を表します。
ChartPlotArea format グラフのプロット エリアの書式設定を指定します。
height プロット エリアの高さの値を指定します。
insideHeight プロット エリアの内側の高さの値を指定します。
insideLeft プロット エリアの左内側の値を指定します。
insideTop プロット エリアの内側の上部の値を指定します。
insideWidth プロット エリアの内側の幅の値を指定します。
left プロット エリアの左の値を指定します。
position プロット エリアの位置を指定します。
top プロット エリアの一番上の値を指定します。
width プロット エリアの幅の値を指定します。
ChartPlotAreaFormat 罫線 グラフのプロット エリアの境界属性を指定します。
fill オブジェクトの塗りつぶし形式を指定します。これには、背景の書式設定情報が含まれます。
ChartSeries axisGroup 指定した系列のグループを指定します。
dataLabels 系列のすべてのデータ ラベルのコレクションを表します。
explosion 円グラフまたはドーナツ グラフ スライスの爆発値を指定します。
firstSliceAngle 最初の円グラフまたはドーナツ グラフ スライスの角度を度単位で指定します (垂直から時計回り)。
invertIfNegative アイテムが負の数に対応するときに、Excel が反転された場合は true。
重複 横棒と縦棒の配置方法を指定します。
secondPlotSize 円グラフまたは縦棒グラフのいずれかの第 2 セクションのサイズを、第 1 の円のサイズに対する割合で指定します。
splitType 円グラフまたは縦棒グラフの 2 つのセクションを分割する方法を指定します。
varyByCategories Excel が各データ マーカーに異なる色またはパターンを割り当てている場合は true。
ChartTrendline backwardPeriod 近似曲線を後方へ拡張するときの区間数を表します。
forwardPeriod 近似曲線を前方へ拡張するときの区間数を表します。
label グラフの近似曲線のラベルを表します。
showEquation true の場合、グラフに近似曲線の数式が表示されます。
showRSquared 近似曲線の r 2 乗値がグラフに表示されている場合は true。
ChartTrendlineLabel 定型句 近似曲線ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。
format グラフの近似曲線ラベルの形式。
formula A1 スタイルの表記を使用してグラフの近似曲線ラベルの数式を表す文字列値。
height グラフの近似曲線ラベルの高さ (ポイント数) を返します。
horizontalAlignment グラフの近似曲線ラベルの水平方向の配置を表します。
left グラフの近似曲線ラベルの左端からグラフ領域の左端までの距離をポイント単位で表します。
numberFormat 近似曲線ラベルの書式コードを表す文字列値。
text グラフの近似曲線ラベルのテキストを表す文字列。
textOrientation グラフの近似曲線ラベルに対するテキストの向きを表す角度を表します。
top グラフの近似曲線ラベルの上端からグラフ領域の上部までの距離をポイント単位で表します。
verticalAlignment グラフの近似曲線ラベルの垂直方向の配置を表します。
width グラフの近似曲線ラベルの幅 (ポイント数) を返します。
ChartTrendlineLabelFormat 罫線 色、線のスタイル、太さを含む罫線の書式を指定します。
fill 現在のグラフの近似曲線ラベルの塗りつぶし形式を指定します。
font グラフの近似曲線ラベルのフォント属性 (フォント名、フォント サイズ、色など) を指定します。
CustomDataValidation formula ユーザーの入力規則のカスタム数式。
DataPivotHierarchy field DataPivotHierarchy に関連付けられているピボット フィールドを返します。
id DataPivotHierarchy の ID。
name DataPivotHierarchy の名前。
numberFormat DataPivotHierarchy の数値形式。
position DataPivotHierarchy の位置。
setToDefault() DataPivotHierarchy を既定値にリセットします。
showAs データを特定の集計計算として表示するかどうかを指定します。
summarizeBy DataPivotHierarchy のすべての項目が表示されるかどうかを指定します。
DataPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) 現在の軸にピボット階層を追加します。
getCount() コレクションに含まれるピボット階層の数を取得します。
getItem(name: string) DataPivotHierarchy を名前または ID で取得します。
getItemOrNullObject(name: string) 名前に基づいて DataPivotHierarchy を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
remove(DataPivotHierarchy: Excel.DataPivotHierarchy) 現在の軸からピボット階層を削除します。
DataValidation clear() 現在の範囲からデータの入力規則をクリアします。
errorAlert 無効なデータが入力された場合のエラー警告。
ignoreBlanks データの入力規則を空白セルで実行するかどうかを指定します。
Prompt ユーザーがセルを選択するとプロンプトが表示されます。
ルール 異なる種類のデータ入力規則を含む入力規則。
type データ入力規則の種類については、「 Excel.DataValidationType 」を参照してください。
有効 すべてのセルの値がデータの入力規則に従っているかどうかを表します。
DataValidationErrorAlert message エラー アラート メッセージを表します。
showAlert ユーザーが無効なデータを入力したときにエラー メッセージ ダイアログを表示するかどうかを指定します。
style データ検証アラートの種類については、 Excel.DataValidationAlertStyle を参照してください。
title エラー アラート ダイアログのタイトルを表します。
DataValidationPrompt message プロンプトのメッセージを指定します。
showPrompt ユーザーがデータの入力規則を含むセルを選択するときにプロンプトを表示するかどうかを指定します。
title プロンプトのタイトルを指定します。
DataValidationRule カスタム データ検証条件のカスタム数式。
date 日付のデータ検証条件。
decimal 10 進数のデータ検証条件。
リスト リストのデータ検証条件。
textLength テキストの長さデータの入力規則。
time 時刻のデータ検証条件。
wholeNumber 整数データの入力規則。
DateTimeDataValidation 数式 1 演算子プロパティが GreaterThan などの二項演算子に設定されている場合は、右オペランドを指定します (左側のオペランドは、ユーザーがセルに入力しようとする値です)。
数式 2 三項演算子 Between および NotBetween を使用して、上限オペランドを指定します。
operator データの検証に使用する演算子。
FilterPivotHierarchy enableMultipleFilterItems 複数のフィルター項目を許可するかどうかを指定します。
fields FilterPivotHierarchy に関連付けられているピボット フィールドを返します。
id FilterPivotHierarchy の ID。
name FilterPivotHierarchy の名前。
position FilterPivotHierarchy の位置。
setToDefault() FilterPivotHierarchy を既定値にリセットします。
FilterPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) 現在の軸にピボット階層を追加します。
getCount() コレクションに含まれるピボット階層の数を取得します。
getItem(name: string) 名前または ID で FilterPivotHierarchy を取得します。
getItemOrNullObject(name: string) 名前に基づいて FilterPivotHierarchy を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy) 現在の軸からピボット階層を削除します。
ListDataValidation inCellDropDown リストをセルのドロップダウンに表示するかどうかを指定します。
source データの入力規則のリストのソース。
PivotField id ピボットフィールドの ID。
アイテム ピボットフィールドに関連付けられているピボット項目を返します。
name PivotField の名前。
showAllItems PivotField のすべての項目を表示するかどうかを指定します。
sortByLabels(sortBy: SortBy) PivotField を並べ替えます。
subtotals PivotField の小計。
PivotFieldCollection getCount() コレクション内のピボット フィールドの数を取得します。
getItem(name: string) 名前または ID で PivotField を取得します。
getItemOrNullObject(name: string) 名前で PivotField を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
PivotHierarchy fields PivotHierarchy に関連付けられているピボット フィールドを返します。
id PivotHierarchy の ID。
name PivotHierarchy の名前。
PivotHierarchyCollection getCount() コレクションに含まれるピボット階層の数を取得します。
getItem(name: string) 名前または ID で PivotHierarchy を取得します。
getItemOrNullObject(name: string) 名前に基づいて PivotHierarchy を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
PivotItem id ピボット項目の ID。
isExpanded 項目を展開して子項目を表示するか、または項目を折りたたんで子項目を非表示にするかを指定します。
name PivotItem の名前。
visible ピボット項目を表示するかどうかを指定します。
PivotItemCollection getCount() コレクション内のピボット項目の数を取得します。
getItem(name: string) 名前または ID で PivotItem を取得します。
getItemOrNullObject(name: string) 名前で PivotItem を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
PivotLayout getColumnLabelRange() ピボットテーブルの列ラベルが存在する範囲を返します。
getDataBodyRange() ピボットテーブルのデータ値が存在する範囲を返します。
getFilterAxisRange() ピボットテーブルのフィルター エリアの範囲を返します。
getRange() フィルター エリアを除く、ピボットテーブルが存在する範囲を返します。
getRowLabelRange() ピボットテーブルの行ラベルが存在する範囲を返します。
layoutType このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。
showColumnGrandTotals ピボットテーブル レポートに列の総計を表示するかどうかを指定します。
showRowGrandTotals ピボットテーブル レポートに行の総計を表示するかどうかを指定します。
subtotalLocation このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。
PivotTable columnHierarchies ピボットテーブルの列ピボット階層。
dataHierarchies ピボットテーブルのデータ ピボット階層。
delete() ピボットテーブルを削除します。
filterHierarchies ピボットテーブルのフィルター ピボット階層。
階層 ピボットテーブルのピボット階層。
レイアウト ピボットテーブルのレイアウトとビジュアル構造を記述する PivotLayout。
rowHierarchies ピボットテーブルの行ピボット階層。
PivotTableCollection add(name: string, source: Range | string |テーブル, 目的地: 範囲 |文字列) 指定したソース データに基づいてピボットテーブルを追加し、インポート先範囲の左上のセルに挿入します。
Range dataValidation dataValidation オブジェクトを返します。
RowColumnPivotHierarchy fields RowColumnPivotHierarchy に関連付けられているピボット フィールドを返します。
id RowColumnPivotHierarchy の ID。
name RowColumnPivotHierarchy の名前。
position RowColumnPivotHierarchy の位置。
setToDefault() RowColumnPivotHierarchy を既定値にリセットします。
RowColumnPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) 現在の軸にピボット階層を追加します。
getCount() コレクションに含まれるピボット階層の数を取得します。
getItem(name: string) 名前または ID で RowColumnPivotHierarchy を取得します。
getItemOrNullObject(name: string) 名前に基づいて RowColumnPivotHierarchy を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy) 現在の軸からピボット階層を削除します。
ランタイム enableEvents 現在の作業ウィンドウまたはコンテンツ アドインで JavaScript イベントを切り替えます。
ShowAsRule baseField ShowAsの計算の基礎となるピボットフィールド (ShowAsCalculationの種類に応じて該当する場合は)、それ以外の場合はnull。
baseItem ShowAsの計算の基礎となる項目 (ShowAsCalculationの種類に応じて該当する場合は)、それ以外の場合はnull。
計算 ピボットフィールドに使用する ShowAs の計算。
スタイル autoIndent セル内のテキストの配置が等分散に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。
textOrientation スタイルで適用されるテキストの向き。
Subtotals automatic Automatic が true に設定されている場合、Subtotalsを設定するときに他のすべての値は無視されます。
average
count
countNumbers
max
min
product
standardDeviation
standardDeviationP
合計
variance
varianceP
表 legacyId 数値 ID を返します。
TableChangedEventArgs getRange(ctx: Excel.RequestContext) 特定のワークシートの表の変更された領域を表す範囲を取得します。
getRangeOrNullObject(ctx: Excel.RequestContext) 特定のワークシートの表の変更された領域を表す範囲を取得します。
ブック readOnly ブックが読み取り専用モードで開かれている場合は true を返します。
WorkbookCreated WorkbookCreated オブジェクトは、Application.CreateWorkbook によって作成される最上位レベルのオブジェクトです。
ワークシート onCalculated ワークシートの計算時に発生します。
showGridlines グリッド線をユーザーに表示するかどうかを指定します。
showHeadings 見出しをユーザーに表示するかどうかを指定します。
WorksheetCalculatedEventArgs type イベントの種類を取得します。
worksheetId 計算が発生したワークシートの ID を取得します。
WorksheetChangedEventArgs getRange(ctx: Excel.RequestContext) 特定のワークシートで変更されたエリアを表す範囲を取得します。
getRangeOrNullObject(ctx: Excel.RequestContext) 特定のワークシートで変更されたエリアを表す範囲を取得します。
WorksheetCollection onCalculated ブック内の任意のワークシートが計算されるときに発生します。

関連項目

  • 最終更新: