Blazor Leaflet

https://mehigh17.github.io/BlazorLeaflet
Admin
Blazor Leaflet is a Blazor component wrapper for Leaflet's APIs, offering a simple and homogeneous...
Tokens:39,135
Snippets:310
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### NotifyZoomStart

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Notifies the map of a zoom start event.

```APIDOC
## NotifyZoomStart

### Description
Notifies the map of a zoom start event.

### Method Signature
`NotifyZoomStart(Event e)`

### Parameters
- **e** (Event) - The zoom start event arguments.
```

--------------------------------

### NotifyMoveStart

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Notifies the map of a move start event.

```APIDOC
## NotifyMoveStart

### Description
Notifies the map of a move start event.

### Method Signature
`NotifyMoveStart(Event e)`

### Parameters
- **e** (Event) - The move start event arguments.
```

--------------------------------

### Zoom Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map.html

Gets or sets the initial zoom level of the map.

```APIDOC
## Zoom

### Description
Initial map zoom level.

### Property Type
`float`

### Access
`getset`
```

--------------------------------

### Corner1 Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ImageLayer-members.html

Gets or sets the first corner of the image layer's bounds.

```APIDOC
## Corner1 Property

### Description
Represents the first corner of the image bounds for the `ImageLayer`.

### Type
PointF
```

--------------------------------

### Center Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map.html

Gets or sets the initial geographic center of the map.

```APIDOC
## Center

### Description
Initial geographic center of the map.

### Property Type
`LatLng`

### Access
`getset`
```

--------------------------------

### Marker Constructors

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Marker.html

Demonstrates the different ways to create a Marker instance using coordinates or a LatLng object.

```APIDOC
## Marker Constructors

### Description
These constructors allow you to create a new Marker object by specifying its position using different coordinate systems.

### Constructors

- **Marker(float x, float y)**: Creates a marker at the specified x and y coordinates.
- **Marker(PointF position)**: Creates a marker at the specified PointF position.
- **Marker(LatLng latLng)**: Creates a marker at the specified LatLng geographical coordinates.
```

--------------------------------

### LatLng Constructors

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1LatLng.html

Provides different ways to instantiate a LatLng object.

```APIDOC
## LatLng Constructors

### Description
These constructors allow you to create `LatLng` objects using various combinations of coordinates.

### Constructors

- **LatLng(PointF position)**: Creates a `LatLng` object from a `PointF` object.
- **LatLng(float lat, float lng)**: Creates a `LatLng` object with specified latitude and longitude.
- **LatLng(float lat, float lng, float alt)**: Creates a `LatLng` object with specified latitude, longitude, and altitude.
```

--------------------------------

### LatLng Constructors

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1LatLng-members.html

Provides different ways to instantiate a LatLng object.

```APIDOC
## LatLng()

### Description
Initializes a new instance of the LatLng class with default values.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```csharp
var latLng = new LatLng();
```

### Response
N/A
```

```APIDOC
## LatLng(PointF position)

### Description
Initializes a new instance of the LatLng class with a PointF object.

### Method
Constructor

### Endpoint
N/A

### Parameters
- **position** (PointF) - Description of the PointF parameter

### Request Example
```csharp
var point = new PointF(10.0f, 20.0f);
var latLng = new LatLng(point);
```

### Response
N/A
```

```APIDOC
## LatLng(float lat, float lng)

### Description
Initializes a new instance of the LatLng class with latitude and longitude values.

### Method
Constructor

### Endpoint
N/A

### Parameters
- **lat** (float) - The latitude value.
- **lng** (float) - The longitude value.

### Request Example
```csharp
var latLng = new LatLng(45.5f, -73.6f);
```

### Response
N/A
```

```APIDOC
## LatLng(float lat, float lng, float alt)

### Description
Initializes a new instance of the LatLng class with latitude, longitude, and altitude values.

### Method
Constructor

### Endpoint
N/A

### Parameters
- **lat** (float) - The latitude value.
- **lng** (float) - The longitude value.
- **alt** (float) - The altitude value.

### Request Example
```csharp
var latLng = new LatLng(45.5f, -73.6f, 100.0f);
```

### Response
N/A
```

--------------------------------

### Id Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Gets the unique identifier for the map instance.

```APIDOC
## Id Property

### Description
Gets the unique identifier for the map instance.

### Property Type
string
```

--------------------------------

### Zoom Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Gets or sets the current zoom level of the map.

```APIDOC
## Zoom

### Description
Gets or sets the current zoom level of the map.

### Property Type
float
```

--------------------------------

### ImageLayer Constructor

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ImageLayer.html

Initializes a new instance of the ImageLayer class with the specified URL and corner coordinates.

```APIDOC
## ImageLayer Constructor

### Description
Initializes a new instance of the ImageLayer class.

### Parameters
* **url** (string) - The URL of the image to display.
* **corner1** (PointF) - The first corner coordinate of the image overlay.
* **corner2** (PointF) - The second corner coordinate of the image overlay.
```

--------------------------------

### Marker Constructors

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Marker-members.html

Constructors for creating a new Marker instance.

```APIDOC
## Marker Constructors

### Marker(float x, float y)

Creates a new Marker at the specified pixel coordinates.

### Marker(PointF position)

Creates a new Marker at the specified PointF position.

### Marker(LatLng latLng)

Creates a new Marker at the specified LatLng coordinates.
```

--------------------------------

### MinZoom Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Gets or sets the minimum zoom level allowed for the map.

```APIDOC
## MinZoom Property

### Description
Gets or sets the minimum zoom level allowed for the map.

### Property Type
float?
```

--------------------------------

### ImageLayer Constructor

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ImageLayer-members.html

Constructs a new ImageLayer with the specified URL and corner coordinates.

```APIDOC
## ImageLayer Constructor

### Description
Initializes a new instance of the `ImageLayer` class.

### Parameters
- **url** (string) - The URL of the image to display.
- **corner1** (PointF) - The first corner of the image bounds.
- **corner2** (PointF) - The second corner of the image bounds.
```

--------------------------------

### MaxZoom Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Gets or sets the maximum zoom level allowed for the map.

```APIDOC
## MaxZoom Property

### Description
Gets or sets the maximum zoom level allowed for the map.

### Property Type
float?
```

--------------------------------

### MaxBounds Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map.html

Gets or sets the maximum geographical bounds that the map view is restricted to.

```APIDOC
## MaxBounds

### Description
When this option is set, the map restricts the view to the given geographical bounds, bouncing the user back if the user tries to pan outside the view.

### Property Type
`Tuple<LatLng, LatLng>`

### Access
`getset`
```

--------------------------------

### Map Constructor

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Initializes a new instance of the Map class, requiring an IJSRuntime for JavaScript interop.

```APIDOC
## Map Constructor

### Description
Initializes a new instance of the Map class.

### Method Signature
`Map(IJSRuntime jsRuntime)`

### Parameters
- **jsRuntime** (IJSRuntime) - The JavaScript runtime interface for Blazor interop.
```

--------------------------------

### Corner2 Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ImageLayer-members.html

Gets or sets the second corner of the image layer's bounds.

```APIDOC
## Corner2 Property

### Description
Represents the second corner of the image bounds for the `ImageLayer`.

### Type
PointF
```

--------------------------------

### Tooltip Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Tooltip.html

This section details the configurable properties of the Tooltip class, including content, direction, visibility, and appearance.

```APIDOC
## Tooltip Class Properties

### Content
* **Type**: string
* **Description**: The content to be displayed within the tooltip.
* **Get/Set**: Yes

### Direction
* **Type**: string
* **Default**: "auto"
* **Description**: Specifies the direction in which the tooltip should open. Possible values include 'right', 'left', 'top', 'bottom', 'center', and 'auto'. 'auto' dynamically adjusts the direction based on the tooltip's position.
* **Get/Set**: Yes

### IsPermanent
* **Type**: bool
* **Description**: Determines if the tooltip should be displayed permanently or only on mouseover.
* **Get/Set**: Yes

### IsSticky
* **Type**: bool
* **Description**: If true, the tooltip will follow the mouse cursor instead of remaining fixed at the feature's center.
* **Get/Set**: Yes

### Opacity
* **Type**: double
* **Default**: 0.9
* **Description**: Controls the opacity of the tooltip container.
* **Get/Set**: Yes

### Pane
* **Type**: string
* **Description**: Specifies the map pane where the tooltip will be added. Defaults to 'tooltipPane'.
* **Get/Set**: Yes

### Offset
* **Type**: Point
* **Default**: new Point(0, 7)
* **Description**: The offset applied to the tooltip's position. Useful for adjusting the anchor point.
* **Get/Set**: Yes

### ClassName
* **Type**: string
* **Default**: string.Empty
* **Description**: Allows assigning a custom CSS class name to the tooltip for styling purposes.
* **Get/Set**: Yes
```

--------------------------------

### MbTilesLayer Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1MbTilesLayer.html

This section details the properties available for the MbTilesLayer class, including UrlTemplate, MinimumZoom, MaximumZoom, Id, Pane, Attribution, Tooltip, and Popup.

```APIDOC
## MbTilesLayer Properties

### UrlTemplate
- **Type**: `string`
- **Access**: `get`, `set`
- **Description**: Instantiates a tile layer object given a URL template.

### MinimumZoom
- **Type**: `float`
- **Access**: `get`, `set`
- **Description**: The minimum zoom level down to which this layer will be displayed (inclusive).

### MaximumZoom
- **Type**: `float`
- **Default**: `18`
- **Access**: `get`, `set`
- **Description**: The maximum zoom level up to which this layer will be displayed (inclusive).

### Id
- **Type**: `string`
- **Access**: `get`
- **Description**: Unique identifier used by the interoperability service on the client side to identify layers.

### Pane
- **Type**: `virtual string`
- **Default**: `"overlayPane"`
- **Access**: `get`, `set`
- **Description**: By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default.

### Attribution
- **Type**: `string`
- **Access**: `get`, `set`
- **Description**: String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.

### Tooltip
- **Type**: `Tooltip`
- **Access**: `get`, `set`
- **Description**: The tooltip assigned to this marker.

### Popup
- **Type**: `Popup`
- **Access**: `get`, `set`
- **Description**: The popup shown when the marker is clicked.
```

--------------------------------

### Tooltip Class Members

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Tooltip-members.html

This section details the properties and methods available for the Tooltip class.

```APIDOC
## Tooltip Class Members

### Properties

- **Attribution** (BlazorLeaflet.Models.Layer)
- **ClassName** (BlazorLeaflet.Models.DivOverlay)
- **Content** (BlazorLeaflet.Models.Tooltip)
- **Direction** (BlazorLeaflet.Models.Tooltip)
- **Id** (BlazorLeaflet.Models.Layer)
- **IsPermanent** (BlazorLeaflet.Models.Tooltip)
- **IsSticky** (BlazorLeaflet.Models.Tooltip)
- **Offset** (BlazorLeaflet.Models.Tooltip)
- **Opacity** (BlazorLeaflet.Models.Tooltip)
- **Pane** (BlazorLeaflet.Models.Tooltip)
- **Popup** (BlazorLeaflet.Models.Layer)
- **Tooltip** (BlazorLeaflet.Models.Layer)

### Methods

- **EventHandler**(Layer sender, Event e) (defined in BlazorLeaflet.Models.Layer)
- **Layer**() (defined in BlazorLeaflet.Models.Layer)
- **NotifyAdd**(Event eventArgs) (defined in BlazorLeaflet.Models.Layer)
- **NotifyPopupClose**(PopupEvent eventArgs) (defined in BlazorLeaflet.Models.Layer)
- **NotifyPopupOpen**(PopupEvent eventArgs) (defined in BlazorLeaflet.Models.Layer)
- **NotifyRemove**(Event eventArgs) (defined in BlazorLeaflet.Models.Layer)
- **NotifyTooltipClose**(TooltipEvent eventArgs) (defined in BlazorLeaflet.Models.Layer)
- **NotifyTooltipOpen**(TooltipEvent eventArgs) (defined in BlazorLeaflet.Models.Layer)
- **OnAdd** (defined in BlazorLeaflet.Models.Layer)
- **OnPopupClose** (defined in BlazorLeaflet.Models.Layer)
- **OnPopupOpen** (defined in BlazorLeaflet.Models.Layer)
- **OnRemove** (defined in BlazorLeaflet.Models.Layer)
- **OnTooltipClose** (defined in BlazorLeaflet.Models.Layer)
- **OnTooltipOpen** (defined in BlazorLeaflet.Models.Layer)
- **PopupEventHandler**(Layer sender, PopupEvent e) (defined in BlazorLeaflet.Models.Layer)
- **TooltipEventHandler**(Layer sender, TooltipEvent e) (defined in BlazorLeaflet.Models.Layer)
```

--------------------------------

### MinZoom Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map.html

Gets or sets the minimum zoom level allowed for the map. If not set, it defaults to the lowest minZoom of any GridLayer or TileLayer.

```APIDOC
## MinZoom

### Description
Minimum zoom level of the map. If not specified and at least one GridLayer or TileLayer is in the map, the lowest of their minZoom options will be used instead.

### Property Type
`float?`

### Access
`getset`
```

--------------------------------

### MaxZoom Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map.html

Gets or sets the maximum zoom level allowed for the map. If not set, it defaults to the highest maxZoom of any GridLayer or TileLayer.

```APIDOC
## MaxZoom

### Description
Maximum zoom level of the map. If not specified and at least one GridLayer or TileLayer is in the map, the highest of their maxZoom options will be used instead.

### Property Type
`float?`

### Access
`getset`
```

--------------------------------

### OnKeyUp Event

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Event handler for key up events on the map.

```APIDOC
## OnKeyUp Event

### Description
Event handler for key up events on the map.

### Event Type
EventHandler<Event>
```

--------------------------------

### Event Class Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Events_1_1Event.html

The Event class contains a 'Type' property which is a string representing the type of the event. This property is accessible for both getting and setting its value.

```APIDOC
## Event Class

### Description
Represents a base event class for BlazorLeaflet. It contains properties common to all events.

### Properties
#### Type
- **Type** (string) - The type of the event. [get, set]
```

--------------------------------

### Popup Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Popup.html

This section details the configurable properties of the Popup class, allowing customization of its appearance, behavior, and content.

```APIDOC
## Popup Properties

### MaximumWidth
- **Type**: `int`
- **Default**: `300`
- **Description**: Maximum width of the popup in pixels.

### MinimumWidth
- **Type**: `int`
- **Default**: `50`
- **Description**: Minimum width of the popup in pixels.

### MaximumHeight
- **Type**: `int?`
- **Description**: If set, creates a scrollable container of the given height inside a popup if its content exceeds it.

### AutoPanEnabled
- **Type**: `bool`
- **Default**: `true`
- **Description**: Set to `false` to disable the map's automatic panning animation to fit the opened popup.

### AutoPanPaddingTopLeft
- **Type**: `Point?`
- **Description**: Margin between the popup and the top-left corner of the map view after autopanning.

### AutoPanPaddingBottomLeft
- **Type**: `Point?`
- **Description**: Margin between the popup and the bottom-right corner of the map view after autopanning.

### AutoPanPadding
- **Type**: `Point`
- **Default**: `new Point(5, 5)`
- **Description**: Equivalent of setting both `AutoPanPaddingTopLeft` and `AutoPanPaddingBottomLeft` to the same value.

### KeepInView
- **Type**: `bool`
- **Description**: Set to `true` to prevent users from panning the popup off the screen while it is open.

### ShowCloseButton
- **Type**: `bool`
- **Default**: `true`
- **Description**: Controls the presence of a close button in the popup.

### AutoClose
- **Type**: `bool`
- **Default**: `true`
- **Description**: Set to `false` to override the default behavior of the popup closing when another popup is opened.

### CloseOnEscapeKey
- **Type**: `bool`
- **Default**: `true`
- **Description**: Set to `false` to override the default behavior of the ESC key for closing the popup.

### Content
- **Type**: `string`
- **Description**: The content of the popup.

### Offset
- **Type**: `Point`
- **Default**: `new Point(0, 7)`
- **Description**: The offset of the popup position. Useful to control the anchor of the popup when opening it on some overlays.

### ClassName
- **Type**: `string`
- **Default**: `string.Empty`
- **Description**: A custom CSS class name to assign to the popup.

### Pane
- **Type**: `string`
- **Default**: `"popupPane"`
- **Description**: Map pane where the popup will be added.
```

--------------------------------

### OnInitialized Event

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Event handler that is invoked after the component has been initialized.

```APIDOC
## OnInitialized Event

### Description
Event handler that is invoked after the component has been initialized.

### Event Type
EventCallback
```

--------------------------------

### Path Events

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Path-members.html

Event handlers for the Path class and its inherited classes.

```APIDOC
## Path Events

### Description
Event handlers that can be attached to Path objects to respond to user interactions and map events.

### Event Handlers
- **EventHandler**(Layer sender, Event e) - Handles general layer events.
- **MouseEventHandler**(InteractiveLayer sender, MouseEvent e) - Handles mouse events on interactive layers.
- **NotifyAdd**(Event eventArgs) - Called when the layer is added to the map.
- **NotifyClick**(MouseEvent eventArgs) - Called when the layer is clicked.
- **NotifyContextMenu**(MouseEvent eventArgs) - Called when the context menu is triggered on the layer.
- **NotifyDblClick**(MouseEvent eventArgs) - Called when the layer is double-clicked.
- **NotifyMouseDown**(MouseEvent eventArgs) - Called when the mouse button is pressed down on the layer.
- **NotifyMouseOut**(MouseEvent eventArgs) - Called when the mouse leaves the layer.
- **NotifyMouseOver**(MouseEvent eventArgs) - Called when the mouse enters the layer.
- **NotifyMouseUp**(MouseEvent eventArgs) - Called when the mouse button is released on the layer.
- **NotifyPopupClose**(PopupEvent eventArgs) - Called when a popup is closed.
- **NotifyPopupOpen**(PopupEvent eventArgs) - Called when a popup is opened.
- **NotifyRemove**(Event eventArgs) - Called when the layer is removed from the map.
- **NotifyTooltipClose**(TooltipEvent eventArgs) - Called when a tooltip is closed.
- **NotifyTooltipOpen**(TooltipEvent eventArgs) - Called when a tooltip is opened.

### Overridable Event Methods
- **OnAdd** - Override to provide custom logic when the layer is added.
- **OnClick** - Override to provide custom logic for click events.
- **OnContextMenu** - Override to provide custom logic for context menu events.
- **OnDblClick** - Override to provide custom logic for double-click events.
- **OnMouseDown** - Override to provide custom logic for mouse down events.
- **OnMouseOut** - Override to provide custom logic for mouse out events.
- **OnMouseOver** - Override to provide custom logic for mouse over events.
- **OnMouseUp** - Override to provide custom logic for mouse up events.
- **OnPopupClose** - Override to provide custom logic when a popup is closed.
- **OnPopupOpen** - Override to provide custom logic when a popup is opened.
- **OnRemove** - Override to provide custom logic when the layer is removed.
- **OnTooltipClose** - Override to provide custom logic when a tooltip is closed.
- **OnTooltipOpen** - Override to provide custom logic when a tooltip is opened.
```

--------------------------------

### Subdomains

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1TileLayer.html

Specifies the subdomains for the tile service. Defaults to an array containing 'abc'.

```APIDOC
## Property: Subdomains

### Description
Subdomains of the tile service.

### Type
string []

### Default Value
new string[] { "abc" }

### Access
getset
```

--------------------------------

### ToPointF Method

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1LatLng-members.html

Converts the LatLng object to a PointF object.

```APIDOC
## ToPointF()

### Description
Converts the current LatLng object to a PointF object.

### Method
Instance Method

### Endpoint
N/A

### Parameters
None

### Request Example
```csharp
var latLng = new LatLng(45.5f, -73.6f);
PointF point = latLng.ToPointF();
```

### Response
- **PointF**: A PointF object representing the latitude and longitude.
```

--------------------------------

### Path Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Path.html

These properties allow customization of the path's appearance, such as its stroke color, width, opacity, and fill properties.

```APIDOC
## Property Documentation

## ◆ DrawStroke
| bool BlazorLeaflet.Models.Path.DrawStroke = true  
---
getset
Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. 

## ◆ Fill
| bool BlazorLeaflet.Models.Path.Fill  
---
getset
Whether to fill the path with color. Set it to false to disable filling on polygons or circles. 

## ◆ FillColor
| Color BlazorLeaflet.Models.Path.FillColor  
---
getset
Fill color. Defaults to the value of the color option 

## ◆ FillOpacity
| double BlazorLeaflet.Models.Path.FillOpacity = 0.2  
---
getset
Fill opacity. 

## ◆ FillRule
| string BlazorLeaflet.Models.Path.FillRule = "evenodd"  
---
getset
A string that defines how the inside of a shapeis determined. 

## ◆ LineCap
| string BlazorLeaflet.Models.Path.LineCap = "round"  
---
getset
A string that defines shape to be used at the endof the stroke. 

## ◆ LineJoin
| string BlazorLeaflet.Models.Path.LineJoin = "round"  
---
getset
A string that defines shape to be used at the cornersof the stroke. 

## ◆ StrokeColor
| Color BlazorLeaflet.Models.Path.StrokeColor = Color.FromArgb(0x33, 0x88, 0xFF)  
---
getset
Stroke color. 

## ◆ StrokeDashArray
| string BlazorLeaflet.Models.Path.StrokeDashArray  
---
getset
A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers. 

## ◆ StrokeDashOffset
| string BlazorLeaflet.Models.Path.StrokeDashOffset  
---
getset
A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers. 

## ◆ StrokeOpacity
| double BlazorLeaflet.Models.Path.StrokeOpacity = 1.0  
---
getset
Stroke opacity. 

## ◆ StrokeWidth
| int BlazorLeaflet.Models.Path.StrokeWidth = 3  
---
getset
Stroke width. 
```

--------------------------------

### RaiseOnInitialized Method

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Raises the OnInitialized event.

```APIDOC
## RaiseOnInitialized

### Description
This method is used internally to raise the OnInitialized event, typically called after the map has been fully set up.

### Method Signature
`RaiseOnInitialized()`
```

--------------------------------

### UninitializedMapException()

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Exceptions_1_1UninitializedMapException-members.html

Initializes a new instance of the UninitializedMapException class with a default error message.

```APIDOC
## UninitializedMapException()

### Description
Initializes a new instance of the UninitializedMapException class with a default error message.

### Method
Constructor

### Parameters
None

### Response
None
```

--------------------------------

### UrlTemplate

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1TileLayer.html

The URL template used to fetch tiles for this layer. This is essential for instantiating a tile layer.

```APIDOC
## Property: UrlTemplate

### Description
Instantiates a tile layer object given a URL template.

### Type
string

### Access
getset
```

--------------------------------

### Marker Event Handlers

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Marker-members.html

Event handlers for marker interactions.

```APIDOC
## Marker Event Handlers

### DragEndEventHandler(Marker sender, DragEndEvent e)

Delegate for handling the DragEnd event of a marker.

### DragEventHandler(Marker sender, DragEvent e)

Delegate for handling the Drag event of a marker.

### EventHandlerMarker(Marker sender, Event e)

Delegate for handling generic events on a marker.
```

--------------------------------

### ImageLayer Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ImageLayer.html

Properties available for configuring and managing ImageLayer instances.

```APIDOC
## ImageLayer Properties

### Opacity
* **Type**: float
* **Default**: 1.0f
* **Description**: The opacity of the image overlay.

### Alt
* **Type**: string
* **Default**: string.Empty
* **Description**: Text for the alt attribute of the image (useful for accessibility).

### CrossOrigin
* **Type**: string
* **Description**: Whether the crossOrigin attribute will be added to the image. If a String is provided, the image will have its crossOrigin attribute set to the String provided. This is needed if you want to access image pixel data. Refer to CORS Settings for valid String values.

### ErrorOverlayUrl
* **Type**: string
* **Default**: string.Empty
* **Description**: URL to the overlay image to show in place of the overlay that failed to load.

### zIndex
* **Type**: int
* **Default**: 1
* **Description**: The explicit zIndex of the overlay layer.

### ClassName
* **Type**: string
* **Default**: string.Empty
* **Description**: A custom class name to assign to the image. Empty by default.

### Url
* **Type**: string
* **Description**: Image url.

### Corner1
* **Type**: PointF
* **Description**: The first corner coordinate of the image overlay.

### Corner2
* **Type**: PointF
* **Description**: The second corner coordinate of the image overlay.

### IsInteractive
* **Type**: bool
* **Default**: true
* **Description**: If false, the layer will not emit mouse events and will act as a part of the underlying map. (events currently not implemented in BlazorLeaflet).

### IsBubblingMouseEvents
* **Type**: virtual bool
* **Default**: true
* **Description**: When true, a mouse event on this layer will trigger the same event on the map (unless L.DomEvent.stopPropagation is used).

### Id
* **Type**: string
* **Description**: Unique identifier used by the interoperability service on the client side to identify layers.

### Pane
* **Type**: virtual string
* **Default**: "overlayPane"
* **Description**: By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default.

### Attribution
* **Type**: string
* **Description**: String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.

### Tooltip
* **Type**: Tooltip
* **Description**: The tooltip assigned to this marker.

### Popup
* **Type**: Popup
* **Description**: The popup shown when the marker is clicked.
```

--------------------------------

### InteractiveLayer Methods

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1InteractiveLayer-members.html

Methods available for the InteractiveLayer class.

