次の方法で共有

Excel JavaScript API 1.7 の新機能

  • [アーティクル]

Excel JavaScript API 要件セット 1.7 の機能には、グラフ、イベント、ワークシート、範囲、ドキュメント プロパティ、名前付きアイテム、保護のオプションとスタイルに対応する API が含まれます。

グラフのカスタマイズ

新しいグラフ API を使用して実行できる操作には、他の種類のグラフの作成、グラフへのデータ系列の追加、グラフ タイトルの設定、軸タイトルの追加、表示単位の追加、移動平均を使用した近似曲線の追加、線形近似曲線への変更などがあります。 以下はその一例です。

  • グラフの軸: グラフ内の軸の単位、ラベル、タイトルを取得、設定、書式設定する。
  • グラフのデータ系列: グラフ内のデータ系列を追加、設定、削除する。 データ系列マーカー、プロット順序、サイジングを変更する。
  • グラフの近似曲線: グラフ内の近似曲線を追加、取得、書式設定する。
  • グラフの凡例: グラフ内の凡例のフォントを書式設定する。
  • グラフ データ ポイント要素: データ要素の色を設定する。
  • グラフタイトル部分文字列 - グラフのタイトル部分文字列を取得して設定します。
  • グラフの種類: 他の種類のグラフを作成するオプションを使用する。

イベント

Excel イベント API には各種のイベント ハンドラーが用意されています。これらのハンドラーを使用することで、特定のイベントが発生したときに、アドインで目的の関数を自動的に実行できます。 実行する関数は、目的のシナリオに必要な処理を行うように設計できます。 現在利用可能なイベントのリストについては、Excel JavaScript API を使用してイベントを操作するを参照してください。

ワークシートと範囲の外観のカスタマイズ

新しい API を使用して、ワークシートの外観をさまざまな方法でカスタマイズできます。たとえば、次のようなカスタマイズが可能です。

  • ワークシート内でスクロールするときに特定の行または列が常に表示されるよう、ウィンドウ枠を固定する。 たとえば、ワークシート内の最初の行にヘッダーが示される場合、その行にウィンドウ枠を固定すると、ワークシートをスクロールダウンしても列の見出しは表示されたままになります。
  • ワークシートのタブの色を変更する。
  • ワークシートの見出しを追加する。

範囲の外観をさまざまな方法でカスタマイズできます。たとえば、次のようなカスタマイズが可能です。

  • 特定の範囲に対してセルのスタイルを設定し、その範囲内のすべてのセルに一貫した書式設定が適用されるようにする。 セルのスタイルとは、フォント、フォントのサイズ、数値形式、セルの罫線、セルの網掛けなど、文字に定義された書式設定一式を指します。 Excel の組み込みのセル スタイルのいずれかを使用することも、独自のカスタム セル スタイルを作成することもできます。
  • 範囲に適用するテキストの向きを設定する。
  • 特定の範囲からブック内の別の場所または外部の場所にリンクするハイパーリンクを追加または変更する。

ドキュメント プロパティの管理

ドキュメント プロパティ API を使用して、組み込みのドキュメント プロパティにアクセスできます。また、ブックの状態を格納してワークフローやビジネス ロジックを操作するためのカスタム ドキュメント プロパティを作成、管理することもできます。

ワークシートのコピー

ワークシート コピー API を使用して、ワークシートのデータと書式設定を同じブック内の新しいワークシートにコピーできます。これにより、必要となるデータの転送量を削減することができます。

範囲の操作の簡易化

各種の範囲 API を使用して、周りの領域の取得や範囲のサイズ変更など、さまざまな操作を行うことができます。 これらの API により、範囲の操作やアドレス指定などのタスクが効率化されます。

さらに、次の機能も使用できます。

  • ブックとワークシートの保護オプション: これらの API を使用して、ワークシートおよびブック構造内のデータを保護する。
  • 名前付きアイテムの更新: この API を使用して、名前付きアイテムを更新する。
  • アクティブセルの取得 - この API を使用してブックのアクティブなセルを取得します。

API リスト

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

