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

ChartMapCatalogEntry

Namespace ChartForgeX.Core
Assembly ChartForgeX
Modifiers sealed

Describes a reusable map catalog entry and how its GeoJSON should be imported.

Inheritance

  • Object
  • ChartMapCatalogEntry

Usage

Explore 5 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 4

Accepted by parameters 1

Constructors

public ChartMapCatalogEntry(String id, String name, String geography, String level, String source, String joinKey, String sourceUrl, String fileName, Func<ChartMapGeoJsonOptions>? optionsFactory = null, Boolean isEmbedded = false, Boolean isLarge = false, String? notes = null) #

Initializes a new catalog entry.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
geography System.String requiredposition: 2
level System.String requiredposition: 3
source System.String requiredposition: 4
joinKey System.String requiredposition: 5
sourceUrl System.String requiredposition: 6
fileName System.String requiredposition: 7
optionsFactory System.Func<ChartForgeX.Core.ChartMapGeoJsonOptions>? = null optionalposition: 8
isEmbedded System.Boolean = false optionalposition: 9
isLarge System.Boolean = false optionalposition: 10
notes System.String? = null optionalposition: 11

Methods

public ChartMapGeoJsonOptions CreateOptions() #
Returns: ChartMapGeoJsonOptions

Creates a fresh options instance for this entry.

Returns

The recommended GeoJSON import options.

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

Creates a map definition from this entry's standard file name inside an asset directory.

Parameters

directory System.String requiredposition: 0
The directory containing catalog GeoJSON assets.

Returns

The map definition.

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

Creates a map definition from this entry's standard file name inside an asset directory and caller-specific refinements.

Parameters

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

Returns

The map definition.

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

Creates a map definition from GeoJSON using this entry's recommended import options.

Parameters

geoJson System.String requiredposition: 0
The GeoJSON document.

Returns

The map definition.

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

Creates a map definition from GeoJSON using this entry's recommended import options and caller-specific refinements.

Parameters

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

Returns

The map definition.

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

Creates a map definition from a GeoJSON file using this entry's recommended import options.

Parameters

path System.String requiredposition: 0
The GeoJSON file path.

Returns

The map definition.

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

Creates a map definition from a GeoJSON file using this entry's recommended import options and caller-specific refinements.

Parameters

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

Returns

The map definition.

Properties

public String Id { get; } #

Gets the stable catalog ID.

public String Name { get; } #

Gets the display name.

public String Geography { get; } #

Gets the covered geography, such as EU, US, or World.

public String Level { get; } #

Gets the administrative or statistical level, such as NUTS3, state, county, or admin0.

public String Source { get; } #

Gets the source authority or dataset family.

public String JoinKey { get; } #

Gets the recommended join key used by metric data for this map.

public String SourceUrl { get; } #

Gets the source URL or landing page for the geometry.

public String FileName { get; } #

Gets the recommended local file name when this entry is stored as an external GeoJSON asset.

public Boolean IsEmbedded { get; } #

Gets a value indicating whether the entry is embedded in the core package.

public Boolean IsExternal { get; } #

Gets a value indicating whether the entry is a known external dataset that must be supplied by the host.

public ChartMapCatalogEntryKind Kind { get; } #

Gets how the map catalog entry is made available to callers.

public Boolean IsLarge { get; } #

Gets a value indicating whether the entry is normally too large to embed in the core package.

public String Notes { get; } #

Gets the notes associated with the catalog entry.