Excel JavaScript プレビュー APIExcel JavaScript preview APIs

新しい Excel JavaScript API は最初に "プレビュー" で導入され、その後、十分なテストが行われ、ユーザー フィードバックが得られてから、番号付きの特定の要件セットの一部になります。New Excel JavaScript APIs are first introduced in "preview" and later become part of a specific, numbered requirement set after sufficient testing occurs and user feedback is acquired.

最初の表には API が簡潔にまとめられています。その後の表は詳しい一覧になっています。The first table provides a concise summary of the APIs, while the subsequent table gives a detailed list.

注意

プレビュー API は変更されることがあります。運用環境での使用は意図されていません。Preview APIs are subject to change and are not intended for use in a production environment. 試用はテスト環境と開発環境に限定することをお勧めします。We recommend that you try them out in test and development environments only. 運用環境やビジネス上重要なドキュメントでプレビュー API を使用しないでください。Do not use preview APIs in a production environment or within business-critical documents.

プレビュー Api を使用するには:To use preview APIs:

  • CDN のベータ版ライブラリを参照する必要がhttps://appsforoffice.microsoft.com/lib/beta/hosted/office.js)あります (。You must reference the beta library on the CDN (https://appsforoffice.microsoft.com/lib/beta/hosted/office.js). TypeScript のコンパイルおよび IntelliSense 用の型定義ファイルは、CDN と、定義された定義ファイルにあります。The type definition file for TypeScript compilation and IntelliSense is found at the CDN and DefinitelyTyped. これらの種類は、でnpm install --save-dev @types/office-js-previewインストールできます。You can install these types with npm install --save-dev @types/office-js-preview.
  • より新しい Office ビルドにアクセスするには、 Office Insider プログラムに参加する必要がある場合があります。You may need to join the Office Insider program for access to more recent Office builds.
機能領域Feature area 説明Description 関連オブジェクトRelevant objects
スライサーSlicer テーブルやピボットテーブルにスライサーを挿入し、構成します。Insert and configure slicers to tables and PivotTables. SlicerSlicer
コメントComments コメントを追加、編集、削除します。Add, edit, and delete comments. CommentCommentCollectionComment, CommentCollection
ブックを保存して閉じるWorkbook Save and Close ブックを保存して閉じます。Save and close workbooks. WorkbookWorkbook
ブックを挿入するInsert Workbook あるブックを別のブックに挿入します。Insert one workbook into another. WorkbookWorkbook

API リストAPI list

次の表に、現在プレビュー中の Excel JavaScript Api を示します。The following table lists the Excel JavaScript APIs currently in preview. すべての Excel JavaScript Api (プレビュー Api および以前リリースされた Api を含む) の完全なリストを表示するには、「すべての Excel Javascript api」を参照してください。To see a complete list of all Excel JavaScript APIs (including preview APIs and previously released APIs), see all Excel JavaScript APIs.

クラスClass フィールドFields 説明Description
CommentComment contentcontent コメントの内容を取得または設定します。Gets or sets the comment's content. 文字列はテキスト形式です。The string is plain text.
delete()delete() コメントと、接続されているすべての返信を削除します。Deletes the comment and all the connected replies.
getLocation()getLocation() このコメントが配置されているセルを取得します。Gets the cell where this comment is located.
authorEmailauthorEmail コメント作成者のメール アドレスを取得します。Gets the email of the comment's author.
authorNameauthorName コメント作成者の名前を取得します。Gets the name of the comment's author.
creationDatecreationDate コメントの作成日時を取得します。Gets the creation time of the comment. コメントがメモから変換されている場合、コメントには作成日時がないため、null が返されます。Returns null if the comment was converted from a note, since the comment does not have a creation date.
idid コメント ID を表します。Represents the comment identifier. 読み取り専用です。Read-only.
mentionsmentions コメントに記載されているエンティティ (人物など) を取得します。Gets the entities (e.g. people) that are mentioned in comments.
repliesreplies コメントに関連付けられている返信オブジェクトのコレクションを表します。Represents a collection of reply objects associated with the comment. 読み取り専用です。Read-only.
richContentrichContent リッチコメントの内容 (コメントに含まれるメンションなど) を取得します。Gets the rich comment content (e.g. mentions in comments). この文字列は、エンドユーザーに表示されることを意図したものではありません。This string is not meant to be displayed to end-users. アドインでは、リッチコメントコンテンツを解析するためにのみ使用する必要があります。Your add-in should only use this to parse rich comment content.
解析resolved コメントスレッドの状態を取得または設定します。Gets or sets the comment thread status. 値 "true" は、コメントスレッドが解決された状態であることを意味します。A value of "true" means the comment thread is in the resolved state.
updateMentions (contentWithMentions ション: CommentRichContent)updateMentions(contentWithMentions: Excel.CommentRichContent) 特別に書式設定された文字列とメンションの一覧を使用して、コメントの内容を更新します。Updates the comment content with a specially formatted string and a list of mentions.
CommentCollectionCommentCollection add (cellAddress: Range | string, Content: CommentRichContent | string, contenttype?: Excel)add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType) 指定したセルで、指定した内容の新しいコメントを作成します。Creates a new comment with the given content on the given cell. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.
getCount()getCount() コレクションに含まれるコメントの数を取得します。Gets the number of comments in the collection.
getItem(commentId: string)getItem(commentId: string) ID に基づいてコレクションからコメントを取得します。Gets a comment from the collection based on its ID. 読み取り専用です。Read-only.
getItemAt(index: number)getItemAt(index: number) 位置に基づいてコレクションからコメントを取得します。Gets a comment from the collection based on its position.
getItemByCell(cellAddress: Range | string)getItemByCell(cellAddress: Range | string) 指定したセルからコメントを取得します。Gets the comment from the specified cell.
getItemByReplyId(replyId: string)getItemByReplyId(replyId: string) 指定した返信が接続されているコメントを取得します。Gets the comment to which the given reply is connected.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
コメントについてCommentMention emailemail コメントで言及されているエンティティの電子メールアドレスを取得または設定します。Gets or sets the email address of the entity that is mentioned in comment.
idid エンティティの id を取得または設定します。Gets or sets the id of the entity. これは、のCommentRichContent.richContentid 情報に合わせて配置されます。This is aligned with the id information in CommentRichContent.richContent.
namename コメントで言及されているエンティティの名前を取得または設定します。Gets or sets the name of the entity that is mentioned in comment.
CommentReplyCommentReply contentcontent コメント返信の内容を取得または設定します。Gets or sets the comment reply's content. 文字列はテキスト形式です。The string is plain text.
delete()delete() コメント返信を削除します。Deletes the comment reply.
getLocation()getLocation() このコメントの返信があるセルを取得します。Gets the cell where this comment reply is located.
getParentComment()getParentComment() この返信の親コメントを取得します。Gets the parent comment of this reply.
authorEmailauthorEmail コメント返信作成者のメール アドレスを取得します。Gets the email of the comment reply's author.
authorNameauthorName コメント返信作成者の名前を取得します。Gets the name of the comment reply's author.
creationDatecreationDate コメント返信の作成日時を取得します。Gets the creation time of the comment reply.
idid コメント返信 ID を表します。Represents the comment reply identifier. 読み取り専用です。Read-only.
mentionsmentions コメントに記載されているエンティティ (人物など) を取得します。Gets the entities (e.g. people) that are mentioned in comments.
解析resolved コメントの返信状態を取得または設定します。Gets or sets the comment reply status. 値 "true" は、コメント応答が解決された状態であることを意味します。A value of "true" means the comment reply is in the resolved state.
richContentrichContent リッチコメントの内容 (コメントに含まれるメンションなど) を取得します。Gets the rich comment content (e.g. mentions in comments). この文字列は、エンドユーザーに表示されることを意図したものではありません。This string is not meant to be displayed to end-users. アドインでは、リッチコメントコンテンツを解析するためにのみ使用する必要があります。Your add-in should only use this to parse rich comment content.
updateMentions (contentWithMentions ション: CommentRichContent)updateMentions(contentWithMentions: Excel.CommentRichContent) 特別に書式設定された文字列とメンションの一覧を使用して、コメントの内容を更新します。Updates the comment content with a specially formatted string and a list of mentions.
CommentReplyCollectionCommentReplyCollection add (content: CommentRichContent | String, contenttype?: Excel)add(content: CommentRichContent | string, contentType?: Excel.ContentType) コメントのコメント返信を作成します。Creates a comment reply for comment.
getCount()getCount() コレクションのコメント返信数を取得します。Gets the number of comment replies in the collection.
getItem(commentReplyId: string)getItem(commentReplyId: string) その ID で識別されるコメント返信を返します。Returns a comment reply identified by its ID. 読み取り専用です。Read-only.
getItemAt(index: number)getItemAt(index: number) コレクション内の位置に基づいてコメント返信を取得します。Gets a comment reply based on its position in the collection.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
CommentRichContentCommentRichContent mentionsmentions コメント内で記述されているすべてのエンティティ (人物など) を含む配列。An array containing all the entities (e.g. people) mentioned within the comment.
richContentrichContent
PivotLayoutPivotLayout enableFieldListenableFieldList フィールド リストを UI に表示できるかどうかを指定します。Specifies whether the field list can be shown in the UI.
getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>)getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>) データ階層と、それぞれの階層の行および列の項目に基づいて、ピボットテーブル内の一意のセルを取得します。 Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies. 返されるセルは、指定した階層のデータが含まれる、指定された行と列の交差部分です。 The returned cell is the intersection of the given row and column that contains the data from the given hierarchy. このメソッドは、特定のセルでの getPivotItems および getDataHierarchy の呼び出しを逆にしたものです。This method is the inverse of calling getPivotItems and getDataHierarchy on a particular cell.
PivotTableStylePivotTableStyle delete()delete() PivotTableStyle を削除します。Deletes the PivotTableStyle.
duplicate()duplicate() すべてのスタイル要素のコピーでこの PivotTableStyle の複製を作成します。Creates a duplicate of this PivotTableStyle with copies of all the style elements.
namename PivotTableStyle の名前を取得します。Gets the name of the PivotTableStyle.
readOnlyreadOnly この PivotTableStyle オブジェクトが読み取り専用であるかどうかを指定します。Specifies whether this PivotTableStyle object is read-only. 読み取り専用です。Read-only.
PivotTableStyleCollectionPivotTableStyleCollection add(name: string, makeUniqueName?: boolean)add(name: string, makeUniqueName?: boolean) 指定された名前で空の PivotTableStyle を作成します。Creates a blank PivotTableStyle with the specified name.
getCount()getCount() コレクションに含まれる PivotTableStyle の数を取得します。Gets the number of PivotTable styles in the collection.
getDefault()getDefault() 親オブジェクトのスコープに対する既定の PivotTableStyle を取得します。Gets the default PivotTableStyle for the parent object's scope.
getItem(name: string)getItem(name: string) 名前に基づいて PivotTableStyle を取得します。Gets a PivotTableStyle by name.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) 名前に基づいて PivotTableStyle を取得します。Gets a PivotTableStyle by name. PivotTableStyle が存在しない場合は、null オブジェクトを返します。If the PivotTableStyle does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
setDefault(newDefaultStyle: PivotTableStyle | string)setDefault(newDefaultStyle: PivotTableStyle | string) 親オブジェクトのスコープで使用する既定の PivotTableStyle を設定します。Sets the default PivotTableStyle for use in the parent object's scope.
RangeRange getSpillParent()getSpillParent() スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。Gets the range object containing the anchor cell for a cell getting spilled into. 複数のセルを含む範囲に適用される場合は失敗します。Fails if applied to a range with more than one cell. 読み取り専用です。Read-only.
getSpillParentOrNullObject()getSpillParentOrNullObject() スピルするセルのアンカー セルを含む範囲オブジェクトを取得します。Gets the range object containing the anchor cell for a cell getting spilled into. 読み取り専用です。Read-only.
getSpillingToRange()getSpillingToRange() アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。Gets the range object containing the spill range when called on an anchor cell. 複数のセルを含む範囲に適用される場合は失敗します。Fails if applied to a range with more than one cell. 読み取り専用です。Read-only.
getSpillingToRangeOrNullObject()getSpillingToRangeOrNullObject() アンカー セルで呼び出されたとき、スピル範囲を含む範囲オブジェクトを取得します。Gets the range object containing the spill range when called on an anchor cell. 読み取り専用です。Read-only.
group (groupOption: Excel. groupoptiongroup(groupOption: Excel.GroupOption) アウトラインの列と行をグループ化します。Groups columns and rows for an outline.
hideGroupDetails (groupopoff: Excel. groupopoff)hideGroupDetails(groupOption: Excel.GroupOption) 行または列グループの詳細を非表示にします。Hide details of the row or column group.
hasSpillhasSpill すべてのセルにスピル ボーダーがあるかどうかを表します。Represents if all cells have a spill border.
heightheight 100% ズームの場合の、範囲の上端から範囲の下端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. 読み取り専用です。Read-only.
leftleft 100% ズームの場合の、ワークシートの左端から範囲の左端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. 読み取り専用です。Read-only.
savedAsArraysavedAsArray すべてのセルが配列数式として保存されるかどうかを表します。Represents if ALL the cells would be saved as an array formula.
toptop 100% ズームの場合の、ワークシートの上端から範囲の上端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. 読み取り専用です。Read-only.
widthwidth 100% ズームの場合の、範囲の左端から範囲の右端までの距離を、ポイント単位で返します。 Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. 読み取り専用です。Read-only.
showGroupDetails (groupopoff: Excel. groupopoff)showGroupDetails(groupOption: Excel.GroupOption) 行または列グループの詳細を表示します。Show details of the row or column group.
グループ解除 (groupOption: Excel. groupoptionungroup(groupOption: Excel.GroupOption) アウトラインの列と行のグループ化を解除します。Ungroups columns and rows for an outline.
RangeFormatRangeFormat adjustIndent (金額: 数値)adjustIndent(amount: number) 範囲の書式のインデントを調整します。Adjusts the indentation of the range formatting. インデントの値の範囲は 0 ~ 250 です。The indent value ranges from 0 to 250.
ShapeShape copyTo(destinationSheet?: Worksheet | string)copyTo(destinationSheet?: Worksheet | string) Shape オブジェクトをコピーして貼り付けます。Copies and pastes a Shape object.
placementplacement オブジェクトがその下のセルに接続されている方法を表します。Represents how the object is attached to the cells below it.
ShapeCollectionShapeCollection addSvg(xml: string)addSvg(xml: string) XML 文字列からスケーラブルなベクター グラフィックス (SVG) を作成し、それをワークシートに追加します。Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet. 新しい画像を表す Shape オブジェクトを返します。Returns a Shape object that represents the new image.
SlicerSlicer captioncaption スライサーのキャプションを表します。Represents the caption of slicer.
clearFilters()clearFilters() 現在スライサーに適用されているすべてのフィルターを消去します。Clears all the filters currently applied on the slicer.
delete()delete() スライサーを削除します。Deletes the slicer.
getSelectedItems()getSelectedItems() 選択されたアイテムのキーの配列を返します。Returns an array of selected items' keys. 読み取り専用です。Read-only.
heightheight スライサーの高さ (ポイント数) を表します。Represents the height, in points, of the slicer.
leftleft スライサーの左側からワークシートの左までの距離を表します (ポイント数)。Represents the distance, in points, from the left side of the slicer to the left of the worksheet.
namename スライサーの名前を表します。Represents the name of slicer.
nameInFormulanameInFormula 数式で使用するスライサーの名前を表します。Represents the slicer name used in the formula.
idid スライサーの一意の ID を表します。Represents the unique id of slicer. 読み取り専用です。Read-only.
isFilterClearedisFilterCleared スライサーに現在適用されているフィルターがすべて消去されている場合、true となります。True if all filters currently applied on the slicer are cleared.
slicerItemsslicerItems スライサーに含まれる SlicerItems のコレクションを表します。Represents the collection of SlicerItems that are part of the slicer. 読み取り専用です。Read-only.
worksheetworksheet スライサーを含んでいるワークシートを表します。Represents the worksheet containing the slicer. 読み取り専用です。Read-only.
selectItems(items?: string[])selectItems(items?: string[]) キーに基づいてスライサーアイテムを選択します。Selects slicer items based on their keys. 以前の選択はクリアされます。The previous selections are cleared.
sortBysortBy スライサーに含まれるアイテムの並べ替え順序を表します。Represents the sort order of the items in the slicer. 可能な値は、"DataSourceOrder"、"昇順"、"降順" です。Possible values are: "DataSourceOrder", "Ascending", "Descending".
stylestyle スライサー スタイルを表す定数値。Constant value that represents the Slicer style. 可能な値は次のとおりです。 "SlicerStyleLight1" は "SlicerStyleLight6"、"TableStyleOther1" ~ "TableStyleOther2"、"SlicerStyleDark1" ~ "SlicerStyleDark6" です。Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". ブックに存在するカスタムのユーザー定義スタイルも指定できます。A custom user-defined style present in the workbook can also be specified.
toptop スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.
widthwidth スライサーの幅 (ポイント数) を表します。Represents the width, in points, of the slicer.
SlicerCollectionSlicerCollection add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet)add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet) ブックに新しいスライサーを追加します。Adds a new slicer to the workbook.
getCount()getCount() コレクションに含まれるスライサーの数を返します。Returns the number of slicers in the collection.
getItem(key: string)getItem(key: string) 名前または ID を使用してスライサー オブジェクトを取得します。Gets a slicer object using its name or id.
getItemAt(index: number)getItemAt(index: number) コレクション内の位置に基づいてスライサーを取得します。Gets a slicer based on its position in the collection.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) 名前または ID に基づいてスライサーを取得します。スライサーが存在しない場合は null オブジェクトを返します。Gets a slicer using its name or id. If the slicer does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
SlicerItemSlicerItem isSelectedisSelected スライサー アイテムが選択されている場合、true となります。True if the slicer item is selected.
hasDatahasData スライサー アイテムにデータが含まれている場合、true となります。True if the slicer item has data.
keykey スライサー アイテムを表す一意の値を表します。Represents the unique value representing the slicer item.
namename UI に表示されるタイトルを表します。Represents the title displayed in the UI.
SlicerItemCollectionSlicerItemCollection getCount()getCount() スライサーのスライサー アイテム数を返します。Returns the number of slicer items in the slicer.
getItem(key: string)getItem(key: string) そのキーまたは名前を利用してスライサー アイテム オブジェクトを取得します。Gets a slicer item object using its key or name.
getItemAt(index: number)getItemAt(index: number) コレクション内の位置に基づいてスライサー アイテムを取得します。Gets a slicer item based on its position in the collection.
getItemOrNullObject(key: string)getItemOrNullObject(key: string) そのキーまたは名前を使用してスライサー アイテムを取得します。Gets a slicer item using its key or name. スライサー アイテムが存在しない場合は null オブジェクトを返します。If the slicer item does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
SlicerStyleSlicerStyle delete()delete() SlicerStyle を削除します。Deletes the SlicerStyle.
duplicate()duplicate() すべてのスタイル要素のコピーでこの SlicerStyle の複製を作成します。Creates a duplicate of this SlicerStyle with copies of all the style elements.
namename SlicerStyle の名前を取得します。Gets the name of the SlicerStyle.
readOnlyreadOnly この SlicerStyle オブジェクトが読み取り専用であるかどうかを指定します。Specifies whether this SlicerStyle object is read-only. 読み取り専用です。Read-only.
SlicerStyleCollectionSlicerStyleCollection add(name: string, makeUniqueName?: boolean)add(name: string, makeUniqueName?: boolean) 指定された名前で空の SlicerStyle を作成します。Creates a blank SlicerStyle with the specified name.
getCount()getCount() コレクション内のスライサー スタイルの数を取得します。Gets the number of slicer styles in the collection.
getDefault()getDefault() 親オブジェクトのスコープに対する既定の SlicerStyle を取得します。Gets the default SlicerStyle for the parent object's scope.
getItem(name: string)getItem(name: string) 名前で SlicerStyle を取得します。Gets a SlicerStyle by name.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) 名前で SlicerStyle を取得します。Gets a SlicerStyle by name. SlicerStyle が存在しない場合は、null オブジェクトを返します。If the SlicerStyle does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
setDefault(newDefaultStyle: SlicerStyle | string)setDefault(newDefaultStyle: SlicerStyle | string) 親オブジェクトのスコープで使用する既定の SlicerStyle を設定します。Sets the default SlicerStyle for use in the parent object's scope.
TableTable clearStyle()clearStyle() 既定のテーブル スタイルを使用するようにテーブルを変更します。Changes the table to use the default table style.
onFilteredonFiltered フィルターが特定のテーブルに適用されたときに発生します。Occurs when filter is applied on a specific table.
TableCollectionTableCollection onFilteredonFiltered ブックまたはワークシートのテーブルにフィルターが適用されたときに発生します。Occurs when filter is applied on any table in a workbook, or a worksheet.
TableFilteredEventArgsTableFilteredEventArgs tableIdtableId フィルターが適用されているテーブルの id を表します。Represents the id of the table in which the filter is applied.
typetype イベントの種類を表します。Represents the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.
worksheetIdworksheetId テーブルが含まれるワークシートの ID を表します。Represents the id of the worksheet which contains the table.
TableStyleTableStyle delete()delete() TableStyle を削除します。Deletes the TableStyle.
duplicate()duplicate() すべてのスタイル要素のコピーでこの TableStyle の複製を作成します。Creates a duplicate of this TableStyle with copies of all the style elements.
namename TableStyle の名前を取得します。Gets the name of the TableStyle.
readOnlyreadOnly この TableStyle オブジェクトが読み取り専用であるかどうかを指定します。Specifies whether this TableStyle object is read-only. 読み取り専用です。Read-only.
TableStyleCollectionTableStyleCollection add(name: string, makeUniqueName?: boolean)add(name: string, makeUniqueName?: boolean) 指定された名前で空の TableStyle を作成します。Creates a blank TableStyle with the specified name.
getCount()getCount() コレクションに含まれるテーブル スタイルの数を取得します。Gets the number of table styles in the collection.
getDefault()getDefault() 親オブジェクトのスコープに対する既定の TableStyle を取得します。Gets the default TableStyle for the parent object's scope.
getItem(name: string)getItem(name: string) 名前で TableStyle を取得します。Gets a TableStyle by name.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) 名前で TableStyle を取得します。Gets a TableStyle by name. TableStyle が存在しない場合は、null オブジェクトを返します。If the TableStyle does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
setDefault(newDefaultStyle: TableStyle | string)setDefault(newDefaultStyle: TableStyle | string) 親オブジェクトのスコープで使用する既定の TableStyle を設定します。Sets the default TableStyle for use in the parent object's scope.
TimelineStyleTimelineStyle delete()delete() TableStyle を削除します。Deletes the TableStyle.
duplicate()duplicate() すべてのスタイル要素のコピーでこの TimelineStyle の複製を作成します。Creates a duplicate of this TimelineStyle with copies of all the style elements.
namename TimelineStyle の名前を取得します。Gets the name of the TimelineStyle.
readOnlyreadOnly この TimelineStyle オブジェクトが読み取り専用であるかどうかを指定します。Specifies whether this TimelineStyle object is read-only. 読み取り専用です。Read-only.
TimelineStyleCollectionTimelineStyleCollection add(name: string, makeUniqueName?: boolean)add(name: string, makeUniqueName?: boolean) 指定された名前で空の TimelineStyle を作成します。Creates a blank TimelineStyle with the specified name.
getCount()getCount() コレクションに含まれるタイムライン スタイルの数を取得します。Gets the number of timeline styles in the collection.
getDefault()getDefault() 親オブジェクトのスコープに対する既定の TimelineStyle を取得します。Gets the default TimelineStyle for the parent object's scope.
getItem(name: string)getItem(name: string) 名前で TimelineStyle を取得します。Gets a TimelineStyle by name.
getItemOrNullObject(name: string)getItemOrNullObject(name: string) 名前で TimelineStyle を取得します。Gets a TimelineStyle by name. TimelineStyle が存在しない場合は、null オブジェクトを返します。If the TimelineStyle does not exist, will return a null object.
itemsitems このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.
setDefault(newDefaultStyle: TimelineStyle | string)setDefault(newDefaultStyle: TimelineStyle | string) 親オブジェクトのスコープで使用する既定の TimelineStyle を設定します。Sets the default TimelineStyle for use in the parent object's scope.
WorkbookWorkbook close(closeBehavior?: Excel.CloseBehavior)close(closeBehavior?: Excel.CloseBehavior) 現在のブックを閉じます。Close current workbook.
getActiveSlicer()getActiveSlicer() ブックで現在アクティブになっているスライサーを取得します。Gets the currently active slicer in the workbook. アクティブなスライサーがない場合は、 ItemNotFound例外がスローされます。If there is no active slicer, an ItemNotFound exception is thrown.
getActiveSlicerOrNullObject()getActiveSlicerOrNullObject() ブックで現在アクティブになっているスライサーを取得します。Gets the currently active slicer in the workbook. アクティブになっているスライサーがない場合、null オブジェクトが返されます。If there is no active slicer, a null object is returned.
commentscomments ブックに関連付けられているコメントの集まりを表します。Represents a collection of Comments associated with the workbook. 読み取り専用です。Read-only.
pivotTableStylespivotTableStyles ブックに関連付けられている PivotTableStyle のコレクションを表します。Represents a collection of PivotTableStyles associated with the workbook. 読み取り専用です。Read-only.
slicerStylesslicerStyles ブックに関連付けられている SlicerStyle のコレクションを表します。Represents a collection of SlicerStyles associated with the workbook. 読み取り専用です。Read-only.
slicersslicers ブックに関連付けられているスライサーの集まりを表します。Represents a collection of Slicers associated with the workbook. 読み取り専用です。Read-only.
tableStylestableStyles ブックに関連付けられている TableStyle のコレクションを表します。Represents a collection of TableStyles associated with the workbook. 読み取り専用です。Read-only.
timelineStylestimelineStyles ブックに関連付けられている TimelineStyle のコレクションを表します。Represents a collection of TimelineStyles associated with the workbook. 読み取り専用です。Read-only.
save(saveBehavior?: Excel.SaveBehavior)save(saveBehavior?: Excel.SaveBehavior) 現在のブックを保存します。Save current workbook.
use1904DateSystemuse1904DateSystem ブックの日付を 1904 年から計算する場合、true となります。True if the workbook uses the 1904 date system.
WorksheetWorksheet commentscomments ワークシート上のすべての Comments オブジェクトの集まりを返します。Returns a collection of all the Comments objects on the worksheet. 読み取り専用です。Read-only.
onColumnSortedonColumnSorted 1 つ以上の列を並べ替えたときに発生します。Occurs when one or more columns have been sorted. これは、左から右に並べ替えを実行したときに発生します。This happens as the result of a left-to-right sort operation.
onFilteredonFiltered フィルターが特定のワークシートに適用されたときに発生します。Occurs when filter is applied on a specific worksheet.
onRowHiddenChangedonRowHiddenChanged 特定のワークシートで、1つまたは複数の行の非表示の状態が変更されたときに発生します。Occurs when the hidden state of one or more rows has changed on a specific worksheet.
onRowSortedonRowSorted 1 つ以上の行を並べ替えたときに発生します。Occurs when one or more rows have been sorted. これは、上から下に並べ替えを実行したときに発生します。This happens as the result of a top-to-bottom sort operation.
onSingleClickedonSingleClicked ワークシートで左クリック/タップしたときに発生します。Occurs when left-clicked/tapped operation happens in the worksheet. このイベントは、次のケースをクリックしても発生しません。This event will not be fired when clicking in the following cases:
slicersslicers ワークシートに含まれるスライサーをまとめて返します。Returns collection of slicers that are part of the worksheet. 読み取り専用です。Read-only.
showOutlineLevels (rowLevels: number, columnLevels: number)showOutlineLevels(rowLevels: number, columnLevels: number) アウトラインレベルで行または列のグループを表示します。Shows row or column groups by their outline levels.
WorksheetCollectionWorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string)addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) あるブックの指定されたワークシートを現在のブックに挿入します。Inserts the specified worksheets of a workbook into the current workbook.
onColumnSortedonColumnSorted 1 つ以上の列を並べ替えたときに発生します。Occurs when one or more columns have been sorted. これは、左から右に並べ替えを実行したときに発生します。This happens as the result of a left-to-right sort operation.
onFilteredonFiltered ブック内でワークシートのフィルターが適用されたときに発生します。Occurs when any worksheet's filter is applied in the workbook.
onRowHiddenChangedonRowHiddenChanged 特定のワークシートで、1つまたは複数の行の非表示の状態が変更されたときに発生します。Occurs when the hidden state of one or more rows has changed on a specific worksheet.
onRowSortedonRowSorted 1 つ以上の行を並べ替えたときに発生します。Occurs when one or more rows have been sorted. これは、上から下に並べ替えを実行したときに発生します。This happens as the result of a top-to-bottom sort operation.
onSingleClickedonSingleClicked ワークシートのコレクションで左クリック/タップ操作が行われるときに発生します。Occurs when left-clicked/tapped operation happens in the worksheet collection. このイベントは、次のケースをクリックしても発生しません。This event will not be fired when clicking in the following cases:
WorksheetColumnSortedEventArgsWorksheetColumnSortedEventArgs addressaddress 特定のワークシートで並べ替えられたエリアを表す範囲のアドレスを取得します。Gets the range address that represents the sorted areas of a specific worksheet. 並べ替え操作の結果として変更された列のみが返されます。Only columns changed as a result of the sort operation are returned.
sourcesource イベントのソースを取得します。Gets the source of the event. 詳細については、Excel.EventSource をご覧ください。See Excel.EventSource for details.
typetype イベントの種類を取得します。Gets the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.
worksheetIdworksheetId 並べ替えが発生したワークシートの ID を取得します。Gets the id of the worksheet where the sorting happened.
WorksheetFilteredEventArgsWorksheetFilteredEventArgs typetype イベントの種類を表します。Represents the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.
worksheetIdworksheetId フィルターが適用されたワークシートの ID を表します。Represents the id of the worksheet in which the filter is applied.
WorksheetRowHiddenChangedEventArgsWorksheetRowHiddenChangedEventArgs addressaddress 特定のワークシートで変更されたエリアを表す範囲のアドレスを取得します。Gets the range address that represents the changed area of a specific worksheet.
changeTypechangeType イベントがトリガーされた方法を表す変更の種類を取得します。Gets the type of change that represents how the event was triggered. 詳細は「Excel.RowHiddenChangeType」をご覧ください。See Excel.RowHiddenChangeType for details.
sourcesource イベントのソースを取得します。Gets the source of the event. 詳細については、Excel.EventSource をご覧ください。See Excel.EventSource for details.
typetype イベントの種類を取得します。Gets the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.
worksheetIdworksheetId データが変更されたワークシートの ID を取得します。Gets the id of the worksheet in which the data changed.
WorksheetRowSortedEventArgsWorksheetRowSortedEventArgs addressaddress 特定のワークシートで並べ替えられたエリアを表す範囲のアドレスを取得します。Gets the range address that represents the sorted areas of a specific worksheet. 並べ替え操作の結果として変更された行のみが返されます。Only rows changed as a result of the sort operation are returned.
sourcesource イベントのソースを取得します。Gets the source of the event. 詳細については、Excel.EventSource をご覧ください。See Excel.EventSource for details.
typetype イベントの種類を取得します。Gets the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.
worksheetIdworksheetId 並べ替えが発生したワークシートの ID を取得します。Gets the id of the worksheet where the sorting happened.
WorksheetSingleClickedEventArgsWorksheetSingleClickedEventArgs addressaddress 特定のワークシートで左クリック/タップされたセルを表すアドレスを取得します。Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.
offsetXoffsetX 左クリックまたは左にクリックされたポイント (右から左へ記述する言語の場合は右) からの距離をポイント単位で指定します。左クリック/タップしたセルの枠線の端点を指定します。The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell.
offsetYoffsetY 左クリック/タップされたポイントから、左クリック/タップされたセルの上側の目盛線までの距離を、ポイント単位で表します。The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.
typetype イベントの種類を取得します。Gets the type of the event.
worksheetIdworksheetId 左クリック/タップされたワークシートの ID を取得します。Gets the id of the worksheet in which the cell was left-clicked/tapped.

関連項目See also