Visio.ShapeDataItem class

Pacote:

visio

Representa o ShapeDataItem.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 1.1 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
format	Uma cadeia de caracteres que especifica o formato do item de dados de forma.
formattedValue	Uma cadeia de caracteres que especifica o valor formatado do item de dados de forma.
label	Uma cadeia de caracteres que especifica o rótulo do item de dados de forma.
value	Uma cadeia de caracteres que especifica o valor do item de dados de forma.

Métodos

load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
setMockData(data)	Definir dados simulados
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.ShapeDataItem original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.ShapeDataItemData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Visio.RequestContext

format

Uma cadeia de caracteres que especifica o formato do item de dados de forma.

readonly format: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

formattedValue

Uma cadeia de caracteres que especifica o valor formatado do item de dados de forma.

readonly formattedValue: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

label

Uma cadeia de caracteres que especifica o rótulo do item de dados de forma.

readonly label: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

value

Uma cadeia de caracteres que especifica o valor do item de dados de forma.

readonly value: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 1.1 ]

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options

Visio.Interfaces.ShapeDataItemLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Visio.ShapeDataItem

Exemplos

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)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Visio.ShapeDataItem

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Visio.ShapeDataItem

setMockData(data)

Definir dados simulados

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

Parâmetros

data

Visio.Interfaces.ShapeDataItemData

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.ShapeDataItem original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.ShapeDataItemData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Visio.Interfaces.ShapeDataItemData;

Retornos

Visio.Interfaces.ShapeDataItemData