ExcelScript.Shape interface

ワークシート内の汎用図形オブジェクトを表します。 図形には、幾何学的な図形、線、図形のグループなどがあります。

メソッド

copyTo(destinationSheet)

オブジェクトをコピーして貼り付 Shape けます。 貼り付けされた図形は、この図形と同じピクセル位置にコピーされます。

delete()

ワークシートから図形を削除します。

getAltTextDescription()

オブジェクトの代替説明テキストを指定 Shape します。

getAltTextTitle()

オブジェクトの代替タイトル テキストを指定 Shape します。

getAsImage(format)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。 DPI は 96 です。 サポートされている唯一の形式は次のとおりです。 ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEGそして ExcelScript.PictureFormat.GIF.

getConnectionSiteCount()

この図形の結合点の数を返します。

getFill()

この図形の塗りつぶしの書式設定を返します。

getGeometricShape()

図形に関連付けられた幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

getGeometricShapeType()

この幾何学的な図形の幾何学的な図形の種類を指定します。 詳細は「ExcelScript.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometricShape" ではない場合に返します。

getGroup()

図形に関連付けられた図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

getHeight()

図形の高さをポイントで指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

getId()

図形識別子を指定します。

getImage()

図形に関連付けられた画像を返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。

getImageAsBase64(format)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。 DPI は 96 です。 サポートされている唯一の形式は次のとおりです。 ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEGそして ExcelScript.PictureFormat.GIF.

getLeft()

図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

getLevel()

指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。

getLine()

図形に関連付けられた線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

getLineFormat()

この図形の線の書式設定を返します。

getLockAspectRatio()

この図形の縦横比をロックする場合に指定します。

getName()

図形の名前を指定します。

getParentGroup()

この図形の親グループを指定します。

getPlacement()

オブジェクトがその下のセルに接続されている方法を表します。

getRotation()

図形の回転角度を度で指定します。

getTextFrame()

この図形のテキスト フレーム オブジェクトを返します。 読み取り専用です。

getTop()

図形の上端からワークシートの上までのポイント単位の距離です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

getType()

この図形の種類を返します。 詳細は「ExcelScript.ShapeType」をご覧ください。

getVisible()

図形が表示される場合に指定します。

getWidth()

図形の幅をポイント単位で指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

getZOrderPosition()

指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。

incrementLeft(increment)

指定したポイント数だけ水平方向に図形を移動します。

incrementRotation(increment)

z 軸を中心に、指定された度数だけ、図形を時計回りに回転します。 プロパティを rotation 使用して、図形の絶対回転を設定します。

incrementTop(increment)

指定したポイント数だけ垂直方向に図形を移動します。

scaleHeight(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の高さを変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。

scaleWidth(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の幅を変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の幅に対して拡大または縮小されます。

setAltTextDescription(altTextDescription)

オブジェクトの代替説明テキストを指定 Shape します。

setAltTextTitle(altTextTitle)

オブジェクトの代替タイトル テキストを指定 Shape します。

setGeometricShapeType(geometricShapeType)

この幾何学的な図形の幾何学的な図形の種類を指定します。 詳細は「ExcelScript.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometricShape" ではない場合に返します。

setHeight(height)

図形の高さをポイントで指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

setLeft(left)

図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

setLockAspectRatio(lockAspectRatio)

この図形の縦横比をロックする場合に指定します。

setName(name)

図形の名前を指定します。

setPlacement(placement)

オブジェクトがその下のセルに接続されている方法を表します。

setRotation(rotation)

図形の回転角度を度で指定します。

setTop(top)

図形の上端からワークシートの上までのポイント単位の距離です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

setVisible(visible)

図形が表示される場合に指定します。

setWidth(width)

図形の幅をポイント単位で指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

setZOrder(position)

指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。

メソッドの詳細

copyTo(destinationSheet)

オブジェクトをコピーして貼り付 Shape けます。 貼り付けされた図形は、この図形と同じピクセル位置にコピーされます。

copyTo(destinationSheet?: Worksheet | string): Shape;

パラメーター

destinationSheet

ExcelScript.Worksheet | string

図形オブジェクトを貼り付けするシート。 既定値は、コピーされた図形のワークシートです。

戻り値

delete()

ワークシートから図形を削除します。

delete(): void;

戻り値

void

getAltTextDescription()

オブジェクトの代替説明テキストを指定 Shape します。

getAltTextDescription(): string;

戻り値

string

getAltTextTitle()

オブジェクトの代替タイトル テキストを指定 Shape します。

getAltTextTitle(): string;

戻り値

string

getAsImage(format)

警告

この API は非推奨になりました。

Use getImageAsBase64 instead.

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。 DPI は 96 です。 サポートされている唯一の形式は次のとおりです。 ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEGそして ExcelScript.PictureFormat.GIF.

getAsImage(format: PictureFormat): string;

パラメーター

format
ExcelScript.PictureFormat

イメージの形式を指定します。

戻り値

string

getConnectionSiteCount()

この図形の結合点の数を返します。

getConnectionSiteCount(): number;

戻り値

number

getFill()

この図形の塗りつぶしの書式設定を返します。

getFill(): ShapeFill;

戻り値

getGeometricShape()

図形に関連付けられた幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

getGeometricShape(): GeometricShape;

戻り値

getGeometricShapeType()

この幾何学的な図形の幾何学的な図形の種類を指定します。 詳細は「ExcelScript.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometricShape" ではない場合に返します。

getGeometricShapeType(): GeometricShapeType;

戻り値

getGroup()

図形に関連付けられた図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

getGroup(): ShapeGroup;

戻り値

getHeight()

図形の高さをポイントで指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

getHeight(): number;

戻り値

number

getId()

図形識別子を指定します。

getId(): string;

戻り値

string

getImage()

図形に関連付けられた画像を返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。

getImage(): Image;

戻り値

/**
* This script transfers an image from one worksheet to another.
*/
function main(workbook: ExcelScript.Workbook)
{
  // Get the worksheet with the image on it.
  let firstWorksheet = workbook.getWorksheet("FirstSheet");

  // Get the first image from the worksheet.
  // If a script added the image, you could add a name to make it easier to find.
  let image: ExcelScript.Image;
  firstWorksheet.getShapes().forEach((shape, index) => {
    if (shape.getType() === ExcelScript.ShapeType.image) {
      image = shape.getImage();
      return;
    }
  });

  // Copy the image to another worksheet.
  image.getShape().copyTo("SecondSheet");
}

getImageAsBase64(format)

図形を画像に変換し、base 64 でエンコードされた文字列として画像を返します。 DPI は 96 です。 サポートされている唯一の形式は次のとおりです。 ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEGそして ExcelScript.PictureFormat.GIF.

getImageAsBase64(format: PictureFormat): string;

パラメーター

format
ExcelScript.PictureFormat

イメージの形式を指定します。

戻り値

string

getLeft()

図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

getLeft(): number;

戻り値

number

getLevel()

指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。

getLevel(): number;

戻り値

number

getLine()

図形に関連付けられた線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

getLine(): Line;

戻り値

getLineFormat()

この図形の線の書式設定を返します。

getLineFormat(): ShapeLineFormat;

戻り値

getLockAspectRatio()

この図形の縦横比をロックする場合に指定します。

getLockAspectRatio(): boolean;

戻り値

boolean

getName()

図形の名前を指定します。

getName(): string;

戻り値

string

getParentGroup()

この図形の親グループを指定します。

getParentGroup(): Shape;

戻り値

getPlacement()

オブジェクトがその下のセルに接続されている方法を表します。

getPlacement(): Placement;

戻り値

getRotation()

図形の回転角度を度で指定します。

getRotation(): number;

戻り値

number

getTextFrame()

この図形のテキスト フレーム オブジェクトを返します。 読み取り専用です。

getTextFrame(): TextFrame;

戻り値

getTop()

図形の上端からワークシートの上までのポイント単位の距離です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

getTop(): number;

戻り値

number

getType()

この図形の種類を返します。 詳細は「ExcelScript.ShapeType」をご覧ください。

getType(): ShapeType;

戻り値

getVisible()

図形が表示される場合に指定します。

getVisible(): boolean;

戻り値

boolean

getWidth()

図形の幅をポイント単位で指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

getWidth(): number;

戻り値

number

getZOrderPosition()

指定された図形の z オーダーでの位置を返します。0 はオーダー スタックの一番下を表します。

getZOrderPosition(): number;

戻り値

number

incrementLeft(increment)

指定したポイント数だけ水平方向に図形を移動します。

incrementLeft(increment: number): void;

パラメーター

increment

number

増分をポイント単位で指定すると、図形は水平方向に移動されます。 正の値を指定すると、図形は右に移動し、負の値を指定すると左に移動します。 シートが右から左に向いた場合は、正の値を指定すると図形が左に移動し、負の値が右に移動します。

戻り値

void

incrementRotation(increment)

z 軸を中心に、指定された度数だけ、図形を時計回りに回転します。 プロパティを rotation 使用して、図形の絶対回転を設定します。

incrementRotation(increment: number): void;

パラメーター

increment

number

図形を回転する度数。 正の値を指定すると、図形は時計回りに回転し、負の値は反時計回りに回転します。

戻り値

void

incrementTop(increment)

指定したポイント数だけ垂直方向に図形を移動します。

incrementTop(increment: number): void;

パラメーター

increment

number

増分をポイント単位で指定すると、図形は垂直方向に移動されます。 正の値を指定すると、図形は下に移動し、負の値を指定すると上に移動します。

戻り値

void

scaleHeight(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の高さを変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。

scaleHeight(
            scaleFactor: number,
            scaleType: ShapeScaleType,
            scaleFrom?: ShapeScaleFrom
        ): void;

パラメーター

scaleFactor

number

現在の高さと変更後の高さの比率、または元の高さと変更後の高さの比率を指定します。

scaleType
ExcelScript.ShapeScaleType

図形を元のサイズまたは現在のサイズを基準に拡大/縮小するかどうかを指定します。 元のサイズのスケーリング オプションは、イメージに対してのみ機能します。

scaleFrom
ExcelScript.ShapeScaleFrom

省略可能です。 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。 省略すると、図形の左上隅が位置を保持します。

戻り値

void

scaleWidth(scaleFactor, scaleType, scaleFrom)

指定した係数分だけ図形の幅を変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の幅に対して拡大または縮小されます。

scaleWidth(
            scaleFactor: number,
            scaleType: ShapeScaleType,
            scaleFrom?: ShapeScaleFrom
        ): void;

パラメーター

scaleFactor

number

現在の幅と変更後の幅の比率、または元の幅と変更後の幅の比率を指定します。

scaleType
ExcelScript.ShapeScaleType

図形を元のサイズまたは現在のサイズを基準に拡大/縮小するかどうかを指定します。 元のサイズのスケーリング オプションは、イメージに対してのみ機能します。

scaleFrom
ExcelScript.ShapeScaleFrom

省略可能です。 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。 省略すると、図形の左上隅が位置を保持します。

戻り値

void

setAltTextDescription(altTextDescription)

オブジェクトの代替説明テキストを指定 Shape します。

setAltTextDescription(altTextDescription: string): void;

パラメーター

altTextDescription

string

戻り値

void

setAltTextTitle(altTextTitle)

オブジェクトの代替タイトル テキストを指定 Shape します。

setAltTextTitle(altTextTitle: string): void;

パラメーター

altTextTitle

string

戻り値

void

setGeometricShapeType(geometricShapeType)

この幾何学的な図形の幾何学的な図形の種類を指定します。 詳細は「ExcelScript.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometricShape" ではない場合に返します。

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

パラメーター

geometricShapeType
ExcelScript.GeometricShapeType

戻り値

void

setHeight(height)

図形の高さをポイントで指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

setHeight(height: number): void;

パラメーター

height

number

戻り値

void

setLeft(left)

図形の左側からワークシートの左側までの距離 (ポイント数) です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

setLeft(left: number): void;

パラメーター

left

number

戻り値

void

setLockAspectRatio(lockAspectRatio)

この図形の縦横比をロックする場合に指定します。

setLockAspectRatio(lockAspectRatio: boolean): void;

パラメーター

lockAspectRatio

boolean

戻り値

void

setName(name)

図形の名前を指定します。

setName(name: string): void;

パラメーター

name

string

戻り値

void

setPlacement(placement)

オブジェクトがその下のセルに接続されている方法を表します。

setPlacement(placement: Placement): void;

パラメーター

戻り値

void

setRotation(rotation)

図形の回転角度を度で指定します。

setRotation(rotation: number): void;

パラメーター

rotation

number

戻り値

void

setTop(top)

図形の上端からワークシートの上までのポイント単位の距離です。 負の値 InvalidArgument を入力として設定すると、例外をスローします。

setTop(top: number): void;

パラメーター

top

number

戻り値

void

setVisible(visible)

図形が表示される場合に指定します。

setVisible(visible: boolean): void;

パラメーター

visible

boolean

戻り値

void

setWidth(width)

図形の幅をポイント単位で指定します。 負の値 InvalidArgument または 0 を入力として設定すると、例外をスローします。

setWidth(width: number): void;

パラメーター

width

number

戻り値

void

setZOrder(position)

指定された図形をコレクションの z オーダーで上または下に移動します。他の図形の手前または奥に移動します。

setZOrder(position: ShapeZOrder): void;

パラメーター

position
ExcelScript.ShapeZOrder

Z オーダー スタック内の図形を他の図形に対して相対的に移動する場所。 詳細は「ExcelScript.ShapeZOrder」をご覧ください。

戻り値

void