HtmlForgeX

API Reference

Class

JsVectorMapRegionSettings

Namespace HtmlForgeX
Assembly HtmlForgeX

Settings builder for region coloring (choropleth) to avoid manual scale dictionaries.

Inheritance

  • Object
  • JsVectorMapRegionSettings

Methods

Add 2 overloads
public JsVectorMapRegionSettings Add(Country country, Int32 level) #
Returns: JsVectorMapRegionSettings

Adds a region level (1..10). Examples: Add("PL", 10), Add("US", 9).

Parameters

iso2OrIso3 System.String requiredposition: 0
level System.Int32 requiredposition: 1
Add(HtmlForgeX.Country country, System.Int32 level) #

Adds a typed region level using Country.

Parameters

country HtmlForgeX.Country required
level System.Int32 required
public JsVectorMapRegionSettings AddRange(IEnumerable<Country> countries, Int32 level) #
Returns: JsVectorMapRegionSettings

Adds many typed regions with the same level using Country.

Parameters

countries System.Collections.Generic.IEnumerable{HtmlForgeX.Country} requiredposition: 0
level System.Int32 requiredposition: 1
public JsVectorMapRegionSettings Alpha(Double min, Double max) #
Returns: JsVectorMapRegionSettings

Sets alpha range for the generated scale (default 0.1..1.0).

Parameters

min System.Double requiredposition: 0
max System.Double requiredposition: 1
public JsVectorMapRegionSettings Assign(Country country, TablerColor color) #
Returns: JsVectorMapRegionSettings

Numeric values keyed by typed country codes.

Parameters

country HtmlForgeX.Country requiredposition: 0
color HtmlForgeX.TablerColor requiredposition: 1
AssignHex 2 overloads
public JsVectorMapRegionSettings AssignHex(Country country, String hex) #
Returns: JsVectorMapRegionSettings

Assigns an explicit color to one region using typed Country and hex.

Parameters

country HtmlForgeX.Country requiredposition: 0
hex System.String requiredposition: 1
public JsVectorMapRegionSettings AssignHex(String iso2, String hex) #
Returns: JsVectorMapRegionSettings

Assigns an explicit color to one region using ISO string and hex.

Parameters

iso2 System.String requiredposition: 0
hex System.String requiredposition: 1
public JsVectorMapRegionSettings BaseColor(TablerColor color) #
Returns: JsVectorMapRegionSettings

Sets base color for the generated scale.

Parameters

color HtmlForgeX.TablerColor requiredposition: 0
public JsVectorMap End() #
Returns: JsVectorMap

Returns to the root map after applying region coloring.

public JsVectorMap Numeric(IDictionary<String, Double> values, Int32 bins = 10, JsVectorNumericBinMode mode = EqualInterval) #
Returns: JsVectorMap

Assign numeric values and let the builder bin them into levels automatically.

Parameters

values System.Collections.Generic.IDictionary{System.String,System.Double} requiredposition: 0
bins System.Int32 = 10 optionalposition: 1
mode HtmlForgeX.JsVectorNumericBinMode = EqualInterval optionalposition: 2
public JsVectorMapRegionSettings Palette(params TablerColor[] colors) #
Returns: JsVectorMapRegionSettings

Use a discrete palette of Tabler colors instead of an alpha scale.

Parameters

colors HtmlForgeX.TablerColor[] requiredposition: 0
public JsVectorMapRegionSettings PaletteHex(params String[] hexColors) #
Returns: JsVectorMapRegionSettings

Use a discrete palette of custom hex colors (e.g., "#FF0000").

Parameters

hexColors System.String[] requiredposition: 0