Visio.ShapeView class
Representa la clase ShapeView.
- Extends
Comentarios
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| highlight | Representa el resaltado alrededor de la forma. |
Métodos
| add |
Agrega una superposición encima de la forma. |
| add |
Agrega una superposición encima de la forma. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| remove |
Quita una superposición específica o todas las superposiciones de la forma. |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| set |
El propósito de SetText API es actualizar el texto dentro de una forma de Visio en tiempo de ejecución. El texto actualizado conserva las propiedades de formato existentes del texto de la forma. |
| show |
Muestra una superposición determinada en la forma. |
| toJSON() | Invalida el método JavaScript |
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
highlight
Representa el resaltado alrededor de la forma.
highlight: Visio.Highlight;Valor de propiedad
Comentarios
Ejemplos
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));
}
});
Detalles del método
addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)
Agrega una superposición encima de la forma.
addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;Parámetros
- OverlayType
- Visio.OverlayType
Un tipo de superposición. Puede ser "Text", "Image" o "Html".
- Content
-
string
Contenido de superposición.
- OverlayHorizontalAlignment
- Visio.OverlayHorizontalAlignment
Alineación horizontal de superposición. Puede ser "Left", "Center" o "Right".
- OverlayVerticalAlignment
- Visio.OverlayVerticalAlignment
Alineación vertical de superposición. Puede ser "Top", "Middle", "Bottom".
- Width
-
number
Ancho de superposición.
- Height
-
number
Alto de superposición.
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
Ejemplos
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
const overlayId = shape.view.addOverlay("Image", "Visio Online", "Center", "Middle", 50, 50);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
addOverlay(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)
Agrega una superposición encima de la forma.
addOverlay(OverlayTypeString: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignmentString: "Left" | "Center" | "Right", OverlayVerticalAlignmentString: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;Parámetros
- OverlayTypeString
-
"Text" | "Image" | "Html"
Un tipo de superposición. Puede ser "Text", "Image" o "Html".
- Content
-
string
Contenido de superposición.
- OverlayHorizontalAlignmentString
-
"Left" | "Center" | "Right"
Alineación horizontal de superposición. Puede ser "Left", "Center" o "Right".
- OverlayVerticalAlignmentString
-
"Top" | "Middle" | "Bottom"
Alineación vertical de superposición. Puede ser "Top", "Middle", "Bottom".
- Width
-
number
Ancho de superposición.
- Height
-
number
Alto de superposición.
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
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.ShapeViewLoadOptions): Visio.ShapeView;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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.ShapeView;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
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.ShapeView;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
removeOverlay(OverlayId)
Quita una superposición específica o todas las superposiciones de la forma.
removeOverlay(OverlayId: number): void;Parámetros
- OverlayId
-
number
Un identificador de superposición. Elimina el identificador específico de superposición de la forma.
Devoluciones
void
Comentarios
Ejemplos
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
shape.view.removeOverlay(1);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Visio.Interfaces.ShapeViewUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Visio.ShapeView): void;Parámetros
- properties
- Visio.ShapeView
Devoluciones
void
setText(Text)
El propósito de SetText API es actualizar el texto dentro de una forma de Visio en tiempo de ejecución. El texto actualizado conserva las propiedades de formato existentes del texto de la forma.
setText(Text: string): void;Parámetros
- Text
-
string
El parámetro Text es el texto actualizado que se va a mostrar en la forma.
Devoluciones
void
Comentarios
showOverlay(overlayId, show)
Muestra una superposición determinada en la forma.
showOverlay(overlayId: number, show: boolean): void;Parámetros
- overlayId
-
number
El identificador de superposición en contexto.
- show
-
boolean
Si se va a mostrar la superposición.
Devoluciones
void
Comentarios
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.ShapeView original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.ShapeViewData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Visio.Interfaces.ShapeViewData;