ChartMapDefinition

Namespace ChartForgeX.Core

Assembly ChartForgeX

Modifiers sealed

Describes reusable map geometry that can be rendered with different map visual styles.

Inheritance

Explore 19 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.

ChartMapDefinition 2 overloads

public ChartMapDefinition(String id, String name, Double width, Double height, IEnumerable<ChartMapRegion> regions) #

Initializes a new instance of the ChartMapDefinition class with bounds starting at zero.

id System.String requiredposition: 0: The stable map identifier.
name System.String requiredposition: 1: The display name.
width System.Double requiredposition: 2: The map coordinate width.
height System.Double requiredposition: 3: The map coordinate height.
regions System.Collections.Generic.IEnumerable<ChartForgeX.Core.ChartMapRegion> requiredposition: 4: The drawable regions.

public ChartMapDefinition(String id, String name, ChartRect bounds, IEnumerable<ChartMapRegion> regions) #

Initializes a new instance of the ChartMapDefinition class.

id System.String requiredposition: 0: The stable map identifier.
name System.String requiredposition: 1: The display name.
bounds ChartForgeX.Primitives.ChartRect requiredposition: 2: The coordinate bounds occupied by the map paths.
regions System.Collections.Generic.IEnumerable<ChartForgeX.Core.ChartMapRegion> requiredposition: 3: The drawable regions.

public static ChartMapDefinition FromGeoJson(String id, String name, String geoJson, ChartMapGeoJsonOptions? options = null)

Returns: ChartMapDefinition

Creates a map definition from a GeoJSON FeatureCollection or Feature.

id System.String requiredposition: 0: The stable map identifier.
name System.String requiredposition: 1: The display name.
geoJson System.String requiredposition: 2: The GeoJSON document.
options ChartForgeX.Core.ChartMapGeoJsonOptions? = null optionalposition: 3: Optional import settings.

A reusable map definition.

public Boolean TryResolveRegion(String region, out String code) #

Returns: Boolean

Resolves a caller-provided region code or alias to the canonical region code.

region System.String requiredposition: 0: The code, name, or alias to resolve.
code System.String requiredposition: 1: The canonical region code.

true when the region can be resolved; otherwise false.

public String Id { get; } #

Gets the stable map identifier.

public String Name { get; } #

Gets the display name of the map.

public ChartRect Bounds { get; } #

Gets the coordinate bounds occupied by the map paths.

public IReadOnlyList<ChartMapRegion> Regions { get; } #

Gets the drawable regions.