Visio.ShapeDataItem class

  • Referencia
Paquete:
visio

Representa el elemento ShapeDataItem.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: 1.1 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
format

Cadena que especifica el formato del elemento de datos de formas.
formattedValue

Cadena que especifica el valor con formato del elemento de datos de formas.
label

Una cadena que especifica la etiqueta del elemento de datos de formas.
value

Una cadena que especifica el valor del elemento de datos de formas.

Métodos

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Visio.ShapeDataItem original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.ShapeDataItemData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Visio.RequestContext

format

Cadena que especifica el formato del elemento de datos de formas.

readonly format: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

formattedValue

Cadena que especifica el valor con formato del elemento de datos de formas.

readonly formattedValue: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

label

Una cadena que especifica la etiqueta del elemento de datos de formas.

readonly label: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

value

Una cadena que especifica el valor del elemento de datos de formas.

readonly value: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: 1.1 ]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options
Visio.Interfaces.ShapeDataItemLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Visio.ShapeDataItem

Ejemplos

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)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Visio.ShapeDataItem

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Visio.ShapeDataItem

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Visio.ShapeDataItem original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.ShapeDataItemData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Visio.Interfaces.ShapeDataItemData;

Devoluciones

Visio.Interfaces.ShapeDataItemData