Project

ChartForgeX

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

View on GitHub Visit Website Releases Get package

Stars 45

Forks 2

NuGet downloads 48,107

Release ChartForgeX-v1.7.0

Language: HTML Updated: 2026-09-02

API Reference

Class

TopologyChartExtensions

Namespace ChartForgeX.Topology

Provides convenience rendering and export methods for topology charts.

Inheritance

Object
TopologyChartExtensions

Methods

AddArtworkNode(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, ChartForgeX.Topology.TopologyIconArtwork artwork, System.Double x, System.Double y, ChartForgeX.Topology.TopologyNodeKind kind, ChartForgeX.Topology.TopologyHealthStatus status, System.String groupId, System.String subtitle, System.String href, System.String tooltip, System.Double width, System.Double height, System.String symbol, System.String cssClass, System.String color, System.String backgroundColor, ChartForgeX.Topology.TopologyNodeDisplayMode displayMode)

Adds a positioned node with node-specific artwork.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The node id.
label System.String required: The node label.
artwork ChartForgeX.Topology.TopologyIconArtwork required: Trusted SVG or image artwork for SVG and HTML renderers.
x System.Double required: The x-coordinate.
y System.Double required: The y-coordinate.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind.
status ChartForgeX.Topology.TopologyHealthStatus required: The node status.
groupId System.String required: The optional group id.
subtitle System.String required: The optional subtitle.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
width System.Double required: The node width.
height System.Double required: The node height.
symbol System.String required: The optional short visual symbol shown by fallback renderers.
cssClass System.String required: The optional caller-provided CSS class tokens.
color System.String required: The optional node accent color, independent from health status.
backgroundColor System.String required: The optional node surface fill color.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode required: The display mode to apply with the artwork.

Returns

The current topology chart.

AddAutoArtworkNode(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, ChartForgeX.Topology.TopologyIconArtwork artwork, ChartForgeX.Topology.TopologyNodeKind kind, ChartForgeX.Topology.TopologyHealthStatus status, System.String groupId, System.String subtitle, System.String href, System.String tooltip, System.Double width, System.Double height, System.String symbol, System.String cssClass, System.String color, System.String backgroundColor, ChartForgeX.Topology.TopologyNodeDisplayMode displayMode)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The node id.
label System.String required: The node label.
artwork ChartForgeX.Topology.TopologyIconArtwork required: Trusted SVG or image artwork for SVG and HTML renderers.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind.
status ChartForgeX.Topology.TopologyHealthStatus required: The node status.
groupId System.String required: The optional group id.
subtitle System.String required: The optional subtitle.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
width System.Double required: The node width.
height System.Double required: The node height.
symbol System.String required: The optional short visual symbol shown by fallback renderers.
cssClass System.String required: The optional caller-provided CSS class tokens.
color System.String required: The optional node accent color, independent from health status.
backgroundColor System.String required: The optional node surface fill color.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode required: The display mode to apply with the artwork.

Returns

The current topology chart.

AddAutoGroup(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, ChartForgeX.Topology.TopologyHealthStatus status, System.String subtitle, System.String href, System.String tooltip, System.String cssClass, System.String symbol, System.String color, System.String iconId)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The group id.
label System.String required: The group label.
status ChartForgeX.Topology.TopologyHealthStatus required: The group status.
subtitle System.String required: The optional subtitle.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
cssClass System.String required: The optional caller-provided CSS class tokens.
symbol System.String required: The optional short visual symbol shown in the group header.
color System.String required: The optional group accent color, independent from health status.
iconId System.String required: The optional reusable icon id from a topology icon catalog.

Returns

The current topology chart.

AddAutoIconNode(ChartForgeX.Topology.TopologyChart arg1, System.String arg2, System.String arg3, System.String arg4, ChartForgeX.Topology.TopologyHealthStatus arg5, System.String arg6, System.String arg7, System.String arg8, System.String arg9, System.Double arg10, System.Double arg11, System.String arg12, ChartForgeX.Topology.TopologyIconCatalog arg13)

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

Parameters

