Comparteix a través de

Referencia de Directed Graph Markup Language (DGML)

  • Article

El formato DGML (Directed Graph Markup Language) describe la información que se usa para la visualización y para realizar el análisis de complejidad, y se usa para continuar los mapas de código en Visual Studio. DGML usa XML simple para describir los gráficos dirigidos cíclicos y acíclicos. Un gráfico dirigido es un conjunto de nodos que están conectados mediante vínculos, o bordes. Se pueden usar nodos y vínculos para representar estructuras de red, como elementos en un proyecto de software.

Tenga en cuenta que algunas versiones de Visual Studio solo admiten un subconjunto de capacidades DGML; consulte Compatibilidad de versiones con las herramientas de arquitectura y modelado.

Nota

Al editar un archivo .dgml, IntelliSense le ayuda a identificar los atributos disponibles para cada elemento y sus valores. Para especificar color en un atributo, use nombres para los colores comunes, como "Blue", o valores hexadecimales de ARGB, como "#ffa0b1c3". DGML emplea un pequeño subconjunto de los formatos de definición de color de Windows Presentation Foundation (WPF). Para más información, consulte Clase Colors.

Sintaxis DGML

En la tabla siguiente se describen los tipos de elementos que se emplean en DGML:

  • <DirectedGraph></DirectedGraph>

    Este elemento es el elemento raíz de un documento de mapa de código (.dgml). Todos los demás elementos de DGML aparecen dentro del ámbito de este elemento.

    En la lista siguiente se describen atributos opcionales que puede incluir:

    Background: color del fondo del mapa

    BackgroundImage: ubicación de un archivo de imagen que se va a usar como fondo del mapa.

    GraphDirection: cuando el mapa está establecido en el diseño de árbol (Sugiyama), organiza los nodos para que la mayoría de los vínculos fluyan en la dirección especificada: TopToBottom, BottomToTop, LeftToRight o RightToLeft. Consulte Cambiar el diseño del mapa.

    Layout: establece el mapa en los diseños siguientes: None, Sugiyama (diseño de árbol), ForceDirected (clústeres rápidos) o DependencyMatrix. Consulte Cambiar el diseño del mapa.

    NeighborhoodDistance: cuando el mapa está establecido en el diseño de árbol o de clústeres rápidos, solo muestra aquellos nodos que están a un número especificado (1-7) de vínculos de los nodos seleccionados. Consulte Cambiar el diseño del mapa.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" Background="Blue" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Nodes>
      ...
   </Nodes>
   <Links>
      ...
   </Links>
   <Categories>
      ...
   </Categories>
   <Properties>
      ...
   </Properties>
</DirectedGraph>

  • <Nodes></Nodes>

    Este elemento opcional contiene una lista de elementos <Node/>, que definen nodos del mapa. Para obtener más información, vea el elemento <Node/>.

    Nota

    Al hacer referencia a un nodo no definido en un elemento <Link/>, el mapa crea un elemento <Node/> automáticamente.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Nodes>
      <Node ... />
   </Nodes>
   <Links>
      <Link ... />
   </Links>
