API Reference
Class
ChartMapDefinition
Describes reusable map geometry that can be rendered with different map visual styles.
Inheritance
- Object
- ChartMapDefinition
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method Chart.AddMapBaseLayer
- Method Chart.AddMapBoundaryLayer
- Method Chart.AddRegionHeatmap
- Method Chart.AddRegionMap
- Method ChartMapCatalog.TryGet
- Constructor ChartMapLayer.ChartMapLayer
Constructors
ChartMapDefinition 2 overloads
ChartMapDefinition(System.String id, System.String name, System.Double width, System.Double height, System.Collections.Generic.IEnumerable{ChartForgeX.Core.ChartMapRegion} regions) #Initializes a new instance of the ChartMapDefinition class with bounds starting at zero.
Parameters
- id System.String
- The stable map identifier.
- name System.String
- The display name.
- width System.Double
- The map coordinate width.
- height System.Double
- The map coordinate height.
- regions System.Collections.Generic.IEnumerable{ChartForgeX.Core.ChartMapRegion}
- The drawable regions.
ChartMapDefinition(System.String id, System.String name, ChartForgeX.Primitives.ChartRect bounds, System.Collections.Generic.IEnumerable{ChartForgeX.Core.ChartMapRegion} regions) #Initializes a new instance of the ChartMapDefinition class.
Parameters
- id System.String
- The stable map identifier.
- name System.String
- The display name.
- bounds ChartForgeX.Primitives.ChartRect
- The coordinate bounds occupied by the map paths.
- regions System.Collections.Generic.IEnumerable{ChartForgeX.Core.ChartMapRegion}
- The drawable regions.
Methods
FromGeoJson(System.String id, System.String name, System.String geoJson, ChartForgeX.Core.ChartMapGeoJsonOptions options) #Creates a map definition from a GeoJSON FeatureCollection or Feature.
Parameters
- id System.String
- The stable map identifier.
- name System.String
- The display name.
- geoJson System.String
- The GeoJSON document.
- options ChartForgeX.Core.ChartMapGeoJsonOptions
- Optional import settings.
Returns
A reusable map definition.
TryResolveRegion(System.String region, System.String@ code) #Resolves a caller-provided region code or alias to the canonical region code.
Parameters
- region System.String
- The code, name, or alias to resolve.
- code System.String@
- The canonical region code.
Returns
true when the region can be resolved; otherwise false.