クラス フィールド 説明
グラフ chartType グラフの種類を指定します。
id グラフの一意の ID。
showAllFieldButtons ピボットグラフにすべてのフィールド ボタンを表示するかどうかを指定します。
ChartAreaFormat 境 色、線のスタイル、太さを含むグラフ領域の罫線の形式を表します。
ChartAxes getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup) 種類とグループで識別された特定の軸を返します。
ChartAxis axisGroup 指定した軸のグループを指定します。
baseTimeUnit 指定したカテゴリ軸の基本単位を指定します。
categoryType カテゴリ軸の種類を指定します。
customDisplayUnit カスタム軸の表示単位の値を指定します。
displayUnit 軸の表示単位を表します。
height グラフ軸の高さをポイント単位で指定します。
left 軸の左端からグラフ領域の左側までの距離をポイント単位で指定します。
logBase 対数スケールを使用する場合の対数の底を指定します。
majorTickMark 指定した軸の目盛りの種類を指定します。
majorTimeUnitScale categoryType プロパティが dateAxis に設定されている場合に、カテゴリ軸のメジャー単位スケール値を指定します。
minorTickMark 指定した軸の補助目盛りの種類を指定します。
minorTimeUnitScale categoryType プロパティが dateAxis に設定されている場合に、カテゴリ軸の小単位スケール値を指定します。
reversePlotOrder Excel でデータ ポイントを最後から最初にプロットするかどうかを指定します。
scaleType 値軸スケールの種類を指定します。
setCategoryNames(sourceData: Range) 指定した軸のすべてのカテゴリ名を設定します。
setCustomDisplayUnit(value: number) 軸の表示単位をカスタム値に設定します。
showDisplayUnitLabel 軸の表示単位ラベルを表示するかどうかを指定します。
tickLabelPosition 指定された軸の目盛ラベルの位置を指定します。
tickLabelSpacing 目盛ラベル間のカテゴリまたは系列の数を指定します。
tickMarkSpacing 目盛りの間のカテゴリまたは系列の数を指定します。
top 軸の上端からグラフ領域の上端までの距離をポイント単位で指定します。
type 軸の種類を指定します。
visible 軸が表示されるかどうかを指定します。
width グラフ軸の幅をポイント単位で指定します。
ChartBorder color グラフの罫線の色を表す HTML カラー コード。
lineStyle 罫線のスタイルを表します。
weight 罫線の太さ (ポイント数) を表します。
ChartDataLabel position データ ラベルの位置を表す値。
分離器 グラフのデータ ラベルに使用される区切り文字を表す文字列。
showBubbleSize データ ラベルのバブル サイズを表示するかどうかを指定します。
showCategoryName データ ラベル カテゴリ名を表示するかどうかを指定します。
showLegendKey データ ラベルの凡例キーを表示するかどうかを指定します。
showPercentage データ ラベルの割合を表示するかどうかを指定します。
showSeriesName データ ラベル系列名を表示するかどうかを指定します。
showValue データ ラベルの値を表示するかどうかを指定します。
ChartFormatString font グラフ文字オブジェクトのフォント名、フォント サイズ、色などのフォント属性を表します。
ChartLegend height グラフの凡例の高さをポイント単位で指定します。
left グラフの凡例の左の値をポイント単位で指定します。
legendEntries 凡例に含まれる凡例エントリのコレクションを表します。
showShadow 凡例にグラフに影があるかどうかを指定します。
top グラフの凡例の上部を指定します。
width グラフの凡例の幅をポイント単位で指定します。
ChartLegendEntry visible グラフの凡例エントリの表示を表します。
ChartLegendEntryCollection getCount() コレクション内の凡例エントリの数を返します。
getItemAt(index: number) 指定したインデックス位置にある凡例エントリを返します。
items このコレクション内に読み込まれた子アイテムを取得します。
ChartLineFormat lineStyle 線のスタイルを表します。
weight 線の太さ (ポイント数) を表します。
ChartPoint dataLabel グラフ データ ポイントのデータ ラベルを返します。
hasDataLabel データ ポイントにデータ ラベルがあるかどうかを表します。
markerBackgroundColor データ ポイントのマーカーの背景色の HTML 色コード表現 (たとえば、#FF0000 は赤を表します)。
markerForegroundColor データ ポイントのマーカーの前景色の HTML カラー コード表現 (たとえば、#FF0000 は赤を表します)。
markerSize データ ポイントのマーカー サイズを表します。
markerStyle データ ポイントのマーカー スタイルを表します。
ChartPointFormat 境 色、スタイル、太さの情報を含むグラフ データ ポイントの罫線の形式を表します。
ChartSeries chartType グラフ系列の種類を表します。
delete() グラフ系列を削除します。
doughnutHoleSize グラフ系列のドーナツの穴の大きさを表します。
フィルター 系列をフィルター処理するかどうかを指定します。
gapWidth グラフ系列間に設けられる間隔を表します。
hasDataLabels 系列にデータ ラベルがあるかどうかを指定します。
markerBackgroundColor グラフ系列のマーカーの背景色を指定します。
markerForegroundColor グラフ系列のマーカーの前景色を指定します。
markerSize グラフ系列のマーカー サイズを指定します。
markerStyle グラフ系列のマーカー スタイルを指定します。
plotOrder グラフ グループ内のグラフ系列のプロット順序を指定します。
setBubbleSizes(sourceData: Range) グラフ系列のバブル サイズを設定します。
setValues(sourceData: Range) グラフ系列の値を設定します。
setXAxisValues(sourceData: Range) グラフ系列の x 軸の値を設定します。
showShadow 系列に影があるかどうかを指定します。
滑らか 系列がスムーズかどうかを指定します。
trendlines 系列内の近似曲線のコレクション。
ChartSeriesCollection add(name?: string, index?: number) コレクションに新しい系列を追加します。
ChartTitle getSubstring(start: number, length: number) グラフ タイトルの部分文字列を取得します。
height グラフ タイトルの高さ (ポイント数) を返します。
horizontalAlignment グラフ タイトルの水平方向の配置を指定します。
left グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。
position グラフ タイトルの位置を表します。
setFormula(formula: string) A1 スタイルの表記法を使用するグラフ タイトルの数式を表す文字列値を設定します。
showShadow グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。
textOrientation グラフタイトルのテキストの向きを指定します。
top グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。
verticalAlignment グラフ タイトルの垂直方向の配置を指定します。
width グラフ タイトルの幅をポイント単位で指定します。
ChartTitleFormat 境 色、線のスタイル、太さを含むグラフ タイトルの罫線の形式を表します。
ChartTrendline delete() trendline オブジェクトを削除します。
format グラフの近似曲線の書式設定を表します。
遮る 近似曲線の切片の値を表します。
movingAveragePeriod グラフの近似曲線の期間を表します。
name 近似曲線の名前を表します。
polynomialOrder グラフの近似曲線の順序を表します。
type グラフの近似曲線の種類を表します。
ChartTrendlineCollection add(type?: Excel.ChartTrendlineType) 近似曲線のコレクションに新しい近似曲線を追加します。
getCount() コレクションに含まれる近似曲線の数を返します。
getItem(index: number) インデックスによって近似曲線オブジェクトを取得します。これは、items 配列の挿入順序です。
items このコレクション内に読み込まれた子アイテムを取得します。
ChartTrendlineFormat line グラフの線の書式設定を表します。
CustomProperty delete() カスタム プロパティを削除します。
key カスタム プロパティのキー。
type カスタム プロパティに使用される値の型。
value カスタム プロパティの値を指定します。
CustomPropertyCollection add(key: string, value: any) 新しいカスタム プロパティを作成、または既存のカスタム プロパティを設定します。
deleteAll() このコレクション内のすべてのカスタム プロパティを削除します。
getCount() カスタム プロパティの数を取得します。
getItem(key: string) キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。
getItemOrNullObject(key: string) キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。
items このコレクション内に読み込まれた子アイテムを取得します。
DataConnectionCollection refreshAll() ピボットテーブルから Power BI データセット、データ モデルなど、コレクション内のデータ接続を同じブック内のテーブルまたは範囲に更新します。
DocumentProperties 著者 ブックの作成者。
カテゴリ ブックのカテゴリ。
comments ブックのメタデータの [コメント] フィールド。
company ブックの会社。
creationDate ブックの作成日を取得します。
カスタム ブックのカスタム プロパティのコレクションを取得します。
キーワード ブックのキーワード。
lastAuthor ブックの最後の作成者を取得します。
上司 ブックのマネージャー。
revisionNumber ブックのリビジョン番号を取得します。
subject ブックの件名。
title ブックのタイトル。
NamedItem arrayValues 名前付きアイテムの値と型を含むオブジェクトを返します。
formula 名前付き項目の数式。
NamedItemArrayValues types 名前付き項目配列内の各項目の型を表します
values 名前付きアイテムの配列に含まれる各アイテムの値を表します。読み取り専用。
Range getAbsoluteResizedRange(numRows: number, numColumns: number) 現在のRange オブジェクトと同じ左上のセルを持ち、指定した行数と列数を持つRange オブジェクトを取得します。
getImage() 範囲を Base64 でエンコードされた PNG イメージとしてレンダリングします。
getSurroundingRegion() この範囲内の左上のセルの周囲の領域を表す Range オブジェクトを返します。
hyperlink 現在の範囲のハイパーリンクを表します。
isEntireColumn 現在の範囲が列全体であるかどうかを表します。
isEntireRow 現在の範囲が行全体であるかどうかを表します。
numberFormatLocal ユーザーの言語設定に基づいて、指定した範囲の Excel の数値書式コードを表します。
showCard() アクティブ セルに多数の値が含まれる場合、そのセルのカードを表示します。
style 現在の範囲のスタイルを表します。
範囲の形式 textOrientation 範囲内のすべてのセルのテキストの向き。
useStandardHeight Range オブジェクトの行の高さがシートの標準の高さと等しいかどうかを判断します。
useStandardWidth Range オブジェクトの列幅がシートの標準幅と等しいかどうかを指定します。
RangeHyperlink address ハイパーリンクの URL ターゲットを表します。
documentReference ハイパーリンクのドキュメント参照先を表します。
screenTip ハイパーリンクの上にカーソルを合わせると表示される文字列を表します。
textToDisplay 該当する範囲内の左上端のセルに表示される文字列を表します。
スタイル borders 4 つの罫線のスタイルを表す 4 つの罫線オブジェクトのコレクション。
組み込み スタイルが組み込みスタイルかどうかを指定します。
delete() このスタイルを削除します。
fill スタイルの塗りつぶし。
font スタイルのフォントを表す Font オブジェクト。
formulaHidden ワークシートが保護されているときに数式を非表示にするかどうかを指定します。
horizontalAlignment スタイルでの水平方向の配置を表します。
includeAlignment スタイルに自動インデント、水平方向の配置、垂直方向の配置、テキストの折り返し、インデント レベル、およびテキストの向きのプロパティが含まれるかどうかを指定します。
includeBorder スタイルに色、色のインデックス、線のスタイル、太さの罫線のプロパティが含まれるかどうかを指定します。
includeFont スタイルに背景、太字、色、色インデックス、フォント スタイル、斜体、名前、サイズ、取り消し線、添字、上付き文字、下線の各フォント プロパティが含まれるかどうかを指定します。
includeNumber スタイルに数値書式プロパティを含めるかどうかを指定します。
includePatterns スタイルに色、色のインデックス、負の場合は反転、パターン、パターンの色、およびパターンの色インデックスの内部プロパティを含めるかどうかを指定します。
includeProtection スタイルに非表示の数式とロックされた保護プロパティを含めるかどうかを指定します。
indentLevel スタイルのインデント レベルを示す 0 から 250 の範囲内の整数。
locked ワークシートが保護されているときにオブジェクトがロックされているかどうかを指定します。
name スタイルの名前。
numberFormat スタイルで適用される数値形式の表示形式コード。
numberFormatLocal スタイルで適用される数値形式のローカライズされた表示形式コード。
readingOrder スタイルで適用される読み上げ順序。
shrinkToFit 使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。
verticalAlignment スタイルの垂直方向の配置を指定します。
wrapText Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
StyleCollection add(name: string) コレクションに新しいスタイルを追加します。
getItem(name: string) 名前で Style を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
表 onChanged セル内のデータが特定のテーブルで変更されたときに発生します。
onSelectionChanged 特定のテーブルで選択内容が変更されたときに発生します。
TableChangedEventArgs address 特定のワークシート上のテーブル内で変更されたエリアを表すアドレスを取得します。
changeType 変更されたイベントのトリガー方法を表す変更の種類を取得します。
source イベントのソースを取得します。
tableId データが変更されたテーブルの ID を取得します。
type イベントの種類を取得します。
worksheetId データが変更されたワークシートの ID を取得します。
TableCollection onChanged ブックまたはワークシート内の任意のテーブルでデータが変更されたときに発生します。
TableSelectionChangedEventArgs address 特定のワークシート上のテーブル内で選択されたエリアを表す範囲のアドレスを取得します。
isInsideTable 選択範囲がテーブル内にあるかどうかを指定します。
tableId 選択範囲が変更されたテーブルの ID を取得します。
type イベントの種類を取得します。
worksheetId 選択範囲が変更されたワークシートの ID を取得します。
ブック dataConnections ブック内のすべてのデータ接続を表します。
getActiveCell() ブックで現在アクティブなセルを取得します。
name ブックの名前を取得します。
プロパティ ブックのプロパティを取得します。
protection ブックの保護オブジェクトを返します。
スタイル ブックに関連付けられているスタイルのコレクションを表します。
WorkbookProtection protect(password?: string) ブックを保護します。
保護 ブックが保護されているかどうかを指定します。
unprotect(password?: string) ブックの保護を解除します。
ワークシート copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet) ワークシートをコピーし、指定した位置に配置します。
freezePanes ワークシート上の固定ウィンドウを操作するために使用できるオブジェクトを取得します。
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) 特定の行インデックスと列インデックスから始まり、特定の数の行と列にまたがる Range オブジェクトを取得します。
onActivated ワークシートがアクティブになったときに発生します。
onChanged 特定のワークシートでデータが変更されたときに発生します。
onDeactivated ワークシートが非アクティブ化されたときに発生します。
onSelectionChanged 特定のワークシートで選択内容が変更されたときに発生します。
standardHeight ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。
standardWidth ワークシート内のすべての列の標準 (既定) 幅を指定します。
tabColor ワークシートのタブの色。
WorksheetActivatedEventArgs type イベントの種類を取得します。
worksheetId アクティブ化されたワークシートの ID を取得します。
WorksheetAddedEventArgs source イベントのソースを取得します。
type イベントの種類を取得します。
worksheetId ブックに追加されるワークシートの ID を取得します。
WorksheetChangedEventArgs address 特定のワークシートで変更されたエリアを表す範囲のアドレスを取得します。
changeType 変更されたイベントのトリガー方法を表す変更の種類を取得します。
source イベントのソースを取得します。
type イベントの種類を取得します。
worksheetId データが変更されたワークシートの ID を取得します。
WorksheetCollection onActivated ブック内のワークシートがアクティブになると発生します。
onAdded ブックに新しいワークシートが追加されたときに発生します。
onDeactivated ブック内のワークシートが非アクティブ化されたときに発生します。
onDeleted ワークシートがブックから削除されたときに発生します。
WorksheetDeactivatedEventArgs type イベントの種類を取得します。
worksheetId 非アクティブ化されたワークシートの ID を取得します。
WorksheetDeletedEventArgs source イベントのソースを取得します。
type イベントの種類を取得します。
worksheetId ブックから削除されたワークシートの ID を取得します。
WorksheetFreezePanes freezeAt(frozenRange: Range | string) アクティブなワークシート ビューに固定セルを設定します。
freezeColumns(count?: number) ワークシートの最初の列または列を固定します。
freezeRows(count?: number) ワークシートの一番上の行を固定します。
getLocation() アクティブなワークシート ビュー内の固定セルを記述する範囲を取得します。
getLocationOrNullObject() アクティブなワークシート ビュー内の固定セルを記述する範囲を取得します。
unfreeze() ワークシートからすべての固定ウィンドウを削除します。
WorksheetProtection unprotect(password?: string) ワークシートの保護を解除します。
WorksheetProtectionOptions allowEditObjects オブジェクトの編集を許可するワークシート保護オプションを表します。
allowEditScenarios シナリオの編集を許可するワークシート保護オプションを表します。
selectionMode 選択モードのワークシート保護オプションを表します。
WorksheetSelectionChangedEventArgs address 特定のワークシートで選択されたエリアを表す範囲のアドレスを取得します。
type イベントの種類を取得します。
worksheetId 選択範囲が変更されたワークシートの ID を取得します。

関連項目