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

TopologyIconPackJson

Namespace ChartForgeX.Topology

Reads and writes dependency-free JSON manifests for topology icon packs.

Inheritance

  • Object
  • TopologyIconPackJson

Methods

AddJsonPack 2 overloads
AddJsonPack(ChartForgeX.Topology.TopologyIconCatalog catalog, System.String json) #

Adds a JSON manifest icon pack to the catalog.

Parameters

catalog ChartForgeX.Topology.TopologyIconCatalog required
The target catalog.
json System.String required
The JSON manifest.

Returns

The current catalog.

AddJsonPack(ChartForgeX.Topology.TopologyIconCatalog catalog, System.IO.TextReader reader) #

Adds a JSON manifest icon pack read from a text reader to the catalog.

Parameters

catalog ChartForgeX.Topology.TopologyIconCatalog required
The target catalog.
reader System.IO.TextReader required
The source text reader.

Returns

The current catalog.

AddJsonPackFile(ChartForgeX.Topology.TopologyIconCatalog catalog, System.String path) #

Adds a JSON manifest icon pack read from a file to the catalog.

Parameters

catalog ChartForgeX.Topology.TopologyIconCatalog required
The target catalog.
path System.String required
The manifest file path.

Returns

The current catalog.

AddJsonPacksFromDirectory(ChartForgeX.Topology.TopologyIconCatalog catalog, System.String directoryPath, System.String searchPattern, System.Boolean recursive) #

Adds all JSON icon-pack manifests from a directory to the catalog in deterministic file-name order.

Parameters

catalog ChartForgeX.Topology.TopologyIconCatalog required
The target catalog.
directoryPath System.String required
The source directory path.
searchPattern System.String required
The file search pattern.
recursive System.Boolean required
Whether child directories should be searched.

Returns

The current catalog.

FromJson 2 overloads
FromJson(System.String json) #

Creates a topology icon pack from a JSON manifest.

Parameters

json System.String required
The JSON manifest.

Returns

The imported topology icon pack.

FromJson(System.String json, System.String manifestDirectory) #

Creates a topology icon pack from a JSON manifest and optionally resolves pack-local sidecar artwork.

Parameters

json System.String required
The JSON manifest.
manifestDirectory System.String required
The manifest directory used to resolve sidecar artwork paths.

Returns

The imported topology icon pack.

LoadJsonCatalogFromDirectory 2 overloads
LoadJsonCatalogFromDirectory(System.String directoryPath, System.String searchPattern, System.Boolean recursive, System.Boolean includeBuiltInPacks) #

Loads a topology icon catalog from a directory and returns per-file diagnostics.

Parameters

directoryPath System.String required
The source directory path.
searchPattern System.String required
The file search pattern.
recursive System.Boolean required
Whether child directories should be searched.
includeBuiltInPacks System.Boolean required
Whether the returned catalog should start with ChartForgeX built-in packs.

Returns

The loaded catalog plus per-file diagnostics.

LoadJsonCatalogFromDirectory(System.String directoryPath, ChartForgeX.Topology.TopologyIconCatalogLoadOptions options) #

Loads a topology icon catalog from a directory and returns per-file diagnostics.

Parameters

directoryPath System.String required
The source directory path.
options ChartForgeX.Topology.TopologyIconCatalogLoadOptions required
The load options.

Returns

The loaded catalog plus per-file diagnostics.

LoadJsonManifest 3 overloads
LoadJsonManifest(System.String path) #

Loads a topology icon pack from a JSON manifest file.

Parameters

path System.String required
The manifest file path.

Returns

The imported topology icon pack.

LoadJsonManifest(System.IO.TextReader reader) #

Loads a topology icon pack from a JSON manifest text reader.

Parameters

reader System.IO.TextReader required
The source text reader.

Returns

The imported topology icon pack.

LoadJsonManifest(System.IO.TextReader reader, System.String manifestDirectory) #

Loads a topology icon pack from a JSON manifest text reader and resolves pack-local sidecar artwork.

Parameters

reader System.IO.TextReader required
The source text reader.
manifestDirectory System.String required
The manifest directory used to resolve sidecar artwork paths.

Returns

The imported topology icon pack.

LoadJsonManifestResultsFromDirectory(System.String directoryPath, System.String searchPattern, System.Boolean recursive) #

Loads all JSON icon-pack manifests from a directory and reports per-file success or failure.

Parameters

directoryPath System.String required
The source directory path.
searchPattern System.String required
The file search pattern.
recursive System.Boolean required
Whether child directories should be searched.

Returns

Per-file load results in deterministic file-name order.

LoadJsonManifestsFromDirectory(System.String directoryPath, System.String searchPattern, System.Boolean recursive) #

Loads all JSON icon-pack manifests from a directory in deterministic file-name order.

Parameters

directoryPath System.String required
The source directory path.
searchPattern System.String required
The file search pattern.
recursive System.Boolean required
Whether child directories should be searched.

Returns

The imported topology icon packs.

SaveJsonManifest(ChartForgeX.Topology.TopologyIconPack pack, System.String path, System.Boolean indented) #

Saves a topology icon pack to a JSON manifest file.

Parameters

pack ChartForgeX.Topology.TopologyIconPack required
The icon pack.
path System.String required
The target manifest file path.
indented System.Boolean required
Whether the manifest should be indented.
ToJsonManifest(ChartForgeX.Topology.TopologyIconPack pack, System.Boolean indented) #

Serializes a topology icon pack as a deterministic JSON manifest.

Parameters

pack ChartForgeX.Topology.TopologyIconPack required
The icon pack.
indented System.Boolean required
Whether the manifest should be indented.

Returns

The JSON manifest.

WriteJsonManifest(ChartForgeX.Topology.TopologyIconPack pack, System.IO.TextWriter writer, System.Boolean indented) #

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

Parameters

pack ChartForgeX.Topology.TopologyIconPack required
The icon pack.
writer System.IO.TextWriter required
The target text writer.
indented System.Boolean required
Whether the manifest should be indented.

Fields

Schema #

Gets the manifest schema identifier.