Visio.Document class
ドキュメント クラスを表します。
- Extends
注釈
[ API セット: 1.1 ]
プロパティ
| application | このドキュメントを含む Visio アプリケーションのインスタンスを表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| pages | ドキュメントに関連付けられているページのコレクションを表します。 |
| view | DocumentView オブジェクトを返します。 |
メソッド
| get |
ドキュメントのアクティブ ページを返します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
ドキュメントのアクティブ ページを設定します。 |
| set |
モック データを設定する |
| show |
TaskPane を表示または非表示にします。 これは、作業ウィンドウを表示/非表示にするために Visio 図面を埋め込む DV Excel アドイン/その他のサードパーティ製アプリによって使用されます。 |
| show |
TaskPane を表示または非表示にします。 これは、作業ウィンドウを表示/非表示にするために Visio 図面を埋め込む DV Excel アドイン/その他のサードパーティ製アプリによって使用されます。 |
| start |
すべてのページについて、図内のデータの更新をトリガーします。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
イベント
| on |
図でデータが更新されたときに発生します。 |
| on |
セッションで予期されるエラーまたは予期しないエラーが発生した場合に発生します。 |
| on |
ドキュメントの読み込み、更新、または変更時に発生します。 |
| on |
ページの読み込みが完了したときに発生します。 |
| on |
図形の現在の選択が変更されたときに発生します。 |
| on |
ユーザーがマウス ポインターを図形の境界ボックスに移動したときに発生します。 |
| on |
ユーザーが図形の境界ボックスからマウスを移動したときに発生します。 |
| on |
作業ウィンドウの状態が変更されるたびに発生します。 |
プロパティの詳細
application
このドキュメントを含む Visio アプリケーションのインスタンスを表します。
readonly application: Visio.Application;プロパティ値
注釈
[ API セット: 1.1 ]
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
pages
ドキュメントに関連付けられているページのコレクションを表します。
readonly pages: Visio.PageCollection;プロパティ値
注釈
[ API セット: 1.1 ]
例
Visio.run(session, function (ctx) {
const pages = ctx.document.pages;
const pageCount = pages.getCount();
return ctx.sync().then(function () {
console.log("Pages Count: " +pageCount.value);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
view
メソッドの詳細
getActivePage()
ドキュメントのアクティブ ページを返します。
getActivePage(): Visio.Page;戻り値
注釈
[ API セット: 1.1 ]
例
Visio.run(session, function (ctx) {
const document = ctx.document;
const activePage = document.getActivePage();
activePage.load("name");
return ctx.sync().then(function () {
console.log("pageName: " +activePage.name);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Visio.Interfaces.DocumentLoadOptions): Visio.Document;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Visio.Document;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Document;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Visio.Interfaces.DocumentUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Visio.Document): void;パラメーター
- properties
- Visio.Document
戻り値
void
setActivePage(PageName)
ドキュメントのアクティブ ページを設定します。
setActivePage(PageName: string): void;パラメーター
- PageName
-
string
ページの名前です。
戻り値
void
注釈
[ API セット: 1.1 ]
例
Visio.run(session, function (ctx) {
const document = ctx.document;
const pageName = "Page-1";
document.setActivePage(pageName);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
setMockData(data)
モック データを設定する
setMockData(data: Visio.Interfaces.DocumentData): void;パラメーター
戻り値
void
showTaskPane(taskPaneType, initialProps, show)
TaskPane を表示または非表示にします。 これは、作業ウィンドウを表示/非表示にするために Visio 図面を埋め込む DV Excel アドイン/その他のサードパーティ製アプリによって使用されます。
showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;パラメーター
- taskPaneType
- Visio.TaskPaneType
第 1 パーティー TaskPane の種類。 Enum TaskPaneType から値を取得できます
- initialProps
-
any
省略可能なパラメーター。 これは、作業ウィンドウの内容を初期化するために必要な初期データが格納される汎用データ構造です。
- show
-
boolean
省略可能なパラメーター。 false に設定すると、指定した作業ウィンドウが非表示になります。
戻り値
void
注釈
[ API セット: 1.1 ]
showTaskPane(taskPaneTypeString, initialProps, show)
TaskPane を表示または非表示にします。 これは、作業ウィンドウを表示/非表示にするために Visio 図面を埋め込む DV Excel アドイン/その他のサードパーティ製アプリによって使用されます。
showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;パラメーター
- taskPaneTypeString
-
"None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"
第 1 パーティー TaskPane の種類。 Enum TaskPaneType から値を取得できます
- initialProps
-
any
省略可能なパラメーター。 これは、作業ウィンドウの内容を初期化するために必要な初期データが格納される汎用データ構造です。
- show
-
boolean
省略可能なパラメーター。 false に設定すると、指定した作業ウィンドウが非表示になります。
戻り値
void
注釈
[ API セット: 1.1 ]
startDataRefresh()
すべてのページについて、図内のデータの更新をトリガーします。
startDataRefresh(): void;戻り値
void
注釈
[ API セット: 1.1 ]
例
Visio.run(session, function (ctx) {
const document = ctx.document;
document.startDataRefresh();
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Visio.Document オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Visio.Interfaces.DocumentData型指定) を返します。
toJSON(): Visio.Interfaces.DocumentData;戻り値
イベントの詳細
onDataRefreshComplete
図でデータが更新されたときに発生します。
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onDocumentError
セッションで予期されるエラーまたは予期しないエラーが発生した場合に発生します。
readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onDocumentLoadComplete
ドキュメントの読み込み、更新、または変更時に発生します。
readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onPageLoadComplete
ページの読み込みが完了したときに発生します。
readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onSelectionChanged
図形の現在の選択が変更されたときに発生します。
readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onShapeMouseEnter
ユーザーがマウス ポインターを図形の境界ボックスに移動したときに発生します。
readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onShapeMouseLeave
ユーザーが図形の境界ボックスからマウスを移動したときに発生します。
readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
onTaskPaneStateChanged
作業ウィンドウの状態が変更されるたびに発生します。
readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;イベントの種類
注釈
[ API セット: 1.1 ]
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示