```APIDOC
## Methods

### MouseEventHandler
- **Signature**: `MouseEventHandler(InteractiveLayer sender, MouseEvent e)`
- **Description**: Handles mouse events for interactive layers.

### NotifyClick
- **Signature**: `NotifyClick(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a click event occurs on the layer.

### NotifyContextMenu
- **Signature**: `NotifyContextMenu(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a context menu event occurs on the layer.

### NotifyDblClick
- **Signature**: `NotifyDblClick(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a double-click event occurs on the layer.

### NotifyMouseDown
- **Signature**: `NotifyMouseDown(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a mouse down event occurs on the layer.

### NotifyMouseOut
- **Signature**: `NotifyMouseOut(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a mouse out event occurs on the layer.

### NotifyMouseOver
- **Signature**: `NotifyMouseOver(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a mouse over event occurs on the layer.

### NotifyMouseUp
- **Signature**: `NotifyMouseUp(MouseEvent eventArgs)`
- **Description**: Notifies listeners when a mouse up event occurs on the layer.

### OnClick
- **Description**: Event handler for click events.

### OnContextMenu
- **Description**: Event handler for context menu events.

### OnDblClick
- **Description**: Event handler for double-click events.

### OnMouseDown
- **Description**: Event handler for mouse down events.

### OnMouseOut
- **Description**: Event handler for mouse out events.

### OnMouseOver
- **Description**: Event handler for mouse over events.

### OnMouseUp
- **Description**: Event handler for mouse up events.
```

--------------------------------

### ToPointF Method

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1LatLng.html

Converts a LatLng object to a PointF object.

```APIDOC
## ToPointF Method

### Description
This method converts the current `LatLng` object into a `PointF` object, which might be useful for certain rendering or calculation purposes.

### Method Signature

- **PointF ToPointF()**: Returns a `PointF` representation of the `LatLng` object.
```

--------------------------------

### UninitializedMapException(string message)

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Exceptions_1_1UninitializedMapException-members.html

Initializes a new instance of the UninitializedMapException class with a specified error message.

```APIDOC
## UninitializedMapException(string message)

### Description
Initializes a new instance of the UninitializedMapException class with a specified error message.

### Method
Constructor

### Parameters
#### Path Parameters
- **message** (string) - Required - The error message that explains the reason for this exception.

### Response
None
```

--------------------------------

### ShapefileLayer Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ShapefileLayer.html

This section details the properties available for the ShapefileLayer class, including UrlTemplate, Id, Pane, Attribution, Tooltip, and Popup.

```APIDOC
## Properties

### UrlTemplate
- **Type**: `string`
- **Access**: `get, set`
- **Description**: Instantiates a tile layer object given a URL template.

### Id
- **Type**: `string`
- **Access**: `get`
- **Description**: Unique identifier used by the interoperability service on the client side to identify layers.

### Pane
- **Type**: `string`
- **Access**: `get, set`
- **Default**: `"overlayPane"`
- **Description**: By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default.

### Attribution
- **Type**: `string`
- **Access**: `get, set`
- **Description**: String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.

### Tooltip
- **Type**: `Tooltip`
- **Access**: `get, set`
- **Description**: The tooltip assigned to this marker.

### Popup
- **Type**: `Popup`
- **Access**: `get, set`
- **Description**: The popup shown when the marker is clicked.
```

--------------------------------

### DivOverlay Constructors

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1DivOverlay-members.html

Constructors for the DivOverlay class.

```APIDOC
## Constructors

### DivOverlay()

- **Description**: Default constructor for DivOverlay.
- **Access**: (Not specified in source)
```

--------------------------------

### NotifyKeyUp

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Notifies the map of a key up event.

```APIDOC
## NotifyKeyUp

### Description
Notifies the map of a key up event.

### Method Signature
`NotifyKeyUp(Event eventArgs)`

### Parameters
- **eventArgs** (Event) - The key event arguments.
```

--------------------------------

### ImageLayer Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1ImageLayer.html

This section details the configurable properties of the ImageLayer class, allowing for customization of image overlays.

```APIDOC
## ImageLayer Properties

This class provides several properties to configure an image overlay:

### Alt
- **Type**: string
- **Default**: string.Empty
- **Description**: Text for the alt attribute of the image (useful for accessibility).

### ClassName
- **Type**: string
- **Default**: string.Empty
- **Description**: A custom class name to assign to the image. Empty by default.

### CrossOrigin
- **Type**: string
- **Description**: Whether the crossOrigin attribute will be added to the image. If a String is provided, the image will have its crossOrigin attribute set to the String provided. This is needed if you want to access image pixel data. Refer to CORS Settings for valid String values.

### ErrorOverlayUrl
- **Type**: string
- **Default**: string.Empty
- **Description**: URL to the overlay image to show in place of the overlay that failed to load.

### Opacity
- **Type**: float
- **Default**: 1.0f
- **Description**: The opacity of the image overlay.

### Url
- **Type**: string
- **Description**: Image url.

### zIndex
- **Type**: int
- **Default**: 1
- **Description**: The explicit zIndex of the overlay layer.
```

--------------------------------

### Marker Events

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Marker-members.html

Events that can be handled by a Marker.

```APIDOC
## Marker Events

### Description
These are events that can be triggered by a Marker.

### Events
- **OnDrag**
- **OnDragEnd**
- **OnDragStart**
- **OnMove**
- **OnMoveEnd**
- **OnMoveStart**
```

--------------------------------

### AddLayer

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map.html

Adds a specified layer to the map. Throws an exception if the layer is null or if the map has not been initialized.

```APIDOC
## AddLayer()

### Description
Adds a layer to the map.

### Method Signature
`void AddLayer(Layer _layer_)`

### Parameters
*   **_layer_** (Layer) - The layer to be added.

### Exceptions
*   `System.ArgumentNullException`: Throws when the layer is null.
*   `UninitializedMapException`: Throws when the map has not been yet initialized.
```

--------------------------------

### OnMouseUp Event

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Event handler for mouse up events on the map.

```APIDOC
## OnMouseUp Event

### Description
Event handler for mouse up events on the map.

### Event Type
EventHandler<MouseEvent>
```

--------------------------------

### OnLoad Event

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Event handler for map load events.

```APIDOC
## OnLoad Event

### Description
Event handler for map load events.

### Event Type
EventHandler<Event>
```

--------------------------------

### NotifyLoad

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Notifies the map of a load event.

```APIDOC
## NotifyLoad

### Description
Notifies the map of a load event.

### Method Signature
`NotifyLoad(Event e)`

### Parameters
- **e** (Event) - The load event arguments.
```

--------------------------------

### BuildRenderTree

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1LeafletMap-members.html

Builds the rendering tree for the LeafletMap component. This is a protected method used internally by Blazor.

```APIDOC
## BuildRenderTree

### Description
Builds the rendering tree for the LeafletMap component.

### Method
protected

### Signature
BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder)
```

--------------------------------

### StringHelper.GetRandomString

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Utils_1_1StringHelper-members.html

Generates a random string of a specified length. This is a static inline method.

```APIDOC
## GetRandomString(int length)

### Description
Generates a random string of the specified length.

### Method Signature
static BlazorLeaflet.Utils.StringHelper.GetRandomString(int length)
```

--------------------------------

### Tooltip Properties

Source: https://mehigh17.github.io/BlazorLeaflet/functions.html

Properties specific to BlazorLeaflet Tooltip objects.

```APIDOC
## Content

### Description
Gets or sets the content of the tooltip.

### Type
BlazorLeaflet.Models.Tooltip

### Parameters
None

### Response
Tooltip content
```

```APIDOC
## Direction

### Description
Gets or sets the direction of the tooltip relative to the target.

### Type
BlazorLeaflet.Models.Tooltip

### Parameters
None

### Response
Tooltip direction
```

```APIDOC
## IsPermanent

### Description
Gets or sets a value indicating whether the tooltip is permanently visible.

### Type
BlazorLeaflet.Models.Tooltip

### Parameters
None

### Response
Boolean indicating permanent visibility
```

```APIDOC
## IsSticky

### Description
Gets or sets a value indicating whether the tooltip remains fixed after the mouse leaves.

### Type
BlazorLeaflet.Models.Tooltip

### Parameters
None

### Response
Boolean indicating sticky behavior
```

```APIDOC
## Opacity

### Description
Gets or sets the opacity of the tooltip.

### Type
BlazorLeaflet.Models.Tooltip

### Parameters
None

### Response
Opacity value
```

--------------------------------

### OnKeyPress Event

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Event handler for key press events on the map.

```APIDOC
## OnKeyPress Event

### Description
Event handler for key press events on the map.

### Event Type
EventHandler<Event>
```

--------------------------------

### ClassName Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1DivOverlay.html

Allows setting a custom CSS class name for the popup associated with the DivOverlay.

```APIDOC
## Property Documentation

## ◆ ClassName
| virtual string BlazorLeaflet.Models.DivOverlay.ClassName = string.Empty
---
getset
A custom CSS class name to assign to the popup.
```

--------------------------------

### Popup Events

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Popup-members.html

Events that can be handled by the Popup class.

```APIDOC
## Popup Events

### Description
Events that can be subscribed to for the Popup class.

### Event Handlers
- **EventHandler**(Layer sender, Event e) (defined in BlazorLeaflet.Models.Layer) - Inherited event handler.
- **NotifyAdd**(Event eventArgs) (defined in BlazorLeaflet.Models.Layer) - Inherited notification for when the layer is added to the map.
- **NotifyPopupClose**(PopupEvent eventArgs) (defined in BlazorLeaflet.Models.Layer) - Inherited notification for when a popup associated with the layer is closed.
- **NotifyPopupOpen**(PopupEvent eventArgs) (defined in BlazorLeaflet.Models.Layer) - Inherited notification for when a popup associated with the layer is opened.
- **NotifyRemove**(Event eventArgs) (defined in BlazorLeaflet.Models.Layer) - Inherited notification for when the layer is removed from the map.
- **NotifyTooltipClose**(TooltipEvent eventArgs) (defined in BlazorLeaflet.Models.Layer) - Inherited notification for when a tooltip associated with the layer is closed.
- **NotifyTooltipOpen**(TooltipEvent eventArgs) (defined in BlazorLeaflet.Models.Layer) - Inherited notification for when a tooltip associated with the layer is opened.
- **OnAdd** (defined in BlazorLeaflet.Models.Layer) - Inherited method called when the layer is added to the map.
- **OnPopupClose** (defined in BlazorLeaflet.Models.Layer) - Inherited method called when a popup associated with the layer is closed.
- **OnPopupOpen** (defined in BlazorLeaflet.Models.Layer) - Inherited method called when a popup associated with the layer is opened.
- **OnRemove** (defined in BlazorLeaflet.Models.Layer) - Inherited method called when the layer is removed from the map.
- **OnTooltipClose** (defined in BlazorLeaflet.Models.Layer) - Inherited method called when a tooltip associated with the layer is closed.
- **OnTooltipOpen** (defined in BlazorLeaflet.Models.Layer) - Inherited method called when a tooltip associated with the layer is opened.
- **PopupEventHandler**(Layer sender, PopupEvent e) (defined in BlazorLeaflet.Models.Layer) - Inherited event handler for popup events.
- **TooltipEventHandler**(Layer sender, TooltipEvent e) (defined in BlazorLeaflet.Models.Layer) - Inherited event handler for tooltip events.
```

--------------------------------

### NotifyMouseUp

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Notifies the map of a mouse up event.

```APIDOC
## NotifyMouseUp

### Description
Notifies the map of a mouse up event.

### Method Signature
`NotifyMouseUp(MouseEvent eventArgs)`

### Parameters
- **eventArgs** (MouseEvent) - The mouse event arguments.
```

--------------------------------

### Marker Notification Methods

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Marker-members.html

Internal methods for handling various events and lifecycle changes.

```APIDOC
## Marker Notification Methods

### NotifyDrag(DragEvent eventArgs)

Handles the drag event for the marker.

### NotifyDragEnd(DragEndEvent eventArgs)

Handles the drag end event for the marker.

### NotifyDragStart(Event eventArgs)

Handles the drag start event for the marker.

### NotifyMove(DragEvent eventArgs)

Handles the move event for the marker.

### NotifyMoveEnd(Event eventArgs)

Handles the move end event for the marker.

### NotifyMoveStart(Event eventArgs)

Handles the move start event for the marker.
```

--------------------------------

### ResizeEvent Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Events_1_1ResizeEvent-members.html

Details about the properties available on the ResizeEvent class.

```APIDOC
## ResizeEvent Members

### Properties

- **NewSize** (BlazorLeaflet.Models.Events.ResizeEvent)
  - Description: Represents the new size of the map after a resize event.

- **OldSize** (BlazorLeaflet.Models.Events.ResizeEvent)
  - Description: Represents the old size of the map before a resize event.

- **Type** (BlazorLeaflet.Models.Event)
  - Description: Inherited from BlazorLeaflet.Models.Event, this property represents the type of the event.
```

--------------------------------

### GridLayer Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1GridLayer-members.html

This section details the properties available for the GridLayer class.

```APIDOC
## Properties

### Opacity

- **Type**: (defined in BlazorLeaflet.Models.GridLayer)
- **Description**: Represents the opacity of the grid layer.

### Size

- **Type**: (defined in BlazorLeaflet.Models.GridLayer)
- **Description**: Represents the size of the grid layer.

### UpdateInterval

- **Type**: (defined in BlazorLeaflet.Models.GridLayer)
- **Description**: Specifies the interval for updating the grid layer.

### UpdateWhenZooming

- **Type**: (defined in BlazorLeaflet.Models.GridLayer)
- **Description**: Determines if the grid layer should update when zooming.

### ZIndex

- **Type**: (defined in BlazorLeaflet.Models.GridLayer)
- **Description**: Represents the z-index of the grid layer.
```

--------------------------------

### Popup Properties

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1Popup-members.html

Properties available for the Popup class.

```APIDOC
## Popup Properties

### Description
Properties that can be set on a Popup object.

### Properties
- **Attribution** (BlazorLeaflet.Models.Layer) - Inherited from Layer.
- **AutoClose** (BlazorLeaflet.Models.Popup) - Determines if the popup closes automatically when the user clicks the map.
- **AutoPanEnabled** (BlazorLeaflet.Models.Popup) - Enables or disables the automatic panning of the map when the popup opens.
- **AutoPanPadding** (BlazorLeaflet.Models.Popup) - The padding in pixels to enforce on the map view when panning.
- **AutoPanPaddingBottomLeft** (BlazorLeaflet.Models.Popup) - Specific padding for the bottom-left corner.
- **AutoPanPaddingTopLeft** (BlazorLeaflet.Models.Popup) - Specific padding for the top-left corner.
- **ClassName** (BlazorLeaflet.Models.DivOverlay) - Inherited from DivOverlay. A custom CSS class name to assign to the popup.
- **CloseOnEscapeKey** (BlazorLeaflet.Models.Popup) - Determines if the popup closes when the escape key is pressed.
- **Content** (BlazorLeaflet.Models.Popup) - The content of the popup, which can be HTML or a string.
- **KeepInView** (BlazorLeaflet.Models.Popup) - Ensures the popup remains within the map view when opened.
- **MaximumHeight** (BlazorLeaflet.Models.Popup) - The maximum height of the popup content.
- **MaximumWidth** (BlazorLeaflet.Models.Popup) - The maximum width of the popup content.
- **MinimumWidth** (BlazorLeaflet.Models.Popup) - The minimum width of the popup content.
- **Offset** (BlazorLeaflet.Models.DivOverlay) - Inherited from DivOverlay. The offset of the popup.
- **Pane** (BlazorLeaflet.Models.Popup) - The map pane that the popup will be added to.
- **ShowCloseButton** (BlazorLeaflet.Models.Popup) - Determines if the close button is displayed on the popup.
```

--------------------------------

### Pane Property

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Models_1_1DivOverlay.html

Specifies the map pane where the popup will be added. Defaults to 'popupPane'.

```APIDOC
## Property Documentation

## ◆ Pane
| override string BlazorLeaflet.Models.DivOverlay.Pane = "popupPane"
---
getset
Map pane where the popup will be added.
```

--------------------------------

### OnContextMenu Event

Source: https://mehigh17.github.io/BlazorLeaflet/classBlazorLeaflet_1_1Map-members.html

Event handler for context menu events on the map.

```APIDOC
## OnContextMenu Event

### Description
Event handler for context menu events on the map.

### Event Type
EventHandler<MouseEvent>
```
Tokens:
Raw