API Reference
Class
ChartTileMapDefinition
Describes reusable tile-map geometry.
Inheritance
- Object
- ChartTileMapDefinition
Usage
Explore 6 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 3
- Property ChartOptions.TileMapDefinition
- Method ChartTileMapCatalog.All
- Method ChartTileMapCatalog.Get
Accepted by parameters 3
- Method Chart.AddTileHeatmap
- Method Chart.AddTileMap
- Method ChartTileMapCatalog.TryGet
Constructors
public ChartTileMapDefinition(String id, String name, IEnumerable<ChartTileMapRegion> regions) #Initializes a new instance of the ChartTileMapDefinition class.
Parameters
- id System.String
- The stable map identifier.
- name System.String
- The display name.
- regions System.Collections.Generic.IEnumerable<ChartForgeX.Core.ChartTileMapRegion>
- The tile regions.
Methods
public Boolean TryResolveRegion(String region, out String code) #Returns:
BooleanResolves 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.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String Id { get; } #Gets the stable map identifier.
public String Name { get; } #Gets the display name of the tile map.
public Int32 ColumnCount { get; } #Gets the number of occupied tile columns.
public Int32 RowCount { get; } #Gets the number of occupied tile rows.
public IReadOnlyList<ChartTileMapRegion> Regions { get; } #Gets the drawable regions.