Skip to content

Commit 85e678d

Browse files
1022922: Updated ReadMe file of the project.
1 parent 5f8d730 commit 85e678d

1 file changed

Lines changed: 43 additions & 9 deletions

File tree

README.md

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,52 @@
11
# Adding Annotations to Blazor Maps
22

3-
This sample explains about how to add annotations to a Syncfusion Blazor Maps in a Blazor WebAssembly app.
3+
This project demonstrates how to add and configure annotations in **Syncfusion Blazor Maps** within a **Blazor WebAssembly** application. It is intended as a focused sample to help developers understand how annotations can be overlaid on map components to display custom content such as text, shapes, or UI elements at specific geographic locations.
44

5-
**Examples**: https://blazor.syncfusion.com/demos/maps/annotation?theme=bootstrap5
5+
The sample is aligned with Syncfusion’s Blazor Maps component and shows practical usage patterns that can be adapted to real-world applications requiring map-based visualization with additional contextual information.
66

7-
**Documentation**: https://blazor.syncfusion.com/documentation/maps/annotations
7+
## Project Overview
8+
9+
Blazor Maps supports rich data visualization by allowing developers to render maps with layers, markers, and annotations. This sample specifically highlights the annotation feature, which enables placing custom content on the map surface. The example illustrates how annotations integrate with the map lifecycle in a Blazor WebAssembly environment using Syncfusion UI components.
10+
11+
The project is designed to be simple, easy to run, and suitable for learning or reference purposes when working with Syncfusion Blazor Maps.
12+
13+
## Features
14+
15+
- Demonstrates adding annotations to Syncfusion Blazor Maps
16+
- Uses Blazor WebAssembly as the hosting model
17+
- Shows interaction between map layers and annotation elements
18+
- Clean and minimal setup focused on annotations only
819

920
## Prerequisites
1021

11-
* Visual Studio 2022
22+
To run this project, ensure the following software is installed:
23+
24+
- Visual Studio 2022
25+
- .NET SDK compatible with Blazor WebAssembly
26+
- Basic familiarity with Blazor and Razor components
27+
28+
## How to Run the Project
29+
30+
1. Clone or download this repository to your local machine.
31+
2. Open the solution file using **Visual Studio 2022**.
32+
3. Restore the required NuGet packages by rebuilding the solution.
33+
4. Run the project using the built-in debugger or IIS Express.
34+
5. The Blazor WebAssembly app will launch in your default browser.
35+
36+
## Usage
37+
38+
Once the application is running, the map component loads with predefined annotations. These annotations are positioned based on configuration defined in the Blazor components and demonstrate how custom content can be attached to specific map coordinates.
39+
40+
Developers can modify the annotation settings to experiment with different placement, styling, or content types.
41+
42+
## Examples and Documentation
43+
44+
- **Live Example**:
45+
https://blazor.syncfusion.com/demos/maps/annotation?theme=bootstrap5
46+
47+
- **Documentation**:
48+
https://blazor.syncfusion.com/documentation/maps/annotations
1249

13-
## How to run the project
50+
## Support and Resources
1451

15-
* Checkout this project to a location in your disk.
16-
* Open the solution file using the Visual Studio 2022.
17-
* Restore the NuGet packages by rebuilding the solution.
18-
* Run the project.
52+
For additional help or advanced scenarios, refer to the official Syncfusion Blazor documentation and demos. These resources provide deeper insights into configuration options, performance considerations, and advanced map customization.

0 commit comments

Comments
 (0)