Visio.Shape class

Comments コレクションを返します。

readonly comments: Visio.CommentCollection;

プロパティ値

注釈

[ API セット: 1.1 ]

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

context: RequestContext;

プロパティ値

図形オブジェクトのハイパーリンク コレクションを返します。

readonly hyperlinks: Visio.HyperlinkCollection;

プロパティ値

注釈

[ API セット: 1.1 ]

図形の識別子。

readonly id: number;

プロパティ値

注釈

[ API セット: 1.1 ]

図形の名前。

readonly name: string;

プロパティ値

注釈

[ API セット: 1.1 ]

図形が選択されている場合は true を返します。 ユーザーが true に設定すれば、明示的に図形を選択できます。

select: boolean;

プロパティ値

注釈

[ API セット: 1.1 ]

図形のデータ セクションを返します。

readonly shapeDataItems: Visio.ShapeDataItemCollection;

プロパティ値

注釈

[ API セット: 1.1 ]

SubShape コレクションを取得します。

readonly subShapes: Visio.ShapeCollection;

プロパティ値

注釈

[ API セット: 1.1 ]

図形のテキスト。

readonly text: string;

プロパティ値

注釈

[ API セット: 1.1 ]

図形のビューを返します。

readonly view: Visio.ShapeView;

プロパティ値

注釈

[ API セット: 1.1 ]

図形の絶対境界ボックスを指定する AbsoluteBoundingBox オブジェクトを返します。

getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

戻り値

注釈

[ API セット: 1.1 ]

図形の境界ボックスを指定する BoundingBox オブジェクトを返します。

getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

戻り値

注釈

[ API セット: 1.1 ]

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

load(options?: Visio.Interfaces.ShapeLoadOptions): Visio.Shape;

パラメーター

戻り値

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

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

パラメーター

戻り値

例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Sample Name";
    const shape = activePage.shapes.getItem(shapeName);
    shape.load(["name", "id", "text", "select"]);
    return ctx.sync().then(function () {
        console.log(shape.name);
        console.log(shape.id);
        console.log(shape.text);
        console.log(shape.select);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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));
    }
});

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

set(properties: Visio.Shape): void;

パラメーター

戻り値

モック データを設定する

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

パラメーター

戻り値

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

toJSON(): Visio.Interfaces.ShapeData;

戻り値