Excel JavaScript API 1.9 の新機能
1.9 の要件セットにより、500 件を超える新しい Excel API が 導入されました。 最初の表には API が簡潔にまとめられています。その後の表は詳しい一覧になっています。
機能領域 | 説明 | 関連オブジェクト |
---|---|---|
Shapes | 画像、幾何学な図形、テキスト ボックスを挿入、位置変更、書式設定します。 | ShapeCollectionShapeGeometrShapeイメージ |
オート フィルター | 範囲にフィルターを追加します。 | AutoFilter |
エリア | 連続していない範囲をサポートします。 | RangeAreas |
特別なセル | ある範囲内に日付、コメント、数式を含むセルを取得します。 | Range |
検索 | ある範囲またはワークシート内で値や数式を見つけます。 | RangeWorksheet |
コピーと貼り付け | 範囲間で値、書式、数式をコピーします。 | Range |
計算 | Excel 計算エンジンを細かく操作できます。 | アプリケーション |
新しいグラフ | 新しくサポートされたグラフである、マップ、箱ひげ図、ウォーターフォール、サンバースト、パレート、 じょうごをお試しください。 | Chart |
範囲の形式 | 範囲の形式の新しい機能です。 | Range |
API リスト
次の表に、Excel JavaScript API 要件セット 1.9 の API を示します。 Excel JavaScript API 要件セット 1.9 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、 要件セット 1.9 以前の Excel API に関するページを参照してください。
クラス | フィールド | 説明 |
---|---|---|
Application | calculationEngineVersion | 最後の完全な再計算に使用した Excel 計算エンジンのバージョンを返します。 |
calculationState | アプリケーションの計算の状態を返します。 | |
iterativeCalculation | 反復計算設定を返します。 | |
suspendScreenUpdatingUntilNextSync() | 次の context.sync() が呼び出されるまで、画面の更新を中断します。 |
|
AutoFilter | apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria) | 範囲にオートフィルターを適用します。 |
clearCriteria() | オートフィルターのフィルター条件と並べ替えの状態をクリアします。 | |
criteria | オートフィルターが適用された範囲のすべてのフィルター条件を保持する配列です。 | |
enabled | オートフィルターが有効かどうかを指定します。 | |
getRange() | オートフィルターが適用される範囲を表す Range オブジェクトを返します。 |
|
getRangeOrNullObject() | オートフィルターが適用される範囲を表す Range オブジェクトを返します。 |
|
isDataFiltered | オートフィルターにフィルター条件があるかどうかを指定します。 | |
reapply() | 範囲に現在指定されている AutoFilter オブジェクトを適用します。 | |
remove() | 範囲の AutoFilter を削除します。 | |
CellBorder | color | 1 つの境界線の color プロパティを表します。 |
style | 1 つの境界線の style プロパティを表します。 |
|
tintAndShade | 1 つの境界線の tintAndShade プロパティを表します。 |
|
weight | 1 つの境界線の weight プロパティを表します。 |
|
CellBorderCollection | bottom |
format.borders.bottom プロパティを表します。 |
diagonalDown |
format.borders.diagonalDown プロパティを表します。 |
|
diagonalUp |
format.borders.diagonalUp プロパティを表します。 |
|
horizontal |
format.borders.horizontal プロパティを表します。 |
|
left |
format.borders.left プロパティを表します。 |
|
right |
format.borders.right プロパティを表します。 |
|
top |
format.borders.top プロパティを表します。 |
|
vertical |
format.borders.vertical プロパティを表します。 |
|
CellProperties | address |
address プロパティを表します。 |
addressLocal |
addressLocal プロパティを表します。 |
|
hidden |
hidden プロパティを表します。 |
|
CellPropertiesFill | color |
format.fill.color プロパティを表します。 |
pattern |
format.fill.pattern プロパティを表します。 |
|
patternColor |
format.fill.patternColor プロパティを表します。 |
|
patternTintAndShade |
format.fill.patternTintAndShade プロパティを表します。 |
|
tintAndShade |
format.fill.tintAndShade プロパティを表します。 |
|
CellPropertiesFont | bold |
format.font.bold プロパティを表します。 |
color |
format.font.color プロパティを表します。 |
|
italic |
format.font.italic プロパティを表します。 |
|
name |
format.font.name プロパティを表します。 |
|
size |
format.font.size プロパティを表します。 |
|
strikethrough |
format.font.strikethrough プロパティを表します。 |
|
subscript |
format.font.subscript プロパティを表します。 |
|
superscript |
format.font.superscript プロパティを表します。 |
|
tintAndShade |
format.font.tintAndShade プロパティを表します。 |
|
underline |
format.font.underline プロパティを表します。 |
|
CellPropertiesFormat | autoIndent |
autoIndent プロパティを表します。 |
borders |
borders プロパティを表します。 |
|
fill |
fill プロパティを表します。 |
|
font |
font プロパティを表します。 |
|
horizontalAlignment |
horizontalAlignment プロパティを表します。 |
|
indentLevel |
indentLevel プロパティを表します。 |
|
protection |
protection プロパティを表します。 |
|
readingOrder |
readingOrder プロパティを表します。 |
|
shrinkToFit |
shrinkToFit プロパティを表します。 |
|
textOrientation |
textOrientation プロパティを表します。 |
|
useStandardHeight |
useStandardHeight プロパティを表します。 |
|
useStandardWidth |
useStandardWidth プロパティを表します。 |
|
verticalAlignment |
verticalAlignment プロパティを表します。 |
|
wrapText |
wrapText プロパティを表します。 |
|
CellPropertiesProtection | formulaHidden |
format.protection.formulaHidden プロパティを表します。 |
locked |
format.protection.locked プロパティを表します。 |
|
ChangedEventDetail | valueAfter | 変更後の値を表します。 |
valueBefore | 変更前の値を表します。 | |
valueTypeAfter | 変更後の値の種類を表します。 | |
valueTypeBefore | 変更前の値の種類を表します。 | |
Chart | activate() | Excel UI でグラフをアクティブにします。 |
pivotOptions | ピボット グラフのオプションをカプセル化します。 | |
ChartAreaFormat | colorScheme | グラフの配色を指定します。 |
roundedCorners | グラフのグラフ領域に角が丸くなっているかどうかを指定します。 | |
ChartAxis | linkNumberFormat | 数値形式をセルにリンクするかどうかを指定します。 |
ChartBinOptions | allowOverflow | ビン オーバーフローがヒストグラム グラフまたはパレート グラフで有効かどうかを指定します。 |
allowUnderflow | ヒストグラム チャートまたはパレート チャートでビンアンダーフローを有効にするかどうかを指定します。 | |
count | ヒストグラム グラフまたはパレート グラフのビン数を指定します。 | |
overflowValue | ヒストグラム グラフまたはパレート グラフのビン オーバーフロー値を指定します。 | |
type | ヒストグラム グラフまたはパレート グラフのビンの種類を指定します。 | |
underflowValue | ヒストグラム グラフまたはパレート グラフのビンアンダーフロー値を指定します。 | |
width | ヒストグラム グラフまたはパレート グラフのビン幅の値を指定します。 | |
ChartBoxwhiskerOptions | quartileCalculation | ボックス グラフとウィスカ グラフの四分位数計算の種類を指定します。 |
showInnerPoints | ボックス グラフとウィスカ グラフに内側のポイントを表示するかどうかを指定します。 | |
showMeanLine | ボックスグラフとウィスカチャートに平均線を表示するかどうかを指定します。 | |
showMeanMarker | 平均マーカーをボックスグラフとウィスカチャートに表示するかどうかを指定します。 | |
showOutlierPoints | 外れ値の点を箱グラフとウィスカ グラフに表示するかどうかを指定します。 | |
ChartDataLabel | linkNumberFormat | 数値書式をセルにリンクするかどうかを指定します (セル内で数値書式が変更されたときにラベルが変更されるようにします)。 |
ChartDataLabels | linkNumberFormat | 数値形式をセルにリンクするかどうかを指定します。 |
ChartErrorBars | endStyleCap | エラー バーに終了スタイルの上限があるかどうかを指定します。 |
format | 誤差範囲の書式の種類を指定します。 | |
include | 誤差範囲のどの部分を含めるかを指定します。 | |
type | 誤差範囲でマークされている範囲の種類。 | |
visible | エラー バーを表示するかどうかを指定します。 | |
ChartErrorBarsFormat | line | グラフの線の書式設定を表します。 |
ChartMapOptions | labelStrategy | 地域マップ グラフの系列マップ ラベル戦略を指定します。 |
level | 領域マップ グラフの系列マッピング レベルを指定します。 | |
projectionType | リージョン マップ グラフの系列投影の種類を指定します。 | |
ChartPivotOptions | showAxisFieldButtons | ピボットグラフに軸フィールド ボタンを表示するかどうかを指定します。 |
showLegendFieldButtons | ピボットグラフに凡例フィールド ボタンを表示するかどうかを指定します。 | |
showReportFilterFieldButtons | ピボットグラフにレポート フィルター フィールド ボタンを表示するかどうかを指定します。 | |
showValueFieldButtons | ピボットグラフに表示値フィールド ボタンを表示するかどうかを指定します。 | |
ChartSeries | binOptions | ヒストグラム図とパレート図のビンのオプションをカプセル化します。 |
boxwhiskerOptions | 箱ひげ図グラフのオプションをカプセル化します。 | |
bubbleScale | 既定のサイズのパーセンテージを表す 0 (ゼロ) から 300 までの整数値とすることができます。 | |
gradientMaximumColor | 領域マップ グラフ系列の最大値の色を指定します。 | |
gradientMaximumType | 領域マップ グラフ系列の最大値の型を指定します。 | |
gradientMaximumValue | 領域マップ グラフ系列の最大値を指定します。 | |
gradientMidpointColor | 領域マップ グラフ系列の中点値の色を指定します。 | |
gradientMidpointType | リージョン マップ グラフ系列の中点値の型を指定します。 | |
gradientMidpointValue | リージョン マップ グラフ系列の中点の値を指定します。 | |
gradientMinimumColor | 領域マップ グラフ系列の最小値の色を指定します。 | |
gradientMinimumType | 地域マップ グラフ系列の最小値の型を指定します。 | |
gradientMinimumValue | 領域マップ グラフ系列の最小値を指定します。 | |
gradientStyle | 領域マップ グラフの系列グラデーション スタイルを指定します。 | |
invertColor | 系列内の負のデータ ポイントの塗りつぶしの色を指定します。 | |
mapOptions | リージョン マップ グラフのオプションをカプセル化します。 | |
parentLabelStrategy | ツリーマップ グラフの系列親ラベル戦略領域を指定します。 | |
showConnectorLines | コネクタ線をウォーターフォール グラフに表示するかどうかを指定します。 | |
showLeaderLines | 系列内のデータ ラベルごとに引出し線を表示するかどうかを指定します。 | |
splitValue | 円グラフまたは円グラフの 2 つのセクションを区切るしきい値を指定します。 | |
xErrorBars | グラフ系列の誤差範囲オブジェクトを表します。 | |
yErrorBars | グラフ系列の誤差範囲オブジェクトを表します。 | |
ChartTrendlineLabel | linkNumberFormat | 数値書式をセルにリンクするかどうかを指定します (セル内で数値書式が変更されたときにラベルが変更されるようにします)。 |
ColumnProperties | address |
address プロパティを表します。 |
addressLocal |
addressLocal プロパティを表します。 |
|
columnIndex |
columnIndex プロパティを表します。 |
|
ConditionalFormat | getRanges() | 1 つまたは複数の四角形の範囲を含む RangeAreas を返します。この範囲に対して、この四角形の形式が適用されます。 |
DataValidation | getInvalidCells() | 無効なセル値を持つ 1 つ以上の四角形の範囲を含む、 RangeAreas オブジェクトを返します。 |
getInvalidCellsOrNullObject() | 無効なセル値を持つ 1 つ以上の四角形の範囲を含む、 RangeAreas オブジェクトを返します。 |
|
FilterCriteria | subField | リッチ値に対してリッチ フィルターを実行するためにフィルターによって使用されるプロパティ。 |
GeometricShape | id | 図形 ID を返します。 |
shape | ジオメトリ シェイプの Shape オブジェクトを返します。 |
|
GroupShapeCollection | getCount() | 図形グループの図形の数を返します。 |
getItem(key: string) | 名前または ID を使用して図形を取得します。 | |
getItemAt(index: number) | コレクション内の位置に基づいて図形を取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
HeaderFooter | centerFooter | ワークシートの中央フッター。 |
centerHeader | ワークシートの中央ヘッダー。 | |
leftFooter | ワークシートの左側のフッター。 | |
leftHeader | ワークシートの左側のヘッダー。 | |
rightFooter | ワークシートの右側のフッター。 | |
rightHeader | ワークシートの右側のヘッダー。 | |
HeaderFooterGroup | defaultForAllPages | 偶数/奇数または最初のページが指定されていない場合にすべてのページに使用される汎用ヘッダー/フッター。 |
evenPages | 偶数ページに使用するヘッダー/フッター。奇数ページには奇数のヘッダー/フッターを指定する必要があります。 | |
firstPage | 最初のページに使用するヘッダー/フッター。その他すべてのページには汎用または偶数/奇数のヘッダー/フッターが使用されます。 | |
oddPages | 奇数ページに使用するヘッダー/フッター。偶数ページには偶数のヘッダー/フッターを指定する必要があります。 | |
state | ヘッダー/フッターが設定される状態。 | |
useSheetMargins | ワークシートのページ レイアウト オプションに設定されているページ余白に合わせてヘッダー/フッターの位置が調整されているかどうかを示すフラグを取得または設定します。 | |
useSheetScale | ワークシートのページ レイアウト オプションに設定されているページ パーセンテージ スケールによってヘッダー/フッターが調整されているかどうかを示すフラグを取得または設定します。 | |
Image | format | 画像の形式を返します。 |
id | イメージ オブジェクトの図形識別子を指定します。 | |
shape | イメージに関連付けられている Shape オブジェクトを返します。 |
|
IterativeCalculation | enabled | Excel で反復計算を使用して循環参照を解決する場合、true となります。 |
maxChange | Excel で循環参照が解決されるため、各イテレーション間の最大変更量を指定します。 | |
maxIteration | Excel が循環参照を解決するために使用できるイテレーションの最大数を指定します。 | |
Line | beginArrowheadLength | 指定された線の始点の矢印の長さを表します。 |
beginArrowheadStyle | 指定された線の始点の矢印のスタイルを表します。 | |
beginArrowheadWidth | 指定された線の始点の矢印の幅を表します。 | |
beginConnectedShape | 指定された線の始点が接続されている図形を表します。 | |
beginConnectedSite | コネクタの始点が接続されている結合点を表します。 | |
connectBeginShape(shape: Excel.Shape, connectionSite: number) | 指定されたコネクタの始点を指定された図形に接続します。 | |
connectEndShape(shape: Excel.Shape, connectionSite: number) | 指定されたコネクタの終点を指定された図形に接続します。 | |
connectorType | 線のコネクタの種類を表します。 | |
disconnectBeginShape() | 指定されたコネクタの始点を図形から切り離します。 | |
disconnectEndShape() | 指定されたコネクタの終点を図形から切り離します。 | |
endArrowheadLength | 指定された線の終点の矢印の長さを表します。 | |
endArrowheadStyle | 指定された線の終点の矢印のスタイルを表します。 | |
endArrowheadWidth | 指定された線の終点の矢印の幅を表します。 | |
endConnectedShape | 指定された線の終点が接続されている図形を表します。 | |
endConnectedSite | コネクタの終点が接続されている結合点を表します。 | |
id | 図形識別子を指定します。 | |
isBeginConnected | 指定した線の先頭が図形に接続されているかどうかを指定します。 | |
isEndConnected | 指定した線の末尾が図形に接続されているかどうかを指定します。 | |
shape | 行に関連付けられている Shape オブジェクトを返します。 |
|
PageBreak | columnIndex | 改ページの列インデックスを指定します。 |
delete() | 改ページ オブジェクトを削除します。 | |
getCellAfterBreak() | 改ページの後の最初のセルを取得します。 | |
rowIndex | 改ページの行インデックスを指定します。 | |
PageBreakCollection | add(pageBreakRange: Range | string) | 指定された範囲の左上セルの前に改ページを追加します。 |
getCount() | コレクション内の改ページの数を取得します。 | |
getItem(index: number) | インデックス経由で改ページ オブジェクトを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
removePageBreaks() | コレクション内の手動改ページをすべてリセットします。 | |
PageLayout | blackAndWhite | ワークシートの白黒印刷オプション。 |
bottomMargin | ポイント単位での印刷に使用するワークシートの下部ページ余白。 | |
centerHorizontally | ワークシートの中央の水平方向のフラグ。 | |
centerVertically | ワークシートの中央に垂直フラグを設定します。 | |
draftMode | ワークシートの下書きモード オプション。 | |
firstPageNumber | 印刷するワークシートの最初のページ番号。 | |
footerMargin | 印刷時に使用するワークシートのフッター余白をポイント単位で指定します。 | |
getPrintArea() | ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 |
|
getPrintAreaOrNullObject() | ワークシートの印刷領域を表す 1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトを取得します。 |
|
getPrintTitleColumns() | タイトル列を表す範囲オブジェクトを取得します。 | |
getPrintTitleColumnsOrNullObject() | タイトル列を表す範囲オブジェクトを取得します。 | |
getPrintTitleRows() | タイトル行を表す範囲オブジェクトを取得します。 | |
getPrintTitleRowsOrNullObject() | タイトル行を表す範囲オブジェクトを取得します。 | |
headerMargin | 印刷時に使用するワークシートのヘッダー余白をポイント単位で指定します。 | |
headersFooters | ワークシートのヘッダーとフッターの構成。 | |
leftMargin | 印刷時に使用するワークシートの左余白をポイント単位で指定します。 | |
orientation | ページのワークシートの向き。 | |
paperSize | ページのワークシートの用紙サイズ。 | |
printComments | 印刷時にワークシートのコメントを表示するかどうかを指定します。 | |
printErrors | ワークシートの印刷エラー オプション。 | |
printGridlines | ワークシートの目盛線を印刷するかどうかを指定します。 | |
printHeadings | ワークシートの見出しを印刷するかどうかを指定します。 | |
printOrder | ワークシートのページ印刷順序オプション。 | |
rightMargin | 印刷時に使用するワークシートの右余白をポイント単位で指定します。 | |
setPrintArea(printArea: Range |RangeAreas |string) | ワークシートの印刷範囲を設定します。 | |
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions) | ワークシートのページ余白を単位で設定します。 | |
setPrintTitleColumns(printTitleColumns: Range | string) | セルを含む列を、印刷時、ワークシートの各ページの左で繰り返すように設定します。 | |
setPrintTitleRows(printTitleRows: Range | string) | セルを含む行を、印刷時、ワークシートの各ページの上で繰り返すように設定します。 | |
topMargin | 印刷時に使用するワークシートの上余白をポイント単位で指定します。 | |
zoom | ワークシートの印刷ズーム オプション。 | |
PageLayoutMarginOptions | bottom | 印刷に使用する単位のページ レイアウトの下余白を指定します。 |
footer | 印刷に使用する単位のページ レイアウト フッター余白を指定します。 | |
header | 印刷に使用する単位のページ レイアウト ヘッダー余白を指定します。 | |
left | 印刷に使用する単位のページ レイアウトの左余白を指定します。 | |
right | 印刷に使用する単位のページ レイアウトの右余白を指定します。 | |
top | 印刷に使用する単位のページ レイアウトの上余白を指定します。 | |
PageLayoutZoomOptions | horizontalFitToPages | 横方向に合わせるページ数。 |
scale | 印刷ページのスケール値は 10 から 400 までです。 | |
verticalFitToPages | 縦方向に合わせるページ数。 | |
PivotField | sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>) | 与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。 |
PivotLayout | autoFormat | 更新時またはフィールドの移動時に書式を自動的に設定するかどうかを指定します。 |
getDataHierarchy(cell: Range | string) | PivotTable 内で指定された範囲の値を計算するために使用される DataHierarchy を取得します。 | |
getPivotItems(axis: Excel.PivotAxis, cell: Range | string) | PivotTable 内で指定された範囲の値を構成する PivotItems を軸から取得します。 | |
preserveFormatting | ピボット、並べ替え、ページ フィールド 項目の変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。 | |
setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy) | 必要なすべての条件とコンテキストを自動的に選択するため、指定したセルを使用して自動的に並べ替えを実行するようピボットテーブルを設定します。 | |
PivotTable | enableDataValueEditing | ピボットテーブルでデータ本文の値をユーザーが編集できるかどうかを指定します。 |
useCustomSortLists | 並べ替え時にピボットテーブルでカスタム リストを使用するかどうかを指定します。 | |
Range | autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType) | 指定したオートフィル ロジックを使用して、現在の範囲からターゲット範囲までの範囲を入力します。 |
convertDataTypeToText() | データ型を持つ範囲セルをテキストに変換します。 | |
convertToLinkedDataType(serviceID: number, languageCulture: string) | 範囲セルをワークシート内のリンクされたデータ型に変換します。 | |
copyFrom(sourceRange: Range |RangeAreas |string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean) | セル データまたは書式設定をソース範囲または RangeAreas から現在の範囲にコピーします。 |
|
find(text: string, criteria: Excel.SearchCriteria) | 指定された条件に基づいて指定された文字列を見つけます。 | |
findOrNullObject(text: string, criteria: Excel.SearchCriteria) | 指定された条件に基づいて指定された文字列を見つけます。 | |
flashFill() | 現在の範囲にフラッシュフィルを実行します。 | |
getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | 2D 配列を返します。各セルのフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。 | |
getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions) | 一次元配列を返します。各列のフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。 | |
getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions) | 一次元配列を返します。各行のフォント、塗りつぶし、罫線、配置などのプロパティ データをカプセル化します。 | |
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | 指定した型と値に一致するすべてのセルを表す 1 つまたは複数の四角形の範囲を含む、 RangeAreas オブジェクトを取得します。 |
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | 指定した型と値に一致するすべてのセルを表す 1 つ以上の範囲を含む、 RangeAreas オブジェクトを取得します。 |
|
getTables(fullyContained?: boolean) | 範囲と重なるテーブルの集まりを範囲限定で取得します。 | |
linkedDataTypeState | 各セルのデータ型の状態を表します。 | |
removeDuplicates(columns: number[], includesHeader: boolean) | 列によって指定される範囲から重複する値を削除します。 | |
replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria) | 現在の範囲内で、指定された条件に基づき、指定された文字列を検索し、置換します。 | |
setCellProperties(cellPropertiesData: SettableCellProperties[][]) | セル プロパティの 2D 配列に基づいて範囲をUpdatesし、フォント、塗りつぶし、罫線、配置などをカプセル化します。 | |
setColumnProperties(columnPropertiesData: SettableColumnProperties[]) | 列プロパティの 1 次元配列に基づいて範囲をUpdatesし、フォント、塗りつぶし、罫線、配置などをカプセル化します。 | |
setDirty() | 次の再計算が発生したときに再計算する範囲を設定します。 | |
setRowProperties(rowPropertiesData: SettableRowProperties[]) | 行プロパティの 1 次元配列に基づいて範囲をUpdatesし、フォント、塗りつぶし、罫線、配置などをカプセル化します。 | |
RangeAreas | address | A1 スタイルの RangeAreas 参照を返します。 |
addressLocal | ユーザー ロケールの RangeAreas 参照を返します。 |
|
areaCount | この RangeAreas オブジェクトを構成する四角形の範囲の数を返します。 |
|
areas | この RangeAreas オブジェクトを構成する四角形の範囲のコレクションを返します。 |
|
calculate() |
RangeAreas 内のすべてのセルを計算します。 |
|
cellCount |
RangeAreas オブジェクト内のセルの数を返し、個々のすべての四角形の範囲のセル数を合計します。 |
|
clear(applyTo?: Excel.ClearApplyTo) | この RangeAreas オブジェクトを構成する各領域の値、書式、塗りつぶし、罫線、およびその他のプロパティをクリアします。 |
|
conditionalFormats | この RangeAreas オブジェクト内の任意のセルと交差する条件付き形式のコレクションを返します。 |
|
convertDataTypeToText() | データ型を持つ RangeAreas 内のすべてのセルをテキストに変換します。 |
|
convertToLinkedDataType(serviceID: number, languageCulture: string) |
RangeAreas 内のすべてのセルをリンクされたデータ型に変換します。 |
|
copyFrom(sourceRange: Range |RangeAreas |string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean) | セル データまたは書式設定をソース範囲または RangeAreas から現在の RangeAreas にコピーします。 |
|
dataValidation |
RangeAreas 内のすべての範囲のデータ検証オブジェクトを返します。 |
|
format |
RangeAreas オブジェクト内のすべての範囲のフォント、塗りつぶし、罫線、配置、およびその他のプロパティをカプセル化して、RangeFormat オブジェクトを返します。 |
|
getEntireColumn() |
RangeAreas の列全体を表すRangeAreas オブジェクトを返します (たとえば、現在のRangeAreas がセル "B4:E11, H2" を表している場合、列 "B:E, H:H" を表すRangeAreas を返します)。 |
|
getEntireRow() |
RangeAreas の行全体を表すRangeAreas オブジェクトを返します (たとえば、現在のRangeAreas がセル "B4:E11" を表している場合は、行 "4:11" を表すRangeAreas を返します)。 |
|
getIntersection(anotherRange: Range |RangeAreas |string) | 指定した範囲またはRangeAreas の積集合を表すRangeAreas オブジェクトを返します。 |
|
getIntersectionOrNullObject(anotherRange: Range |RangeAreas |string) | 指定した範囲またはRangeAreas の積集合を表すRangeAreas オブジェクトを返します。 |
|
getOffsetRangeAreas(rowOffset: number, columnOffset: number) | 特定の行と列のオフセットによってシフトされる RangeAreas オブジェクトを返します。 |
|
getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | 指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 |
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType) | 指定した型と値に一致するすべてのセルを表す RangeAreas オブジェクトを返します。 |
|
getTables(fullyContained?: boolean) | この RangeAreas オブジェクト内の任意の範囲と重複するテーブルのスコープ付きコレクションを返します。 |
|
getUsedRangeAreas(valuesOnly?: boolean) |
RangeAreas オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreas を返します。 |
|
getUsedRangeAreasOrNullObject(valuesOnly?: boolean) |
RangeAreas オブジェクト内の個々の四角形の範囲のすべての使用領域を構成する使用RangeAreas を返します。 |
|
isEntireColumn | この RangeAreas オブジェクトのすべての範囲が列全体を表すかどうかを指定します (例: "A:C, Q:Z")。 |
|
isEntireRow | この RangeAreas オブジェクトのすべての範囲が行全体を表すかどうかを指定します (例: "1:3, 5:7")。 |
|
setDirty() | 次の再計算が発生したときに再計算される RangeAreas を設定します。 |
|
style | この RangeAreas オブジェクトのすべての範囲のスタイルを表します。 |
|
worksheet | 現在の RangeAreas のワークシートを返します。 |
|
RangeBorder | tintAndShade | 範囲の境界線の色を明るくまたは暗くする二重を指定します。値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 |
RangeBorderCollection | tintAndShade | 範囲の境界線の色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 |
RangeCollection | getCount() |
RangeCollection 内の範囲の数を返します。 |
getItemAt(index: number) |
RangeCollection 内の位置に基づいて範囲オブジェクトを返します。 |
|
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
RangeFill | pattern | 範囲のパターン。 |
patternColor | 範囲パターンの色を表す HTML カラー コードは、#RRGGBB 形式 (例: "FFA500")、または名前付き HTML 色 (例: "オレンジ") として表されます。 | |
patternTintAndShade | 範囲の塗りつぶしのパターンの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 | |
tintAndShade | 範囲の塗りつぶしの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 | |
RangeFont | strikethrough | フォントの取り消し線の状態を指定します。 |
subscript | フォントの添字の状態を指定します。 | |
superscript | フォントの上付き文字の状態を指定します。 | |
tintAndShade | 範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 | |
RangeFormat | autoIndent | テキストの配置が等しい分布に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。 |
indentLevel | インデント レベルを示す 0 から 250 までの整数。 | |
readingOrder | 範囲に適用される読み上げ順序。 | |
shrinkToFit | 使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。 | |
RemoveDuplicatesResult | removed | 操作によって削除された重複行の数。 |
uniqueRemaining | 結果として生じた範囲に存在する残りの一意の行の数。 | |
ReplaceCriteria | completeMatch | 一致が完全であるか部分的である必要があるかどうかを指定します。 |
matchCase | 一致で大文字と小文字が区別されるかどうかを指定します。 | |
RowProperties | address |
address プロパティを表します。 |
addressLocal |
addressLocal プロパティを表します。 |
|
rowIndex |
rowIndex プロパティを表します。 |
|
SearchCriteria | completeMatch | 一致が完全であるか部分的である必要があるかどうかを指定します。 |
matchCase | 一致で大文字と小文字が区別されるかどうかを指定します。 | |
searchDirection | 検索の方向を指定します。 | |
SettableCellProperties | format |
format プロパティを表します。 |
hyperlink |
hyperlink プロパティを表します。 |
|
style |
style プロパティを表します。 |
|
SettableColumnProperties | columnHidden |
columnHidden プロパティを表します。 |
format |
format プロパティを表します。 |
|
SettableRowProperties | format |
format プロパティを表します。 |
rowHidden |
rowHidden プロパティを表します。 |
|
Shape | altTextDescription |
Shape オブジェクトの代替説明テキストを指定します。 |
altTextTitle |
Shape オブジェクトの代替タイトル テキストを指定します。 |
|
connectionSiteCount | この図形の結合点の数を返します。 | |
delete() | ワークシートから図形を削除します。 | |
fill | この図形の塗りつぶしの書式設定を返します。 | |
geometricShape | 図形に関連付けられた幾何学的図形を返します。 | |
geometricShapeType | このジオメトリ シェイプのジオメトリ シェイプ タイプを指定します。 | |
getAsImage(format: Excel.PictureFormat) | 図形をイメージに変換し、イメージを Base64 でエンコードされた文字列として返します。 | |
group | 図形に関連付けられた図形グループを返します。 | |
height | 図形の高さをポイント単位で指定します。 | |
id | 図形識別子を指定します。 | |
image | 図形に関連付けられた画像を返します。 | |
incrementLeft(increment: number) | 指定したポイント数だけ水平方向に図形を移動します。 | |
incrementRotation(increment: number) | z 軸を中心に、指定された度数だけ、図形を時計回りに回転します。 | |
incrementTop(increment: number) | 指定したポイント数だけ垂直方向に図形を移動します。 | |
left | 図形の左側からワークシートの左側までの距離 (ポイント数) です。 | |
level | 指定した図形のレベルを指定します。 | |
line | 図形に関連付けられた線を返します。 | |
lineFormat | この図形の線の書式設定を返します。 | |
lockAspectRatio | この図形の縦横比がロックされているかどうかを指定します。 | |
name | 図形の名前を指定します。 | |
onActivated | 図形がアクティブになったときに発生します。 | |
onDeactivated | 図形が非アクティブになると発生します。 | |
parentGroup | この図形の親グループを指定します。 | |
rotation | 図形の回転を度単位で指定します。 | |
scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom) | 指定した係数分だけ図形の高さを変更します。 | |
scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom) | 指定した係数分だけ図形の幅を変更します。 | |
setZOrder(position: Excel.ShapeZOrder) | 指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。 | |
textFrame | この図形のテキスト フレーム オブジェクトを返します。 | |
top | 図形の上端からワークシートの上までのポイント単位の距離です。 | |
type | この図形の種類を返します。 | |
visible | 図形を表示するかどうかを指定します。 | |
width | 図形の幅をポイント単位で指定します。 | |
zOrderPosition | 指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。 | |
ShapeActivatedEventArgs | shapeId | アクティブ化された図形の ID を取得します。 |
type | イベントの種類を取得します。 | |
worksheetId | 図形がアクティブ化されているワークシートの ID を取得します。 | |
ShapeCollection | addGeometricShape(geometricShapeType: Excel.GeometricShapeType) | 幾何学的図形をワークシートに追加します。 |
addGroup(values: Array<string |図形>) | このコレクションのワークシート内の図形のサブセットをグループ化します。 | |
addImage(base64ImageString: string) | Base64 でエンコードされた文字列からイメージを作成し、ワークシートに追加します。 | |
addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType) | ワークシートに行を追加します。 | |
addTextBox(text?: string) | 指定されたテキストを含むテキスト ボックスをワークシートに追加します。 | |
getCount() | ワークシートの図形数を返します。 | |
getItem(key: string) | 名前または ID を使用して図形を取得します。 | |
getItemAt(index: number) | コレクション内の位置を使用して図形を取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
ShapeDeactivatedEventArgs | shapeId | 非アクティブ化された図形の ID を取得します。 |
type | イベントの種類を取得します。 | |
worksheetId | 図形が非アクティブ化されているワークシートの ID を取得します。 | |
ShapeFill | clear() | この図形の塗りつぶしの書式設定をクリアします。 |
foregroundColor | #RRGGBB 形式 ("FFA500" など) または名前付き HTML カラー ("オレンジ" など) で、HTML 色形式で図形塗りつぶしの前景色を表します。 | |
setSolidColor(color: string) | 図形の塗りつぶしの書式設定を均一な色に設定します。 | |
transparency | 塗りつぶしの透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値として指定します。 | |
type | 図形の塗りつぶしの種類を返します。 | |
ShapeFont | bold | フォントの太字の状態を表します。 |
color | テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。 | |
italic | フォントの斜体の状態を表します。 | |
name | フォント名 ("Calibri" など) を表します。 | |
size | フォント サイズをポイント単位で表します (例: 11)。 | |
underline | フォントに適用する下線の種類。 | |
ShapeGroup | id | 図形識別子を指定します。 |
shape | グループに関連付けられている Shape オブジェクトを返します。 |
|
shapes |
Shape オブジェクトのコレクションを返します。 |
|
ungroup() | 指定した図形グループに含まれるグループ化された図形のグループを解除します。 | |
ShapeLineFormat | color | #RRGGBB 形式 ("FFA500" など) または名前付き HTML の色 (例: "オレンジ") の形式で、行の色を HTML 色形式で表します。 |
dashStyle | 図形の線スタイルを表します。 | |
style | 図形の線スタイルを表します。 | |
transparency | 指定された線の透明度を示す 0.0 (不透明) から 1.0 (透明) までの値を表します。 | |
visible | 図形要素の線の書式を表示するかどうかを指定します。 | |
weight | 線の太さ (ポイント数) を表します。 | |
SortField | subField | 並べ替えるリッチ値のターゲット プロパティ名であるサブフィールドを指定します。 |
StyleCollection | getCount() | コレクション内のスタイルの数を取得します。 |
getItemAt(index: number) | コレクション内の位置に基づいてスタイルを取得します。 | |
Table | autoFilter | テーブルの AutoFilter オブジェクトを表します。 |
TableAddedEventArgs | source | イベントのソースを取得します。 |
tableId | 追加されるテーブルの ID を取得します。 | |
type | イベントの種類を取得します。 | |
worksheetId | テーブルが追加されるワークシートの ID を取得します。 | |
TableChangedEventArgs | details | 変更の詳細に関する情報を取得します。 |
TableCollection | onAdded | ブックに新しいテーブルが追加されたときに発生します。 |
onDeleted | 指定されたテーブルがブックで削除されたときに発生します。 | |
TableDeletedEventArgs | source | イベントのソースを取得します。 |
tableId | 削除されたテーブルの ID を取得します。 | |
tableName | 削除されたテーブルの名前を取得します。 | |
type | イベントの種類を取得します。 | |
worksheetId | テーブルが削除されるワークシートの ID を取得します。 | |
TableScopedCollection | getCount() | コレクションに含まれるテーブルの数を取得します。 |
getFirst() | コレクション内の最初のテーブルを取得します。 | |
getItem(key: string) | 名前または ID でテーブルを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
TextFrame | autoSizeSetting | テキスト フレームの自動サイズ設定。 |
bottomMargin | テキスト フレームの下余白を表します (ポイント数)。 | |
deleteText() | テキスト フレーム内のテキストをすべて削除します。 | |
hasText | テキスト フレームにテキストが含まれているかどうかを指定します。 | |
horizontalAlignment | テキスト フレームの水平方向の配置を表します。 | |
horizontalOverflow | テキスト フレームの水平方向のオーバーフローの動作を表します。 | |
leftMargin | テキスト フレームの左余白を表します (ポイント数)。 | |
orientation | テキスト フレームのテキストの向きを示す角度を表します。 | |
readingOrder | テキスト フレームの読む方向を表します (左から右または右から左)。 | |
rightMargin | テキスト フレームの右余白を表します (ポイント数)。 | |
textRange | テキスト フレーム内の図形にアタッチされているテキスト、およびテキストを操作するためのプロパティとメソッドを表します。 | |
topMargin | テキスト フレームの上余白を表します (ポイント数)。 | |
verticalAlignment | テキスト フレームの垂直方向の配置を表します。 | |
verticalOverflow | テキスト フレームの垂直方向のオーバーフローの動作を表します。 | |
TextRange | font | テキスト範囲のフォント属性を表す ShapeFont オブジェクトを返します。 |
getSubstring(start: number, length?: number) | 指定された範囲の部分文字列に対する TextRange オブジェクトを返します。 | |
text | テキスト範囲のプレーン テキスト コンテンツを表します。 | |
Workbook | autoSave | ブックが自動保存モードかどうかを指定します。 |
calculationEngineVersion | Excel 計算エンジンのバージョンとして数字を返します。 | |
chartDataPointTrack | 関連付けられている実際のデータ ポイントをブックの全グラフが追跡している場合、true となります。 | |
getActiveChart() | ブックで現在アクティブになっているグラフを取得します。 | |
getActiveChartOrNullObject() | ブックで現在アクティブになっているグラフを取得します。 | |
getIsActiveCollabSession() | ブックが複数のユーザーによって (共同編集によって) 編集されている場合は、 true を返します。 |
|
getSelectedRanges() | ブックから現在選択されている 1 つまたは複数の範囲を取得します。 | |
isDirty | ブックが最後に保存されてから変更が加えられたかどうかを指定します。 | |
onAutoSaveSettingChanged | ブックの [自動保存] 設定が変更されたときに発生します。 | |
previouslySaved | ブックがローカルまたはオンラインで保存されたかどうかを指定します。 | |
usePrecisionAsDisplayed | ブックを表示桁数でのみ計算する場合、true となります。 | |
WorkbookAutoSaveSettingChangedEventArgs | type | イベントの種類を取得します。 |
ワークシート | autoFilter | ワークシートの AutoFilter オブジェクトを表します。 |
enableCalculation | Excel が必要に応じてワークシートを再計算するかどうかを決定します。 | |
findAll(text: string, criteria: Excel.WorksheetSearchCriteria) | 指定した条件に基づいて指定された文字列のすべての出現箇所を検索し、1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトとして返します。 |
|
findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria) | 指定した条件に基づいて指定された文字列のすべての出現箇所を検索し、1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトとして返します。 |
|
getRanges(address?: string) | アドレスまたは名前で指定された四角形の範囲の 1 つ以上のブロックを表す、 RangeAreas オブジェクトを取得します。 |
|
horizontalPageBreaks | ワークシートの水平改ページをまとめて取得します。 | |
onFormatChanged | フォーマットが特定のワークシートで変更されたときに発生します。 | |
pageLayout | ワークシートの PageLayout オブジェクトを取得します。 |
|
replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria) | 現在のワークシート内で、指定された条件に基づき、指定された文字列を検索し、置換します。 | |
shapes | ワークシート上のすべての Shape オブジェクトをまとめて返します。 | |
verticalPageBreaks | ワークシートの垂直改ページをまとめて取得します。 | |
WorksheetChangedEventArgs | details | 変更の詳細に関する情報を表します。 |
WorksheetCollection | onChanged | ブックのワークシートが変更されたときに発生します。 |
onFormatChanged | ブック内のワークシートの書式が変更された場合に発生します。 | |
onSelectionChanged | ワークシートで選択範囲を変更したときに発生します。 | |
WorksheetFormatChangedEventArgs | address | 特定のワークシートで変更されたエリアを表す範囲のアドレスを取得します。 |
getRange(ctx: Excel.RequestContext) | 特定のワークシートで変更されたエリアを表す範囲を取得します。 | |
getRangeOrNullObject(ctx: Excel.RequestContext) | 特定のワークシートで変更されたエリアを表す範囲を取得します。 | |
source | イベントのソースを取得します。 | |
type | イベントの種類を取得します。 | |
worksheetId | データが変更されたワークシートの ID を取得します。 | |
WorksheetSearchCriteria | completeMatch | 一致が完全であるか部分的である必要があるかどうかを指定します。 |
matchCase | 一致で大文字と小文字が区別されるかどうかを指定します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins