API Reference

Class

TopologyIconPack

Namespace ChartForgeX.Topology

Assembly ChartForgeX

Modifiers sealed

Represents a named set of reusable topology icons.

Inheritance

Object
TopologyIconPack

Usage

Explore 24 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 14

Property TopologyIconCatalog.Packs
Property TopologyIconCatalogItem.Pack
Property TopologyIconCatalogLoadResult.LoadedPacks
Method TopologyIconPack.AddIcon
Method TopologyIconPack.WithIconTags
Method TopologyIconPack.WithMetadata
Method TopologyIconPack.WithTags
Method TopologyIconPackJson.FromJson
Method TopologyIconPackJson.LoadJsonManifest
Method TopologyIconPackJson.LoadJsonManifestsFromDirectory
Property TopologyIconPackLoadResult.Pack
Property TopologyIconPackSummary.Pack
Property TopologyIconPackValidationResult.Pack
Property TopologyIconSvgPackImportResult.Pack

Accepted by parameters 10

Method TopologyIconCatalog.AddOrReplacePack parameter pack
Method TopologyIconCatalog.AddPack parameter pack
Extension method TopologyIconPack.SaveJsonManifest parameter pack
Extension method TopologyIconPack.ToJsonManifest parameter pack
Extension method TopologyIconPack.Validate parameter pack
Extension method TopologyIconPack.WriteJsonManifest parameter pack
Method TopologyIconPackJson.SaveJsonManifest parameter pack
Method TopologyIconPackJson.ToJsonManifest parameter pack
Method TopologyIconPackJson.WriteJsonManifest parameter pack
Method TopologyIconValidationExtensions.Validate parameter pack

Constructors

public TopologyIconPack(String id, String label, String? vendor = null, String? version = null, Boolean isBuiltIn = false)

Initializes a topology icon pack.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
vendor System.String? = null optionalposition: 2
version System.String? = null optionalposition: 3
isBuiltIn System.Boolean = false optionalposition: 4

Methods

AddIcon 2 overloads

public TopologyIconPack AddIcon(String id, String label, TopologyNodeKind nodeKind, TopologyIconShape shape = Auto, String? symbol = null, String? color = null, String? category = null, TopologyNodeDisplayMode? displayMode = null)

Returns: TopologyIconPack

Adds an icon definition to the pack.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
nodeKind ChartForgeX.Topology.TopologyNodeKind requiredposition: 2
shape ChartForgeX.Topology.TopologyIconShape = Auto optionalposition: 3
symbol System.String? = null optionalposition: 4
color System.String? = null optionalposition: 5
category System.String? = null optionalposition: 6
displayMode ChartForgeX.Topology.TopologyNodeDisplayMode? = null optionalposition: 7

public TopologyIconPack AddIcon(TopologyIconDefinition icon) #

Returns: TopologyIconPack

Adds a pre-built icon definition to the pack.

Parameters

icon ChartForgeX.Topology.TopologyIconDefinition requiredposition: 0

public TopologyIconPack WithIconTags(String iconId, params String[] tags) #

Returns: TopologyIconPack

Adds search tags to an icon inside this pack.

Parameters

iconId System.String requiredposition: 0
tags System.String[] requiredposition: 1

public TopologyIconPack WithMetadata(String key, String value) #

Returns: TopologyIconPack

Adds or replaces pack metadata and returns the current pack.

Parameters

key System.String requiredposition: 0
value System.String requiredposition: 1

public TopologyIconPack WithTags(params String[] tags) #

Returns: TopologyIconPack

Adds pack-level search tags and returns the current pack.

Parameters

tags System.String[] requiredposition: 0

Inherited Methods

Properties

public String Id { get; set; } #

Gets or sets the stable pack id.

public String Label { get; set; } #

Gets or sets the display label.

public String? Vendor { get; set; } #

Gets or sets the optional pack vendor.

public String? Version { get; set; } #

Gets or sets the optional pack version.

public Boolean IsBuiltIn { get; set; } #

Gets whether the pack is supplied by ChartForgeX.

public IReadOnlyList<TopologyIconDefinition> Icons { get; } #

Gets icons in the pack.

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.

Extension Methods

public static Void SaveJsonManifest(TopologyIconPack pack, String path, Boolean indented = true) #

Returns: Void

Saves a topology icon pack to a JSON manifest file.

Parameters

pack ChartForgeX.Topology.TopologyIconPack requiredposition: 0: The icon pack.
path System.String requiredposition: 1: The target manifest file path.
indented System.Boolean = true optionalposition: 2: Whether the manifest should be indented.

public static String ToJsonManifest(TopologyIconPack pack, Boolean indented = true) #

Returns: String

Serializes a topology icon pack as a deterministic JSON manifest.

Parameters

pack ChartForgeX.Topology.TopologyIconPack requiredposition: 0: The icon pack.
indented System.Boolean = true optionalposition: 1: Whether the manifest should be indented.

Returns

The JSON manifest.

public static TopologyIconPackValidationResult Validate(TopologyIconPack pack) #

Returns: TopologyIconPackValidationResult

Validates a topology icon pack for authoring issues and renderer compatibility.

Parameters

pack ChartForgeX.Topology.TopologyIconPack requiredposition: 0: The icon pack to validate.

Returns

Validation diagnostics for the pack.

public static Void WriteJsonManifest(TopologyIconPack pack, TextWriter writer, Boolean indented = true) #

Returns: Void

Writes a topology icon pack JSON manifest to a text writer.

Parameters

pack ChartForgeX.Topology.TopologyIconPack requiredposition: 0: The icon pack.
writer System.IO.TextWriter requiredposition: 1: The target text writer.
indented System.Boolean = true optionalposition: 2: Whether the manifest should be indented.