Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

TopologyChartExtensions

Namespace ChartForgeX.Topology
Assembly ChartForgeX
Modifiers static

Provides convenience rendering and export methods for topology charts.

Inheritance

  • Object
  • TopologyChartExtensions

Methods

public static TopologyChart AddArtworkNode(TopologyChart chart, String id, String label, TopologyIconArtwork artwork, Double x, Double y, TopologyNodeKind kind = Generic, TopologyHealthStatus status = Unknown, String? groupId = null, String? subtitle = null, String? href = null, String? tooltip = null, Double width = 120, Double height = 64, String? symbol = null, String? cssClass = null, String? color = null, String? backgroundColor = null, TopologyNodeDisplayMode displayMode = Artwork) #
Returns: TopologyChart

Adds a positioned node with node-specific artwork.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The node id.
label System.String requiredposition: 2
The node label.
artwork ChartForgeX.Topology.TopologyIconArtwork requiredposition: 3
Trusted SVG or image artwork for SVG and HTML renderers.
x System.Double requiredposition: 4
The x-coordinate.
y System.Double requiredposition: 5
The y-coordinate.
kind ChartForgeX.Topology.TopologyNodeKind = Generic optionalposition: 6
The node kind.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 7
The node status.
groupId System.String? = null optionalposition: 8
The optional group id.
subtitle System.String? = null optionalposition: 9
The optional subtitle.
href System.String? = null optionalposition: 10
The optional href.
tooltip System.String? = null optionalposition: 11
The optional tooltip.
width System.Double = 120 optionalposition: 12
The node width.
height System.Double = 64 optionalposition: 13
The node height.
symbol System.String? = null optionalposition: 14
The optional short visual symbol shown by fallback renderers.
cssClass System.String? = null optionalposition: 15
The optional caller-provided CSS class tokens.
color System.String? = null optionalposition: 16
The optional node accent color, independent from health status.
backgroundColor System.String? = null optionalposition: 17
The optional node surface fill color.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode = Artwork optionalposition: 18
The display mode to apply with the artwork.

Returns

The current topology chart.

public static TopologyChart AddAutoArtworkNode(TopologyChart chart, String id, String label, TopologyIconArtwork artwork, TopologyNodeKind kind = Generic, TopologyHealthStatus status = Unknown, String? groupId = null, String? subtitle = null, String? href = null, String? tooltip = null, Double width = 120, Double height = 64, String? symbol = null, String? cssClass = null, String? color = null, String? backgroundColor = null, TopologyNodeDisplayMode displayMode = Artwork) #
Returns: TopologyChart

Adds an auto-placed node with node-specific artwork.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The node id.
label System.String requiredposition: 2
The node label.
artwork ChartForgeX.Topology.TopologyIconArtwork requiredposition: 3
Trusted SVG or image artwork for SVG and HTML renderers.
kind ChartForgeX.Topology.TopologyNodeKind = Generic optionalposition: 4
The node kind.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 5
The node status.
groupId System.String? = null optionalposition: 6
The optional group id.
subtitle System.String? = null optionalposition: 7
The optional subtitle.
href System.String? = null optionalposition: 8
The optional href.
tooltip System.String? = null optionalposition: 9
The optional tooltip.
width System.Double = 120 optionalposition: 10
The node width.
height System.Double = 64 optionalposition: 11
The node height.
symbol System.String? = null optionalposition: 12
The optional short visual symbol shown by fallback renderers.
cssClass System.String? = null optionalposition: 13
The optional caller-provided CSS class tokens.
color System.String? = null optionalposition: 14
The optional node accent color, independent from health status.
backgroundColor System.String? = null optionalposition: 15
The optional node surface fill color.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode = Artwork optionalposition: 16
The display mode to apply with the artwork.

Returns

The current topology chart.

public static TopologyChart AddAutoGroup(TopologyChart chart, String id, String label, TopologyHealthStatus status = Unknown, String? subtitle = null, String? href = null, String? tooltip = null, String? cssClass = null, String? symbol = null, String? color = null, String? iconId = null) #
Returns: TopologyChart

Adds an auto-placed group to the topology chart. Deterministic layout modes assign the coordinates and size.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The group id.
label System.String requiredposition: 2
The group label.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 3
The group status.
subtitle System.String? = null optionalposition: 4
The optional subtitle.
href System.String? = null optionalposition: 5
The optional href.
tooltip System.String? = null optionalposition: 6
The optional tooltip.
cssClass System.String? = null optionalposition: 7
The optional caller-provided CSS class tokens.
symbol System.String? = null optionalposition: 8
The optional short visual symbol shown in the group header.
color System.String? = null optionalposition: 9
The optional group accent color, independent from health status.
iconId System.String? = null optionalposition: 10
The optional reusable icon id from a topology icon catalog.

Returns

The current topology chart.

public static TopologyChart AddAutoIconNode(TopologyChart chart, String id, String label, String iconId, TopologyHealthStatus status = Unknown, String? groupId = null, String? subtitle = null, String? href = null, String? tooltip = null, Double width = 120, Double height = 64, String? cssClass = null, TopologyIconCatalog? catalog = null) #
Returns: TopologyChart