</DirectedGraph>

  • <Node/>

    Este elemento define un único nodo. Aparece dentro de la lista de elementos <Nodes><Nodes/>.

    Este elemento debe incluir los atributos siguientes:

    Id: nombre único del nodo y el valor predeterminado del atributo Label, si no se especifica ningún atributo Label independiente. Este nombre debe coincidir con el atributo Source o Target del vínculo que hace referencia a él.

    En la lista siguiente se describen algunos atributos opcionales que puede incluir:

    Label: nombre para mostrar del nodo.

    Atributos de estilo. Vea Customize code maps by editing the DGML files.

    Category: nombre de una categoría que identifica elementos que comparten este atributo. Para obtener más información, vea el elemento <Category/>.

    Property: nombre de una propiedad que identifica elementos que tienen el mismo valor de propiedad. Para obtener más información, vea el elemento <Property/>.

    Group: si el nodo contiene otros nodos, establezca este atributo en Expanded o Collapsed para mostrar u ocultar su contenido. Debe haber un elemento <Link/> que incluya el atributo Category="Contains" y especifique el nodo primario como nodo de origen y el nodo secundario como nodo de destino. Consulte Agrupar elementos de código.

    Visibility: establezca este atributo en Visible, Hidden o Collapsed. Utilice System.Windows.Visibility. Consulte Ocultar o mostrar nodos y vínculos.

    Reference: establezca este atributo para vincular un documento o una dirección URL. Consulte Vincular documentos o direcciones URL a elementos de código y vínculos.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Nodes>
      <Node Id="Driver" Label="Student" Category="Person" />
      <Node Id="Passenger" Label="Instructor" Category="Person" />
      <Node Id="Car" Label="Car" Category="Automobile" />
      <Node Id="Truck" Label="Truck" Category="Automobile" />
   </Nodes>
   <Links>
      <Link ... />
   </Links>
   <Categories>
      <Category Id="Person" Background="Orange" />
      <Category Id="Automobile" Background="Yellow"/>
   </Categories>
</DirectedGraph>

  • <Links></Links>

    Este elemento contiene la lista de elementos <Link>, que definen vínculos entre nodos. Para obtener más información, vea el elemento <Link/>.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Links>
      <Link ... />
   </Links>
</DirectedGraph>

  • <Link/>

    Este elemento define un único vínculo que conecta un nodo de origen con un nodo de destino. Aparece dentro de la lista de elementos <Links></Links>.

    Nota

    Si este elemento hace referencia a un nodo no definido, el documento de mapa crea automáticamente un nodo que tiene los atributos especificados, en su caso.

    Este elemento debe incluir los atributos siguientes:

    Source: nodo de origen del vínculo.

    Target: nodo de destino del vínculo.

    En la lista siguiente se describen algunos atributos opcionales que puede incluir:

    Label: nombre para mostrar del vínculo.

    Atributos de estilo. Vea Customize code maps by editing the DGML files.

    Category: nombre de una categoría que identifica elementos que comparten este atributo. Para obtener más información, vea el elemento <Category/>.

    Property: nombre de una propiedad que identifica elementos que tienen el mismo valor de propiedad. Para obtener más información, vea el elemento <Property/>.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Nodes>
      <Node Id="Driver" Label="Student" Category="Person" />
      <Node Id="Passenger" Label="Instructor" Category="Person" />
      <Node Id="Car" Label="Car" Category="Automobile" />
      <Node Id="Truck" Label="Truck" Category="Automobile" />
   </Nodes>
   <Links>
      <Category Id="Person" Background="Orange" />
      <Category Id="Automobile" Background="Yellow"/>
      <Link Source="Driver" Target="Car" Label="Passed" Stroke="Black" Background="Green" Category="PassedTest" />
      <Link Source="Driver" Target="Truck" Label="Failed" Stroke="Black" Background="Red" Category="PassedTest" />
   </Links>
</DirectedGraph>

  • <Categories></Categories>

    Este elemento contiene la lista de elementos <Category/>. Para obtener más información, vea el elemento <Category/>.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Categories>
       <Category ... />
   </Categories>
