ExcelApi 1.19 では、グラフと図形の機能が追加され、Excel でデータをより適切に視覚化するのに役立ちます。 また、リンクされたデータ型のサポート、ドット表記、基本的なセル値の拡張オプションなど、データ型機能の更新も含まれます。
次の表は API の簡潔な概要を示し、後続の API リスト テーブルでは詳細な一覧を示します。
| 機能領域 | 説明 | 関連オブジェクト |
|---|---|---|
| グラフ ラベル | グラフ ラベルの外観を制御します。 | ChartDataLabel、 ChartDataLabelAnchor、 ChartLeaderLines、 ChartLeaderLinesFormat |
| リンクされたエンティティ | 外部ソースから Excel に接続されているデータ型のサポートを追加します。 詳細については、「リンクされたエンティティ セル値を作成する」を参照してください。 | LinkedEntityDataDomain、 LinkedEntityDataDomainCollection、 LinkedEntityDataDomainCreateOptions、 LinkedEntityIdCulture、 LinkedEntityLoadServiceRequest |
API リスト
次の表に、Excel JavaScript API 要件セット 1.19 の API を示します。 Excel JavaScript API 要件セット 1.19 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、 要件セット 1.19 以前の Excel API に関するページを参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| BasicCardLayout | レイアウト | このレイアウトの種類を表します。 |
| BasicCompactLayout | icon | カードを開くために使用するアイコンの名前を指定します。 |
| BasicViewLayouts | カード | ビュー内のこの値とそのプロパティのレイアウトカード表します。 |
| コンパクト | 値を表すスペースが限られている場合に使用されるレイアウトを表します。 | |
| BooleanCellValue | レイアウト | このブール値のビューのレイアウト情報を表します。 |
| プロパティ | このブール値の追加プロパティを表します。 | |
| 供給者 | この BooleanCellValueのデータを提供したサービスを説明する情報を表します。 |
|
| referencedValues |
BooleanCellValue.properties内で参照されるセル値を表します。 |
|
| CardLayoutTwoColumnSection | レイアウト | このセクションのレイアウトの種類を表します。 |
| ChartDataLabel | geometricShapeType | データ ラベルの幾何学的図形の種類を指定します。 |
| getSubstring(start: number, length?: number) | データ ラベルの部分文字列を返します。 | |
| getTailAnchor() | 固定吹き出しとして表示されるデータ ラベルのテール アンカーを返します。 | |
| setHeight(height: number) | データ ラベルの高さをポイント単位で設定します。 | |
| setWidth(width: number) | データ ラベルの幅をポイント単位で設定します。 | |
| showAsStickyCallout | データ ポイントにテール アンカーがアタッチされた吹き出しとしてデータ ラベルを表示するかどうかを指定します。 | |
| ChartDataLabelAnchor | left | アンカーからグラフ データ ラベルの左端までの距離をポイント単位で指定します。 |
| top | アンカーからグラフ データ ラベルの上端までの距離をポイント単位で指定します。 | |
| ChartDataLabels | geometricShapeType | データ ラベルの幾何学的図形の種類を指定します。 |
| leaderLines | データ ラベルの引き出し線を表す オブジェクトを取得します。 | |
| showAsStickyCallout | データ ポイントにテール アンカーがアタッチされた吹き出しとしてデータ ラベルを表示するかどうかを指定します。 | |
| showLeaderLines | データ ラベルの引き出し線を表示するかどうかを指定します。 | |
| ChartLeaderLines | format | 系列内のデータ ラベルの引出し線の書式設定を表します。 |
| ChartLeaderLinesFormat | line | グラフの引き出し線の線の書式設定を表す オブジェクトを取得します。 |
| DoubleCellValue | レイアウト | この二重値のビューのレイアウト情報を表します。 |
| numberFormat | この値を表示するために使用される数値書式指定文字列を返します。 | |
| プロパティ | この二重値の追加プロパティを表します。 | |
| 供給者 | この DoubleCellValueのデータを提供したサービスを説明する情報を表します。 |
|
| referencedValues |
DoubleCellValue.properties内で参照されるセル値を表します。 |
|
| JavaScriptCustomFunctionReferenceCellValue | basicType | この値を持つセルの Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルの Range.values によって返される値を表します。 |
|
| functionType |
FunctionCellValueの種類を表します。 |
|
| id | カスタム関数の ID を表します。 | |
| Namespace | カスタム関数で使用される名前空間を表します。 | |
| type | このセル値の型を表します。 | |
| LinkedEntityDataDomain | dataProvider | リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を取得します。 |
| delete() | このオブジェクトを LinkedEntityDataDomainCollectionから削除します。 |
|
| id | Office アドインによって定義されたリンク されたエンティティ データ ドメインの ID を取得します。 | |
| lastRefreshed | ブックが開き、このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトが最後に更新されてからの日付と時刻 (ローカル タイム ゾーン内) を取得します。 |
|
| loadFunctionId | Office アドインによって定義されたリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するためにオンデマンドで呼び出されるカスタム関数の ID を取得します。 |
|
| name | リンクされたエンティティ データ ドメインの名前を取得します。 | |
| periodicRefreshInterval | このリンクされたエンティティ データ ドメイン LinkedEntityCellValue オブジェクトが自動的に更新される頻度を秒単位で取得します。 |
|
| refresh() | このリンクされたエンティティ データ ドメインのすべての LinkedEntityCellValue オブジェクトを更新します。 |
|
| refreshMode | このリンクされたエンティティ データ ドメインの LinkedEntityCellValue オブジェクトを更新する方法とタイミングを定義する更新モードを指定します。 |
|
| serviceId | リンクされたエンティティ データ ドメインのサービス ID を取得します。 | |
| supportedRefreshModes | リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを取得します。 | |
| LinkedEntityDataDomainAddedEventArgs | id | ブックに追加したばかりのリンク エンティティ データ ドメインの ID を取得します。 |
| serviceId | ブックに追加したばかりのリンクされたエンティティ データ ドメインのサービス ID を取得します。 | |
| source | イベントのソースを取得します。 | |
| type | イベントの種類を取得します。 | |
| LinkedEntityDataDomainCollection | add(options: Excel.LinkedEntityDataDomainCreateOptions) | Office アドインによって定義されたリンクされたエンティティ データ ドメイン オブジェクトをコレクションに追加します。 |
| getCount() | コレクション内のリンクされたエンティティ データ ドメインの数を取得します。 | |
| getItem(id: string) |
idによってリンクされたエンティティ データ ドメインを取得します。 |
|
| getItemAt(index: number) | コレクション内のインデックスによってリンクされたエンティティ データ ドメインを取得します。 | |
| getItemByName(name: string) |
nameによってリンクされたエンティティ データ ドメインを取得します。 |
|
| getItemByNameOrNullObject(name: string) |
nameによってリンクされたエンティティ データ ドメインを取得します。 |
|
| getItemOrNullObject(id: string) |
idによってリンクされたエンティティ データ ドメインを取得します。 |
|
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| onLinkedEntityDataDomainAdded | 新しいリンク エンティティ データ ドメインがブックに追加されたときに発生します。 | |
| onRefreshCompleted | リンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 更新する要求が完了したときに発生します。 |
|
| onRefreshModeChanged | リンクされたエンティティ データ ドメインの refreshMode が変更されたときに発生します。 |
|
| refreshAll() | このコレクション内のすべてのリンクされたエンティティ データ ドメインのすべての LinkedEntityCellValue オブジェクトを更新します。 |
|
| LinkedEntityDataDomainCreateOptions | dataProvider | リンクされたエンティティ データ ドメインのデータ プロバイダーの名前を指定します。 |
| id | リンクされたエンティティ データ ドメインの ID を指定します。 | |
| loadFunctionId | このリンク エンティティ データ ドメインの LinkedEntityCellValue オブジェクトを解決または更新するために、オンデマンドで呼び出されるカスタム関数の ID を指定します。 |
|
| name | リンクされたエンティティ データ ドメインの名前を指定します。 | |
| periodicRefreshInterval | このリンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 自動的に更新される頻度を秒単位で指定します。 |
|
| supportedRefreshModes | リンクされたエンティティ データ ドメインでサポートされているすべての更新モードを指定します。 | |
| LinkedEntityDataDomainRefreshCompletedEventArgs | errors | リンクされたエンティティ データ ドメインのオブジェクト LinkedEntityCellValue 更新する要求中に発生したエラーを取得します。 |
| id |
LinkedEntityCellValue オブジェクトが更新されたリンク エンティティ データ ドメインの ID を取得します。 |
|
| すっきり | リンクされたエンティティ データ ドメインのLinkedEntityCellValue オブジェクトが正常に更新された場合はtrueを返し、それ以外の場合はfalseを返します。 |
|
| serviceId |
LinkedEntityCellValue オブジェクトが更新されたリンクされたエンティティ データ ドメインのサービス ID を取得します。 |
|
| source | イベントのソースを取得します。 | |
| type | イベントの種類を取得します。 | |
| LinkedEntityDataDomainRefreshModeChangedEventArgs | id | 更新モードが変更されたリンク エンティティ データ ドメインの ID を取得します。 |
| refreshMode | リンクされたエンティティ データ ドメインの新しい更新モードを取得します。 | |
| serviceId | 更新モードが変更されたリンク されたエンティティ データ ドメインのサービス ID を取得します。 | |
| source | イベントのソースを取得します。 | |
| type | イベントの種類を取得します。 | |
| LinkedEntityIdCulture | 文化 |
LinkedEntityCellValue オブジェクトの作成に使用される言語カルチャを表します。 |
| entityId |
LinkedEntityCellValue オブジェクトの作成に使用されるサービスに固有の識別子を表します。 |
|
| LinkedEntityLoadServiceRequest | domainId |
LinkedEntityCellValue オブジェクトの作成に使用するサービスに固有のドメインを表します。 |
| エンティティ | 読み込む LinkedEntityCellValue オブジェクトのエンティティ ID とカルチャを表します。 |
|
| LinkedEntityLoadServiceResult | エンティティ | 読み込まれた LinkedEntityCellValue オブジェクトを表します。 |
| Range | getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | 各セルのフォント、塗りつぶし、罫線、配置、およびその他のプロパティの表示データをカプセル化する 2D 配列を返します。 |
| StringCellValue | レイアウト | この文字列値のビューのレイアウト情報を表します。 |
| プロパティ | この文字列値の追加プロパティを表します。 | |
| 供給者 | この StringCellValueのデータを提供したサービスを説明する情報を表します。 |
|
| referencedValues |
StringCellValue.properties内で参照されるセル値を表します。 |
|
| ブック | getActiveShape() | ブック内のアクティブな図形を取得します。 |
| getActiveShapeOrNullObject() | ブック内のアクティブな図形を取得します。 | |
| linkedEntityDataDomains | ブックで使用できるリンクされたエンティティ データ ドメインのコレクションを返します。 | |
| ワークシート | showDataTypeIcons | ワークシートにデータ型アイコンを表示するかどうかを指定します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins