Visio.ShapeView class

ShapeView クラスを表します。

Extends

注釈

[ API セット: 1.1 ]

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

highlight

図形の周囲の強調表示を表します。

メソッド

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

図形の上にオーバーレイを追加します。

addOverlay(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)

図形の上にオーバーレイを追加します。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

removeOverlay(OverlayId)

特定のオーバーレイまたは図形上のすべてのオーバーレイを削除します。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

setMockData(data)

モック データを設定する

setText(Text)

SetText API の目的は、実行時に Visio Shape 内のテキストを更新することです。 更新されたテキストは、図形のテキストの既存の書式設定プロパティを保持します。

showOverlay(overlayId, show)

図形に特定のオーバーレイを表示します。

toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Visio.ShapeView オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Visio.Interfaces.ShapeViewData型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

highlight

図形の周囲の強調表示を表します。

highlight: Visio.Highlight;

プロパティ値

注釈

[ API セット: 1.1 ]

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.highlight = { color: "#E7E7E7", width: 100 };
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

メソッドの詳細

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

図形の上にオーバーレイを追加します。

addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;

パラメーター

OverlayType
Visio.OverlayType

オーバーレイの種類。 'Text'、'Image'、または 'Html' を指定できます。

Content

string

オーバーレイのコンテンツ。

OverlayHorizontalAlignment
Visio.OverlayHorizontalAlignment

オーバーレイの水平方向の配置。 'Left'、'Center'、または 'Right' を指定できます。

OverlayVerticalAlignment
Visio.OverlayVerticalAlignment

オーバーレイの垂直方向の配置。 'Top'、'Middle'、'Bottom' を指定できます。

Width

number

オーバーレイの幅。

Height

number

オーバーレイの高さ。

戻り値

注釈

[ API セット: 1.1 ]

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const overlayId = shape.view.addOverlay("Image", "Visio Online", "Center", "Middle", 50, 50);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

addOverlay(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)

図形の上にオーバーレイを追加します。

addOverlay(OverlayTypeString: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignmentString: "Left" | "Center" | "Right", OverlayVerticalAlignmentString: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;

パラメーター

OverlayTypeString

"Text" | "Image" | "Html"

オーバーレイの種類。 'Text'、'Image'、または 'Html' を指定できます。

Content

string

オーバーレイのコンテンツ。

OverlayHorizontalAlignmentString

"Left" | "Center" | "Right"

オーバーレイの水平方向の配置。 'Left'、'Center'、または 'Right' を指定できます。

OverlayVerticalAlignmentString

"Top" | "Middle" | "Bottom"

オーバーレイの垂直方向の配置。 'Top'、'Middle'、'Bottom' を指定できます。

Width

number

オーバーレイの幅。

Height

number

オーバーレイの高さ。

戻り値

注釈

[ API セット: 1.1 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Visio.Interfaces.ShapeViewLoadOptions): Visio.ShapeView;

パラメーター

options
Visio.Interfaces.ShapeViewLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Visio.ShapeView;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.ShapeView;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

removeOverlay(OverlayId)

特定のオーバーレイまたは図形上のすべてのオーバーレイを削除します。

removeOverlay(OverlayId: number): void;

パラメーター

OverlayId

number

オーバーレイの ID。図形から特定のオーバーレイの ID を削除します。

戻り値

void

注釈

[ API セット: 1.1 ]

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.removeOverlay(1);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Visio.Interfaces.ShapeViewUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Visio.ShapeView): void;

パラメーター

properties
Visio.ShapeView

戻り値

void

setMockData(data)

モック データを設定する

setMockData(data: Visio.Interfaces.ShapeViewData): void;

パラメーター

戻り値

void

setText(Text)

SetText API の目的は、実行時に Visio Shape 内のテキストを更新することです。 更新されたテキストは、図形のテキストの既存の書式設定プロパティを保持します。

setText(Text: string): void;

パラメーター

Text

string

Text パラメーターは、図形に表示する更新されたテキストです。

戻り値

void

注釈

[ API セット: 1.1 ]

showOverlay(overlayId, show)

図形に特定のオーバーレイを表示します。

showOverlay(overlayId: number, show: boolean): void;

パラメーター

overlayId

number

コンテキスト内のオーバーレイ ID。

show

boolean

オーバーレイを表示するかどうか。

戻り値

void

注釈

[ API セット: 1.1 ]

toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Visio.ShapeView オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Visio.Interfaces.ShapeViewData型指定) を返します。

toJSON(): Visio.Interfaces.ShapeViewData;

戻り値