Excel JavaScript API 1.12 の新機能
ExcelApi 1.12 では、動的配列を追跡するための API を追加し、数式の直接の優先順位を見つけることで、範囲内の数式のサポートが強化されました。 また、ピボットテーブル フィルターの API コントロールも追加されました。 コメント、カルチャ設定、カスタム プロパティの機能領域も改善されました。
機能領域 | 説明 | 関連オブジェクト |
---|---|---|
コメント イベント | コメント コレクションに追加、変更、削除のイベントを追加します。 | CommentCollection |
日付と時刻の カルチャ設定 | 日付と時刻の書式設定に関する追加のカルチャ設定にアクセスできます。 | CultureInfo、 NumberFormatInfoアプリケーション |
直接の優先順位 | セルの数式を評価するために使用される範囲を返します。 | Range |
ピボット フィルター | ピボットテーブルのフィールドに値駆動型フィルターを適用します。 | PivotField、 PivotFilters |
範囲スピル | アドインが動的配列の結果に関連付けられている範囲を検索できるようにします。 | Range |
ワークシート レベルのカスタム プロパティ | ブック レベルにスコープを設定するだけでなく、カスタム プロパティのスコープをワークシート レベルに設定できます。 | WorksheetCustomProperty、 WorksheetCustomPropertyCollection |
API リスト
次の表に、Excel JavaScript API 要件セット 1.12 の API を示します。 Excel JavaScript API 要件セット 1.12 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、「 要件セット 1.12 以前の Excel API」を参照してください。
クラス | フィールド | 説明 |
---|---|---|
ChartAxisTitle | textOrientation | グラフ軸タイトルのテキストの向きを指定します。 |
ChartSeries | getDimensionValues(dimension: Excel.ChartSeriesDimension) | グラフ系列の 1 つのディメンションから値を取得します。 |
コメント | contentType | コメントのコンテンツ タイプを取得します。 |
CommentAddedEventArgs | commentDetails | 関連する応答のコメント ID と ID を含む CommentDetail 配列を取得します。 |
source | イベントのソースを指定します。 | |
type | イベントの種類を取得します。 | |
worksheetId | イベントが発生したワークシートの ID を取得します。 | |
CommentChangedEventArgs | changeType | 変更されたイベントのトリガー方法を表す変更の種類を取得します。 |
commentDetails | 関連する応答のコメント ID と ID を含む CommentDetail 配列を取得します。 |
|
source | イベントのソースを指定します。 | |
type | イベントの種類を取得します。 | |
worksheetId | イベントが発生したワークシートの ID を取得します。 | |
CommentCollection | onAdded | コメントが追加されたときに発生します。 |
onChanged | コメント コレクション内のコメントまたは返信が変更されたときに発生します (応答が削除されたときなど)。 | |
onDeleted | コメント コレクションでコメントが削除されたときに発生します。 | |
CommentDeletedEventArgs | commentDetails | 関連する応答のコメント ID と ID を含む CommentDetail 配列を取得します。 |
source | イベントのソースを指定します。 | |
type | イベントの種類を取得します。 | |
worksheetId | イベントが発生したワークシートの ID を取得します。 | |
CommentDetail | commentId | コメントの ID を表します。 |
replyIds | コメントに属する関連する応答の ID を表します。 | |
CommentReply | contentType | 応答のコンテンツ タイプ。 |
CultureInfo | datetimeFormat | 日付と時刻を表示するカルチャに適した形式を定義します。 |
DatetimeFormatInfo | dateSeparator | 日付区切り記号として使用される文字列を取得します。 |
longDatePattern | 長い日付値の書式指定文字列を取得します。 | |
longTimePattern | 長い時間の値の書式指定文字列を取得します。 | |
shortDatePattern | 短い日付値の書式指定文字列を取得します。 | |
timeSeparator | 時刻区切り記号として使用される文字列を取得します。 | |
PivotDateFilter | コンパレータ | コンパレータは、他の値が比較される静的な値です。 |
condition | 必要なフィルター条件を定義するフィルターの条件を指定します。 | |
排他的 |
true 場合、フィルターは条件を満たす項目を除外します。 |
|
lowerBound |
between フィルター条件の範囲の下限。 |
|
upperBound |
between フィルター条件の範囲の上限。 |
|
wholeDays |
equals 、before 、after 、およびbetween フィルター条件では、比較を 1 日として行う必要があるかどうかを示します。 |
|
PivotField | applyFilter(filter: Excel.PivotFilters) | フィールドの現在の PivotFilter を 1 つ以上設定し、フィールドに適用します。 |
clearAllFilters() | すべてのフィールドのフィルターからすべての条件をクリアします。 | |
clearFilter(filterType: Excel.PivotFilterType) | 指定された型のフィールドのフィルターから既存のすべての条件をクリアします (現在適用されている場合)。 | |
getFilters() | フィールドに現在適用されているすべてのフィルターを取得します。 | |
isFiltered(filterType?: Excel.PivotFilterType) | フィールドに適用されたフィルターがあるかどうかを確認します。 | |
PivotFilters | dateFilter | PivotField の現在適用されている日付フィルター。 |
labelFilter | PivotField の現在適用されているラベル フィルター。 | |
manualFilter | PivotField の現在適用されている手動フィルター。 | |
valueFilter | PivotField の現在適用されている値フィルター。 | |
PivotLabelFilter | コンパレータ | コンパレータは、他の値が比較される静的な値です。 |
condition | 必要なフィルター条件を定義するフィルターの条件を指定します。 | |
排他的 |
true 場合、フィルターは条件を満たす項目を除外します。 |
|
lowerBound |
between フィルター条件の範囲の下限。 |
|
substring |
beginsWith 、endsWith 、およびcontains フィルター条件に使用される部分文字列。 |
|
upperBound |
between フィルター条件の範囲の上限。 |
|
PivotManualFilter | selectedItems | 手動でフィルター処理する選択した項目の一覧。 |
PivotTable | allowMultipleFiltersPerField | ピボットテーブルで、テーブル内の特定のピボットフィールドに対して複数のピボットフィルターを適用できるかどうかを指定します。 |
PivotTableScopedCollection | getCount() | コレクション内のピボットテーブルの数を取得します。 |
getFirst() | コレクション内の最初のピボットテーブルを取得します。 | |
getItem(key: string) | 名前に基づいてピボットテーブルを取得します。 | |
getItemOrNullObject(name: string) | 名前に基づいてピボットテーブルを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
PivotValueFilter | コンパレータ | コンパレータは、他の値が比較される静的な値です。 |
condition | 必要なフィルター条件を定義するフィルターの条件を指定します。 | |
排他的 |
true 場合、フィルターは条件を満たす項目を除外します。 |
|
lowerBound |
between フィルター条件の範囲の下限。 |
|
selectionType | フィルターが上位/下位 N 個の項目、上位/下位 N%、または上位/下位の N 個の合計を対象とするかどうかを指定します。 | |
閾 | 上位/下位のフィルター条件に対してフィルター処理される項目数、パーセント数、または合計の "N" しきい値。 | |
upperBound |
between フィルター条件の範囲の上限。 |
|
value | フィルター処理するフィールドで選択した "値" の名前。 | |
Range | getDirectPrecedents() | 同じワークシート内または複数のワークシートで、指定した範囲のすべての直接の優先順位セルを含む範囲を表す WorkbookRangeAreas オブジェクトを返します。 |
getPivotTables(fullyContained?: boolean) | 範囲と重複するピボットテーブルのスコープ付きコレクションを取得します。 | |
getSpillParent() | スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。 | |
getSpillParentOrNullObject() | セルがスピルされるアンカー セルを含む range オブジェクトを取得します。 | |
getSpillingToRange() | アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。 | |
getSpillingToRangeOrNullObject() | アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。 | |
hasSpill | すべてのセルにスピル ボーダーがあるかどうかを表します。 | |
numberFormatCategories | 各セルの数値形式のカテゴリを表します。 | |
savedAsArray | すべてのセルを配列数式として保存するかどうかを表します。 | |
RangeAreasCollection | getCount() | このコレクション内の RangeAreas オブジェクトの数を取得します。 |
getItemAt(index: number) | コレクション内の位置に基づいて RangeAreas オブジェクトを返します。 |
|
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
WorkbookRangeAreas | addresses | A1 スタイルのアドレスの配列を返します。 |
areas |
RangeAreasCollection オブジェクトを返します。 |
|
getRangeAreasBySheet(key: string) | コレクション内のワークシート ID または名前に基づいて、 RangeAreas オブジェクトを返します。 |
|
getRangeAreasOrNullObjectBySheet(key: string) | コレクション内のワークシート名または ID に基づいて、 RangeAreas オブジェクトを返します。 |
|
範囲 |
RangeCollection オブジェクトでこのオブジェクトを構成する範囲を返します。 |
|
ワークシート | customProperties | ワークシート レベルのカスタム プロパティのコレクションを取得します。 |
WorksheetCustomProperty | delete() | カスタム プロパティを削除します。 |
key | カスタム プロパティのキーを取得します。 | |
value | カスタム プロパティの値を取得または設定します。 | |
WorksheetCustomPropertyCollection | add(key: string, value: string) | 指定したキーにマップする新しいカスタム プロパティを追加します。 |
getCount() | このワークシートのカスタム プロパティの数を取得します。 | |
getItem(key: string) | キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。 | |
getItemOrNullObject(key: string) | キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins