Excel JavaScript API 1.16 の新機能
ExcelApi 1.16 では、データ型 API が追加されました。 データ型 API を使用すると、Excel セルには 、Web からの画像、計算全体で形式を保持する 書式設定された数値値 、特にエンティティ カードを含めることができます。 エンティティ カードは、2 次元グリッドを超えて Excel アドインの可能性を拡張します。 セル内にアイコンが表示され、選択すると Excel UI でカードモーダル ウィンドウが開きます。 詳細については、「エンティティ値データ型でカードを使用する」を参照してください。
次の表は API の簡潔な概要を示し、後続の API リスト テーブルでは詳細な一覧を示します。
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 | カードのセクションを表します。 | |
字幕 | カードのサブタイトルを含むプロパティの仕様を表します。 | |
title | カードのタイトル、またはカードのタイトルを含むプロパティの仕様を表します。 | |
CardLayoutTableSection | レイアウト | このセクションのレイアウトの種類を表します。 |
CellValueAttributionAttributes | licenseAddress | このプロパティの使用方法を説明するライセンスまたはソースの URL を表します。 |
licenseText | このプロパティを管理するライセンスの名前を表します。 | |
sourceAddress |
CellValue のソースへの URL を表します。 |
|
sourceText |
CellValue のソースの名前を表します。 |
|
CellValueExtraProperties | 書き込み | この CellValue を使用してセルを上書きするかどうかを表します。 |
writableNote |
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 | カード | ビュー内のこのエンティティのレイアウトカード表します。 |
コンパクト | エンティティを表すスペースが限られている場合に使用されるレイアウトを表します。 | |
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 を表します。 |
altText | アクセシビリティ シナリオでイメージが表す内容を説明するために使用できる代替テキストを表します。 | |
帰属 | このイメージを使用するためのソースとライセンスの要件を説明する属性情報を表します。 | |
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