AzureMapsControl.Components 1.12.0-alpha0028

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-alpha0028
                    
NuGet\Install-Package AzureMapsControl.Components -Version 1.12.0-alpha0028
                    
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-alpha0028" />
                    
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-alpha0028" />
                    
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-alpha0028
                    
#r "nuget: AzureMapsControl.Components, 1.12.0-alpha0028"
                    
#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-alpha0028
                    
#: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-alpha0028&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=AzureMapsControl.Components&version=1.12.0-alpha0028&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 233 12/19/2024
2.0.0-net9.9 66 12/19/2024
2.0.0-net9.8 70 12/19/2024
2.0.0-net9.7 76 12/19/2024
2.0.0-net9.6 69 12/18/2024
2.0.0-net9.5 64 12/18/2024
2.0.0-net9.4 73 12/18/2024
2.0.0-net9.3 70 12/18/2024
2.0.0-net9.2 87 12/18/2024
1.17.0 1,086 10/9/2025
1.16.1 30,842 6/18/2024
1.16.0 633 6/14/2024
1.16.0-alpha0003 152 6/14/2024
1.16.0-alpha0001 453 3/27/2024
1.15.0 6,781 3/12/2024
1.15.0-alpha0002 161 3/12/2024
1.14.1 560 2/28/2024
1.14.0 1,124 12/22/2023
1.14.0-alpha0015 172 12/22/2023
1.13.0 26,786 9/14/2022
1.13.0-alpha0001 365 9/13/2022
1.12.0 3,267 8/3/2022
1.12.0-alpha0038 303 8/3/2022
1.12.0-alpha0028 347 7/8/2022
1.12.0-alpha0019 284 7/7/2022
1.12.0-alpha0011 318 6/14/2022
1.12.0-alpha0004 398 2/2/2022
1.12.0-alpha0003 350 2/2/2022
1.11.0 9,689 11/12/2021
1.11.0-alpha0015 390 11/12/2021
1.10.0 512 11/8/2021
1.10.0-net60-alpha0001 296 10/19/2021
1.10.0-alpha0010 368 11/8/2021
1.9.0 1,511 8/4/2021
1.9.0-alpha0006 457 8/4/2021
1.8.3 1,162 7/14/2021
1.8.3-beta0001 412 7/14/2021
1.8.2 591 7/13/2021
1.8.2-beta0001 453 7/13/2021
1.8.1 707 6/25/2021
1.8.1-beta0001 464 6/25/2021
1.8.0 563 6/19/2021
1.8.0-html-marker-laye0001 435 6/8/2021
1.8.0-alpha0003 456 6/19/2021
1.7.1 701 6/8/2021
1.7.1-beta0001 435 6/3/2021
1.7.0 659 5/31/2021
1.7.0-alpha0014 452 5/31/2021
1.7.0-alpha0004 410 5/18/2021
1.7.0-alpha0001 411 5/13/2021
1.6.1 734 5/18/2021
1.6.1-beta0001 421 5/18/2021
1.6.0 599 5/7/2021
1.6.0-alpha0050 474 5/7/2021
1.6.0-alpha0031 472 5/7/2021
1.6.0-alpha0015 446 5/7/2021
1.5.2 570 5/6/2021
1.5.2-beta0001 467 5/6/2021
1.5.1 819 4/30/2021
1.5.1-beta0001 409 4/30/2021
1.5.0 585 4/26/2021
1.5.0-alpha0016 432 4/23/2021
1.4.0 554 4/23/2021
1.4.0-alpha0005 429 4/20/2021
1.3.0 631 4/19/2021
1.3.0-beta0003 483 4/17/2021
1.3.0-beta0002 434 4/17/2021
1.3.0-beta0001 442 4/17/2021
1.3.0-alpha0001 421 4/16/2021
1.2.0 543 4/15/2021
1.2.0-alpha0004 405 4/15/2021
1.1.0 621 4/13/2021
1.1.0-alpha0015 397 4/13/2021
1.0.0 651 4/9/2021
1.0.0-beta0008 434 3/26/2021
1.0.0-beta0007 429 3/24/2021
1.0.0-beta0006 456 3/23/2021
1.0.0-beta0005 441 3/22/2021
1.0.0-beta0004 469 3/19/2021
1.0.0-beta0003 449 3/19/2021
1.0.0-beta0002 451 3/19/2021
1.0.0-beta0001 432 3/19/2021
0.17.1 540 4/6/2021
0.17.1-beta0001 406 4/5/2021
0.17.0 596 3/24/2021
0.16.0 585 3/23/2021
0.15.0 779 3/8/2021
0.15.0-alpha0038 461 3/8/2021
0.14.0 584 3/5/2021
0.14.0-alpha0003 420 3/5/2021
0.13.0 596 3/3/2021
0.13.0-alpha0001 441 3/3/2021
0.12.0 672 2/18/2021
0.12.0-typescript0001 442 2/18/2021
0.12.0-publish-typescri0001 446 2/18/2021
0.12.0-alpha0018 448 2/18/2021
0.11.0 582 2/17/2021
0.11.0-alpha0003 412 2/17/2021
0.10.1 585 2/15/2021
0.10.0 548 2/15/2021
0.10.0-alpha0011 407 2/15/2021
0.10.0-alpha0005 413 2/15/2021
0.9.0 621 1/24/2021
0.9.0-alpha0013 510 1/24/2021
0.9.0-alpha0006 512 1/3/2021
0.9.0-alpha0003 475 12/8/2020
0.8.1 636 1/3/2021
0.8.0 713 12/8/2020
0.8.0-beta0001 452 12/8/2020
0.8.0-alpha0005 489 11/25/2020
0.7.1 654 11/25/2020
0.7.0 662 11/25/2020
0.7.0-beta0001 501 11/25/2020
0.7.0-alpha0002 469 11/24/2020
0.6.0-beta0001 509 11/24/2020
0.6.0-alpha0005 490 11/24/2020
0.6.0-alpha0001 479 11/23/2020
0.5.2 1,872 11/24/2020
0.5.1 617 11/23/2020
0.5.0 610 11/19/2020
0.4.0 607 11/12/2020
0.3.0-beta0001 539 11/12/2020
0.3.0-alpha0019 455 11/19/2020
0.3.0-alpha0010 491 11/12/2020
0.3.0-alpha0004 530 11/12/2020
0.2.0 617 11/12/2020
0.2.0-beta0003 559 11/12/2020
0.2.0-beta0002 522 11/12/2020
0.2.0-beta0001 504 11/11/2020
0.1.0 707 11/11/2020
0.1.0-beta0002 514 11/11/2020
0.1.0-beta0001 515 11/11/2020
0.1.0-alpha0236 542 11/11/2020
0.1.0-alpha0116 496 11/11/2020
0.1.0-alpha0112 518 11/11/2020
0.1.0-alpha0097 510 11/11/2020
0.1.0-alpha0091 530 11/11/2020
0.1.0-alpha0090 550 11/10/2020
0.1.0-alpha0089 520 11/10/2020
0.1.0-alpha0088 540 11/10/2020
0.1.0-alpha0087 539 11/10/2020
0.1.0-alpha0086 529 11/10/2020
0.1.0-alpha0085 539 11/10/2020
0.1.0-alpha0084 535 11/10/2020
0.1.0-alpha0083 526 11/10/2020
0.1.0-alpha0082 573 11/9/2020
0.1.0-alpha0081 588 11/9/2020
0.1.0-alpha0080 572 11/9/2020
0.1.0-alpha0079 538 11/7/2020
0.1.0-alpha0077 746 11/6/2020
0.1.0-alpha0076 679 11/6/2020
0.1.0-alpha0074 606 11/6/2020
0.1.0-alpha0071 554 11/6/2020
0.0.1-ci-20201106.2 467 11/6/2020
0.0.1-ci-20201106.1 393 11/6/2020
0.0.1-ci-20201105.7 437 11/5/2020
0.0.1-ci-20201105.6 443 11/5/2020
0.0.1-ci-20201105.5 449 11/5/2020
0.0.1-ci-20201105.4 443 11/5/2020
0.0.1-ci-20201105.3 418 11/5/2020
0.0.1-ci-20201105.2 399 11/5/2020
0.0.1-ci-20201105.1 387 11/5/2020
0.0.1-ci-20201104.2 395 11/4/2020
0.0.1-ci-20201104.1 404 11/4/2020
0.0.1-ci-20201030.5 398 10/30/2020
0.0.1-ci-20201030.4 404 10/30/2020
0.0.1-ci-20201030.3 422 10/30/2020
0.0.1-ci-20201030.2 435 10/30/2020
0.0.1-ci-20201030.1 414 10/30/2020
0.0.1-ci-20201029.3 399 10/29/2020
0.0.1-ci-20201029.2 434 10/29/2020
0.0.1-ci-20201029.1 400 10/29/2020
0.0.1-ci-20201028.1 380 10/28/2020
0.0.1-ci-20201027.1 394 10/27/2020
0.0.1-ci-20201026.2 436 10/26/2020
0.0.1-ci-20201026.1 378 10/26/2020
0.0.1-ci-20201023.2 428 10/23/2020
0.0.1-ci-20201023.1 409 10/23/2020
0.0.1-ci-20201022.1 399 10/22/2020
0.0.1-ci-20201008.1 388 10/8/2020
0.0.1-ci-20201005.1 461 10/5/2020
0.0.1-ci-20200407.1 455 4/7/2020
0.0.1-ci-20200406.3 468 4/6/2020
0.0.1-ci-20200406.2 455 4/6/2020
0.0.1-ci-20200406.1 457 4/6/2020
0.0.1-ci-20200403.5 477 4/3/2020
0.0.1-ci-20200403.4 456 4/3/2020
0.0.1-ci-20200403.3 465 4/3/2020
0.0.1-ci-20200403.2 448 4/3/2020
0.0.1-ci-20200403.1 465 4/3/2020
0.0.1-ci-20200402.2 459 4/2/2020
0.0.1-ci-20200402.1 482 4/2/2020