Visio.Document class

Paquete:

visio

Representa la clase Document.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: 1.1 ]

Propiedades

application	Representa una instancia de aplicación de Visio que contiene este documento.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
pages	Representa una colección de páginas asociadas con el documento.
view	Devuelve el objeto DocumentView.

Métodos

getActivePage()	Devuelve la página activa del documento.
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.
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.
setActivePage(PageName)	Establece la página activa del documento.
showTaskPane(taskPaneType, initialProps, show)	Muestra u oculta un panel de tareas. Esto lo consumirán los complementos de Dv Excel u otras aplicaciones de terceros que insertan el dibujo de Visio para mostrar u ocultar el panel de tareas.
showTaskPane(taskPaneTypeString, initialProps, show)	Muestra u oculta un panel de tareas. Esto lo consumirán los complementos de Dv Excel u otras aplicaciones de terceros que insertan el dibujo de Visio para mostrar u ocultar el panel de tareas.
startDataRefresh()	Activa la actualización de los datos del diagrama en todas las páginas.
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.Document original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.DocumentData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Eventos

onDataRefreshComplete	Se produce cuando los datos se actualizan en el diagrama.
onDocumentError	Se produce cuando se produce un error esperado o inesperado en la sesión.
onDocumentLoadComplete	Se produce cuando se carga, actualiza o cambia el documento.
onPageLoadComplete	Se produce cuando la página termina de cargarse.
onSelectionChanged	Se produce cuando cambia la selección actual de formas.
onShapeMouseEnter	Se produce cuando el usuario mueve el puntero del mouse al cuadro delimitador de una forma.
onShapeMouseLeave	Se produce cuando el usuario mueve el mouse fuera del cuadro delimitador de una forma.
onTaskPaneStateChanged	Se produce cada vez que se cambia un estado del panel de tareas.

Detalles de las propiedades

application

Representa una instancia de aplicación de Visio que contiene este documento.

readonly application: Visio.Application;

Valor de propiedad

Visio.Application

Comentarios

[ Conjunto de API: 1.1 ]

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

pages

Representa una colección de páginas asociadas con el documento.

readonly pages: Visio.PageCollection;

Valor de propiedad

Visio.PageCollection

Comentarios

[ Conjunto de API: 1.1 ]

Ejemplos

Visio.run(session, function (ctx) {
    const pages = ctx.document.pages;
    const pageCount = pages.getCount();
    return ctx.sync().then(function () {
        console.log("Pages Count: " +pageCount.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

view

Devuelve el objeto DocumentView.

readonly view: Visio.DocumentView;

Valor de propiedad

Visio.DocumentView

Comentarios

[ Conjunto de API: 1.1 ]

Detalles del método

getActivePage()

Devuelve la página activa del documento.

getActivePage(): Visio.Page;

Devoluciones

Visio.Page

Comentarios

[ Conjunto de API: 1.1 ]

Ejemplos

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const activePage = document.getActivePage();
    activePage.load("name");
    return ctx.sync().then(function () {
        console.log("pageName: " +activePage.name);
    });   
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.DocumentLoadOptions): Visio.Document;

Parámetros

options

Visio.Interfaces.DocumentLoadOptions

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

Devoluciones

Visio.Document

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.Document;

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.Document

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.Document;

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.Document

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.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Visio.Interfaces.DocumentUpdateData

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.Document): void;

Parámetros

properties

Visio.Document

Devoluciones

void

setActivePage(PageName)

Establece la página activa del documento.

setActivePage(PageName: string): void;

Parámetros

PageName

string

Nombre de la página

Devoluciones

void

Comentarios

[ Conjunto de API: 1.1 ]

Ejemplos

Visio.run(session, function (ctx) {
    const document = ctx.document;
    const pageName = "Page-1";
    document.setActivePage(pageName);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

showTaskPane(taskPaneType, initialProps, show)

Muestra u oculta un panel de tareas. Esto lo consumirán los complementos de Dv Excel u otras aplicaciones de terceros que insertan el dibujo de Visio para mostrar u ocultar el panel de tareas.

showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;

Parámetros

taskPaneType

Visio.TaskPaneType

Tipo del panel de tareas de 1ª entidad. Puede tomar valores de la enumeración TaskPaneType

initialProps

any

Parámetro opcional. Se trata de una estructura de datos genérica que se rellenaría con los datos iniciales necesarios para inicializar el contenido del panel de tareas.

show

boolean

Parámetro opcional. Si se establece en false, ocultará el panel de tareas especificado.

Devoluciones

void

Comentarios

[ Conjunto de API: 1.1 ]

showTaskPane(taskPaneTypeString, initialProps, show)

Muestra u oculta un panel de tareas. Esto lo consumirán los complementos de Dv Excel u otras aplicaciones de terceros que insertan el dibujo de Visio para mostrar u ocultar el panel de tareas.

showTaskPane(taskPaneTypeString: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;

Parámetros

taskPaneTypeString

"None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings"

Tipo del panel de tareas de 1ª entidad. Puede tomar valores de la enumeración TaskPaneType

initialProps

any

Parámetro opcional. Se trata de una estructura de datos genérica que se rellenaría con los datos iniciales necesarios para inicializar el contenido del panel de tareas.

show

boolean

Parámetro opcional. Si se establece en false, ocultará el panel de tareas especificado.

Devoluciones

void

Comentarios

[ Conjunto de API: 1.1 ]

startDataRefresh()

Activa la actualización de los datos del diagrama en todas las páginas.

startDataRefresh(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: 1.1 ]

Ejemplos

Visio.run(session, function (ctx) {
    const document = ctx.document;
    document.startDataRefresh();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.Document original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.DocumentData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Visio.Interfaces.DocumentData;

Devoluciones

Visio.Interfaces.DocumentData

Detalles del evento

onDataRefreshComplete

Se produce cuando los datos se actualizan en el diagrama.

readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onDocumentError

Se produce cuando se produce un error esperado o inesperado en la sesión.

readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onDocumentLoadComplete

Se produce cuando se carga, actualiza o cambia el documento.

readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onPageLoadComplete

Se produce cuando la página termina de cargarse.

readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onSelectionChanged

Se produce cuando cambia la selección actual de formas.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onShapeMouseEnter

Se produce cuando el usuario mueve el puntero del mouse al cuadro delimitador de una forma.

readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onShapeMouseLeave

Se produce cuando el usuario mueve el mouse fuera del cuadro delimitador de una forma.

readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]

onTaskPaneStateChanged

Se produce cada vez que se cambia un estado del panel de tareas.

readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>

Comentarios

[ Conjunto de API: 1.1 ]