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

ChartMapCatalogEntry

Namespace ChartForgeX.Core

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

Inheritance

  • Object
  • ChartMapCatalogEntry

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

ChartMapCatalogEntry(System.String arg1, System.String arg2, System.String arg3, System.String arg4, System.String arg5, System.String arg6, System.String arg7, System.String arg8, System.Func{ChartForgeX.Core.ChartMapGeoJsonOptions} arg9, System.Boolean arg10, System.Boolean arg11, System.String arg12) #

Initializes a new catalog entry.

Parameters

arg1 System.String required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 System.String required
arg6 System.String required
arg7 System.String required
arg8 System.String required
arg9 System.Func{ChartForgeX.Core.ChartMapGeoJsonOptions} required
arg10 System.Boolean required
arg11 System.Boolean required
arg12 System.String required

Methods

CreateOptions() #

Creates a fresh options instance for this entry.

Returns

The recommended GeoJSON import options.

FromAssetDirectory 2 overloads
FromAssetDirectory(System.String directory) #

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

Parameters

directory System.String required
The directory containing catalog GeoJSON assets.

Returns

The map definition.

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

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

Parameters

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 map definition.

FromGeoJson 2 overloads
FromGeoJson(System.String geoJson) #

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

Parameters

geoJson System.String required
The GeoJSON document.

Returns

The map definition.

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

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

Parameters

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

Returns

The map definition.

FromGeoJsonFile 2 overloads
FromGeoJsonFile(System.String path) #

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

Parameters

path System.String required
The GeoJSON file path.

Returns

The map definition.

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

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

Parameters

path System.String required
The GeoJSON file path.
configure System.Action{ChartForgeX.Core.ChartMapGeoJsonOptions} required
Optional configuration applied to a fresh options instance.

Returns

The map definition.

Properties

Id #

Gets the stable catalog ID.

Name #

Gets the display name.

Geography #

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

Level #

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

Source #

Gets the source authority or dataset family.

JoinKey #

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

SourceUrl #

Gets the source URL or landing page for the geometry.

FileName #

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

IsEmbedded #

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

IsExternal #

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

Kind #

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

IsLarge #

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

Notes #

Gets the notes associated with the catalog entry.