Visio.PageView class

リファレンス

パッケージ:: visio

PageView クラスを表します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

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)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setMockData(data)	モックデータを設定する
setPosition(Position)	ビューでページの位置を設定します。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出 `toJSON` します)。元の Visio.PageView オブジェクトは API オブジェクトですが、メソッドは、元の `toJSON` オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として `Visio.Interfaces.PageViewData`型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Visio.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>;

戻り値

OfficeExtension.ClientResult<Visio.Position>

注釈

[ API セット: 1.1 ]

getSelection()

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

getSelection(): Visio.Selection;

戻り値

Visio.Selection

注釈

[ API セット: 1.1 ]

isShapeInViewport(Shape)

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

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

パラメーター

Shape: Visio.Shape

チェックする図形。

戻り値

OfficeExtension.ClientResult<boolean>

注釈

[ API セット: 1.1 ]

load(options)

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

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

パラメーター

options: Visio.Interfaces.PageViewLoadOptions

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

戻り値

Visio.PageView

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

Visio.PageView

load(propertyNamesAndPaths)

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

パラメーター

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

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

戻り値

Visio.PageView

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

setMockData(data)

モックデータを設定する

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

パラメーター

data: Visio.Interfaces.PageViewData

戻り値

void

setPosition(Position)

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

setPosition(Position: Visio.Position): void;

パラメーター

Position: Visio.Position

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

戻り値

void

注釈

[ API セット: 1.1 ]

toJSON()

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

toJSON(): Visio.Interfaces.PageViewData;

戻り値

Visio.Interfaces.PageViewData

Visio.PageView class

注釈

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

zoom

プロパティ値

注釈

例

メソッドの詳細

centerViewportOnShape(ShapeId)

パラメーター

戻り値

注釈

例

fitToWindow()

戻り値

注釈

getPosition()

戻り値

注釈

getSelection()

戻り値

注釈

isShapeInViewport(Shape)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

set(properties, options)

パラメーター

戻り値

set(properties)

パラメーター

戻り値

setMockData(data)

パラメーター

戻り値

setPosition(Position)

パラメーター

戻り値

注釈

toJSON()

戻り値

フィードバック

その他のリソース