Adds an auto-placed node from a reusable icon definition.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
id System.String requiredposition: 1
label System.String requiredposition: 2
iconId System.String requiredposition: 3
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 4
groupId System.String? = null optionalposition: 5
subtitle System.String? = null optionalposition: 6
href System.String? = null optionalposition: 7
tooltip System.String? = null optionalposition: 8
width System.Double = 120 optionalposition: 9
height System.Double = 64 optionalposition: 10
cssClass System.String? = null optionalposition: 11
catalog ChartForgeX.Topology.TopologyIconCatalog? = null optionalposition: 12
public static TopologyChart AddAutoNode(TopologyChart chart, String id, String label, TopologyNodeKind kind = Generic, TopologyHealthStatus status = Unknown, String? groupId = null, String? subtitle = null, String? href = null, String? tooltip = null, Double width = 120, Double height = 64, String? symbol = null, String? cssClass = null, String? color = null, String? iconId = null) #
Returns: TopologyChart

Adds an auto-placed node to the topology chart. Deterministic layout modes assign the coordinates.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The node id.
label System.String requiredposition: 2
The node label.
kind ChartForgeX.Topology.TopologyNodeKind = Generic optionalposition: 3
The node kind.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 4
The node status.
groupId System.String? = null optionalposition: 5
The optional group id.
subtitle System.String? = null optionalposition: 6
The optional subtitle.
href System.String? = null optionalposition: 7
The optional href.
tooltip System.String? = null optionalposition: 8
The optional tooltip.
width System.Double = 120 optionalposition: 9
The node width.
height System.Double = 64 optionalposition: 10
The node height.
symbol System.String? = null optionalposition: 11
The optional short visual symbol shown inside the node icon.
cssClass System.String? = null optionalposition: 12
The optional caller-provided CSS class tokens.
color System.String? = null optionalposition: 13
The optional node accent color, independent from health status.
iconId System.String? = null optionalposition: 14
The optional reusable icon id from a topology icon catalog.

Returns

The current topology chart.

public static TopologyChart AddEdge(TopologyChart chart, String id, String sourceNodeId, String targetNodeId, String? label = null, TopologyEdgeKind kind = Generic, TopologyHealthStatus status = Unknown, VisualLinkDirection direction = None, TopologyEdgeRouting routing = Orthogonal, String? secondaryLabel = null, String? href = null, String? tooltip = null, String? cssClass = null, String? tertiaryLabel = null, String? color = null) #
Returns: TopologyChart

Adds an edge to the topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The edge id.
sourceNodeId System.String requiredposition: 2
The source node id.
targetNodeId System.String requiredposition: 3
The target node id.
label System.String? = null optionalposition: 4
The optional edge label.
kind ChartForgeX.Topology.TopologyEdgeKind = Generic optionalposition: 5
The edge kind.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 6
The edge status.
direction ChartForgeX.Primitives.VisualLinkDirection = None optionalposition: 7
The edge direction.
routing ChartForgeX.Topology.TopologyEdgeRouting = Orthogonal optionalposition: 8
The edge routing.
secondaryLabel System.String? = null optionalposition: 9
The optional secondary label.
href System.String? = null optionalposition: 10
The optional href.
tooltip System.String? = null optionalposition: 11
The optional tooltip.
cssClass System.String? = null optionalposition: 12
The optional caller-provided CSS class tokens.
tertiaryLabel System.String? = null optionalposition: 13
The optional tertiary label.
color System.String? = null optionalposition: 14
The optional edge color independent from health status.

Returns

The current topology chart.

public static TopologyScenario AddEdgeStep(TopologyScenario scenario, String edgeId, String? label = null, String? description = null, Action<TopologyScenarioStep>? configure = null) #
Returns: TopologyScenario

Adds a scenario segment that references an existing topology edge.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
The topology scenario.
edgeId System.String requiredposition: 1
The edge id.
label System.String? = null optionalposition: 2
The optional segment label.
description System.String? = null optionalposition: 3
The optional segment description.
configure System.Action<ChartForgeX.Topology.TopologyScenarioStep>? = null optionalposition: 4
Optional step configuration.

Returns

The current scenario.

public static TopologyChart AddGroup(TopologyChart chart, String id, String label, Double x, Double y, Double width, Double height, TopologyHealthStatus status = Unknown, String? subtitle = null, String? href = null, String? tooltip = null, String? cssClass = null, String? symbol = null, String? color = null, String? iconId = null) #
Returns: TopologyChart

Adds a group to the topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The group id.
label System.String requiredposition: 2
The group label.
x System.Double requiredposition: 3
The x-coordinate.
y System.Double requiredposition: 4
The y-coordinate.
width System.Double requiredposition: 5
The group width.
height System.Double requiredposition: 6
The group height.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 7
The group status.
subtitle System.String? = null optionalposition: 8
The optional subtitle.
href System.String? = null optionalposition: 9
The optional href.
tooltip System.String? = null optionalposition: 10
The optional tooltip.
cssClass System.String? = null optionalposition: 11
The optional caller-provided CSS class tokens.
symbol System.String? = null optionalposition: 12
The optional short visual symbol shown in the group header.
color System.String? = null optionalposition: 13
The optional group accent color, independent from health status.
iconId System.String? = null optionalposition: 14
The optional reusable icon id from a topology icon catalog.

Returns

The current topology chart.