arg1 ChartForgeX.Topology.TopologyChart required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 ChartForgeX.Topology.TopologyHealthStatus required
arg6 System.String required
arg7 System.String required
arg8 System.String required
arg9 System.String required
arg10 System.Double required
arg11 System.Double required
arg12 System.String required
arg13 ChartForgeX.Topology.TopologyIconCatalog required

AddAutoNode(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, ChartForgeX.Topology.TopologyNodeKind kind, ChartForgeX.Topology.TopologyHealthStatus status, System.String groupId, System.String subtitle, System.String href, System.String tooltip, System.Double width, System.Double height, System.String symbol, System.String cssClass, System.String color, System.String iconId)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The node id.
label System.String required: The node label.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind.
status ChartForgeX.Topology.TopologyHealthStatus required: The node status.
groupId System.String required: The optional group id.
subtitle System.String required: The optional subtitle.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
width System.Double required: The node width.
height System.Double required: The node height.
symbol System.String required: The optional short visual symbol shown inside the node icon.
cssClass System.String required: The optional caller-provided CSS class tokens.
color System.String required: The optional node accent color, independent from health status.
iconId System.String required: The optional reusable icon id from a topology icon catalog.

Returns

The current topology chart.

AddEdge(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String sourceNodeId, System.String targetNodeId, System.String label, ChartForgeX.Topology.TopologyEdgeKind kind, ChartForgeX.Topology.TopologyHealthStatus status, ChartForgeX.Primitives.VisualLinkDirection direction, ChartForgeX.Topology.TopologyEdgeRouting routing, System.String secondaryLabel, System.String href, System.String tooltip, System.String cssClass, System.String tertiaryLabel, System.String color)

Adds an edge to the topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The edge id.
sourceNodeId System.String required: The source node id.
targetNodeId System.String required: The target node id.
label System.String required: The optional edge label.
kind ChartForgeX.Topology.TopologyEdgeKind required: The edge kind.
status ChartForgeX.Topology.TopologyHealthStatus required: The edge status.
direction ChartForgeX.Primitives.VisualLinkDirection required: The edge direction.
routing ChartForgeX.Topology.TopologyEdgeRouting required: The edge routing.
secondaryLabel System.String required: The optional secondary label.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
cssClass System.String required: The optional caller-provided CSS class tokens.
tertiaryLabel System.String required: The optional tertiary label.
color System.String required: The optional edge color independent from health status.

Returns

The current topology chart.

AddEdgeStep(ChartForgeX.Topology.TopologyScenario scenario, System.String edgeId, System.String label, System.String description, System.Action{ChartForgeX.Topology.TopologyScenarioStep} configure)

Adds a scenario segment that references an existing topology edge.

Parameters

scenario ChartForgeX.Topology.TopologyScenario required: The topology scenario.
edgeId System.String required: The edge id.
label System.String required: The optional segment label.
description System.String required: The optional segment description.
configure System.Action{ChartForgeX.Topology.TopologyScenarioStep} required: Optional step configuration.

Returns

The current scenario.

AddGroup(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, System.Double x, System.Double y, System.Double width, System.Double height, ChartForgeX.Topology.TopologyHealthStatus status, System.String subtitle, System.String href, System.String tooltip, System.String cssClass, System.String symbol, System.String color, System.String iconId)

Adds a group to the topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The group id.
label System.String required: The group label.
x System.Double required: The x-coordinate.
y System.Double required: The y-coordinate.
width System.Double required: The group width.
height System.Double required: The group height.
status ChartForgeX.Topology.TopologyHealthStatus required: The group status.
subtitle System.String required: The optional subtitle.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
cssClass System.String required: The optional caller-provided CSS class tokens.
symbol System.String required: The optional short visual symbol shown in the group header.
color System.String required: The optional group accent color, independent from health status.
iconId System.String required: The optional reusable icon id from a topology icon catalog.

Returns

The current topology chart.

