visio package

クラス

Visio.Application	アプリケーションを表します。
Visio.Comment	コメントを表します。
Visio.CommentCollection	特定の図形の CommentCollection を表します。
Visio.Document	ドキュメント クラスを表します。
Visio.DocumentView	DocumentView クラスを表します。
Visio.Hyperlink	ハイパーリンクを表します。
Visio.HyperlinkCollection	ハイパーリンク コレクションを表します。
Visio.Page	Page クラスを表します。
Visio.PageCollection	ドキュメントの一部であるページ オブジェクトのコレクションを表します。
Visio.PageView	PageView クラスを表します。
Visio.RequestContext	RequestContext オブジェクトは、Visio アプリケーションへの要求を容易にします。 Office アドインと Visio アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Visio オブジェクト モデルにアクセスするには要求コンテキストが必要です。
Visio.Selection	ページの選択範囲を表します。
Visio.Shape	図形クラスを表します。
Visio.ShapeCollection	図形コレクションを表します。
Visio.ShapeDataItem	ShapeDataItem を表します。
Visio.ShapeDataItemCollection	特定の図形の ShapeDataItemCollection を表します。
Visio.ShapeView	ShapeView クラスを表します。

インターフェイス

Visio.BoundingBox	図形の BoundingBox を表します。
Visio.DataRefreshCompleteEventArgs	DataRefreshComplete イベントが発生したドキュメントに関する情報を提供します。
Visio.DocumentErrorEventArgs	DocumentError イベントに関する情報を提供します。
Visio.DocumentLoadCompleteEventArgs	DocumentLoadComplete イベントの成功または失敗に関する情報を提供します。
Visio.Highlight	図形に追加された強調表示のデータを表します。
Visio.Interfaces.ApplicationData	application.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ApplicationLoadOptions	アプリケーションを表します。
Visio.Interfaces.ApplicationUpdateData	application.set({ ... }) で使用するために、Application オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.CollectionLoadOptions	コレクションのメンバーのサブセットのみのプロパティを読み込む方法を提供します。
Visio.Interfaces.CommentCollectionData	commentCollection.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.CommentCollectionLoadOptions	特定の図形の CommentCollection を表します。
Visio.Interfaces.CommentCollectionUpdateData	commentCollection.set({ ... }) で使用するために CommentCollection オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.CommentData	comment.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.CommentLoadOptions	コメントを表します。
Visio.Interfaces.CommentUpdateData	comment.set({ ... }) で使用するために Comment オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.DocumentData	document.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.DocumentLoadOptions	ドキュメント クラスを表します。
Visio.Interfaces.DocumentUpdateData	document.set({ ... }) で使用するために Document オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.DocumentViewData	documentView.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.DocumentViewLoadOptions	DocumentView クラスを表します。
Visio.Interfaces.DocumentViewUpdateData	documentView.set({ ... }) で使用するために DocumentView オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.HyperlinkCollectionData	hyperlinkCollection.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.HyperlinkCollectionLoadOptions	ハイパーリンク コレクションを表します。
Visio.Interfaces.HyperlinkCollectionUpdateData	hyperlinkCollection.set({ ... }) で使用するために HyperlinkCollection オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.HyperlinkData	hyperlink.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.HyperlinkLoadOptions	ハイパーリンクを表します。
Visio.Interfaces.PageCollectionData	pageCollection.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.PageCollectionLoadOptions	ドキュメントの一部であるページ オブジェクトのコレクションを表します。
Visio.Interfaces.PageCollectionUpdateData	pageCollection.set({ ... }) で使用するために PageCollection オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.PageData	page.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.PageLoadOptions	Page クラスを表します。
Visio.Interfaces.PageUpdateData	page.set({ ... }) で使用するために Page オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.PageViewData	pageView.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.PageViewLoadOptions	PageView クラスを表します。
Visio.Interfaces.PageViewUpdateData	pageView.set({ ... }) で使用するために PageView オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.SelectionData	selection.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ShapeCollectionData	shapeCollection.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ShapeCollectionLoadOptions	図形コレクションを表します。
Visio.Interfaces.ShapeCollectionUpdateData	shapeCollection.set({ ... }) で使用するために ShapeCollection オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.ShapeData	shape.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ShapeDataItemCollectionData	shapeDataItemCollection.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ShapeDataItemCollectionLoadOptions	特定の図形の ShapeDataItemCollection を表します。
Visio.Interfaces.ShapeDataItemCollectionUpdateData	shapeDataItemCollection.set({ ... }) で使用するために ShapeDataItemCollection オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.ShapeDataItemData	shapeDataItem.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ShapeDataItemLoadOptions	ShapeDataItem を表します。
Visio.Interfaces.ShapeLoadOptions	図形クラスを表します。
Visio.Interfaces.ShapeUpdateData	shape.set({ ... }) で使用するために Shape オブジェクトのデータを更新するためのインターフェイス。
Visio.Interfaces.ShapeViewData	shapeView.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。
Visio.Interfaces.ShapeViewLoadOptions	ShapeView クラスを表します。
Visio.Interfaces.ShapeViewUpdateData	shapeView.set({ ... }) で使用するために ShapeView オブジェクトのデータを更新するためのインターフェイス。
Visio.PageLoadCompleteEventArgs	PageLoadComplete イベントが発生したページに関する情報を提供します。
Visio.PageRenderCompleteEventArgs	PageRenderComplete イベントを発生させたページに関する情報を提供します。
Visio.Position	ビュー内のオブジェクトの位置を表します。
Visio.SelectionChangedEventArgs	SelectionChanged イベントが発生した図形のコレクションに関する情報を提供します。
Visio.ShapeMouseEnterEventArgs	ShapeMouseEnter イベントを発生させた図形に関する情報を提供します。
Visio.ShapeMouseLeaveEventArgs	ShapeMouseLeave イベントを発生させた図形に関する情報を提供します。
Visio.TaskPaneStateChangedEventArgs	TaskPaneStateChanged イベントに関する情報を提供します。