public static TopologyChart AddIconNode(TopologyChart chart, String id, String label, String iconId, Double x, Double y, TopologyHealthStatus status = Unknown, String? groupId = null, String? subtitle = null, String? href = null, String? tooltip = null, Double width = 120, Double height = 64, String? cssClass = null, TopologyIconCatalog? catalog = null) #
Returns: TopologyChart

Adds a positioned node from a reusable icon definition.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
id System.String requiredposition: 1
label System.String requiredposition: 2
iconId System.String requiredposition: 3
x System.Double requiredposition: 4
y System.Double requiredposition: 5
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 6
groupId System.String? = null optionalposition: 7
subtitle System.String? = null optionalposition: 8
href System.String? = null optionalposition: 9
tooltip System.String? = null optionalposition: 10
width System.Double = 120 optionalposition: 11
height System.Double = 64 optionalposition: 12
cssClass System.String? = null optionalposition: 13
catalog ChartForgeX.Topology.TopologyIconCatalog? = null optionalposition: 14
public static TopologyChart AddNode(TopologyChart chart, String id, String label, Double x, Double y, TopologyNodeKind kind = Generic, TopologyHealthStatus status = Unknown, String? groupId = null, String? subtitle = null, String? href = null, String? tooltip = null, Double width = 120, Double height = 64, String? symbol = null, String? cssClass = null, String? color = null, String? iconId = null, String? backgroundColor = null) #
Returns: TopologyChart

Adds a node to the topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The node id.
label System.String requiredposition: 2
The node label.
x System.Double requiredposition: 3
The x-coordinate.
y System.Double requiredposition: 4
The y-coordinate.
kind ChartForgeX.Topology.TopologyNodeKind = Generic optionalposition: 5
The node kind.
status ChartForgeX.Topology.TopologyHealthStatus = Unknown optionalposition: 6
The node status.
groupId System.String? = null optionalposition: 7
The optional group id.
subtitle System.String? = null optionalposition: 8
The optional subtitle.
href System.String? = null optionalposition: 9
The optional href.
tooltip System.String? = null optionalposition: 10
The optional tooltip.
width System.Double = 120 optionalposition: 11
The node width.
height System.Double = 64 optionalposition: 12
The node height.
symbol System.String? = null optionalposition: 13
The optional short visual symbol shown inside the node icon.
cssClass System.String? = null optionalposition: 14
The optional caller-provided CSS class tokens.
color System.String? = null optionalposition: 15
The optional node accent color, independent from health status.
iconId System.String? = null optionalposition: 16
The optional reusable icon id from a topology icon catalog.
backgroundColor System.String? = null optionalposition: 17
The optional node surface fill color.

Returns

The current topology chart.

public static TopologyChart AddNodeDetail(TopologyChart chart, String nodeId, String label, String value, TopologyHealthStatus? status = null, String? color = null, String? iconId = null) #
Returns: TopologyChart

Adds a typed detail row to a card-like topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
nodeId System.String requiredposition: 1
label System.String requiredposition: 2
value System.String requiredposition: 3
status ChartForgeX.Topology.TopologyHealthStatus? = null optionalposition: 4
color System.String? = null optionalposition: 5
iconId System.String? = null optionalposition: 6
public static TopologyChart AddNodePort(TopologyChart chart, String nodeId, String portId, TopologyEdgePort side, Double offset = 0.5, String? label = null) #
Returns: TopologyChart

Adds a named attachment port to a topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
nodeId System.String requiredposition: 1
portId System.String requiredposition: 2
side ChartForgeX.Topology.TopologyEdgePort requiredposition: 3
offset System.Double = 0.5 optionalposition: 4
label System.String? = null optionalposition: 5
public static TopologyScenario AddNodeStep(TopologyScenario scenario, String nodeId, String? label = null, String? description = null, Action<TopologyScenarioStep>? configure = null) #
Returns: TopologyScenario

Adds a scenario hop that references an existing topology node.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
The topology scenario.
nodeId System.String requiredposition: 1
The node id.
label System.String? = null optionalposition: 2
The optional hop label.
description System.String? = null optionalposition: 3
The optional hop description.
configure System.Action<ChartForgeX.Topology.TopologyScenarioStep>? = null optionalposition: 4
Optional step configuration.

Returns

The current scenario.

public static TopologyChart AddScenario(TopologyChart chart, String id, String label, Action<TopologyScenario>? configure = null) #
Returns: TopologyChart

Adds an interactive scenario that references existing topology nodes and edges.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The scenario id.
label System.String requiredposition: 2
The scenario label.
configure System.Action<ChartForgeX.Topology.TopologyScenario>? = null optionalposition: 3
Optional scenario configuration.

Returns

The current topology chart.

public static TopologyChart ClearEdgeLabelAnchor(TopologyChart chart, String edgeId) #
Returns: TopologyChart

Clears an explicit edge label leader anchor so the label points back to the edge route.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.

Returns

The current topology chart.

public static TopologyChart ConfigureTheme(TopologyChart chart, Action<TopologyTheme> configure) #
Returns: TopologyChart

Configures the current topology theme.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
configure System.Action<ChartForgeX.Topology.TopologyTheme> requiredposition: 1
The theme customization callback.

Returns

The current topology chart.

public static PngFontInfo GetPngFontInfo(TopologyChart chart) #
Returns: PngFontInfo

Resolves the host font used for PNG text and opt-in installed-font layout measurement. SVG viewers resolve the theme font family independently and may choose a different face.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology whose theme supplies the font family.

