Visio.PageView class

PageView クラスを表します。

Extends

プロパティ

context

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

zoom

ページのズーム レベルを取得して設定します。 値は 10 から 400 までの範囲で指定でき、ズームの割合を表します。

メソッド

centerViewportOnShape(ShapeId)

ビューの中央に指定した図形を配置する Visio の描画をパンします。

fitToWindow()

現在のウィンドウにページを合わせます。

getPosition()

ビューでページの位置を指定する位置オブジェクトを返します。

getSelection()

ページの選択範囲を表します。

isShapeInViewport(Shape)

図形がページのビュー内にあるかどうかを確認します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

setPosition(Position)

ビューでページの位置を設定します。

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

zoom

ページのズーム レベルを取得して設定します。 値は 10 から 400 までの範囲で指定でき、ズームの割合を表します。

zoom: number;

プロパティ値

number

注釈

API セット: 1.1

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

メソッドの詳細

centerViewportOnShape(ShapeId)

ビューの中央に指定した図形を配置する Visio の描画をパンします。

centerViewportOnShape(ShapeId: number): void;

パラメーター

ShapeId

number

中央に表示するため ShapeId。

返品

void

注釈

API セット: 1.1

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

fitToWindow()

現在のウィンドウにページを合わせます。

fitToWindow(): void;

返品

void

注釈

API セット: 1.1

getPosition()

ビューでページの位置を指定する位置オブジェクトを返します。

getPosition(): OfficeExtension.ClientResult<Visio.Position>;

返品

注釈

API セット: 1.1

getSelection()

ページの選択範囲を表します。

getSelection(): Visio.Selection;

返品

注釈

API セット: 1.1

isShapeInViewport(Shape)

図形がページのビュー内にあるかどうかを確認します。

isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;

パラメーター

Shape
Visio.Shape

チェックする図形。

返品

注釈

API セット: 1.1

load(options)

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

load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;

パラメーター

options
Visio.Interfaces.PageViewLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

set(properties, options)

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

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

パラメーター

properties
Visio.Interfaces.PageViewUpdateData

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

options
OfficeExtension.UpdateOptions

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

返品

void

set(properties)

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

set(properties: Visio.PageView): void;

パラメーター

properties
Visio.PageView

返品

void

setPosition(Position)

ビューでページの位置を設定します。

setPosition(Position: Visio.Position): void;

パラメーター

Position
Visio.Position

ビューで、ページの新しい位置を指定する位置オブジェクト。

返品

void

注釈

API セット: 1.1

toJSON()

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

toJSON(): Visio.Interfaces.PageViewData;

返品