ExcelApi 1.16 では、 データ型 API が追加されました。 データ型 API を使用すると、Excel セルに、 Web からの画像、計算全体で形式を保持する 書式設定された数値 、特にエンティティ カードを含めることができます。 エンティティ カードは、Excel アドインの可能性を 2 次元グリッドを超えて拡張します。 選択すると、セル内にアイコンが表示され、Excel UI でカード モーダル ウィンドウが開きます。 詳細については、「エンティティ値データ型でカードを使用する」を参照してください。
次の表は API の簡潔な概要を示し、後続の API リスト の表は詳細なリストを示しています。
| 機能領域 | 説明 | 関連オブジェクト |
|---|---|---|
| データ型 | 書式設定された数値と Web 画像のサポートを含む、既存の Excel データ型の拡張機能。 | ArrayCellValue、 BooleanCellValue、 CellValueAttributionAttributes、 CellValueProviderAttributes、 DoubleCellValue、 EmptyCellValue、 EntityCellValue、 FormattedNumberCellValue、 RootReferenceCellValue、 StringCellValue、 ValueTypeNotAvailableCellValue、 WebImageCellValue |
| データ型エラー | 拡張されたデータ型をサポートするエラー オブジェクト。 | BlockedErrorCellValue, BusyErrorCellValue, CalcErrorCellValue, ConnectErrorCellValue, Div0ErrorCellValue, FieldErrorCellValue, GettingDataErrorCellValue, NotAvailableErrorCellValue, NameErrorCellValue, NullErrorCellValue, NumErrorCellValue, PlaceholderErrorCellValue, RefErrorCellValue, SpillErrorCellValue, ValueErrorCellValue |
| エンティティ データ型 と エンティティ カード | エンティティはデータ型のコンテナーです。 カード レイアウト オブジェクトは、エンティティ カードの表示を管理します。 | EntityCellValue、EntityCardLayout、EntityPropertyExtraProperties、EntityViewLayouts、CardLayoutListSection、CardLayoutPropertyReference、CardLayoutSectionStandardProperties、CardLayoutStandardProperties、CardLayoutTableSection |
API リスト
次の表に、Excel JavaScript API 要件セット 1.16 の API を示します。 Excel JavaScript API 要件セット 1.16 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、 要件セット 1.16 以前の「Excel API」を参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| ArrayCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| 要素 | 配列の要素を表します。 | |
| referencedValues |
ArrayCellValue.elements内で参照されるセル値を表します。 |
|
| type | このセル値の型を表します。 | |
| BlockedErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
BlockedErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| BooleanCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| type | このセル値の型を表します。 | |
| BusyErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
BusyErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| CalcErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
CalcErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| functionName | エラーの原因となっている関数の名前を表します。 | |
| type | このセル値の型を表します。 | |
| CardLayoutListSection | レイアウト | このセクションのレイアウトの種類を表します。 |
| CardLayoutPropertyReference | property | カード レイアウトによって参照されるプロパティの名前を表します。 |
| CardLayoutSectionStandardProperties | 折りたたまれた状態 | カードのこのセクションが最初に折りたたまれているかどうかを表します。 |
| 折りたたみ可能 | カードのこのセクションが折りたたみ可能かどうかを表します。 | |
| プロパティ | このセクションのプロパティの名前を表します。 | |
| title | カードのこのセクションのタイトルを表します。 | |
| CardLayoutStandardProperties | mainImage | カードのメイン イメージとして使用されるプロパティを指定します。 |
| sections | カードのセクションを表します。 | |
| subTitle | どのプロパティにカードのサブタイトルが含まれるかの仕様を表します。 | |
| title | カードのタイトル、またはどのプロパティにカードのタイトルが含まれるかの仕様を表します。 | |
| CardLayoutTableSection | レイアウト | このセクションのレイアウトの種類を表します。 |
| CellValueAttributionAttributes | licenseAddress | このプロパティの使用方法を記述したライセンスまたはソースへの URL を表します。 |
| licenseText | このプロパティを管理するライセンスの名前を表します。 | |
| sourceAddress |
CellValueのソースへの URL を表します。 |
|
| sourceText |
CellValueのソースの名前を表します。 |
|
| CellValueExtraProperties | 書き込み可能 | この CellValue を使用してセルを上書きするかどうかを表します。 |
| 書き込み可能注: |
CellValue.writable が false として指定されている理由についての説明を表します。 |
|
| CellValuePropertyMetadata | 属性 | このプロパティを使用するためのソースとライセンス要件を説明する属性情報を表します。 |
| excludeFrom | このプロパティが除外される機能を表します。 | |
| sublabel | カード ビューに表示されるこのプロパティのサブラベルを表します。 | |
| CellValuePropertyMetadataExclusions | autoComplete | true は、プロパティがオートコンプリートによって表示されるプロパティから除外されていることを表します。 |
| calcCompare | true は、再計算中にセル値を比較するために使用されるプロパティからプロパティが除外されていることを表します。 | |
| cardView | true は、プロパティがカード ビューに表示されるプロパティから除外されていることを表します。 | |
| dotNotation | true は、FIELDVALUE 関数を介してアクセスできるプロパティからプロパティが除外されていることを表します。 | |
| CellValueProviderAttributes | description | ロゴが指定されていない場合にカード ビューで使用されるプロバイダーの説明プロパティを表します。 |
| logoSourceAddress | カード ビューでロゴとして使用される画像のダウンロードに使用される URL を表します。 | |
| logoTargetAddress | ユーザーがカード ビューでロゴ要素をクリックした場合のナビゲーション ターゲットとなる URL を表します。 | |
| ChangedEventDetail | valueAsJsonAfter | 変更後の値の型を表します。 |
| valueAsJsonBefore | 変更前の値の型を表します。 | |
| ChartFill | getSolidColor() | グラフ要素の色塗りつぶしの書式設定を統一します。 |
| ConnectErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
ConnectErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| Div0ErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| DoubleCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| type | このセル値の型を表します。 | |
| EmptyCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| type | このセル値の型を表します。 | |
| EntityCardLayout | レイアウト | このレイアウトの種類を表します。 |
| EntityCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| レイアウト | このエンティティのビューのレイアウト情報を表します。 | |
| プロパティ | このエンティティとそのメタデータのプロパティを表します。 | |
| プロバイダー | この EntityCellValueのデータを提供したサービスを説明する情報を表します。 |
|
| referencedValues |
EntityCellValue.properties内で参照されるセル値を表します。 |
|
| text | この値を持つセルがレンダリングされるときに表示されるテキストを表します。 | |
| type | このセル値の型を表します。 | |
| EntityCompactLayout | icon | カードを開くために使用されるアイコンの名前を指定します。 |
| EntityPropertyExtraProperties | propertyMetadata | プロパティに関するメタデータを表します。 |
| EntityViewLayouts | カード | カード ビューでのこのエンティティのレイアウトを表します。 |
| Compact | エンティティを表す領域が限られているときに使用されるレイアウトを表します。 | |
| ExternalErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
ExternalErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| FieldErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
FieldErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| fieldName | FIELDVALUE によって見つからなかったフィールドを表します。 | |
| type | このセル値の型を表します。 | |
| FormattedNumberCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| numberFormat | この値の表示に使用する数値書式文字列を返します。 | |
| type | このセル値の型を表します。 | |
| GettingDataErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| LinkedEntityCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| id | この値の情報を提供したサービス ソースを表します。 | |
| レイアウト | このリンクされたエンティティのビューのレイアウト情報を表します。 | |
| プロパティ | このリンクされたエンティティとそのメタデータのプロパティを表します。 | |
| プロバイダー | この LinkedEntityCellValueでデータを提供したサービスを説明する情報を表します。 |
|
| text | この値を持つセルがレンダリングされるときに表示されるテキストを表します。 | |
| type | このセル値の型を表します。 | |
| LinkedEntityId | カルチャ | この CellValueの作成に使用された言語カルチャを表します。 |
| domainId |
CellValueの作成に使用されるサービスに固有のドメインを表します。 |
|
| entityId |
CellValueの作成に使用されるサービスに固有の識別子を表します。 |
|
| serviceId |
CellValueの作成に使用されたサービスを表します。 |
|
| NameErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| NamedItem | valueAsJson | この名前付きアイテムの値の JSON 表現。 |
| valueAsJsonLocal | この名前付きアイテムの値の JSON 表現。 | |
| NamedItemArrayValues | valuesAsJson | この名前付き項目配列内の値の JSON 表現。 |
| valuesAsJsonLocal | この名前付き項目配列内の値の JSON 表現。 | |
| NotAvailableErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| NullErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| NumErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
NumErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| functionName | エラーの原因となっている関数の名前を表します。 | |
| type | このセル値の型を表します。 | |
| PlaceholderErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| target |
PlaceholderErrorCellValue は、データのダウンロード中に処理中に使用されます。 |
|
| type | このセル値の型を表します。 | |
| Range | valuesAsJson | この範囲内のセルの値の JSON 表現。 |
| valuesAsJsonLocal | この範囲内のセルの値の JSON 表現。 | |
| RangeView | valuesAsJson | この範囲内のセルの値の JSON 表現。 |
| valuesAsJsonLocal | この範囲内のセルの値の JSON 表現。 | |
| RefErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
RefErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| ReferenceCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| reference |
EntityCellValue や ArrayCellValue など、セル値のreferencedValuesプロパティへのインデックスを表します。 |
|
| type | このセル値の型を表します。 | |
| RootReferenceCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| type | このセル値の型を表します。 | |
| SpillErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| columnCount | #SPILL がない場合にスピルする列の数を表します。 エラーを返します。 | |
| errorSubType |
SpillErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| rowCount | #SPILL がない場合にスピルする行数を表します。 エラーを返します。 | |
| type | このセル値の型を表します。 | |
| StringCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| type | このセル値の型を表します。 | |
| TableColumn | valuesAsJson | このテーブル列のセルの値の JSON 表現。 |
| valuesAsJsonLocal | このテーブル列のセルの値の JSON 表現。 | |
| TableColumnCollection | addAsJson(index?: number, values?: CellValue[][], name?: string) | テーブルに新しい列を追加します。 |
| TableRow | valuesAsJson | このテーブル行のセルの値の JSON 表現。 |
| valuesAsJsonLocal | このテーブル行のセルの値の JSON 表現。 | |
| TableRowCollection | addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean) | テーブルに 1 つ以上の行を追加します。 |
| ValueErrorCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| errorSubType |
ValueErrorCellValueの種類を表します。 |
|
| errorType |
ErrorCellValueの種類を表します。 |
|
| type | このセル値の型を表します。 | |
| ValueTypeNotAvailableCellValue | basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| type | このセル値の型を表します。 | |
| WebImageCellValue | address | 画像のダウンロード元の URL を表します。 |
| 代替テキスト | 画像が表す内容を説明するためにアクセシビリティ シナリオで使用できる代替テキストを表します。 | |
| 属性 | このイメージを使用するためのソースとライセンス要件を説明するための属性情報を表します。 | |
| basicType | この値を持つセルに対して Range.valueTypes によって返される値を表します。 |
|
| basicValue | この値を持つセルに対して Range.values によって返される値を表します。 |
|
| プロバイダー | 画像を提供したエンティティまたは個人を説明する情報を表します。 | |
| relatedImagesAddress | この WebImageCellValueに関連していると見なされる画像を含む Web ページの URL を表します。 |
|
| type | このセル値の型を表します。 | |
| ブック | getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId) | 指定されたLinkedEntityIdに基づいてLinkedEntityCellValueを返します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins