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

ChartMapCatalog

Namespace ChartForgeX.Core

Provides generic access to built-in reusable map definitions.

Inheritance

Object
ChartMapCatalog

Methods

All() #

Gets all built-in map definitions.

Returns

The available map definitions.

EmbeddedEntries() #

Gets metadata for map definitions embedded in the core package.

Returns

The embedded catalog entries.

Entries() #

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

Returns

The available catalog entries.

ExternalEntries() #

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

FromAssetDirectory(System.String id, System.String directory) #

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

Parameters

id System.String required: The catalog entry ID.
directory System.String required: The directory containing catalog GeoJSON assets.

Returns

The loaded map definition.

FromAssetDirectory(System.String id, System.String directory, System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} configure)

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

Parameters

id System.String required: The catalog entry ID.
directory System.String required: The directory containing catalog GeoJSON assets.
configure System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} required: Optional configuration applied to a fresh options instance.

Returns

The loaded map definition.

FromGeoJson 2 overloads

FromGeoJson(System.String id, System.String geoJson) #

Loads a known external map definition from a GeoJSON document.

Parameters

id System.String required: The catalog entry ID.
geoJson System.String required: The GeoJSON document.

Returns

The loaded map definition.

FromGeoJson(System.String id, System.String geoJson, System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} configure) #

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

Parameters

id System.String required: The catalog entry ID.
geoJson System.String required: The GeoJSON document.
configure System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} required: Optional configuration applied to a fresh options instance.

Returns

The loaded map definition.

FromGeoJsonFile 2 overloads

FromGeoJsonFile(System.String id, System.String path) #

Loads a known external map definition from a GeoJSON file.

Parameters

id System.String required: The catalog entry ID.
path System.String required: The local GeoJSON file path.

Returns

The loaded map definition.

FromGeoJsonFile(System.String id, System.String path, System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} configure) #

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

Parameters

id System.String required: The catalog entry ID.
path System.String required: The local GeoJSON file path.
configure System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} required: Optional configuration applied to a fresh options instance.

Returns

The loaded map definition.

Get(System.String id) #

Gets a built-in map definition by ID.

Parameters

id System.String required: The map definition ID.

Returns

The requested map definition.

GetEntry(System.String id) #

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

Parameters

id System.String required: The catalog entry ID.

Returns

The requested catalog entry.

Load 2 overloads

Load(System.String id, System.String assetDirectory) #

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

Parameters

id System.String required: The catalog entry ID.
assetDirectory System.String required: The optional directory containing external catalog GeoJSON assets.

Returns

The loaded map definition.

Load(System.String id, System.String assetDirectory, System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} configure) #

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

Parameters

id System.String required: The catalog entry ID.
assetDirectory System.String required: The optional directory containing external catalog GeoJSON assets.
configure System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} required: Optional configuration applied to external GeoJSON import options.

Returns

The loaded map definition.

TryGet(System.String id, ChartForgeX.Core.ChartMapDefinition@ definition) #

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

Parameters

id System.String required: The map definition ID.
definition ChartForgeX.Core.ChartMapDefinition@ required: The resolved map definition.

Returns

true when the definition exists; otherwise false.

TryGetEntry(System.String id, ChartForgeX.Core.ChartMapCatalogEntry@ entry) #

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

Parameters

id System.String required: The catalog entry ID.
entry ChartForgeX.Core.ChartMapCatalogEntry@ required: The resolved catalog entry.

Returns

true when the entry exists; otherwise false.