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

TopologyLegend

Namespace ChartForgeX.Topology

Represents an optional topology legend.

Inheritance

  • Object
  • TopologyLegend

Usage

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

Accepted by parameters

Methods

AddEdgeKind(System.String label, ChartForgeX.Topology.TopologyEdgeKind edgeKind, System.String color, ChartForgeX.Topology.TopologyEdgeLineStyle lineStyle) #

Adds an edge-kind legend item.

Parameters

label System.String required
The item label.
edgeKind ChartForgeX.Topology.TopologyEdgeKind required
The represented edge kind.
color System.String required
An optional color override.
lineStyle ChartForgeX.Topology.TopologyEdgeLineStyle required
An optional edge line style override.

Returns

The current legend.

AddNodeKind(System.String label, ChartForgeX.Topology.TopologyNodeKind nodeKind, System.String color, System.String symbol, System.String backgroundColor, System.String iconId) #

Adds a node-kind legend item.

Parameters

label System.String required
The item label.
nodeKind ChartForgeX.Topology.TopologyNodeKind required
The represented node kind.
color System.String required
An optional color override.
symbol System.String required
An optional short symbol override.
backgroundColor System.String required
An optional node marker background color override.
iconId System.String required
An optional topology icon id for the legend marker.

Returns

The current legend.

AddStatus(System.String label, ChartForgeX.Topology.TopologyHealthStatus status, System.String color) #

Adds a status legend item.

Parameters

label System.String required
The item label.
status ChartForgeX.Topology.TopologyHealthStatus required
The represented status.
color System.String required
An optional color override.

Returns

The current legend.

Create(System.String title) #

Creates a new topology legend.

Parameters

title System.String required
The optional legend title.

Returns

A topology legend.

Default() #

Creates a generic default health legend.

Returns

A default topology legend.

Infer(ChartForgeX.Topology.TopologyChart chart) #

Infers a generic legend from statuses, node kinds, node symbols, and edge kinds used by the chart.

Parameters

chart ChartForgeX.Topology.TopologyChart required
The topology chart.

Returns

An inferred topology legend.

Resolve(ChartForgeX.Topology.TopologyChart chart, ChartForgeX.Topology.TopologyLegendMode mode) #

Resolves the legend according to the requested legend mode.

Parameters

chart ChartForgeX.Topology.TopologyChart required
The topology chart.
mode ChartForgeX.Topology.TopologyLegendMode required
The legend mode.

Returns

The resolved legend, if any.

Properties

Title #

Gets or sets the legend title.

Items #

Gets the legend items.