Returns

The resolved outline font or built-in fallback information.

public static PreparedTopology Prepare(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: PreparedTopology

Validates and prepares a detached layout once for multiple exports and diagnostics. Use PreparedTopology.AssessReadability before fitting a dense layout into a small output.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
public static TopologyReport PrepareReport(TopologyChart chart, TopologyReportOptions? options = null) #
Returns: TopologyReport

Creates readable detail pages using measured card capacity and stable group/input order. Internal relationships remain on their page; cross-page relationships are returned explicitly. This report reflows cards; use TopologyChartExtensions.Prepare when original geometry must be retained.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
options ChartForgeX.Topology.TopologyReportOptions? = null optionalposition: 1
public static Void Save(TopologyChart chart, String path, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Saves the topology chart using the output path extension to choose SVG, HTML, PNG, or a still raster image format.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options for opaque raster formats.
public static Void SaveBmp(TopologyChart chart, String path, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Saves the topology chart as BMP.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.
public static Void SaveHtml(TopologyChart chart, String path, TopologyRenderOptions? options = null) #
Returns: Void

Saves the topology chart as a complete HTML page.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
public static Void SavePng(TopologyChart chart, String path, TopologyRenderOptions? options = null) #
Returns: Void

Saves the topology chart as PNG.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
public static Void SavePpm(TopologyChart chart, String path, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Saves the topology chart as PPM.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.
SaveRasterImage 2 overloads
public static Void SaveRasterImage(TopologyChart chart, String path, RasterImageFormat format, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Saves the topology chart as an opaque raster image file.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
format ChartForgeX.Core.RasterImageFormat requiredposition: 2
The raster image format.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 3
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 4
Optional raster export options.
public static Void SaveRasterImage(TopologyChart chart, String path, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Saves the topology chart as an opaque raster image file using the output path extension to choose the format.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.
public static Void SaveSvg(TopologyChart chart, String path, TopologyRenderOptions? options = null) #
Returns: Void

Saves the topology chart as SVG.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
public static Void SaveTiff(TopologyChart chart, String path, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Saves the topology chart as TIFF.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
path System.String requiredposition: 1
The output path.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.
public static Byte[] ToBmp(TopologyChart chart, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Byte[]

Renders the topology chart to BMP bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2
Optional raster export options.

Returns

A BMP image.

public static String ToHtmlFragment(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: String

Renders the topology chart to an HTML fragment.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

An embeddable HTML fragment.

public static String ToHtmlFragmentWithoutAssets(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: String

Renders the topology chart to an HTML fragment without renderer-owned stylesheet or script assets.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

An embeddable HTML fragment that expects the host document to register topology HTML assets.

public static String ToHtmlPage(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: String

Renders the topology chart to a complete HTML page.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

A complete HTML page.

public static Byte[] ToPng(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: Byte[]

Renders the topology chart to PNG bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

A PNG image.

public static Byte[] ToPpm(TopologyChart chart, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Byte[]

Renders the topology chart to PPM bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2
Optional raster export options.

Returns

A PPM image.

public static Byte[] ToRasterImage(TopologyChart chart, RasterImageFormat format, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Byte[]

Renders the topology chart to opaque raster image bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
format ChartForgeX.Core.RasterImageFormat requiredposition: 1
The raster image format.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.

Returns

Encoded raster image bytes.

public static RgbaImage ToRgbaImage(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: RgbaImage

Renders a topology chart directly to an in-memory RGBA image without encoding it.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart to render.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

The rendered RGBA image.

ToSvg 2 overloads
public static String ToSvg(TopologyChart chart, TopologyRenderOptions? options = null) #
Returns: String

Renders the topology chart to SVG.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

Complete SVG markup.

public static String ToSvg(TopologyChart chart, String idScope, TopologyRenderOptions? options = null) #
Returns: String

Renders the topology chart to SVG with every SVG id scoped, so several renders of the same chart can be embedded in one document (see TopologyRenderOptions.IdScope).

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
idScope System.String requiredposition: 1
A caller-provided scope put in front of every SVG id.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options; null uses the options carried by the chart. They are not modified.

Returns

Complete SVG markup.

public static Byte[] ToTiff(TopologyChart chart, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Byte[]

Renders the topology chart to TIFF bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2
Optional raster export options.

Returns

A TIFF image.

public static TopologyScenario WithColor(TopologyScenario scenario, String? color) #
Returns: TopologyScenario

Sets an optional scenario accent color.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
The topology scenario.
color System.String? requiredposition: 1
The scenario color.

Returns

The current scenario.

public static TopologyScenario WithDescription(TopologyScenario scenario, String? description) #
Returns: TopologyScenario

Sets an optional scenario description.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
The topology scenario.
description System.String? requiredposition: 1
The scenario description.

Returns

The current scenario.

public static TopologyScenarioStep WithDuration(TopologyScenarioStep step, Int32 durationMilliseconds) #
Returns: TopologyScenarioStep

Overrides how long this route step remains visible during timeline playback.

Parameters

step ChartForgeX.Topology.TopologyScenarioStep requiredposition: 0
durationMilliseconds System.Int32 requiredposition: 1
public static TopologyChart WithEdgeColor(TopologyChart chart, String edgeId, String? color) #
Returns: TopologyChart

Sets an explicit edge color independent from health status.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
color System.String? requiredposition: 2
The edge color.

Returns

The current topology chart.

public static TopologyChart WithEdgeEmphasis(TopologyChart chart, String edgeId, TopologyEdgeEmphasis emphasis) #
Returns: TopologyChart

Sets edge visual emphasis independently from health status and line style.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
emphasis ChartForgeX.Topology.TopologyEdgeEmphasis requiredposition: 2
The edge visual emphasis.

Returns

The current topology chart.

public static TopologyChart WithEdgeEndpointLabels(TopologyChart chart, String edgeId, String? sourceLabel, String? targetLabel) #
Returns: TopologyChart

Sets optional labels near the source and target edge endpoints.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
edgeId System.String requiredposition: 1
sourceLabel System.String? requiredposition: 2
targetLabel System.String? requiredposition: 3
WithEdgeLabelAnchor 2 overloads
public static TopologyChart WithEdgeLabelAnchor(TopologyChart chart, String edgeId, ChartPoint anchor) #
Returns: TopologyChart

Sets an explicit point that a displaced edge label should point to.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
anchor ChartForgeX.Primitives.ChartPoint requiredposition: 2
The canvas-space point the label leader should point to.

Returns

The current topology chart.

public static TopologyChart WithEdgeLabelAnchor(TopologyChart chart, String edgeId, Double x, Double y) #
Returns: TopologyChart

Sets an explicit point that a displaced edge label should point to.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
x System.Double requiredposition: 2
The canvas-space horizontal point.
y System.Double requiredposition: 3
The canvas-space vertical point.

Returns

The current topology chart.

public static TopologyChart WithEdgeLabelAnchorNode(TopologyChart chart, String edgeId, String nodeId) #
Returns: TopologyChart

Anchors a displaced edge label leader to the rendered boundary of a node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
nodeId System.String requiredposition: 2
The node id the label leader should point to.

Returns

The current topology chart.

public static TopologyChart WithEdgeLabelAnnotationOffset(TopologyChart chart, String edgeId, Double offsetX, Double offsetY) #
Returns: TopologyChart

Sets the rendered label position for a specific edge and keeps the leader anchored to the edge route.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
offsetX System.Double requiredposition: 2
The horizontal label offset in pixels.
offsetY System.Double requiredposition: 3
The vertical label offset in pixels.

Returns

The current topology chart.

public static TopologyChart WithEdgeLabelOffset(TopologyChart chart, String edgeId, Double x, Double y) #
Returns: TopologyChart

Adjusts the rendered label position for a specific edge without changing the route geometry.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
x System.Double requiredposition: 2
The horizontal label offset in pixels.
y System.Double requiredposition: 3
The vertical label offset in pixels.

Returns

The current topology chart.

public static TopologyChart WithEdgeLayoutHints(TopologyChart chart, String edgeId, Double? preferredLength = null, Int32 minimumRankSpan = 1, Int32 routingPriority = 0) #
Returns: TopologyChart

Sets soft layout intent without promising exact rendered edge length.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
edgeId System.String requiredposition: 1
preferredLength System.Double? = null optionalposition: 2
minimumRankSpan System.Int32 = 1 optionalposition: 3
routingPriority System.Int32 = 0 optionalposition: 4
public static TopologyChart WithEdgeLineStyle(TopologyChart chart, String edgeId, TopologyEdgeLineStyle lineStyle) #
Returns: TopologyChart

Sets an explicit line style for an edge independent from health status.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
lineStyle ChartForgeX.Topology.TopologyEdgeLineStyle requiredposition: 2
The edge line style.

Returns

The current topology chart.

public static TopologyChart WithEdgeMarkers(TopologyChart chart, String edgeId, TopologyMarkerKind? source, TopologyMarkerKind? target) #
Returns: TopologyChart

Sets explicit markers at both edge endpoints. Null keeps direction-derived behavior.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
edgeId System.String requiredposition: 1
source ChartForgeX.Topology.TopologyMarkerKind? requiredposition: 2
target ChartForgeX.Topology.TopologyMarkerKind? requiredposition: 3
public static TopologyChart WithEdgeMuted(TopologyChart chart, String edgeId, Boolean isMuted = true) #
Returns: TopologyChart

Marks an edge as a quiet structural relationship instead of a status route.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
isMuted System.Boolean = true optionalposition: 2
Whether the edge is muted.

Returns

The current topology chart.

public static TopologyChart WithEdgeNamedPorts(TopologyChart chart, String edgeId, String? sourcePortId, String? targetPortId) #
Returns: TopologyChart

Connects an edge through named ports on its source and target nodes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
edgeId System.String requiredposition: 1
sourcePortId System.String? requiredposition: 2
targetPortId System.String? requiredposition: 3
public static TopologyChart WithEdgePorts(TopologyChart chart, String edgeId, TopologyEdgePort sourcePort, TopologyEdgePort targetPort) #
Returns: TopologyChart

Sets preferred attachment sides for an edge.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
sourcePort ChartForgeX.Topology.TopologyEdgePort requiredposition: 2
The preferred source attachment side.
targetPort ChartForgeX.Topology.TopologyEdgePort requiredposition: 3
The preferred target attachment side.

Returns

The current topology chart.

public static TopologyChart WithEdgeRouteBundle(TopologyChart chart, Double centerLane, Double spacing, params String[] edgeIds) #
Returns: TopologyChart

Assigns centered orthogonal route lanes to a related set of edges.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
centerLane System.Double requiredposition: 1
The center lane offset in pixels.
spacing System.Double requiredposition: 2
The spacing between adjacent lanes in pixels.
edgeIds System.String[] requiredposition: 3
The related edge ids in visual lane order.

Returns

The current topology chart.

public static TopologyChart WithEdgeRouteLane(TopologyChart chart, String edgeId, Double routeLane) #
Returns: TopologyChart

Sets a deterministic orthogonal route lane offset for an edge.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
routeLane System.Double requiredposition: 2
The route lane offset in pixels.

Returns

The current topology chart.

public static TopologyChart WithEdgesOfKind(TopologyChart chart, TopologyEdgeKind kind, TopologyEdgeLineStyle? lineStyle = null, TopologyEdgeEmphasis? emphasis = null, Boolean? isMuted = null, String? color = null) #
Returns: TopologyChart

Applies reusable visual styling to all edges of a given kind.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
kind ChartForgeX.Topology.TopologyEdgeKind requiredposition: 1
The edge kind to update.
lineStyle ChartForgeX.Topology.TopologyEdgeLineStyle? = null optionalposition: 2
Optional line style to apply.
emphasis ChartForgeX.Topology.TopologyEdgeEmphasis? = null optionalposition: 3
Optional visual emphasis to apply.
isMuted System.Boolean? = null optionalposition: 4
Optional muted-state override to apply.
color System.String? = null optionalposition: 5
Optional edge color to apply independent from health status.

Returns

The current topology chart.

public static TopologyChart WithEdgeStroke(TopologyChart chart, String edgeId, Double? width = null, Double? opacity = null, params Double[] dashPattern) #
Returns: TopologyChart

Applies edge-specific stroke width, opacity, and an optional alternating dash/gap pattern.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
edgeId System.String requiredposition: 1
width System.Double? = null optionalposition: 2
opacity System.Double? = null optionalposition: 3
dashPattern System.Double[] requiredposition: 4
public static TopologyChart WithEdgeWaypoints(TopologyChart chart, String edgeId, params ChartPoint[] waypoints) #
Returns: TopologyChart

Sets explicit route bend points on an edge.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
edgeId System.String requiredposition: 1
The edge id.
waypoints ChartForgeX.Primitives.ChartPoint[] requiredposition: 2
The route bend points.

Returns

The current topology chart.

public static TopologyChart WithGroupColor(TopologyChart chart, String groupId, String? color) #
Returns: TopologyChart

Sets an optional group accent color independent from the group health status.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
groupId System.String requiredposition: 1
The group id.
color System.String? requiredposition: 2
The group accent color.

Returns

The current topology chart.

public static TopologyChart WithGroupCoordinates(TopologyChart chart, String groupId, Double longitude, Double latitude) #
Returns: TopologyChart

Sets longitude/latitude coordinates for a topology group used by geographic layouts.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
groupId System.String requiredposition: 1
The group id.
longitude System.Double requiredposition: 2
The longitude in degrees.
latitude System.Double requiredposition: 3
The latitude in degrees.

Returns

The current topology chart.

public static TopologyChart WithGroupIcon(TopologyChart chart, String groupId, String iconId, TopologyIconCatalog? catalog = null) #
Returns: TopologyChart

Applies a reusable icon definition to a group.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
groupId System.String requiredposition: 1
The group id.
iconId System.String requiredposition: 2
The icon id, for example microsoft-ad:site.
catalog ChartForgeX.Topology.TopologyIconCatalog? = null optionalposition: 3
Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

public static TopologyChart WithGroupLayout(TopologyChart chart, String groupId, TopologyGroupLayoutPolicy layoutPolicy) #
Returns: TopologyChart

Sets the preferred node arrangement policy for a group when using dense grouped layouts.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
groupId System.String requiredposition: 1
The group id.
layoutPolicy ChartForgeX.Topology.TopologyGroupLayoutPolicy requiredposition: 2
The dense group layout policy.

Returns

The current topology chart.

public static TopologyChart WithGroupPosition(TopologyChart chart, String groupId, Double x, Double y) #
Returns: TopologyChart

Sets an explicit group position while preserving the current group size and styling.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
groupId System.String requiredposition: 1
The group id.
x System.Double requiredposition: 2
The x-coordinate.
y System.Double requiredposition: 3
The y-coordinate.

Returns

The current topology chart.

public static TopologyChart WithGroupSymbol(TopologyChart chart, String groupId, String? symbol) #
Returns: TopologyChart

Sets an optional short group symbol.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
groupId System.String requiredposition: 1
The group id.
symbol System.String? requiredposition: 2
The symbol text or built-in token such as region.

Returns

The current topology chart.

public static TopologyChart WithId(TopologyChart chart, String id) #
Returns: TopologyChart

Sets the topology chart id.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
id System.String requiredposition: 1
The chart id.

Returns

The current topology chart.

WithLayout 2 overloads
public static TopologyChart WithLayout(TopologyChart chart, TopologyLayoutMode layoutMode) #
Returns: TopologyChart

Sets the topology chart layout mode.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
layoutMode ChartForgeX.Topology.TopologyLayoutMode requiredposition: 1
The layout mode.

Returns

The current topology chart.

public static TopologyChart WithLayout(TopologyChart chart, TopologyLayoutMode layoutMode, TopologyLayoutDirection layoutDirection) #
Returns: TopologyChart

Sets the topology chart layout mode and flow direction.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
layoutMode ChartForgeX.Topology.TopologyLayoutMode requiredposition: 1
The layout mode.
layoutDirection ChartForgeX.Topology.TopologyLayoutDirection requiredposition: 2
The layout flow direction.

Returns

The current topology chart.

public static TopologyChart WithLayoutDirection(TopologyChart chart, TopologyLayoutDirection layoutDirection) #
Returns: TopologyChart

Sets the topology chart layout flow direction.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
layoutDirection ChartForgeX.Topology.TopologyLayoutDirection requiredposition: 1
The layout flow direction.

Returns

The current topology chart.

public static TopologyChart WithLegend(TopologyChart chart, TopologyLegend? legend) #
Returns: TopologyChart

Sets the topology legend.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
legend ChartForgeX.Topology.TopologyLegend? requiredposition: 1
The legend to use.

Returns

The current topology chart.

public static TopologyChart WithMapViewport(TopologyChart chart, ChartMapViewport viewport) #
Returns: TopologyChart

Sets the longitude/latitude viewport used by geographic topology layouts.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
viewport ChartForgeX.Core.ChartMapViewport requiredposition: 1
The map viewport.

Returns

The current topology chart.

WithMetadata 2 overloads
public static TopologyScenario WithMetadata(TopologyScenario scenario, String key, String? value) #
Returns: TopologyScenario

Adds host-readable metadata to a topology scenario.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
The topology scenario.
key System.String requiredposition: 1
The metadata key.
value System.String? requiredposition: 2
The metadata value.

Returns

The current scenario.

public static TopologyScenarioStep WithMetadata(TopologyScenarioStep step, String key, String? value) #
Returns: TopologyScenarioStep

Adds host-readable metadata to a topology scenario step.

Parameters

step ChartForgeX.Topology.TopologyScenarioStep requiredposition: 0
The topology scenario step.
key System.String requiredposition: 1
The metadata key.
value System.String? requiredposition: 2
The metadata value.

Returns

The current scenario step.

public static TopologyChart WithNodeArtwork(TopologyChart chart, String nodeId, TopologyIconArtwork artwork, TopologyNodeDisplayMode displayMode = Artwork) #
Returns: TopologyChart

Applies node-specific artwork directly to an existing topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
artwork ChartForgeX.Topology.TopologyIconArtwork requiredposition: 2
Trusted SVG or image artwork for SVG and HTML renderers.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode = Artwork optionalposition: 3
The display mode to apply with the artwork.

Returns

The current topology chart.

public static TopologyChart WithNodeBackground(TopologyChart chart, String nodeId, String? backgroundColor) #
Returns: TopologyChart

Sets an optional node surface fill color independent from the node accent color.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
backgroundColor System.String? requiredposition: 2
The node surface fill color.

Returns

The current topology chart.

public static TopologyChart WithNodeBadge(TopologyChart chart, String nodeId, String? badge) #
Returns: TopologyChart

Sets optional short badge text on a topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
badge System.String? requiredposition: 2
The badge text.

Returns

The current topology chart.

public static TopologyChart WithNodeColor(TopologyChart chart, String nodeId, String? color) #
Returns: TopologyChart

Sets an optional node accent color independent from the node health status.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
color System.String? requiredposition: 2
The node accent color.

Returns

The current topology chart.

public static TopologyChart WithNodeCoordinates(TopologyChart chart, String nodeId, Double longitude, Double latitude) #
Returns: TopologyChart

Sets longitude/latitude coordinates for a topology node used by geographic layouts.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
longitude System.Double requiredposition: 2
The longitude in degrees.
latitude System.Double requiredposition: 3
The latitude in degrees.

Returns

The current topology chart.

public static TopologyChart WithNodeDisplay(TopologyChart chart, String nodeId, TopologyNodeDisplayMode displayMode, String? badge = null) #
Returns: TopologyChart

Sets a node-specific display mode and optional badge text.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode requiredposition: 2
The node display mode.
badge System.String? = null optionalposition: 3
Optional short badge text.

Returns

The current topology chart.

public static TopologyChart WithNodeIcon(TopologyChart chart, String nodeId, String iconId, TopologyIconCatalog? catalog = null) #
Returns: TopologyChart

Applies a reusable icon definition to a node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
iconId System.String requiredposition: 2
The icon id, for example network:switch.
catalog ChartForgeX.Topology.TopologyIconCatalog? = null optionalposition: 3
Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

public static TopologyChart WithNodesDisplay(TopologyChart chart, TopologyNodeKind kind, TopologyNodeDisplayMode displayMode, String? badge = null) #
Returns: TopologyChart

Sets a display mode for all nodes of a kind and optionally assigns a badge.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind requiredposition: 1
The node kind to update.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode requiredposition: 2
The node display mode.
badge System.String? = null optionalposition: 3
Optional short badge text.

Returns

The current topology chart.

public static TopologyChart WithNodesOfKind(TopologyChart chart, TopologyNodeKind kind, String? color = null, String? backgroundColor = null) #
Returns: TopologyChart

Sets reusable node styling for all nodes of a kind.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind requiredposition: 1
The node kind to update.
color System.String? = null optionalposition: 2
The optional node accent color.
backgroundColor System.String? = null optionalposition: 3
The optional node surface fill color.

Returns

The current topology chart.

public static TopologyChart WithNodesOfKindIcon(TopologyChart chart, TopologyNodeKind kind, String iconId, TopologyIconCatalog? catalog = null) #
Returns: TopologyChart

Applies a reusable icon definition to all nodes of a kind.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind requiredposition: 1
The node kind to update.
iconId System.String requiredposition: 2
The icon id, for example common:certificate.
catalog ChartForgeX.Topology.TopologyIconCatalog? = null optionalposition: 3
Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

public static TopologyChart WithNodesOfKindStyle(TopologyChart chart, TopologyNodeKind kind, String? color = null, String? backgroundColor = null, String? iconId = null, TopologyIconCatalog? catalog = null) #
Returns: TopologyChart

Sets reusable node styling and optional icon assignment for all nodes of a kind in one pass.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind requiredposition: 1
The node kind to update.
color System.String? = null optionalposition: 2
The optional node accent color.
backgroundColor System.String? = null optionalposition: 3
The optional node surface fill color.
iconId System.String? = null optionalposition: 4
The optional icon id, for example common:certificate.
catalog ChartForgeX.Topology.TopologyIconCatalog? = null optionalposition: 5
Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

public static TopologyChart WithoutNodeArtwork(TopologyChart chart, String nodeId, Boolean resetArtworkDisplayMode = true) #
Returns: TopologyChart

Removes node-specific artwork from an existing topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
nodeId System.String requiredposition: 1
The node id.
resetArtworkDisplayMode System.Boolean = true optionalposition: 2
Whether to clear an artwork-only display override so icon catalog display defaults can apply again.

Returns

The current topology chart.

public static TopologyScenario WithPlayback(TopologyScenario scenario, Int32 stepDurationMilliseconds = 900, Boolean loop = false, Boolean autoPlay = false) #
Returns: TopologyScenario

Configures route timeline playback without enabling automatic playback by default.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
stepDurationMilliseconds System.Int32 = 900 optionalposition: 1
loop System.Boolean = false optionalposition: 2
autoPlay System.Boolean = false optionalposition: 3
public static TopologyChart WithReciprocalEdgeRouteBundles(TopologyChart chart, Double spacing = 18) #
Returns: TopologyChart

Assigns centered orthogonal route lanes to reciprocal edge pairs that do not already have explicit lanes.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
spacing System.Double = 18 optionalposition: 1
The spacing between adjacent lanes in pixels.

Returns

The current topology chart.

public static TopologyChart WithRenderOptions(TopologyChart chart, TopologyRenderOptions? options) #
Returns: TopologyChart

Sets the render options used when a render, prepare, diagnostics, or export call passes none.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? requiredposition: 1
The options to draw the chart with by default, or null to clear them. The chart keeps its own copy.

Returns

The current topology chart.

public static TopologyScenario WithSpotlight(TopologyScenario scenario, Boolean enabled = true) #
Returns: TopologyScenario

Controls whether the route spotlights members by dimming surrounding topology.

Parameters

scenario ChartForgeX.Topology.TopologyScenario requiredposition: 0
enabled System.Boolean = true optionalposition: 1
public static TopologyChart WithSubtitle(TopologyChart chart, String subtitle) #
Returns: TopologyChart

Sets the topology chart subtitle.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
subtitle System.String requiredposition: 1
The chart subtitle.

Returns

The current topology chart.

public static TopologyChart WithTheme(TopologyChart chart, TopologyTheme theme) #
Returns: TopologyChart

Sets the topology theme.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
theme ChartForgeX.Topology.TopologyTheme requiredposition: 1
The theme to use.

Returns

The current topology chart.

public static TopologyChart WithTitle(TopologyChart chart, String title) #
Returns: TopologyChart

Sets the topology chart title.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
title System.String requiredposition: 1
The chart title.

Returns

The current topology chart.

public static TopologyChart WithViewport(TopologyChart chart, Double width, Double height, Double padding = 24) #
Returns: TopologyChart

Sets the topology viewport.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
width System.Double requiredposition: 1
The viewport width.
height System.Double requiredposition: 2
The viewport height.
padding System.Double = 24 optionalposition: 3
The viewport padding.

Returns

The current topology chart.

public static Void WriteBmp(TopologyChart chart, Stream stream, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Writes the topology chart to a BMP stream.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
stream System.IO.Stream requiredposition: 1
The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.
public static Void WritePpm(TopologyChart chart, Stream stream, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Writes the topology chart to a PPM stream.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
stream System.IO.Stream requiredposition: 1
The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.
public static Void WriteRasterImage(TopologyChart chart, Stream stream, RasterImageFormat format, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Writes the topology chart to an opaque raster image stream.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
stream System.IO.Stream requiredposition: 1
The destination stream.
format ChartForgeX.Core.RasterImageFormat requiredposition: 2
The raster image format.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 3
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 4
Optional raster export options.
public static Void WriteTiff(TopologyChart chart, Stream stream, TopologyRenderOptions? options = null, RasterImageOptions? imageOptions = null) #
Returns: Void

Writes the topology chart to a TIFF stream.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
stream System.IO.Stream requiredposition: 1
The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 2
Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3
Optional raster export options.