Excel JavaScript API 1.4 の新機能What's new in Excel JavaScript API 1.4

要件セット 1.4 の Excel JavaScript API に新たに追加された機能は次のとおりです。The following are the new additions to the Excel JavaScript APIs in requirement set 1.4.

名前付きアイテムの追加と新しいプロパティNamed item add and new properties

新しいプロパティ:New properties:

  • comment
  • scope-ワークシートまたはブックを対象範囲とするアイテム。scope - Worksheet or workbook scoped items.
  • worksheet-名前付きアイテムのスコープが設定されているワークシートを返します。worksheet - Returns the worksheet on which the named item is scoped to.

新しいメソッド:New methods:

  • add(name: string, reference: Range or string, comment: string)-指定したスコープのコレクションに新しい名前を追加します。add(name: string, reference: Range or string, comment: string) - Adds a new name to the collection of the given scope.
  • addFormulaLocal(name: string, formula: string, comment: string)-式のユーザーのロケールを使用して、指定したスコープのコレクションに新しい名前を追加します。addFormulaLocal(name: string, formula: string, comment: string) - Adds a new name to the collection of the given scope using the user's locale for the formula.

Excel 名前空間内の Setting APISettings API in the Excel namespace

Setting オブジェクトは、ドキュメントに永続的に適用される設定のキーと値のペアを表します。The Setting object represents a key:value pair for a setting persisted to the document. Excel.Setting の機能は Office.Settings と同等ですが、共通 API のコールバック モデルではなくバッチ API 構文を使用します。The functionality of Excel.Setting is equivalent to Office.Settings, but uses the batched API syntax, rather than the Common API's callback model.

Api はgetItem() 、キーを使用して設定エントリadd()を取得し、指定されたキー: 値の設定のペアをブックに追加するために含まれます。APIs include getItem() to get setting entry via the key and add() to add the specified key:value setting pair to the workbook.

その他Others

  • 表の列名を設定します。Set the table column name.
  • 表の列を表の末尾に追加します。Add a table column to the end of the table.
  • 一度に複数の行をテーブルに追加します。Add multiple rows to a table at a time.
  • range.getColumnsAfter(count: number) および range.getColumnsBefore(count: number) を使用して、現在の Range オブジェクトの左右にある特定の数の列を取得します。range.getColumnsAfter(count: number) and range.getColumnsBefore(count: number) to get a certain number of columns to the right/left of the current Range object.
  • Get item または null オブジェクト関数: この機能は、キーを使用してオブジェクトを取得することを可能にします。The get item or null object function: This functionality allows getting object using a key. オブジェクトが存在しない場合、返されるオブジェクトのisNullObjectプロパティは true になります。If the object does not exist, the returned object's isNullObject property will be true. これにより、開発者は、オブジェクトが存在するかどうかを確認することができます。ただし、例外処理によって処理する必要はありません。This allows developers to check if an object exists or not without having to handle it through exception handling. この*OrNullObjectメソッドは、ほとんどのコレクションオブジェクトで使用できます。The *OrNullObject method is available on most collection objects.
worksheet.getItemOrNullObject("itemName")

API リストAPI list

次の表に、Excel JavaScript API 要件セット1.4 の Api を示します。The following table lists the APIs in Excel JavaScript API requirement set 1.4. Excel JavaScript API 要件セット1.4 またはそれ以前でサポートされているすべての Api の API リファレンスドキュメントを表示するには、「要件セット1.4 またはそれ以前の Excel api」を参照してください。To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.4 or earlier, see Excel APIs in requirement set 1.4 or earlier.

