AzureMapsControl.Components 1.13.0

.NET 5.0
dotnet add package AzureMapsControl.Components --version 1.13.0
NuGet\Install-Package AzureMapsControl.Components -Version 1.13.0
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.13.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AzureMapsControl.Components --version 1.13.0
#r "nuget: AzureMapsControl.Components, 1.13.0"
#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.13.0

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

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. 
Compatible target framework(s)
Additional computed target framework(s)
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.13.0 13,747 9/14/2022
1.13.0-alpha0001 183 9/13/2022
1.12.0 2,345 8/3/2022
1.12.0-alpha0038 115 8/3/2022
1.12.0-alpha0028 139 7/8/2022
1.12.0-alpha0019 116 7/7/2022
1.12.0-alpha0011 122 6/14/2022
1.12.0-alpha0004 195 2/2/2022
1.12.0-alpha0003 133 2/2/2022
1.11.0 7,712 11/12/2021
1.11.0-alpha0015 183 11/12/2021
1.10.0 316 11/8/2021
1.10.0-net60-alpha0001 149 10/19/2021
1.10.0-alpha0010 174 11/8/2021
1.9.0 1,258 8/4/2021
1.9.0-alpha0006 271 8/4/2021
1.8.3 966 7/14/2021
1.8.3-beta0001 232 7/14/2021
1.8.2 399 7/13/2021
1.8.2-beta0001 257 7/13/2021
1.8.1 510 6/25/2021
1.8.1-beta0001 283 6/25/2021
1.8.0 369 6/19/2021
1.8.0-html-marker-laye0001 252 6/8/2021
1.8.0-alpha0003 253 6/19/2021
1.7.1 479 6/8/2021
1.7.1-beta0001 245 6/3/2021
1.7.0 458 5/31/2021
1.7.0-alpha0014 265 5/31/2021
1.7.0-alpha0004 232 5/18/2021
1.7.0-alpha0001 240 5/13/2021
1.6.1 525 5/18/2021
1.6.1-beta0001 236 5/18/2021
1.6.0 402 5/7/2021
1.6.0-alpha0050 260 5/7/2021
1.6.0-alpha0031 284 5/7/2021
1.6.0-alpha0015 255 5/7/2021
1.5.2 366 5/6/2021
1.5.2-beta0001 271 5/6/2021
1.5.1 603 4/30/2021
1.5.1-beta0001 227 4/30/2021
1.5.0 379 4/26/2021
1.5.0-alpha0016 244 4/23/2021
1.4.0 348 4/23/2021
1.4.0-alpha0005 239 4/20/2021
1.3.0 404 4/19/2021
1.3.0-beta0003 265 4/17/2021
1.3.0-beta0002 247 4/17/2021
1.3.0-beta0001 260 4/17/2021
1.3.0-alpha0001 240 4/16/2021
1.2.0 336 4/15/2021
1.2.0-alpha0004 212 4/15/2021
1.1.0 382 4/13/2021
1.1.0-alpha0015 212 4/13/2021
1.0.0 413 4/9/2021
1.0.0-beta0008 245 3/26/2021
1.0.0-beta0007 250 3/24/2021
1.0.0-beta0006 263 3/23/2021
1.0.0-beta0005 264 3/22/2021
1.0.0-beta0004 256 3/19/2021
1.0.0-beta0003 235 3/19/2021
1.0.0-beta0002 255 3/19/2021
1.0.0-beta0001 242 3/19/2021
0.17.1 322 4/6/2021
0.17.1-beta0001 224 4/5/2021
0.17.0 395 3/24/2021
0.16.0 347 3/23/2021
0.15.0 560 3/8/2021
0.15.0-alpha0038 267 3/8/2021
0.14.0 376 3/5/2021
0.14.0-alpha0003 222 3/5/2021
0.13.0 380 3/3/2021
0.13.0-alpha0001 235 3/3/2021
0.12.0 457 2/18/2021
0.12.0-typescript0001 243 2/18/2021
0.12.0-publish-typescri0001 238 2/18/2021
0.12.0-alpha0018 229 2/18/2021
0.11.0 371 2/17/2021
0.11.0-alpha0003 216 2/17/2021
0.10.1 366 2/15/2021
0.10.0 343 2/15/2021
0.10.0-alpha0011 211 2/15/2021
0.10.0-alpha0005 221 2/15/2021
0.9.0 410 1/24/2021
0.9.0-alpha0013 297 1/24/2021
0.9.0-alpha0006 287 1/3/2021
0.9.0-alpha0003 274 12/8/2020
0.8.1 423 1/3/2021
0.8.0 492 12/8/2020
0.8.0-beta0001 250 12/8/2020
0.8.0-alpha0005 291 11/25/2020
0.7.1 428 11/25/2020
0.7.0 412 11/25/2020
0.7.0-beta0001 287 11/25/2020
0.7.0-alpha0002 274 11/24/2020
0.6.0-beta0001 306 11/24/2020
0.6.0-alpha0005 288 11/24/2020
0.6.0-alpha0001 278 11/23/2020
0.5.2 1,625 11/24/2020
0.5.1 407 11/23/2020
0.5.0 387 11/19/2020
0.4.0 397 11/12/2020
0.3.0-beta0001 307 11/12/2020
0.3.0-alpha0019 256 11/19/2020
0.3.0-alpha0010 297 11/12/2020
0.3.0-alpha0004 300 11/12/2020
0.2.0 405 11/12/2020
0.2.0-beta0003 326 11/12/2020
0.2.0-beta0002 316 11/12/2020
0.2.0-beta0001 302 11/11/2020
0.1.0 445 11/11/2020
0.1.0-beta0002 314 11/11/2020
0.1.0-beta0001 309 11/11/2020
0.1.0-alpha0236 329 11/11/2020
0.1.0-alpha0116 297 11/11/2020
0.1.0-alpha0112 312 11/11/2020
0.1.0-alpha0097 309 11/11/2020
0.1.0-alpha0091 311 11/11/2020
0.1.0-alpha0090 316 11/10/2020
0.1.0-alpha0089 321 11/10/2020
0.1.0-alpha0088 332 11/10/2020
0.1.0-alpha0087 336 11/10/2020
0.1.0-alpha0086 326 11/10/2020
0.1.0-alpha0085 340 11/10/2020
0.1.0-alpha0084 321 11/10/2020
0.1.0-alpha0083 323 11/10/2020
0.1.0-alpha0082 373 11/9/2020
0.1.0-alpha0081 379 11/9/2020
0.1.0-alpha0080 376 11/9/2020
0.1.0-alpha0079 336 11/7/2020
0.1.0-alpha0077 505 11/6/2020
0.1.0-alpha0076 492 11/6/2020
0.1.0-alpha0074 407 11/6/2020
0.1.0-alpha0071 342 11/6/2020
0.0.1-ci-20201106.2 269 11/6/2020
0.0.1-ci-20201106.1 226 11/6/2020
0.0.1-ci-20201105.7 268 11/5/2020
0.0.1-ci-20201105.6 280 11/5/2020
0.0.1-ci-20201105.5 287 11/5/2020
0.0.1-ci-20201105.4 277 11/5/2020
0.0.1-ci-20201105.3 223 11/5/2020
0.0.1-ci-20201105.2 233 11/5/2020
0.0.1-ci-20201105.1 219 11/5/2020
0.0.1-ci-20201104.2 228 11/4/2020
0.0.1-ci-20201104.1 239 11/4/2020
0.0.1-ci-20201030.5 234 10/30/2020
0.0.1-ci-20201030.4 235 10/30/2020
0.0.1-ci-20201030.3 255 10/30/2020
0.0.1-ci-20201030.2 231 10/30/2020
0.0.1-ci-20201030.1 221 10/30/2020
0.0.1-ci-20201029.3 225 10/29/2020
0.0.1-ci-20201029.2 250 10/29/2020
0.0.1-ci-20201029.1 234 10/29/2020
0.0.1-ci-20201028.1 214 10/28/2020
0.0.1-ci-20201027.1 235 10/27/2020
0.0.1-ci-20201026.2 264 10/26/2020
0.0.1-ci-20201026.1 208 10/26/2020
0.0.1-ci-20201023.2 259 10/23/2020
0.0.1-ci-20201023.1 241 10/23/2020
0.0.1-ci-20201022.1 230 10/22/2020
0.0.1-ci-20201008.1 214 10/8/2020
0.0.1-ci-20201005.1 268 10/5/2020
0.0.1-ci-20200407.1 267 4/7/2020
0.0.1-ci-20200406.3 273 4/6/2020
0.0.1-ci-20200406.2 284 4/6/2020
0.0.1-ci-20200406.1 286 4/6/2020
0.0.1-ci-20200403.5 268 4/3/2020
0.0.1-ci-20200403.4 280 4/3/2020
0.0.1-ci-20200403.3 287 4/3/2020
0.0.1-ci-20200403.2 274 4/3/2020
0.0.1-ci-20200403.1 278 4/3/2020
0.0.1-ci-20200402.2 275 4/2/2020
0.0.1-ci-20200402.1 302 4/2/2020