</DirectedGraph>

  • <Category/>

    Este elemento define un atributo Category, que se emplea para identificar elementos que comparten este atributo. Se puede usar un atributo Category para organizar elementos de mapa, proporcionar atributos compartidos a través de la herencia o definir metadatos adicionales.

    Este elemento debe incluir los atributos siguientes:

    Id: nombre único de la categoría y el valor predeterminado del atributo Label, si no se especifica ningún atributo Label independiente.

    En la lista siguiente se describen algunos atributos opcionales que puede incluir:

    Label: nombre de fácil lectura para la categoría.

    BasedOn: categoría principal de la que se hereda el atributo <Category/> del elemento actual.

    En el ejemplo de este elemento, la categoría FailedTest hereda su atributo Stroke de la categoría PassedTest. Consulte "Para crear categorías jerárquicas" en Personalización de mapas de código mediante la edición de los archivos DGML.

    Las categorías también proporcionan cierto comportamiento de plantilla básico que controla la apariencia de los nodos y vínculos cuando se muestran en un mapa. Vea Customize code maps by editing the DGML files.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Nodes>
      <Node Id="Driver" Label="Driver" Category="Person" />
      <Node Id="Car" Label="Car" Category="Automobile" />
      <Node Id="Truck" Label="Truck" Category="Automobile" />
      <Node Id="Passenger" Category="Person" />
   </Nodes>
   <Links>
      <Link Source="Driver" Target="Car" Label="Passed" Category="PassedTest" />
      <Link Source="Driver" Target="Truck" Label="Failed" Category="FailedTest" />
   </Links>
   <Categories>
      <Category Id="Person" Background="Orange" />
      <Category Id="Automobile" Background="Yellow"/>
      <Category Id="PassedTest" Label="Passed" Stroke="Black" Background="Green" />
      <Category Id="FailedTest" Label="Failed" BasedOn="PassedTest" Background="Red" />
   </Categories>
</DirectedGraph>

  • <Properties></Properties>

    Este elemento contiene la lista de elementos <Property/>. Para obtener más información, vea el elemento <Property/>.

    Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Properties>
       <Property ... />
   </Properties>
</DirectedGraph>

  • <Property/>

    Este elemento define un atributo Property que puede usar para asignar un valor a cualquier elemento de DGML o atributo, incluyendo categorías y otras propiedades.

    Este elemento debe incluir los atributos siguientes:

    • Id: nombre único de la propiedad y el valor predeterminado del atributo Label, si no se especifica ningún atributo Label independiente.

    • DataType: tipo de datos almacenados por la propiedad.

      Si desea que la propiedad aparezca en la ventana Propiedades, use la propiedad Label para especificar el nombre para mostrar de la propiedad.

      Consulte Asignar categorías a elementos de código y vínculos.

      Ejemplo:

    <?xml version="1.0" encoding="utf-8"?>
<DirectedGraph Title="DrivingTest" xmlns="http://schemas.microsoft.com/vs/2009/dgml">
   <Nodes>
      <Node Id="Driver" Label="Driver" Category="Person" DrivingAge="18"/>
      <Node Id="Car" Label="Car" Category="Automobile" />
      <Node Id="Truck" Label="Truck" Category="Automobile" />
      <Node Id="Passenger" Category="Person" />
   </Nodes>
   <Links>
      <Link Source="Driver" Target="Car" Label="Passed" Category="PassedTest" />
      <Link Source="Driver" Target="Truck" Label="Failed" Category="FailedTest" />
   </Links>
   <Categories>
      <Category Id="Person" Background="Orange" />
      <Category Id="Automobile" Background="Yellow"/>
      <Category Id="PassedTest" Label="Passed" Stroke="Black" Background="Green" />
      <Category Id="FailedTest" Label="Failed" BasedOn="PassedTest" Background="Red" />
   </Categories>
   <Properties>
       <Property Id="DrivingAge" Label="Driving Age" DataType="System.Int32" />
   </Properties>
</DirectedGraph>

Alias para rutas de acceso usadas con frecuencia

El reemplazo de rutas de acceso usadas con frecuencia con alias ayuda a reducir el tamaño del archivo .dgml y el tiempo necesario para cargar o guardar el archivo. Para crear un alias, agregue una sección <Paths></Paths> al final del archivo .dgml. En esta sección, agregue un elemento <Path/> para definir un alias para la ruta de acceso:

<Paths>
   <Path Id="MyPathAlias" Value="C:\...\..." />
</Paths>

Para hacer referencia al alias desde un elemento del archivo .dgml, rodee el valor Id del elemento <Path/> con un signo de dólar ($) y paréntesis (()):

<Nodes>
   <Node Id="MyNode" Reference="$(MyPathAlias)MyDocument.txt" />
</Nodes>
<Properties>
   <Property Id="Reference" Label="My Document" DataType="System.String" IsReference="True" />
</Properties>

Vea también