Office.SetSelectedDataOptions interface
選択範囲にデータを挿入する方法のオプションを提供します。
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml
async function addImageToCurrentSlide(
imageBase64: string,
options?: PowerPoint.ShapeAddOptions
): Promise<PowerPoint.Shape> {
// Adds an image to the current slide.
const setSelectedDataOptions: Office.SetSelectedDataOptions = {
coercionType: Office.CoercionType.Image
};
if (options) {
if (options.height) {
setSelectedDataOptions.imageHeight = options.height;
}
if (options.left) {
setSelectedDataOptions.imageLeft = options.left;
}
if (options.top) {
setSelectedDataOptions.imageTop = options.top;
}
if (options.width) {
setSelectedDataOptions.imageWidth = options.width;
}
}
return new Promise((resolve, reject) => {
Office.context.document.setSelectedDataAsync(
imageBase64,
setSelectedDataOptions,
async (result: Office.AsyncResult<void>) => {
if (result.error) {
console.error(`ERROR in setSelectedDataAsync(): ${result.error}`);
reject(result.error);
} else {
const shape = await PowerPoint.run(async (context) => {
const slide = context.presentation.getSelectedSlides().getItemAt(0);
slide.shapes.load();
await context.sync();
return slide.shapes.items[slide.shapes.items.length - 1];
});
resolve(shape);
}
}
);
});
}
プロパティ
| async |
コールバックに渡される AsyncResult オブジェクトの asyncContext プロパティで、変更せずに返される任意の型のユーザー定義項目。 |
| cell |
バインド型テーブルと、TableData オブジェクトがデータ パラメーターに渡される場合にのみを使用します。 列、行、またはセルの範囲を指定し、キーと値のペアとして、その範囲に適用するセルの書式設定を指定するオブジェクトの配列。 例: |
| coercion |
データ オブジェクトの図形を明示的に設定します。 指定されていない場合は、データ型から推論されます。 |
| image |
このオプションは、イメージの挿入に適用できます。 イメージの高さを示します。 imageWidth を指定せずにこのオプションを指定すると、イメージの高さの値に合わせてイメージが拡大縮小されます。 イメージの幅とイメージの高さの両方を指定すると、イメージはそれに合わせてサイズ変更されます。 イメージの高さも幅も指定しないと、既定のイメージ サイズと縦横比が使用されます。 この値はポイント単位です。 |
| image |
このオプションは、イメージの挿入に適用できます。 挿入位置を、PowerPoint の場合はスライドの左側からの相対位置、Excel の場合は現在選択されているセルからの相対位置で指定します。 Word では、この値は無視されます。 この値はポイント単位です。 |
| image |
このオプションは、イメージの挿入に適用できます。 PowerPointのスライドの上部に対する挿入位置と、Excel で現在選択されているセルとの関係を示します。 Word では、この値は無視されます。 この値はポイント単位です。 |
| image |
このオプションは、イメージの挿入に適用できます。 イメージの幅を示します。 imageHeight を指定せずにこのオプションを指定すると、イメージの幅の値に合わせてイメージが拡大縮小されます。 イメージの幅とイメージの高さの両方を指定すると、イメージはそれに合わせてサイズ変更されます。 イメージの高さも幅も指定しないと、既定のイメージ サイズと縦横比が使用されます。 この値はポイント単位です。 |
| table |
挿入されたテーブルの場合、ヘッダー行、合計行、およびバンド行など、テーブルの書式設定オプションを指定するキーと値のペアの一覧。 例: |
プロパティの詳細
asyncContext
コールバックに渡される AsyncResult オブジェクトの asyncContext プロパティで、変更せずに返される任意の型のユーザー定義項目。
asyncContext?: any
プロパティ値
any
cellFormat
バインド型テーブルと、TableData オブジェクトがデータ パラメーターに渡される場合にのみを使用します。 列、行、またはセルの範囲を指定し、キーと値のペアとして、その範囲に適用するセルの書式設定を指定するオブジェクトの配列。
例: [{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]
cellFormat?: RangeFormatConfiguration[]
プロパティ値
coercionType
データ オブジェクトの図形を明示的に設定します。 指定されていない場合は、データ型から推論されます。
coercionType?: Office.CoercionType | string
プロパティ値
Office.CoercionType | string
imageHeight
このオプションは、イメージの挿入に適用できます。 イメージの高さを示します。 imageWidth を指定せずにこのオプションを指定すると、イメージの高さの値に合わせてイメージが拡大縮小されます。 イメージの幅とイメージの高さの両方を指定すると、イメージはそれに合わせてサイズ変更されます。 イメージの高さも幅も指定しないと、既定のイメージ サイズと縦横比が使用されます。 この値はポイント単位です。
imageHeight?: number
プロパティ値
number
imageLeft
このオプションは、イメージの挿入に適用できます。 挿入位置を、PowerPoint の場合はスライドの左側からの相対位置、Excel の場合は現在選択されているセルからの相対位置で指定します。 Word では、この値は無視されます。 この値はポイント単位です。
imageLeft?: number
プロパティ値
number
imageTop
このオプションは、イメージの挿入に適用できます。 PowerPointのスライドの上部に対する挿入位置と、Excel で現在選択されているセルとの関係を示します。 Word では、この値は無視されます。 この値はポイント単位です。
imageTop?: number
プロパティ値
number
imageWidth
このオプションは、イメージの挿入に適用できます。 イメージの幅を示します。 imageHeight を指定せずにこのオプションを指定すると、イメージの幅の値に合わせてイメージが拡大縮小されます。 イメージの幅とイメージの高さの両方を指定すると、イメージはそれに合わせてサイズ変更されます。 イメージの高さも幅も指定しないと、既定のイメージ サイズと縦横比が使用されます。 この値はポイント単位です。
imageWidth?: number
プロパティ値
number
tableOptions
挿入されたテーブルの場合、ヘッダー行、合計行、およびバンド行など、テーブルの書式設定オプションを指定するキーと値のペアの一覧。 例: {bandedRows: true, filterButton: false}
tableOptions?: object
プロパティ値
object