クラスClass フィールドFields 説明Description
BindingCollectionBindingCollection getCount()getCount() コレクションに含まれるバインドの数を取得します。Gets the number of bindings in the collection.
getItemOrNullObject(id: string)getItemOrNullObject(id: string) ID によってバインド オブジェクトを取得します。Gets a binding object by ID. バインディング オブジェクトが存在しない場合は null オブジェクトを返します。If the binding object does not exist, will return a null object.
ChartCollectionChartCollection getCount()getCount() ワークシート上のグラフの数を返します。Returns the number of charts in the worksheet.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) グラフ名を使用してグラフを取得します。Gets a chart using its name. 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。If there are multiple charts with the same name, the first one will be returned.
ChartPointsCollectionChartPointsCollection getCount()getCount() 系列に含まれるグラフのポイントの数を返します。Returns the number of chart points in the series.
ChartSeriesCollectionChartSeriesCollection getCount()getCount() コレクションに含まれるデータ系列の数を返します。Returns the number of series in the collection.
NamedItemNamedItem commentcomment この名前に関連付けられているコメントを表します。Represents the comment associated with this name.
delete()delete() 指定された名前を削除します。Deletes the given name.
getRangeOrNullObject()getRangeOrNullObject() 名前に関連付けられている範囲オブジェクトを返します。Returns the range object that is associated with the name. 名前付きアイテムの型が範囲でない場合は、null オブジェクトを返します。Returns a null object if the named item's type is not a range.
scopescope ブックまたは特定のワークシートに対して名前のスコープを設定するかどうかを示します。Indicates whether the name is scoped to the workbook or to a specific worksheet. 可能な値は次のとおりです。ワークシート、ブック。Possible values are: Worksheet, Workbook. 読み取り専用です。Read-only.
worksheetworksheet 名前付きのアイテムの対象になるワークシートを返します。Returns the worksheet on which the named item is scoped to. アイテムのスコープがブックに設定されている場合は、エラーをスローします。Throws an error if the item is scoped to the workbook instead.
worksheetOrNullObjectworksheetOrNullObject 名前付きのアイテムの対象になるワークシートを返します。Returns the worksheet on which the named item is scoped to. アイテムがブックを対象にしている場合は、null オブジェクトを返します。Returns a null object if the item is scoped to the workbook instead.
NamedItemCollectionNamedItemCollection add (name: string, reference: Range | string, comment?: string)add(name: string, reference: Range | string, comment?: string) 指定のスコープのコレクションに新しい名前を追加します。Adds a new name to the collection of the given scope.
addFormulaLocal (name: string, formula: string, comment?: string)addFormulaLocal(name: string, formula: string, comment?: string) ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。Adds a new name to the collection of the given scope using the user's locale for the formula.
getCount()getCount() コレクションに含まれる名前付きアイテムの数を取得します。Gets the number of named items in the collection.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) 名前を使用して、NamedItem オブジェクトを取得します。Gets a NamedItem object using its name. nameditem オブジェクトが存在しない場合は null オブジェクトを返します。If the nameditem object does not exist, will return a null object.
PivotTableCollectionPivotTableCollection getCount()getCount() コレクションに含まれるピボット テーブルの数を取得します。Gets the number of pivot tables in the collection.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) 名前を使用してピボットテーブルを取得します。Gets a PivotTable by name. PivotTable が存在しない場合は null オブジェクトを返します。If the PivotTable does not exist, will return a null object.
RangeRange getIntersectionOrNullObject (anotherRange: Range |文字列)getIntersectionOrNullObject(anotherRange: Range | string) 指定した範囲の長方形の交差を表す範囲オブジェクトを取得します。Gets the range object that represents the rectangular intersection of the given ranges. 交差部分が見つからない場合は、null オブジェクトを返します。If no intersection is found, will return a null object.
getUsedRangeOrNullObject (パラメーターの設定のみ?: boolean)getUsedRangeOrNullObject(valuesOnly?: boolean) 指定した範囲オブジェクトのうち使用されている範囲を返します。範囲内に使用済みのセルがない場合、この関数は null オブジェクトを返します。Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.
RangeViewCollectionRangeViewCollection getCount()getCount() コレクションに含まれる RangeView オブジェクトの数を取得します。Gets the number of RangeView objects in the collection.
設定Setting delete()delete() 設定を削除します。Deletes the setting.
keykey Setting の ID を表すキーを返します。Returns the key that represents the id of the Setting. 読み取り専用です。Read-only.
valuevalue この設定に格納されている値を表します。Represents the value stored for this setting.
SettingCollectionSettingCollection add (key: string, value: string | number | boolean | Date | Array | any)add(key: string, value: string | number | boolean | Date | Array | any) 指定した設定をブックに設定または追加します。Sets or adds the specified setting to the workbook.
getCount()getCount() コレクションに含まれる設定の数を取得します。Gets the number of Settings in the collection.
getItem(key: string)getItem(key: string) キーに基づいて設定エントリを取得します。Gets a Setting entry via the key.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) キーから Setting エントリを取得します。Gets a Setting entry via the key. Setting が存在しない場合は null オブジェクトを返します。If the Setting does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
onSettingsChangedonSettingsChanged ドキュメント内の設定が変更されるときに発生します。Occurs when the Settings in the document are changed.
SettingsChangedEventArgsSettingsChangedEventArgs 設定settings SettingsChanged イベントが発生したバインドを表す Setting オブジェクトを取得します。Gets the Setting object that represents the binding that raised the SettingsChanged event
TableCollectionTableCollection getCount()getCount() コレクションに含まれるテーブルの数を取得します。Gets the number of tables in the collection.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) 名前または ID でテーブルを取得します。Gets a table by Name or ID. テーブルが存在しない場合は null オブジェクトを返します。If the table does not exist, will return a null object.
TableColumnCollectionTableColumnCollection getCount()getCount() 表の列数を取得します。Gets the number of columns in the table.
getItemOrNullObject (key: number |文字列)getItemOrNullObject(key: number | string) 名前または ID によって、列オブジェクトを取得します。Gets a column object by Name or ID. 列が存在しない場合は null オブジェクトを返します。If the column does not exist, will return a null object.
TableRowCollectionTableRowCollection getCount()getCount() 表の行数を取得します。Gets the number of rows in the table.
WorkbookWorkbook 設定settings ブックに関連付けられている Setting のコレクションを表します。Represents a collection of Settings associated with the workbook. 読み取り専用です。Read-only.
WorksheetWorksheet getUsedRangeOrNullObject (パラメーターの設定のみ?: boolean)getUsedRangeOrNullObject(valuesOnly?: boolean) 使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。ワークシート全体が空白の場合、この関数は null オブジェクトを返します。The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return a null object.
姓名names 現在のワークシートにスコープされている名前のコレクション。Collection of names scoped to the current worksheet. 読み取り専用です。Read-only.
WorksheetCollectionWorksheetCollection getCount (visibleOnly?: boolean)getCount(visibleOnly?: boolean) コレクションに含まれるワークシートの数を取得します。Gets the number of worksheets in the collection.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) 名前または ID を使用して、ワークシート オブジェクトを取得します。Gets a worksheet object using its Name or ID. ワークシートが存在しない場合は null オブジェクトを返します。If the worksheet does not exist, will return a null object.

関連項目See also