AddIconNode(ChartForgeX.Topology.TopologyChart arg1, System.String arg2, System.String arg3, System.String arg4, System.Double arg5, System.Double arg6, ChartForgeX.Topology.TopologyHealthStatus arg7, System.String arg8, System.String arg9, System.String arg10, System.String arg11, System.Double arg12, System.Double arg13, System.String arg14, ChartForgeX.Topology.TopologyIconCatalog arg15)

Adds a positioned node from a reusable icon definition.

Parameters

arg1 ChartForgeX.Topology.TopologyChart required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 System.Double required
arg6 System.Double required
arg7 ChartForgeX.Topology.TopologyHealthStatus required
arg8 System.String required
arg9 System.String required
arg10 System.String required
arg11 System.String required
arg12 System.Double required
arg13 System.Double required
arg14 System.String required
arg15 ChartForgeX.Topology.TopologyIconCatalog required

AddNode(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, System.Double x, System.Double y, ChartForgeX.Topology.TopologyNodeKind kind, ChartForgeX.Topology.TopologyHealthStatus status, System.String groupId, System.String subtitle, System.String href, System.String tooltip, System.Double width, System.Double height, System.String symbol, System.String cssClass, System.String color, System.String iconId, System.String backgroundColor)

Adds a node to the topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The node id.
label System.String required: The node label.
x System.Double required: The x-coordinate.
y System.Double required: The y-coordinate.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind.
status ChartForgeX.Topology.TopologyHealthStatus required: The node status.
groupId System.String required: The optional group id.
subtitle System.String required: The optional subtitle.
href System.String required: The optional href.
tooltip System.String required: The optional tooltip.
width System.Double required: The node width.
height System.Double required: The node height.
symbol System.String required: The optional short visual symbol shown inside the node icon.
cssClass System.String required: The optional caller-provided CSS class tokens.
color System.String required: The optional node accent color, independent from health status.
iconId System.String required: The optional reusable icon id from a topology icon catalog.
backgroundColor System.String required: The optional node surface fill color.

Returns

The current topology chart.

AddNodeStep(ChartForgeX.Topology.TopologyScenario scenario, System.String nodeId, System.String label, System.String description, System.Action{ChartForgeX.Topology.TopologyScenarioStep} configure)

Adds a scenario hop that references an existing topology node.

Parameters

scenario ChartForgeX.Topology.TopologyScenario required: The topology scenario.
nodeId System.String required: The node id.
label System.String required: The optional hop label.
description System.String required: The optional hop description.
configure System.Action{ChartForgeX.Topology.TopologyScenarioStep} required: Optional step configuration.

Returns

The current scenario.

AddScenario(ChartForgeX.Topology.TopologyChart chart, System.String id, System.String label, System.Action{ChartForgeX.Topology.TopologyScenario} configure)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The scenario id.
label System.String required: The scenario label.
configure System.Action{ChartForgeX.Topology.TopologyScenario} required: Optional scenario configuration.

Returns

The current topology chart.

ClearEdgeLabelAnchor(ChartForgeX.Topology.TopologyChart chart, System.String edgeId) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.

Returns

The current topology chart.

