HtmlForgeX

API Reference

Class

JsVectorMapSettings

Namespace HtmlForgeX
Assembly HtmlForgeX

Settings sub‑builder for JsVectorMap to keep IntelliSense tidy. Wraps less-common toggles while delegating to root methods.

Inheritance

  • Object
  • JsVectorMapSettings

Methods

Background 3 overloads
public JsVectorMapSettings Background(RGBColor color) #
Returns: JsVectorMapSettings

Sets background color for the map using a CSS string.

Parameters

color System.String requiredposition: 0
Background(HtmlForgeX.TablerColor color) #

Sets background color for the map using a Tabler color.

Parameters

color HtmlForgeX.TablerColor required
Background(HtmlForgeX.RGBColor color) #

Sets background color for the map using an RGB color.

Parameters

color HtmlForgeX.RGBColor required
public JsVectorMapSettings Draggable(Boolean enable = true) #
Returns: JsVectorMapSettings

Enables drag panning.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMap End() #
Returns: JsVectorMap

Returns to the root builder.

public JsVectorMapSettings FocusOn(Double latitude, Double longitude, Double scale = 2, Boolean animate = true) #
Returns: JsVectorMapSettings

Focuses the map on a coordinate at a given zoom scale.

Parameters

latitude System.Double requiredposition: 0
longitude System.Double requiredposition: 1
scale System.Double = 2 optionalposition: 2
animate System.Boolean = true optionalposition: 3
public JsVectorMapSettings FocusOnRegion(String isoCode, Boolean animate = true) #
Returns: JsVectorMapSettings

Focuses the map on a single region (ISO code).

Parameters

isoCode System.String requiredposition: 0
animate System.Boolean = true optionalposition: 1
public JsVectorMapSettings FocusOnRegions(IEnumerable<String> isoCodes, Boolean animate = true) #
Returns: JsVectorMapSettings

Focuses the map on a set of regions (ISO codes).

Parameters

isoCodes System.Collections.Generic.IEnumerable{System.String} requiredposition: 0
animate System.Boolean = true optionalposition: 1
public JsVectorMapSettings GeoGroup(String groupId) #
Returns: JsVectorMapSettings

Assigns a selection group id for cross-component geo selection sync (Leaflet/Globe/VectorMap/DataTables). Use different values when multiple dashboards exist on the same page.

Parameters

groupId System.String requiredposition: 0
public JsVectorMapSettings GeoSelectionTableMode(GeoSelectionTableMode mode) #
Returns: JsVectorMapSettings

Controls how geo selection events affect DataTables filtering across widgets in the same GeoGroup. Use SourceOnly to prevent cascaded/duplicate filtering when multiple widgets bind to the same tables.

Parameters

mode HtmlForgeX.GeoSelectionTableMode requiredposition: 0
public JsVectorMapSettings Height(String height) #
Returns: JsVectorMapSettings

Sets container height (e.g., "350px").

Parameters

height System.String requiredposition: 0
public JsVectorMapSettings Labels(Boolean markers = false, Boolean regions = false) #
Returns: JsVectorMapSettings

Enables simple labels using the name for markers and/or regions.

Parameters

markers System.Boolean = false optionalposition: 0
regions System.Boolean = false optionalposition: 1
public JsVectorMapSettings LazyInit(Boolean enable = true) #
Returns: JsVectorMapSettings

Controls whether initialization is deferred until the map becomes visible.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMapSettings Lines(Nullable<TablerColor> color = null, RGBColor customColor = null, Nullable<Double> width = null, Nullable<Boolean> dashed = null, Nullable<Boolean> animation = null, Nullable<Double> curvature = null) #
Returns: JsVectorMapSettings

Configures line style for connections in a single place.

Parameters

color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 0
Tabler color for the stroke.
customColor HtmlForgeX.RGBColor = null optionalposition: 1
Custom RGB color for the stroke.
width System.Nullable{System.Double} = null optionalposition: 2
Stroke width in pixels.
dashed System.Nullable{System.Boolean} = null optionalposition: 3
Whether to use a dashed stroke pattern.
animation System.Nullable{System.Boolean} = null optionalposition: 4
Enable animated line drawing.
curvature System.Nullable{System.Double} = null optionalposition: 5
Curvature factor (0..1) for curved lines.
public JsVectorMapSettings MarkerStyle(Nullable<Double> radius = null, String fill = null, String stroke = null, Nullable<Double> strokeWidth = null, Nullable<Double> opacity = null) #
Returns: JsVectorMapSettings

