HtmlForgeX

API Reference

Class

LeafletMapSettings

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Settings sub‑builder for LeafletMap to keep the root surface tidy.

Inheritance

  • Object
  • LeafletMapSettings

Methods

public LeafletMapSettings Center(Double latitude, Double longitude) #
Returns: LeafletMapSettings

Sets center lat/lng.

Parameters

latitude System.Double requiredposition: 0
longitude System.Double requiredposition: 1
public LeafletMapSettings DoubleClickZoom(Boolean enable) #
Returns: LeafletMapSettings

Enable/disable double click zoom.

Parameters

enable System.Boolean requiredposition: 0
public LeafletMapSettings Dragging(Boolean enable) #
Returns: LeafletMapSettings

Enable/disable dragging (panning).

Parameters

enable System.Boolean requiredposition: 0
public LeafletMap End() #
Returns: LeafletMap

Return to root.

public LeafletMapSettings FitToContent(Int32 paddingPx = 24) #
Returns: LeafletMapSettings

Fits the map view to all overlays (markers, circles, polylines, polygons) after initialization.

Parameters

paddingPx System.Int32 = 24 optionalposition: 0
public LeafletMapSettings FitToMarkers(Int32 paddingPx = 24) #
Returns: LeafletMapSettings

Fits the map view to markers after initialization.

Parameters

paddingPx System.Int32 = 24 optionalposition: 0
public LeafletMapSettings GeoGroup(String groupId) #
Returns: LeafletMapSettings

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 LeafletMapSettings GeoJson(String geoJson, String tooltipProperty = "tooltip", String popupProperty = "popup") #
Returns: LeafletMapSettings

Adds a GeoJSON overlay layer.

Parameters

geoJson System.String requiredposition: 0
tooltipProperty System.String = "tooltip" optionalposition: 1
popupProperty System.String = "popup" optionalposition: 2
public LeafletMapSettings GeoSelectionTableMode(GeoSelectionTableMode mode) #
Returns: LeafletMapSettings

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 LeafletMapSettings Heatmap(Action<LeafletHeatmapSettings> configure = null) #
Returns: LeafletMapSettings

Enables a heatmap overlay (density layer). Requires the optional heatmap plugin library.

Parameters

configure System.Action{HtmlForgeX.LeafletHeatmapSettings} = null optionalposition: 0
public LeafletMapSettings Height(String height) #
Returns: LeafletMapSettings

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

Parameters

height System.String requiredposition: 0
public LeafletMapSettings LayerControl(Action<LeafletLayerControlSettings> configure = null) #
Returns: LeafletMapSettings

Enables the Leaflet layer control (base layers + overlay toggles).

Parameters

configure System.Action{HtmlForgeX.LeafletLayerControlSettings} = null optionalposition: 0
public LeafletMapSettings LazyInit(Boolean enabled = true) #
Returns: LeafletMapSettings

Controls whether the map initializes only when it becomes visible.

Parameters

enabled System.Boolean = true optionalposition: 0
public LeafletMapSettings Legend(Action<LeafletLegendSettings> configure = null) #
Returns: LeafletMapSettings

Adds a small legend control (swatches + labels) to the map.

Parameters

configure System.Action{HtmlForgeX.LeafletLegendSettings} = null optionalposition: 0
public LeafletMapSettings MarkerClustering(Action<LeafletMarkerClusteringSettings> configure = null) #
Returns: LeafletMapSettings

Enables marker clustering (useful for large marker sets).

Parameters

configure System.Action{HtmlForgeX.LeafletMarkerClusteringSettings} = null optionalposition: 0
public LeafletMapSettings ScrollWheelZoom(Boolean enable) #
Returns: LeafletMapSettings

Enable/disable scroll wheel zoom.

Parameters

enable System.Boolean requiredposition: 0
public LeafletMapSettings SituationSweep(Boolean enable = true, Nullable<Double> speedSeconds = null) #
Returns: LeafletMapSettings

Enables the situation-monitor sweep overlay (best with Situation).

Parameters

enable System.Boolean = true optionalposition: 0
speedSeconds System.Nullable{System.Double} = null optionalposition: 1
public LeafletMapSettings SituationSweepArcWidth(Double degrees) #
Returns: LeafletMapSettings

Sets the sweep arc width in degrees (best with Situation).

Parameters

degrees System.Double requiredposition: 0
SituationSweepStyle 3 overloads
public LeafletMapSettings SituationSweepStyle(String color, Nullable<Double> opacity = null) #
Returns: LeafletMapSettings
EditorBrowsable(2)

Sets the sweep overlay color and opacity (best with Situation).

Parameters

color HtmlForgeX.TablerColor requiredposition: 0
opacity System.Nullable{System.Double} = null optionalposition: 1
SituationSweepStyle(HtmlForgeX.RGBColor color, System.Nullable{System.Double} opacity) #

Sets the sweep overlay color and opacity (best with Situation).

Parameters

color HtmlForgeX.RGBColor required
opacity System.Nullable{System.Double} required
SituationSweepStyle(System.String color, System.Nullable{System.Double} opacity) #

Sets the sweep overlay color and opacity using a custom CSS color string.

Parameters

color System.String required
opacity System.Nullable{System.Double} required
public LeafletMapSettings Style(LeafletMapStyle style) #
Returns: LeafletMapSettings

Applies a visual style preset.

Parameters

style HtmlForgeX.LeafletMapStyle requiredposition: 0
public LeafletMapSettings ThemeTiles(LeafletTileProvider light, LeafletTileProvider dark, String lightName = "Light", String darkName = "Dark", Boolean followThemeChanges = true) #
Returns: LeafletMapSettings

Configures light/dark tile providers and automatically switches them when the page theme changes.

Parameters

light HtmlForgeX.LeafletTileProvider requiredposition: 0
dark HtmlForgeX.LeafletTileProvider requiredposition: 1
lightName System.String = "Light" optionalposition: 2
darkName System.String = "Dark" optionalposition: 3
followThemeChanges System.Boolean = true optionalposition: 4
public LeafletMapSettings TileProvider(LeafletTileProvider provider) #
Returns: LeafletMapSettings

Sets the tile provider.

Parameters

provider HtmlForgeX.LeafletTileProvider requiredposition: 0
public LeafletMapSettings Zoom(Int32 zoom) #
Returns: LeafletMapSettings

Sets initial zoom level.

Parameters

zoom System.Int32 requiredposition: 0
public LeafletMapSettings ZoomControl(Boolean enable) #
Returns: LeafletMapSettings

Show/hide zoom control UI.

Parameters

enable System.Boolean requiredposition: 0