AzureMapsControl.Components 1.12.0-alpha0038

This is a prerelease version of AzureMapsControl.Components.
There is a newer version of this package available.
See the version list below for details.
dotnet add package AzureMapsControl.Components --version 1.12.0-alpha0038
                    
NuGet\Install-Package AzureMapsControl.Components -Version 1.12.0-alpha0038
                    
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.12.0-alpha0038" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AzureMapsControl.Components" Version="1.12.0-alpha0038" />
                    
Directory.Packages.props
<PackageReference Include="AzureMapsControl.Components" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add AzureMapsControl.Components --version 1.12.0-alpha0038
                    
#r "nuget: AzureMapsControl.Components, 1.12.0-alpha0038"
                    
#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.
#:package AzureMapsControl.Components@1.12.0-alpha0038
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=AzureMapsControl.Components&version=1.12.0-alpha0038&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=AzureMapsControl.Components&version=1.12.0-alpha0038&prerelease
                    
Install as a Cake Tool

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 rel="stylesheet" href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/2/atlas.min.css" type="text/css" />
<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/2/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/2/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/2/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/2/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 net5.0 is compatible.  net5.0-windows was computed.  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 was computed.  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 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
2.0.0-net9.10 205 12/19/2024
2.0.0-net9.9 56 12/19/2024
2.0.0-net9.8 59 12/19/2024
2.0.0-net9.7 62 12/19/2024
2.0.0-net9.6 58 12/18/2024
2.0.0-net9.5 58 12/18/2024
2.0.0-net9.4 61 12/18/2024
2.0.0-net9.3 59 12/18/2024
2.0.0-net9.2 76 12/18/2024
1.17.0 78 10/9/2025
1.16.1 27,022 6/18/2024
1.16.0 389 6/14/2024
1.16.0-alpha0003 142 6/14/2024
1.16.0-alpha0001 404 3/27/2024
1.15.0 6,676 3/12/2024
1.15.0-alpha0002 144 3/12/2024
1.14.1 527 2/28/2024
1.14.0 1,097 12/22/2023
1.14.0-alpha0015 159 12/22/2023
1.13.0 26,475 9/14/2022
1.13.0-alpha0001 334 9/13/2022
1.12.0 3,230 8/3/2022
1.12.0-alpha0038 261 8/3/2022
1.12.0-alpha0028 305 7/8/2022
1.12.0-alpha0019 253 7/7/2022
1.12.0-alpha0011 276 6/14/2022
1.12.0-alpha0004 353 2/2/2022
1.12.0-alpha0003 304 2/2/2022
1.11.0 9,474 11/12/2021
1.11.0-alpha0015 340 11/12/2021
1.10.0 476 11/8/2021
1.10.0-net60-alpha0001 255 10/19/2021
1.10.0-alpha0010 325 11/8/2021
1.9.0 1,469 8/4/2021
1.9.0-alpha0006 419 8/4/2021
1.8.3 1,124 7/14/2021
1.8.3-beta0001 376 7/14/2021
1.8.2 550 7/13/2021
1.8.2-beta0001 414 7/13/2021
1.8.1 667 6/25/2021
1.8.1-beta0001 423 6/25/2021
1.8.0 524 6/19/2021
1.8.0-html-marker-laye0001 396 6/8/2021
1.8.0-alpha0003 403 6/19/2021
1.7.1 654 6/8/2021
1.7.1-beta0001 390 6/3/2021
1.7.0 615 5/31/2021
1.7.0-alpha0014 415 5/31/2021
1.7.0-alpha0004 373 5/18/2021
1.7.0-alpha0001 368 5/13/2021
1.6.1 688 5/18/2021
1.6.1-beta0001 377 5/18/2021
1.6.0 556 5/7/2021
1.6.0-alpha0050 432 5/7/2021
1.6.0-alpha0031 429 5/7/2021
1.6.0-alpha0015 405 5/7/2021
1.5.2 527 5/6/2021
1.5.2-beta0001 422 5/6/2021
1.5.1 774 4/30/2021
1.5.1-beta0001 371 4/30/2021
1.5.0 542 4/26/2021
1.5.0-alpha0016 392 4/23/2021
1.4.0 509 4/23/2021
1.4.0-alpha0005 392 4/20/2021
1.3.0 576 4/19/2021
1.3.0-beta0003 433 4/17/2021
1.3.0-beta0002 395 4/17/2021
1.3.0-beta0001 405 4/17/2021
1.3.0-alpha0001 383 4/16/2021
1.2.0 498 4/15/2021
1.2.0-alpha0004 367 4/15/2021
1.1.0 578 4/13/2021
1.1.0-alpha0015 356 4/13/2021
1.0.0 601 4/9/2021
1.0.0-beta0008 397 3/26/2021
1.0.0-beta0007 398 3/24/2021
1.0.0-beta0006 414 3/23/2021
1.0.0-beta0005 399 3/22/2021
1.0.0-beta0004 421 3/19/2021
1.0.0-beta0003 408 3/19/2021
1.0.0-beta0002 405 3/19/2021
1.0.0-beta0001 391 3/19/2021
0.17.1 492 4/6/2021
0.17.1-beta0001 369 4/5/2021
0.17.0 556 3/24/2021
0.16.0 536 3/23/2021
0.15.0 734 3/8/2021
0.15.0-alpha0038 420 3/8/2021
0.14.0 539 3/5/2021
0.14.0-alpha0003 375 3/5/2021
0.13.0 551 3/3/2021
0.13.0-alpha0001 391 3/3/2021
0.12.0 626 2/18/2021
0.12.0-typescript0001 402 2/18/2021
0.12.0-publish-typescri0001 403 2/18/2021
0.12.0-alpha0018 399 2/18/2021
0.11.0 533 2/17/2021
0.11.0-alpha0003 371 2/17/2021
0.10.1 542 2/15/2021
0.10.0 504 2/15/2021
0.10.0-alpha0011 363 2/15/2021
0.10.0-alpha0005 372 2/15/2021
0.9.0 573 1/24/2021
0.9.0-alpha0013 469 1/24/2021
0.9.0-alpha0006 458 1/3/2021
0.9.0-alpha0003 428 12/8/2020
0.8.1 584 1/3/2021
0.8.0 663 12/8/2020
0.8.0-beta0001 405 12/8/2020
0.8.0-alpha0005 444 11/25/2020
0.7.1 600 11/25/2020
0.7.0 601 11/25/2020
0.7.0-beta0001 450 11/25/2020
0.7.0-alpha0002 422 11/24/2020
0.6.0-beta0001 459 11/24/2020
0.6.0-alpha0005 450 11/24/2020
0.6.0-alpha0001 432 11/23/2020
0.5.2 1,825 11/24/2020
0.5.1 570 11/23/2020
0.5.0 559 11/19/2020
0.4.0 562 11/12/2020
0.3.0-beta0001 481 11/12/2020
0.3.0-alpha0019 406 11/19/2020
0.3.0-alpha0010 445 11/12/2020
0.3.0-alpha0004 479 11/12/2020
0.2.0 569 11/12/2020
0.2.0-beta0003 509 11/12/2020
0.2.0-beta0002 471 11/12/2020
0.2.0-beta0001 455 11/11/2020
0.1.0 648 11/11/2020
0.1.0-beta0002 469 11/11/2020
0.1.0-beta0001 462 11/11/2020
0.1.0-alpha0236 495 11/11/2020
0.1.0-alpha0116 452 11/11/2020
0.1.0-alpha0112 469 11/11/2020
0.1.0-alpha0097 467 11/11/2020
0.1.0-alpha0091 485 11/11/2020
0.1.0-alpha0090 488 11/10/2020
0.1.0-alpha0089 478 11/10/2020
0.1.0-alpha0088 499 11/10/2020
0.1.0-alpha0087 493 11/10/2020
0.1.0-alpha0086 484 11/10/2020
0.1.0-alpha0085 490 11/10/2020
0.1.0-alpha0084 484 11/10/2020
0.1.0-alpha0083 474 11/10/2020
0.1.0-alpha0082 530 11/9/2020
0.1.0-alpha0081 536 11/9/2020
0.1.0-alpha0080 527 11/9/2020
0.1.0-alpha0079 492 11/7/2020
0.1.0-alpha0077 696 11/6/2020
0.1.0-alpha0076 636 11/6/2020
0.1.0-alpha0074 559 11/6/2020
0.1.0-alpha0071 501 11/6/2020
0.0.1-ci-20201106.2 404 11/6/2020
0.0.1-ci-20201106.1 349 11/6/2020
0.0.1-ci-20201105.7 391 11/5/2020
0.0.1-ci-20201105.6 399 11/5/2020
0.0.1-ci-20201105.5 407 11/5/2020
0.0.1-ci-20201105.4 396 11/5/2020
0.0.1-ci-20201105.3 360 11/5/2020
0.0.1-ci-20201105.2 354 11/5/2020
0.0.1-ci-20201105.1 340 11/5/2020
0.0.1-ci-20201104.2 352 11/4/2020
0.0.1-ci-20201104.1 360 11/4/2020
0.0.1-ci-20201030.5 352 10/30/2020
0.0.1-ci-20201030.4 364 10/30/2020
0.0.1-ci-20201030.3 375 10/30/2020
0.0.1-ci-20201030.2 378 10/30/2020
0.0.1-ci-20201030.1 361 10/30/2020
0.0.1-ci-20201029.3 354 10/29/2020
0.0.1-ci-20201029.2 383 10/29/2020
0.0.1-ci-20201029.1 354 10/29/2020
0.0.1-ci-20201028.1 337 10/28/2020
0.0.1-ci-20201027.1 355 10/27/2020
0.0.1-ci-20201026.2 385 10/26/2020
0.0.1-ci-20201026.1 330 10/26/2020
0.0.1-ci-20201023.2 387 10/23/2020
0.0.1-ci-20201023.1 359 10/23/2020
0.0.1-ci-20201022.1 354 10/22/2020
0.0.1-ci-20201008.1 344 10/8/2020
0.0.1-ci-20201005.1 408 10/5/2020
0.0.1-ci-20200407.1 410 4/7/2020
0.0.1-ci-20200406.3 413 4/6/2020
0.0.1-ci-20200406.2 411 4/6/2020
0.0.1-ci-20200406.1 411 4/6/2020
0.0.1-ci-20200403.5 423 4/3/2020
0.0.1-ci-20200403.4 413 4/3/2020
0.0.1-ci-20200403.3 415 4/3/2020
0.0.1-ci-20200403.2 402 4/3/2020
0.0.1-ci-20200403.1 420 4/3/2020
0.0.1-ci-20200402.2 409 4/2/2020
0.0.1-ci-20200402.1 435 4/2/2020