Sets default marker styling.

Parameters

radius System.Nullable{System.Double} = null optionalposition: 0
fill System.String = null optionalposition: 1
stroke System.String = null optionalposition: 2
strokeWidth System.Nullable{System.Double} = null optionalposition: 3
opacity System.Nullable{System.Double} = null optionalposition: 4
RegionFill 3 overloads
public JsVectorMapSettings RegionFill(RGBColor fill, RGBColor stroke = null, Nullable<Double> strokeWidth = null) #
Returns: JsVectorMapSettings

Configures base region fill/stroke styling.

Parameters

color System.String requiredposition: 0
stroke System.String = null optionalposition: 1
strokeWidth System.Nullable{System.Double} = null optionalposition: 2
RegionFill(HtmlForgeX.TablerColor fill, System.Nullable{HtmlForgeX.TablerColor} stroke, System.Nullable{System.Double} strokeWidth) #

Configures base region fill/stroke styling using Tabler colors.

Parameters

fill HtmlForgeX.TablerColor required
stroke System.Nullable{HtmlForgeX.TablerColor} required
strokeWidth System.Nullable{System.Double} required
RegionFill(HtmlForgeX.RGBColor fill, HtmlForgeX.RGBColor stroke, System.Nullable{System.Double} strokeWidth) #

Configures base region fill/stroke styling using RGB colors.

Parameters

fill HtmlForgeX.RGBColor required
stroke HtmlForgeX.RGBColor required
strokeWidth System.Nullable{System.Double} required
public JsVectorMapSettings Regions(Action<JsVectorMapRegionSettings> configure) #
Returns: JsVectorMapSettings

Builds a region color scale automatically and assigns levels to regions (1..10) without manual dictionaries.

Parameters

configure System.Action{HtmlForgeX.JsVectorMapRegionSettings} requiredposition: 0
public JsVectorMapSettings SelectableMarkers(Boolean enable = true, Boolean single = false) #
Returns: JsVectorMapSettings

Enables selection of markers by clicking on them.

Parameters

enable System.Boolean = true optionalposition: 0
single System.Boolean = false optionalposition: 1
public JsVectorMapSettings SelectableRegions(Boolean enable = true, Boolean single = false) #
Returns: JsVectorMapSettings

Enables selection of regions by clicking on them.

Parameters

enable System.Boolean = true optionalposition: 0
single System.Boolean = false optionalposition: 1
public JsVectorMapSettings SelectedMarkers(params Int32[] indices) #
Returns: JsVectorMapSettings

Sets initial selected markers (marker indices).

Parameters

indices System.Int32[] requiredposition: 0
SelectedRegions 2 overloads
public JsVectorMapSettings SelectedRegions(params Country[] countries) #
Returns: JsVectorMapSettings

Sets initial selected regions (ISO codes).

Parameters

isoCodes System.String[] requiredposition: 0
SelectedRegions(HtmlForgeX.Country[] countries) #

Sets initial selected regions using typed Country codes.

Parameters

countries HtmlForgeX.Country[] required
public JsVectorMapSettings Tooltips(Boolean enable = true) #
Returns: JsVectorMapSettings

Enables/disables tooltips.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMapSettings TouchEvents(Boolean enable = true) #
Returns: JsVectorMapSettings

Enable/disable touch interactions.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMapSettings ZoomAnimate(Boolean enable = true) #
Returns: JsVectorMapSettings

Enable/disable animated zoom.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMapSettings ZoomButtons(Boolean enable = true) #
Returns: JsVectorMapSettings

Shows or hides zoom buttons.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMapSettings ZoomLimits(Nullable<Double> min = null, Nullable<Double> max = null) #
Returns: JsVectorMapSettings

Sets zoom limits.

Parameters

min System.Nullable{System.Double} = null optionalposition: 0
max System.Nullable{System.Double} = null optionalposition: 1
public JsVectorMapSettings ZoomOnScroll(Boolean enable = true) #
Returns: JsVectorMapSettings

Enables/disables zoom on mouse wheel.

Parameters

enable System.Boolean = true optionalposition: 0
public JsVectorMapSettings ZoomOnScrollSpeed(Double speed) #
Returns: JsVectorMapSettings

Zoom-on-scroll speed (higher = faster).

Parameters

speed System.Double requiredposition: 0
public JsVectorMapSettings ZoomStep(Double step) #
Returns: JsVectorMapSettings

Zoom step used by zoom buttons.

Parameters

step System.Double requiredposition: 0