Visio.PageView class
Representa la clase PageView.
- 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. |
| zoom | Obtener y establecer el nivel de zoom de la página. El valor puede estar entre 10 y 400 y denota el porcentaje de zoom. |
Métodos
| center |
Aplica panorámica en el dibujo de Visio para colocar la forma especificada en el centro de la vista. |
| fit |
Ajustar página a la ventana actual. |
| get |
Devuelve el objeto de posición que especifica la posición de la página en la vista. |
| get |
Representa la selección de la página. |
| is |
Para comprobar si la forma está en vista de la página o no. |
| 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 |
| 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 |
Establece la posición de la página en la vista. |
| 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
zoom
Obtener y establecer el nivel de zoom de la página. El valor puede estar entre 10 y 400 y denota el porcentaje de zoom.
zoom: number;Valor de propiedad
number
Comentarios
Ejemplos
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
activePage.view.zoom = 300;
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
centerViewportOnShape(ShapeId)
Aplica panorámica en el dibujo de Visio para colocar la forma especificada en el centro de la vista.
centerViewportOnShape(ShapeId: number): void;Parámetros
- ShapeId
-
number
ShapeId para que se vea en el centro.
Devoluciones
void
Comentarios
Ejemplos
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
activePage.view.centerViewportOnShape(shape.Id);
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
fitToWindow()
Ajustar página a la ventana actual.
fitToWindow(): void;Devoluciones
void
Comentarios
getPosition()
Devuelve el objeto de posición que especifica la posición de la página en la vista.
getPosition(): OfficeExtension.ClientResult<Visio.Position>;Devoluciones
Comentarios
getSelection()
Representa la selección de la página.
getSelection(): Visio.Selection;Devoluciones
Comentarios
isShapeInViewport(Shape)
Para comprobar si la forma está en vista de la página o no.
isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;Parámetros
- Shape
- Visio.Shape
Forma que se va a comprobar.
Devoluciones
OfficeExtension.ClientResult<boolean>
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.PageViewLoadOptions): Visio.PageView;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.PageView;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.PageView;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
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.PageViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Visio.Interfaces.PageViewUpdateData
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.PageView): void;Parámetros
- properties
- Visio.PageView
Devoluciones
void
setPosition(Position)
Establece la posición de la página en la vista.
setPosition(Position: Visio.Position): void;Parámetros
- Position
- Visio.Position
Objeto de posición que especifica la nueva posición de la página en la vista.
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.PageView original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.PageViewData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Visio.Interfaces.PageViewData;