列挙型

Visio.ColumnType	列値の型を表します。
Visio.ConnectorDirection	DataVisualizer ダイアグラムのコネクタの方向。
Visio.CrossFunctionalFlowchartOrientation	部門連係フローチャート図の向きを表します。
Visio.DataSourceType	データ接続のソースの種類を表します。
Visio.DataValidationErrorType	データ検証エラーの種類を表します。
Visio.DataVisualizerDiagramOperationType	データ ビジュアライザーのダイアグラム操作の種類
Visio.DataVisualizerDiagramResultType	データ ビジュアライザー ダイアグラムの操作の結果。
Visio.DataVisualizerDiagramType	データ ビジュアライザー図用の DiagramType。
Visio.ErrorCodes
Visio.EventType	EventType は、ホストがサポートするイベントの種類を表します。
Visio.LayoutVariant	レイアウトの種類を表します。
Visio.MessageType	MessageType は、ホストからイベントが発生したときのメッセージの種類を表します。
Visio.OverlayHorizontalAlignment	図形を基準としたオーバーレイの水平方向の配置を表します。
Visio.OverlayType	オーバーレイのタイプを表します。
Visio.OverlayVerticalAlignment	図形を基準としたオーバーレイの垂直方向の配置を表します。
Visio.TaskPaneType	TaskPaneType は、API を介してホストがサポートするファースト パーティのタスクペインの種類を表します。 Show TaskPane API、TaskPane State Changed、または同様のイベントの場合に使用されます。
Visio.ToolBarType	アプリのツール バー ID。

関数

Visio.run(batch)	新しい要求コンテキストを使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 Promise が解決されると、実行中に自動的に割り当てられたすべての追跡対象オブジェクトが解放されます。
Visio.run(object, batch)	以前に作成した API オブジェクトの要求コンテキストを使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。
Visio.run(objects, batch)	以前に作成した API オブジェクトの要求コンテキストを使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。
Visio.run(contextObject, batch)	以前に作成したオブジェクトの RequestContext を使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 Promise が解決されると、実行中に自動的に割り当てられたすべての追跡対象オブジェクトが解放されます。

関数の詳細

Visio.run(batch)

新しい要求コンテキストを使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 Promise が解決されると、実行中に自動的に割り当てられたすべての追跡対象オブジェクトが解放されます。

export function run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

パラメーター

batch

(context: Visio.RequestContext) => Promise<T>

Visio.RequestContext を受け取り、promise を返す関数 (通常は context.sync() の結果のみ)。 context パラメーターは、Visio アプリケーションへの要求を容易にします。 Office アドインと Visio アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Visio オブジェクト モデルにアクセスするには要求コンテキストが必要です。

返品

Promise<T>

Visio.run(object, batch)

以前に作成した API オブジェクトの要求コンテキストを使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。

export function run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

パラメーター

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

以前に作成した API オブジェクト。 バッチでは、渡されたオブジェクトと同じ要求コンテキストが使用されます。つまり、オブジェクトに適用されたすべての変更が context.sync() によって取得されます。

batch

(context: Visio.RequestContext) => Promise<T>

Visio.RequestContext を受け取り、promise を返す関数 (通常は context.sync() の結果のみ)。 Promise が解決されると、実行中に自動的に割り当てられたすべての追跡対象オブジェクトが解放されます。

返品

Promise<T>

例

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
Visio.run(session, function (context) {
    const activePage = context.document.getActivePage();
    // Interact with the Visio page... 

    return context.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Visio.run(objects, batch)

以前に作成した API オブジェクトの要求コンテキストを使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

パラメーター

objects

OfficeExtension.ClientObject[]

以前に作成された API オブジェクトの配列。 配列は、すべてのオブジェクトが同じコンテキストを共有していることを確認するために検証されます。 バッチではこの共有要求コンテキストが使用されます。つまり、これらのオブジェクトに適用される変更はすべて context.sync() によって取得されます。

batch

(context: Visio.RequestContext) => Promise<T>

Visio.RequestContext を受け取り、promise (通常は context.sync() の結果のみ) を返す関数。 Promise が解決されると、実行中に自動的に割り当てられたすべての追跡対象オブジェクトが解放されます。

返品

Promise<T>

Visio.run(contextObject, batch)

以前に作成したオブジェクトの RequestContext を使用して、Visio オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 Promise が解決されると、実行中に自動的に割り当てられたすべての追跡対象オブジェクトが解放されます。

export function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

パラメーター

contextObject

OfficeExtension.ClientRequestContext

以前に作成した Visio.RequestContext。 このコンテキストは、(新しいコンテキストを作成する代わりに) バッチ関数によって再利用されます。 つまり、既存の API オブジェクトが同じコンテキストから派生した場合、それらのオブジェクトに加えられた変更をバッチで取得できることを意味します。

batch

(context: Visio.RequestContext) => Promise<T>

RequestContext を受け取り、Promise を返す関数 (通常は context.sync() の結果のみ)。 context パラメーターは、Visio アプリケーションへの要求を容易にします。 Office アドインと Visio アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Visio オブジェクト モデルにアクセスするには RequestContext が必要です。

返品

Promise<T>