Project

ChartForgeX

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

View on GitHub Releases Get package
Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

TopologyIconDefinition

Namespace ChartForgeX.Topology
Assembly ChartForgeX
Modifiers sealed

Describes one topology icon that can be referenced by nodes and groups.

Inheritance

  • Object
  • TopologyIconDefinition

Usage

Explore 7 API references to this type

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

Returned or exposed by 6

Accepted by parameters 1

Constructors

public TopologyIconDefinition(String packId, String id, String label, TopologyNodeKind nodeKind, TopologyIconShape shape = Auto) #

Initializes a topology icon definition.

Parameters

packId System.String requiredposition: 0
id System.String requiredposition: 1
label System.String requiredposition: 2
nodeKind ChartForgeX.Topology.TopologyNodeKind requiredposition: 3
shape ChartForgeX.Topology.TopologyIconShape = Auto optionalposition: 4

Methods

public TopologyIconDefinition WithArtwork(TopologyIconArtwork artwork) #
Returns: TopologyIconDefinition

Sets icon artwork and returns the current icon definition.

Parameters

artwork ChartForgeX.Topology.TopologyIconArtwork requiredposition: 0
public TopologyIconDefinition WithMetadata(String key, String value) #
Returns: TopologyIconDefinition

Adds or replaces icon metadata and returns the current icon definition.

Parameters

key System.String requiredposition: 0
value System.String requiredposition: 1
public TopologyIconDefinition WithTags(params String[] tags) #
Returns: TopologyIconDefinition

Adds icon-level search tags and returns the current icon definition.

Parameters

tags System.String[] requiredposition: 0

Properties

public String PackId { get; set; } #

Gets or sets the source pack id.

public String Id { get; set; } #

Gets or sets the local icon id inside the pack.

public String QualifiedId { get; } #

Gets the fully qualified icon id.

public String Label { get; set; } #

Gets or sets the display label.

public TopologyNodeKind NodeKind { get; set; } #

Gets or sets the default topology node kind for this icon.

public TopologyIconShape Shape { get; set; } #

Gets or sets the renderer-owned shape hint.

public String? Symbol { get; set; } #

Gets or sets the short fallback symbol.

public String? Color { get; set; } #

Gets or sets the optional identity color used when the node does not set a color.

public String? Category { get; set; } #

Gets or sets the optional catalog category.

public TopologyNodeDisplayMode? DisplayMode { get; set; } #

Gets or sets an optional default display mode for this icon.

public TopologyIconArtwork? Artwork { get; set; } #

Gets or sets optional SVG/image artwork used by SVG and HTML renderers.

public Dictionary<String, String> Metadata { get; } #

Gets arbitrary metadata for host-side pickers and vendor adapters.

public List<String> Tags { get; } #

Gets search tags for host-side pickers.