Save(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Saves the topology chart using the output path extension to choose SVG, HTML, PNG, animated GIF, animated PNG, or an opaque raster image format.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options for opaque raster formats.

SaveApng(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options)

Saves the topology chart as an animated PNG by sampling topology motion frames.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options. When motion is unset, the first scenario route is animated.

SaveBmp(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Saves the topology chart as BMP.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveGif(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options)

Saves the topology chart as an animated GIF by sampling topology motion frames.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options. When motion is unset, the first scenario route is animated.

SaveHtml(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options)

Saves the topology chart as a complete HTML page.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

SavePng(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options)

Saves the topology chart as PNG.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

SavePpm(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Saves the topology chart as PPM.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage 2 overloads

SaveRasterImage(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Saves the topology chart as an opaque raster image file.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveSvg(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options)

Saves the topology chart as SVG.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

SaveTiff(ChartForgeX.Topology.TopologyChart chart, System.String path, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Saves the topology chart as TIFF.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
path System.String required: The output path.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

ToApng(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

Renders the topology chart to animated PNG bytes by sampling topology motion frames.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options. When motion is unset, the first scenario route is animated.

Returns

An animated PNG image.

ToBmp(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Renders the topology chart to BMP bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A BMP image.

ToGif(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

Renders the topology chart to animated GIF bytes by sampling topology motion frames.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options. When motion is unset, the first scenario route is animated.

Returns

An animated GIF image.

ToHtmlFragment(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

Renders the topology chart to an HTML fragment.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

Returns

An embeddable HTML fragment.

ToHtmlFragmentWithoutAssets(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

Returns

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

ToHtmlPage(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

Renders the topology chart to a complete HTML page.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

Returns

A complete HTML page.

ToPng(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

Renders the topology chart to PNG bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

Returns

A PNG image.

ToPpm(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Renders the topology chart to PPM bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A PPM image.

ToRasterImage(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Renders the topology chart to opaque raster image bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRgbaImage(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart to render.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

Returns

The rendered RGBA image.

ToSvg(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options) #

Renders the topology chart to SVG.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.

Returns

Complete SVG markup.

ToTiff(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Renders the topology chart to TIFF bytes.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A TIFF image.

WithColor(ChartForgeX.Topology.TopologyScenario scenario, System.String color) #

Sets an optional scenario accent color.

Parameters

scenario ChartForgeX.Topology.TopologyScenario required: The topology scenario.
color System.String required: The scenario color.

Returns

The current scenario.

WithDescription(ChartForgeX.Topology.TopologyScenario scenario, System.String description) #

Sets an optional scenario description.

Parameters

scenario ChartForgeX.Topology.TopologyScenario required: The topology scenario.
description System.String required: The scenario description.

Returns

The current scenario.

WithDuration(ChartForgeX.Topology.TopologyScenarioStep arg1, System.Int32 arg2) #

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

Parameters

arg1 ChartForgeX.Topology.TopologyScenarioStep required
arg2 System.Int32 required

WithEdgeColor(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.String color) #

Sets an explicit edge color independent from health status.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
color System.String required: The edge color.

Returns

The current topology chart.

WithEdgeEmphasis(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, ChartForgeX.Topology.TopologyEdgeEmphasis emphasis)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
emphasis ChartForgeX.Topology.TopologyEdgeEmphasis required: The edge visual emphasis.

Returns

The current topology chart.

WithEdgeLabelAnchor 2 overloads

WithEdgeLabelAnchor(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, ChartForgeX.Primitives.ChartPoint anchor)

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

Parameters

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

Returns

The current topology chart.

WithEdgeLabelAnchor(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.Double x, System.Double y) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
x System.Double required: The canvas-space horizontal point.
y System.Double required: The canvas-space vertical point.

Returns

The current topology chart.

WithEdgeLabelAnchorNode(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.String nodeId) #

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

Parameters

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

Returns

The current topology chart.

WithEdgeLabelAnnotationOffset(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.Double offsetX, System.Double offsetY)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
offsetX System.Double required: The horizontal label offset in pixels.
offsetY System.Double required: The vertical label offset in pixels.

Returns

The current topology chart.

WithEdgeLabelOffset(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.Double x, System.Double y) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
x System.Double required: The horizontal label offset in pixels.
y System.Double required: The vertical label offset in pixels.

Returns

The current topology chart.

WithEdgeLineStyle(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, ChartForgeX.Topology.TopologyEdgeLineStyle lineStyle)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
lineStyle ChartForgeX.Topology.TopologyEdgeLineStyle required: The edge line style.

Returns

The current topology chart.

WithEdgeMuted(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.Boolean isMuted) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
isMuted System.Boolean required: Whether the edge is muted.

Returns

The current topology chart.

WithEdgePorts(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, ChartForgeX.Topology.TopologyEdgePort sourcePort, ChartForgeX.Topology.TopologyEdgePort targetPort)

Sets preferred attachment sides for an edge.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
edgeId System.String required: The edge id.
sourcePort ChartForgeX.Topology.TopologyEdgePort required: The preferred source attachment side.
targetPort ChartForgeX.Topology.TopologyEdgePort required: The preferred target attachment side.

Returns

The current topology chart.

WithEdgeRouteBundle(ChartForgeX.Topology.TopologyChart chart, System.Double centerLane, System.Double spacing, System.String[] edgeIds)

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

Parameters

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

Returns

The current topology chart.

WithEdgeRouteLane(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, System.Double routeLane) #

Sets a deterministic orthogonal route lane offset for an edge.

Parameters

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

Returns

The current topology chart.

WithEdgesOfKind(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyEdgeKind kind, System.Nullable{ChartForgeX.Topology.TopologyEdgeLineStyle} lineStyle, System.Nullable{ChartForgeX.Topology.TopologyEdgeEmphasis} emphasis, System.Nullable{System.Boolean} isMuted, System.String color)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
kind ChartForgeX.Topology.TopologyEdgeKind required: The edge kind to update.
lineStyle System.Nullable{ChartForgeX.Topology.TopologyEdgeLineStyle} required: Optional line style to apply.
emphasis System.Nullable{ChartForgeX.Topology.TopologyEdgeEmphasis} required: Optional visual emphasis to apply.
isMuted System.Nullable{System.Boolean} required: Optional muted-state override to apply.
color System.String required: Optional edge color to apply independent from health status.

Returns

The current topology chart.

WithEdgeWaypoints(ChartForgeX.Topology.TopologyChart chart, System.String edgeId, ChartForgeX.Primitives.ChartPoint[] waypoints)

Sets explicit route bend points on an edge.

Parameters

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

Returns

The current topology chart.

WithGroupColor(ChartForgeX.Topology.TopologyChart chart, System.String groupId, System.String color) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
groupId System.String required: The group id.
color System.String required: The group accent color.

Returns

The current topology chart.

WithGroupCoordinates(ChartForgeX.Topology.TopologyChart chart, System.String groupId, System.Double longitude, System.Double latitude)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
groupId System.String required: The group id.
longitude System.Double required: The longitude in degrees.
latitude System.Double required: The latitude in degrees.

Returns

The current topology chart.

WithGroupIcon(ChartForgeX.Topology.TopologyChart chart, System.String groupId, System.String iconId, ChartForgeX.Topology.TopologyIconCatalog catalog)

Applies a reusable icon definition to a group.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
groupId System.String required: The group id.
iconId System.String required: The icon id, for example microsoft-ad:site.
catalog ChartForgeX.Topology.TopologyIconCatalog required: Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

WithGroupLayout(ChartForgeX.Topology.TopologyChart chart, System.String groupId, ChartForgeX.Topology.TopologyGroupLayoutPolicy layoutPolicy)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
groupId System.String required: The group id.
layoutPolicy ChartForgeX.Topology.TopologyGroupLayoutPolicy required: The dense group layout policy.

Returns

The current topology chart.

WithGroupPosition(ChartForgeX.Topology.TopologyChart chart, System.String groupId, System.Double x, System.Double y) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
groupId System.String required: The group id.
x System.Double required: The x-coordinate.
y System.Double required: The y-coordinate.

Returns

The current topology chart.

WithGroupSymbol(ChartForgeX.Topology.TopologyChart chart, System.String groupId, System.String symbol) #

Sets an optional short group symbol.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
groupId System.String required: The group id.
symbol System.String required: The symbol text or built-in token such as region.

Returns

The current topology chart.

WithId(ChartForgeX.Topology.TopologyChart chart, System.String id) #

Sets the topology chart id.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
id System.String required: The chart id.

Returns

The current topology chart.

WithLayout 2 overloads

WithLayout(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyLayoutMode layoutMode) #

Sets the topology chart layout mode.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
layoutMode ChartForgeX.Topology.TopologyLayoutMode required: The layout mode.

Returns

The current topology chart.

WithLayout(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyLayoutMode layoutMode, ChartForgeX.Topology.TopologyLayoutDirection layoutDirection)

Sets the topology chart layout mode and flow direction.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
layoutMode ChartForgeX.Topology.TopologyLayoutMode required: The layout mode.
layoutDirection ChartForgeX.Topology.TopologyLayoutDirection required: The layout flow direction.

Returns

The current topology chart.

WithLayoutDirection(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyLayoutDirection layoutDirection)

Sets the topology chart layout flow direction.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
layoutDirection ChartForgeX.Topology.TopologyLayoutDirection required: The layout flow direction.

Returns

The current topology chart.

WithLegend(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyLegend legend) #

Sets the topology legend.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
legend ChartForgeX.Topology.TopologyLegend required: The legend to use.

Returns

The current topology chart.

WithMapViewport(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Core.ChartMapViewport viewport) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
viewport ChartForgeX.Core.ChartMapViewport required: The map viewport.

Returns

The current topology chart.

WithMetadata 2 overloads

WithMetadata(ChartForgeX.Topology.TopologyScenario scenario, System.String key, System.String value) #

Adds host-readable metadata to a topology scenario.

Parameters

scenario ChartForgeX.Topology.TopologyScenario required: The topology scenario.
key System.String required: The metadata key.
value System.String required: The metadata value.

Returns

The current scenario.

WithMetadata(ChartForgeX.Topology.TopologyScenarioStep step, System.String key, System.String value) #

Adds host-readable metadata to a topology scenario step.

Parameters

step ChartForgeX.Topology.TopologyScenarioStep required: The topology scenario step.
key System.String required: The metadata key.
value System.String required: The metadata value.

Returns

The current scenario step.

WithNodeArtwork(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, ChartForgeX.Topology.TopologyIconArtwork artwork, ChartForgeX.Topology.TopologyNodeDisplayMode displayMode)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
artwork ChartForgeX.Topology.TopologyIconArtwork required: Trusted SVG or image artwork for SVG and HTML renderers.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode required: The display mode to apply with the artwork.

Returns

The current topology chart.

WithNodeBackground(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, System.String backgroundColor) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
backgroundColor System.String required: The node surface fill color.

Returns

The current topology chart.

WithNodeBadge(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, System.String badge) #

Sets optional short badge text on a topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
badge System.String required: The badge text.

Returns

The current topology chart.

WithNodeColor(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, System.String color) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
color System.String required: The node accent color.

Returns

The current topology chart.

WithNodeCoordinates(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, System.Double longitude, System.Double latitude)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
longitude System.Double required: The longitude in degrees.
latitude System.Double required: The latitude in degrees.

Returns

The current topology chart.

WithNodeDisplay(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, ChartForgeX.Topology.TopologyNodeDisplayMode displayMode, System.String badge)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode required: The node display mode.
badge System.String required: Optional short badge text.

Returns

The current topology chart.

WithNodeIcon(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, System.String iconId, ChartForgeX.Topology.TopologyIconCatalog catalog)

Applies a reusable icon definition to a node.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
iconId System.String required: The icon id, for example network:switch.
catalog ChartForgeX.Topology.TopologyIconCatalog required: Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

WithNodesDisplay(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyNodeKind kind, ChartForgeX.Topology.TopologyNodeDisplayMode displayMode, System.String badge)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind to update.
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode required: The node display mode.
badge System.String required: Optional short badge text.

Returns

The current topology chart.

WithNodesOfKind(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyNodeKind kind, System.String color, System.String backgroundColor)

Sets reusable node styling for all nodes of a kind.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind to update.
color System.String required: The optional node accent color.
backgroundColor System.String required: The optional node surface fill color.

Returns

The current topology chart.

WithNodesOfKindIcon(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyNodeKind kind, System.String iconId, ChartForgeX.Topology.TopologyIconCatalog catalog)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind to update.
iconId System.String required: The icon id, for example common:certificate.
catalog ChartForgeX.Topology.TopologyIconCatalog required: Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

WithNodesOfKindStyle(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyNodeKind kind, System.String color, System.String backgroundColor, System.String iconId, ChartForgeX.Topology.TopologyIconCatalog catalog)

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
kind ChartForgeX.Topology.TopologyNodeKind required: The node kind to update.
color System.String required: The optional node accent color.
backgroundColor System.String required: The optional node surface fill color.
iconId System.String required: The optional icon id, for example common:certificate.
catalog ChartForgeX.Topology.TopologyIconCatalog required: Optional icon catalog. When omitted, built-in packs are used.

Returns

The current topology chart.

WithoutNodeArtwork(ChartForgeX.Topology.TopologyChart chart, System.String nodeId, System.Boolean resetArtworkDisplayMode)

Removes node-specific artwork from an existing topology node.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
nodeId System.String required: The node id.
resetArtworkDisplayMode System.Boolean required: Whether to clear an artwork-only display override so icon catalog display defaults can apply again.

Returns

The current topology chart.

WithPlayback(ChartForgeX.Topology.TopologyScenario arg1, System.Int32 arg2, System.Boolean arg3, System.Boolean arg4) #

Configures route timeline playback without enabling automatic playback by default.

Parameters

arg1 ChartForgeX.Topology.TopologyScenario required
arg2 System.Int32 required
arg3 System.Boolean required
arg4 System.Boolean required

WithReciprocalEdgeRouteBundles(ChartForgeX.Topology.TopologyChart chart, System.Double spacing) #

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

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
spacing System.Double required: The spacing between adjacent lanes in pixels.

Returns

The current topology chart.

WithSpotlight(ChartForgeX.Topology.TopologyScenario arg1, System.Boolean arg2) #

Controls whether the route spotlights members by dimming surrounding topology.

Parameters

arg1 ChartForgeX.Topology.TopologyScenario required
arg2 System.Boolean required

WithSubtitle(ChartForgeX.Topology.TopologyChart chart, System.String subtitle) #

Sets the topology chart subtitle.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
subtitle System.String required: The chart subtitle.

Returns

The current topology chart.

WithTheme 2 overloads

WithTheme(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyTheme theme) #

Sets the topology theme.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
theme ChartForgeX.Topology.TopologyTheme required: The theme to use.

Returns

The current topology chart.

WithTheme(ChartForgeX.Topology.TopologyChart chart, System.Action{ChartForgeX.Topology.TopologyTheme} configure) #

Configures the current topology theme.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
configure System.Action{ChartForgeX.Topology.TopologyTheme} required: The theme customization callback.

Returns

The current topology chart.

WithTitle(ChartForgeX.Topology.TopologyChart chart, System.String title) #

Sets the topology chart title.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
title System.String required: The chart title.

Returns

The current topology chart.

WithViewport(ChartForgeX.Topology.TopologyChart chart, System.Double width, System.Double height, System.Double padding) #

Sets the topology viewport.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
width System.Double required: The viewport width.
height System.Double required: The viewport height.
padding System.Double required: The viewport padding.

Returns

The current topology chart.

WriteApng(ChartForgeX.Topology.TopologyChart chart, System.IO.Stream stream, ChartForgeX.Topology.TopologyRenderOptions options)

Writes the topology chart as an animated PNG stream by sampling topology motion frames.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options. When motion is unset, the first scenario route is animated.

WriteBmp(ChartForgeX.Topology.TopologyChart chart, System.IO.Stream stream, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Writes the topology chart to a BMP stream.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteGif(ChartForgeX.Topology.TopologyChart chart, System.IO.Stream stream, ChartForgeX.Topology.TopologyRenderOptions options)

Writes the topology chart as an animated GIF stream by sampling topology motion frames.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options. When motion is unset, the first scenario route is animated.

WritePpm(ChartForgeX.Topology.TopologyChart chart, System.IO.Stream stream, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Writes the topology chart to a PPM stream.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteRasterImage(ChartForgeX.Topology.TopologyChart chart, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Writes the topology chart to an opaque raster image stream.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteTiff(ChartForgeX.Topology.TopologyChart chart, System.IO.Stream stream, ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.RasterImageOptions imageOptions)

Writes the topology chart to a TIFF stream.

Parameters

chart ChartForgeX.Topology.TopologyChart required: The topology chart.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Topology.TopologyRenderOptions required: Optional render options.
imageOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.