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

ChartMapCatalog

Namespace ChartForgeX.Core
Assembly ChartForgeX
Modifiers static

Provides generic access to built-in reusable map definitions.

Inheritance

  • Object
  • ChartMapCatalog

Methods

public static IReadOnlyList<ChartMapDefinition> All() #
Returns: IReadOnlyList<ChartMapDefinition>

Gets all built-in map definitions.

Returns

The available map definitions.

public static IReadOnlyList<ChartMapCatalogEntry> EmbeddedEntries() #
Returns: IReadOnlyList<ChartMapCatalogEntry>

Gets metadata for map definitions embedded in the core package.

Returns

The embedded catalog entries.

public static IReadOnlyList<ChartMapCatalogEntry> Entries() #
Returns: IReadOnlyList<ChartMapCatalogEntry>

Gets metadata for built-in and known external map definitions.

Returns

The available catalog entries.

public static IReadOnlyList<ChartMapCatalogEntry> ExternalEntries() #
Returns: IReadOnlyList<ChartMapCatalogEntry>

Gets metadata for known external map definitions that must be supplied by a host application or repository asset.

Returns

The known external catalog entries.

FromAssetDirectory 2 overloads
public static ChartMapDefinition FromAssetDirectory(String id, String directory) #
Returns: ChartMapDefinition

Loads a known external map definition from a catalog asset directory using the entry's standard file name.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
directory System.String requiredposition: 1
The directory containing catalog GeoJSON assets.

Returns

The loaded map definition.

public static ChartMapDefinition FromAssetDirectory(String id, String directory, Action<ChartMapGeoJsonOptions>? configure) #
Returns: ChartMapDefinition

Loads a known external map definition from a catalog asset directory with caller-specific import refinements.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
directory System.String requiredposition: 1
The directory containing catalog GeoJSON assets.
configure System.Action<ChartForgeX.Core.ChartMapGeoJsonOptions>? requiredposition: 2
Optional configuration applied to a fresh options instance.

Returns

The loaded map definition.

FromGeoJson 2 overloads
public static ChartMapDefinition FromGeoJson(String id, String geoJson) #
Returns: ChartMapDefinition

Loads a known external map definition from a GeoJSON document.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
geoJson System.String requiredposition: 1
The GeoJSON document.

Returns

The loaded map definition.

public static ChartMapDefinition FromGeoJson(String id, String geoJson, Action<ChartMapGeoJsonOptions>? configure) #
Returns: ChartMapDefinition

Loads a known external map definition from a GeoJSON document with caller-specific import refinements.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
geoJson System.String requiredposition: 1
The GeoJSON document.
configure System.Action<ChartForgeX.Core.ChartMapGeoJsonOptions>? requiredposition: 2
Optional configuration applied to a fresh options instance.

Returns

The loaded map definition.

FromGeoJsonFile 2 overloads
public static ChartMapDefinition FromGeoJsonFile(String id, String path) #
Returns: ChartMapDefinition

Loads a known external map definition from a GeoJSON file.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
path System.String requiredposition: 1
The local GeoJSON file path.

Returns

The loaded map definition.

public static ChartMapDefinition FromGeoJsonFile(String id, String path, Action<ChartMapGeoJsonOptions>? configure) #
Returns: ChartMapDefinition

Loads a known external map definition from a GeoJSON file with caller-specific import refinements.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
path System.String requiredposition: 1
The local GeoJSON file path.
configure System.Action<ChartForgeX.Core.ChartMapGeoJsonOptions>? requiredposition: 2
Optional configuration applied to a fresh options instance.

Returns

The loaded map definition.

public static ChartMapDefinition Get(String id) #
Returns: ChartMapDefinition

Gets a built-in map definition by ID.

Parameters

id System.String requiredposition: 0
The map definition ID.

Returns

The requested map definition.

public static ChartMapCatalogEntry GetEntry(String id) #
Returns: ChartMapCatalogEntry

Gets metadata for a built-in or known external map definition.

Parameters

id System.String requiredposition: 0
The catalog entry ID.

Returns

The requested catalog entry.

Load 2 overloads
public static ChartMapDefinition Load(String id, String? assetDirectory = null) #
Returns: ChartMapDefinition

Loads a map definition by catalog ID, using embedded geometry when available or an asset directory for external entries.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
assetDirectory System.String? = null optionalposition: 1
The optional directory containing external catalog GeoJSON assets.

Returns

The loaded map definition.

public static ChartMapDefinition Load(String id, String? assetDirectory, Action<ChartMapGeoJsonOptions>? configure) #
Returns: ChartMapDefinition

Loads a map definition by catalog ID, using embedded geometry when available or an asset directory for external entries.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
assetDirectory System.String? requiredposition: 1
The optional directory containing external catalog GeoJSON assets.
configure System.Action<ChartForgeX.Core.ChartMapGeoJsonOptions>? requiredposition: 2
Optional configuration applied to external GeoJSON import options.

Returns

The loaded map definition.

public static Boolean TryGet(String id, out ChartMapDefinition definition) #
Returns: Boolean

Attempts to get a built-in map definition by ID.

Parameters

id System.String requiredposition: 0
The map definition ID.
definition ChartForgeX.Core.ChartMapDefinition requiredposition: 1
The resolved map definition.

Returns

true when the definition exists; otherwise false.

public static Boolean TryGetEntry(String id, out ChartMapCatalogEntry entry) #
Returns: Boolean

Attempts to get metadata for a built-in or known external map definition.

Parameters

id System.String requiredposition: 0
The catalog entry ID.
entry ChartForgeX.Core.ChartMapCatalogEntry requiredposition: 1
The resolved catalog entry.

Returns

true when the entry exists; otherwise false.