Visio.ShapeDataItem class

パッケージ:

visio

ShapeDataItem を表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: 1.1 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
format	図形データ項目の形式を指定する文字列です。
formattedValue	図形データ項目の書式設定された値を指定する文字列です。
label	図形データ項目のラベルを指定する文字列です。
value	図形データ項目の値を指定する文字列です。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
setMockData(data)	モック データを設定する
toJSON()	API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Visio.ShapeDataItem オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Visio.Interfaces.ShapeDataItemData型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Visio.RequestContext

format

図形データ項目の形式を指定する文字列です。

readonly format: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

formattedValue

図形データ項目の書式設定された値を指定する文字列です。

readonly formattedValue: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

label

図形データ項目のラベルを指定する文字列です。

readonly label: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

value

図形データ項目の値を指定する文字列です。

readonly value: string;

プロパティ値

string

注釈

[ API セット: 1.1 ]

メソッドの詳細

load(options)

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

load(options?: Visio.Interfaces.ShapeDataItemLoadOptions): Visio.ShapeDataItem;

パラメーター

options

Visio.Interfaces.ShapeDataItemLoadOptions

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

戻り値

Visio.ShapeDataItem

例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const shapeDataItem = shape.shapeDataItems.getItem(0);
    shapeDataItem.load(["label", "value"]);
        return ctx.sync().then(function() {
            console.log(shapeDataItem.label);
            console.log(shapeDataItem.value);
        });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Visio.ShapeDataItem

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Visio.ShapeDataItem

setMockData(data)

モック データを設定する

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

パラメーター

data

Visio.Interfaces.ShapeDataItemData

戻り値

void

toJSON()

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

toJSON(): Visio.Interfaces.ShapeDataItemData;

戻り値

Visio.Interfaces.ShapeDataItemData