Skip to content
ChartForgeX

API Reference

Class

MarkupTopologyDocument

Edit on GitHub
Namespace ChartForgeX.Markup
Assembly ChartForgeX.Markup
Source MarkupTopologyDocument.cs:20
Modifiers sealed

Represents a Markdown-friendly topology diagram document.

Inheritance

  • Object
  • MarkupTopologyDocument

Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 2

Accepted by parameters 1

Constructors

public MarkupTopologyDocument() #
MarkupTopologyDocument.cs:20

Methods

public TopologyChart ToTopologyChart() #
MarkupTopologyDocument.cs:48
Returns: TopologyChart

Converts the markup document into a ChartForgeX topology chart.

Returns

The topology chart.

Properties

public String? Id { get; set; } #
MarkupTopologyDocument.cs:11

Gets or sets the optional chart id.

public String? Title { get; set; } #
MarkupTopologyDocument.cs:14

Gets or sets the title.

public String? Subtitle { get; set; } #
MarkupTopologyDocument.cs:17

Gets or sets the subtitle.

public TopologyLayoutMode LayoutMode { get; set; } #
MarkupTopologyDocument.cs:20

Gets or sets the layout mode.

public TopologyLayoutDirection LayoutDirection { get; set; } #
MarkupTopologyDocument.cs:23

Gets or sets the layout direction.

public Double Width { get; set; } #
MarkupTopologyDocument.cs:26

Gets or sets the viewport width.

public Double Height { get; set; } #
MarkupTopologyDocument.cs:29

Gets or sets the viewport height.

public Double Padding { get; set; } #
MarkupTopologyDocument.cs:32

Gets or sets the viewport padding.

public List<MarkupTopologyGroup> Groups { get; } #
MarkupTopologyDocument.cs:35

Gets declared groups.

public List<MarkupTopologyNode> Nodes { get; } #
MarkupTopologyDocument.cs:38

Gets declared nodes.

public List<MarkupTopologyEdge> Edges { get; } #
MarkupTopologyDocument.cs:41

Gets declared edges.