AzureMapsControl.Components 1.16.1

dotnet add package AzureMapsControl.Components --version 1.16.1                
NuGet\Install-Package AzureMapsControl.Components -Version 1.16.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AzureMapsControl.Components" Version="1.16.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AzureMapsControl.Components --version 1.16.1                
#r "nuget: AzureMapsControl.Components, 1.16.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AzureMapsControl.Components as a Cake Addin
#addin nuget:?package=AzureMapsControl.Components&version=1.16.1

// Install AzureMapsControl.Components as a Cake Tool
#tool nuget:?package=AzureMapsControl.Components&version=1.16.1                

Nuget Nuget (with prereleases) Build Unit Test release codecov Slack

This library allows you to use Azure Maps inside your razor application.

Custom Azure Map

Install the Nuget Package

This library is available on Nuget as AzureMapsControl.Components.

Setup

Add the css and scripts

You will need to add the atlas script and css files as well as the script generated by the library on your application.

<link href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.css" rel="stylesheet" />
<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.js"></script>
<script src="_content/AzureMapsControl.Components/azure-maps-control.js"></script>

Or use the minimized version :

<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.js"></script>
<script src="_content/AzureMapsControl.Components/azure-maps-control.min.js"></script>

Register the Components

You will need to pass the authentication information of your AzureMaps instance to the library. SubscriptionKey, Aad and Anonymous authentication are supported. You will need to call the AddAzureMapsControl method on your services.

You can authenticate using a subscription key :

    // This method gets called by the runtime. Use this method to add services to the container.
    // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddRazorPages();
        services.AddServerSideBlazor();
        
        services.AddAzureMapsControl(configuration => configuration.SubscriptionKey = "Your Subscription Key");
    }

Or using Azure Active Directory:

public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor(options => options.DetailedErrors = true);

            services.AddAzureMapsControl(configuration => {
                configuration.AadAppId = "Your Aad App Id";
                configuration.AadTenant = "Your Aad Tenant";
                configuration.ClientId = "Your Client Id";
            });
        }

The Anonymous authentication requires only a ClientId:

public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor(options => options.DetailedErrors = true);

            services.AddAzureMapsControl(configuration => configuration.ClientId = Configuration["AzureMaps:ClientId"])
        }

It also needs to fetch the token to send to the requests of the atlas library. For that, you have to override the azureMapsControl.Extensions.getTokenCallback method on your application after referencing azure-maps-control.min.js and resolve the token in it. For example :

@page "/"
@namespace AzureMapsControl.Sample.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
@{
    Layout = null;
}

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>AzureMapsControl.Sample</title>
    <base href="~/" />
    <link rel="stylesheet" href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.css" type="text/css" />
    <link rel="stylesheet" href="https://atlas.microsoft.com/sdk/javascript/drawing/0.1/atlas-drawing.min.css" type="text/css" />
    <style>
        body {
            margin: 0;
        }

        #map {
            position: absolute;
            width: 100%;
            min-width: 290px;
            height: 100%;
        }
    </style>
</head>
<body>
    <app>
        <component type="typeof(App)" render-mode="ServerPrerendered" />
    </app>
    <script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.js"></script>
    <script src="https://atlas.microsoft.com/sdk/javascript/drawing/0.1/atlas-drawing.min.js"></script>
    <script src="_content/AzureMapsControl.Components/azure-maps-control.min.js"></script>
    <script src="_framework/blazor.server.js"></script>
    <script type="text/javascript">
        azureMapsControl.Extensions.getTokenCallback = (resolve, reject, map) => {
            const url = "url_of_my_token_endpoint";
            fetch(url).then(function (response) {
                return response.text();
            }).then(function (token) {
                resolve(token);
            });        
        };
    </script>
</body>
</html>

How to use

Want to contribute ?

Contributions are welcome! One of the best way to start is to take a look at the list of issues where help is wanted.

If you need a new feature which is not listed on the issues, feel free to open a new one. Take also a look at the Contributing guidelines.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.16.1 6,927 6/18/2024
1.16.0 155 6/14/2024
1.16.0-alpha0003 99 6/14/2024
1.16.0-alpha0001 286 3/27/2024
1.15.0 4,892 3/12/2024
1.15.0-alpha0002 99 3/12/2024
1.14.1 421 2/28/2024
1.14.0 991 12/22/2023
1.14.0-alpha0015 117 12/22/2023
1.13.0 23,763 9/14/2022
1.13.0-alpha0001 246 9/13/2022
1.12.0 3,096 8/3/2022
1.12.0-alpha0038 164 8/3/2022
1.12.0-alpha0028 204 7/8/2022
1.12.0-alpha0019 155 7/7/2022
1.12.0-alpha0011 158 6/14/2022
1.12.0-alpha0004 231 2/2/2022
1.12.0-alpha0003 172 2/2/2022
1.11.0 8,637 11/12/2021
1.11.0-alpha0015 222 11/12/2021
1.10.0 361 11/8/2021
1.10.0-net60-alpha0001 168 10/19/2021
1.10.0-alpha0010 229 11/8/2021
1.9.0 1,330 8/4/2021
1.9.0-alpha0006 309 8/4/2021
1.8.3 1,010 7/14/2021
1.8.3-beta0001 270 7/14/2021
1.8.2 436 7/13/2021
1.8.2-beta0001 309 7/13/2021
1.8.1 553 6/25/2021
1.8.1-beta0001 316 6/25/2021
1.8.0 408 6/19/2021
1.8.0-html-marker-laye0001 284 6/8/2021
1.8.0-alpha0003 285 6/19/2021
1.7.1 520 6/8/2021
1.7.1-beta0001 279 6/3/2021
1.7.0 503 5/31/2021
1.7.0-alpha0014 302 5/31/2021
1.7.0-alpha0004 265 5/18/2021
1.7.0-alpha0001 272 5/13/2021
1.6.1 565 5/18/2021
1.6.1-beta0001 269 5/18/2021
1.6.0 447 5/7/2021
1.6.0-alpha0050 300 5/7/2021
1.6.0-alpha0031 316 5/7/2021
1.6.0-alpha0015 289 5/7/2021
1.5.2 407 5/6/2021
1.5.2-beta0001 310 5/6/2021
1.5.1 654 4/30/2021
1.5.1-beta0001 270 4/30/2021
1.5.0 417 4/26/2021
1.5.0-alpha0016 277 4/23/2021
1.4.0 389 4/23/2021
1.4.0-alpha0005 272 4/20/2021
1.3.0 437 4/19/2021
1.3.0-beta0003 298 4/17/2021
1.3.0-beta0002 278 4/17/2021
1.3.0-beta0001 291 4/17/2021
1.3.0-alpha0001 267 4/16/2021
1.2.0 373 4/15/2021
1.2.0-alpha0004 251 4/15/2021
1.1.0 431 4/13/2021
1.1.0-alpha0015 242 4/13/2021
1.0.0 463 4/9/2021
1.0.0-beta0008 280 3/26/2021
1.0.0-beta0007 289 3/24/2021
1.0.0-beta0006 296 3/23/2021
1.0.0-beta0005 292 3/22/2021
1.0.0-beta0004 285 3/19/2021
1.0.0-beta0003 283 3/19/2021
1.0.0-beta0002 289 3/19/2021
1.0.0-beta0001 271 3/19/2021
0.17.1 370 4/6/2021
0.17.1-beta0001 255 4/5/2021
0.17.0 435 3/24/2021
0.16.0 403 3/23/2021
0.15.0 607 3/8/2021
0.15.0-alpha0038 300 3/8/2021
0.14.0 411 3/5/2021
0.14.0-alpha0003 255 3/5/2021
0.13.0 423 3/3/2021
0.13.0-alpha0001 267 3/3/2021
0.12.0 498 2/18/2021
0.12.0-typescript0001 281 2/18/2021
0.12.0-publish-typescri0001 285 2/18/2021
0.12.0-alpha0018 255 2/18/2021
0.11.0 407 2/17/2021
0.11.0-alpha0003 251 2/17/2021
0.10.1 414 2/15/2021
0.10.0 379 2/15/2021
0.10.0-alpha0011 242 2/15/2021
0.10.0-alpha0005 253 2/15/2021
0.9.0 446 1/24/2021
0.9.0-alpha0013 347 1/24/2021
0.9.0-alpha0006 316 1/3/2021
0.9.0-alpha0003 305 12/8/2020
0.8.1 455 1/3/2021
0.8.0 535 12/8/2020
0.8.0-beta0001 281 12/8/2020
0.8.0-alpha0005 321 11/25/2020
0.7.1 466 11/25/2020
0.7.0 451 11/25/2020
0.7.0-beta0001 324 11/25/2020
0.7.0-alpha0002 310 11/24/2020
0.6.0-beta0001 337 11/24/2020
0.6.0-alpha0005 323 11/24/2020
0.6.0-alpha0001 308 11/23/2020
0.5.2 1,681 11/24/2020
0.5.1 444 11/23/2020
0.5.0 424 11/19/2020
0.4.0 435 11/12/2020
0.3.0-beta0001 338 11/12/2020
0.3.0-alpha0019 283 11/19/2020
0.3.0-alpha0010 323 11/12/2020
0.3.0-alpha0004 341 11/12/2020
0.2.0 439 11/12/2020
0.2.0-beta0003 375 11/12/2020
0.2.0-beta0002 346 11/12/2020
0.2.0-beta0001 329 11/11/2020
0.1.0 507 11/11/2020
0.1.0-beta0002 347 11/11/2020
0.1.0-beta0001 339 11/11/2020
0.1.0-alpha0236 368 11/11/2020
0.1.0-alpha0116 329 11/11/2020
0.1.0-alpha0112 345 11/11/2020
0.1.0-alpha0097 345 11/11/2020
0.1.0-alpha0091 345 11/11/2020
0.1.0-alpha0090 354 11/10/2020
0.1.0-alpha0089 350 11/10/2020
0.1.0-alpha0088 371 11/10/2020
0.1.0-alpha0087 368 11/10/2020
0.1.0-alpha0086 360 11/10/2020
0.1.0-alpha0085 373 11/10/2020
0.1.0-alpha0084 355 11/10/2020
0.1.0-alpha0083 351 11/10/2020
0.1.0-alpha0082 406 11/9/2020
0.1.0-alpha0081 415 11/9/2020
0.1.0-alpha0080 408 11/9/2020
0.1.0-alpha0079 371 11/7/2020
0.1.0-alpha0077 554 11/6/2020
0.1.0-alpha0076 523 11/6/2020
0.1.0-alpha0074 437 11/6/2020
0.1.0-alpha0071 376 11/6/2020
0.0.1-ci-20201106.2 289 11/6/2020
0.0.1-ci-20201106.1 248 11/6/2020
0.0.1-ci-20201105.7 290 11/5/2020
0.0.1-ci-20201105.6 300 11/5/2020
0.0.1-ci-20201105.5 307 11/5/2020
0.0.1-ci-20201105.4 299 11/5/2020
0.0.1-ci-20201105.3 243 11/5/2020
0.0.1-ci-20201105.2 255 11/5/2020
0.0.1-ci-20201105.1 239 11/5/2020
0.0.1-ci-20201104.2 251 11/4/2020
0.0.1-ci-20201104.1 263 11/4/2020
0.0.1-ci-20201030.5 254 10/30/2020
0.0.1-ci-20201030.4 263 10/30/2020
0.0.1-ci-20201030.3 277 10/30/2020
0.0.1-ci-20201030.2 262 10/30/2020
0.0.1-ci-20201030.1 241 10/30/2020
0.0.1-ci-20201029.3 245 10/29/2020
0.0.1-ci-20201029.2 269 10/29/2020
0.0.1-ci-20201029.1 254 10/29/2020
0.0.1-ci-20201028.1 238 10/28/2020
0.0.1-ci-20201027.1 256 10/27/2020
0.0.1-ci-20201026.2 286 10/26/2020
0.0.1-ci-20201026.1 230 10/26/2020
0.0.1-ci-20201023.2 281 10/23/2020
0.0.1-ci-20201023.1 260 10/23/2020
0.0.1-ci-20201022.1 254 10/22/2020
0.0.1-ci-20201008.1 238 10/8/2020
0.0.1-ci-20201005.1 293 10/5/2020
0.0.1-ci-20200407.1 290 4/7/2020
0.0.1-ci-20200406.3 294 4/6/2020
0.0.1-ci-20200406.2 304 4/6/2020
0.0.1-ci-20200406.1 305 4/6/2020
0.0.1-ci-20200403.5 292 4/3/2020
0.0.1-ci-20200403.4 307 4/3/2020
0.0.1-ci-20200403.3 309 4/3/2020
0.0.1-ci-20200403.2 297 4/3/2020
0.0.1-ci-20200403.1 297 4/3/2020
0.0.1-ci-20200402.2 299 4/2/2020
0.0.1-ci-20200402.1 322 4/2/2020