AzureMapsControl.Components 1.11.0-alpha0015

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

// Install AzureMapsControl.Components as a Cake Tool
#tool nuget:?package=AzureMapsControl.Components&version=1.11.0-alpha0015&prerelease                

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. 
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 3,597 6/18/2024
1.16.0 151 6/14/2024
1.16.0-alpha0003 95 6/14/2024
1.16.0-alpha0001 257 3/27/2024
1.15.0 4,465 3/12/2024
1.15.0-alpha0002 94 3/12/2024
1.14.1 411 2/28/2024
1.14.0 969 12/22/2023
1.14.0-alpha0015 113 12/22/2023
1.13.0 22,961 9/14/2022
1.13.0-alpha0001 241 9/13/2022
1.12.0 3,091 8/3/2022
1.12.0-alpha0038 159 8/3/2022
1.12.0-alpha0028 179 7/8/2022
1.12.0-alpha0019 148 7/7/2022
1.12.0-alpha0011 153 6/14/2022
1.12.0-alpha0004 225 2/2/2022
1.12.0-alpha0003 167 2/2/2022
1.11.0 8,529 11/12/2021
1.11.0-alpha0015 217 11/12/2021
1.10.0 356 11/8/2021
1.10.0-net60-alpha0001 161 10/19/2021
1.10.0-alpha0010 204 11/8/2021
1.9.0 1,325 8/4/2021
1.9.0-alpha0006 304 8/4/2021
1.8.3 1,005 7/14/2021
1.8.3-beta0001 265 7/14/2021
1.8.2 429 7/13/2021
1.8.2-beta0001 286 7/13/2021
1.8.1 546 6/25/2021
1.8.1-beta0001 309 6/25/2021
1.8.0 403 6/19/2021
1.8.0-html-marker-laye0001 279 6/8/2021
1.8.0-alpha0003 278 6/19/2021
1.7.1 515 6/8/2021
1.7.1-beta0001 271 6/3/2021
1.7.0 498 5/31/2021
1.7.0-alpha0014 295 5/31/2021
1.7.0-alpha0004 260 5/18/2021
1.7.0-alpha0001 266 5/13/2021
1.6.1 560 5/18/2021
1.6.1-beta0001 264 5/18/2021
1.6.0 440 5/7/2021
1.6.0-alpha0050 294 5/7/2021
1.6.0-alpha0031 309 5/7/2021
1.6.0-alpha0015 284 5/7/2021
1.5.2 402 5/6/2021
1.5.2-beta0001 302 5/6/2021
1.5.1 647 4/30/2021
1.5.1-beta0001 257 4/30/2021
1.5.0 409 4/26/2021
1.5.0-alpha0016 272 4/23/2021
1.4.0 384 4/23/2021
1.4.0-alpha0005 267 4/20/2021
1.3.0 432 4/19/2021
1.3.0-beta0003 293 4/17/2021
1.3.0-beta0002 273 4/17/2021
1.3.0-beta0001 286 4/17/2021
1.3.0-alpha0001 262 4/16/2021
1.2.0 368 4/15/2021
1.2.0-alpha0004 246 4/15/2021
1.1.0 426 4/13/2021
1.1.0-alpha0015 237 4/13/2021
1.0.0 456 4/9/2021
1.0.0-beta0008 269 3/26/2021
1.0.0-beta0007 284 3/24/2021
1.0.0-beta0006 291 3/23/2021
1.0.0-beta0005 287 3/22/2021
1.0.0-beta0004 279 3/19/2021
1.0.0-beta0003 277 3/19/2021
1.0.0-beta0002 284 3/19/2021
1.0.0-beta0001 266 3/19/2021
0.17.1 365 4/6/2021
0.17.1-beta0001 250 4/5/2021
0.17.0 430 3/24/2021
0.16.0 381 3/23/2021
0.15.0 602 3/8/2021
0.15.0-alpha0038 295 3/8/2021
0.14.0 406 3/5/2021
0.14.0-alpha0003 250 3/5/2021
0.13.0 414 3/3/2021
0.13.0-alpha0001 262 3/3/2021
0.12.0 493 2/18/2021
0.12.0-typescript0001 276 2/18/2021
0.12.0-publish-typescri0001 264 2/18/2021
0.12.0-alpha0018 250 2/18/2021
0.11.0 402 2/17/2021
0.11.0-alpha0003 246 2/17/2021
0.10.1 393 2/15/2021
0.10.0 374 2/15/2021
0.10.0-alpha0011 237 2/15/2021
0.10.0-alpha0005 248 2/15/2021
0.9.0 441 1/24/2021
0.9.0-alpha0013 325 1/24/2021
0.9.0-alpha0006 311 1/3/2021
0.9.0-alpha0003 299 12/8/2020
0.8.1 450 1/3/2021
0.8.0 529 12/8/2020
0.8.0-beta0001 276 12/8/2020
0.8.0-alpha0005 316 11/25/2020
0.7.1 461 11/25/2020
0.7.0 445 11/25/2020
0.7.0-beta0001 319 11/25/2020
0.7.0-alpha0002 299 11/24/2020
0.6.0-beta0001 332 11/24/2020
0.6.0-alpha0005 317 11/24/2020
0.6.0-alpha0001 303 11/23/2020
0.5.2 1,675 11/24/2020
0.5.1 439 11/23/2020
0.5.0 419 11/19/2020
0.4.0 430 11/12/2020
0.3.0-beta0001 333 11/12/2020
0.3.0-alpha0019 278 11/19/2020
0.3.0-alpha0010 318 11/12/2020
0.3.0-alpha0004 336 11/12/2020
0.2.0 434 11/12/2020
0.2.0-beta0003 352 11/12/2020
0.2.0-beta0002 341 11/12/2020
0.2.0-beta0001 324 11/11/2020
0.1.0 501 11/11/2020
0.1.0-beta0002 336 11/11/2020
0.1.0-beta0001 334 11/11/2020
0.1.0-alpha0236 363 11/11/2020
0.1.0-alpha0116 324 11/11/2020
0.1.0-alpha0112 340 11/11/2020
0.1.0-alpha0097 338 11/11/2020
0.1.0-alpha0091 340 11/11/2020
0.1.0-alpha0090 343 11/10/2020
0.1.0-alpha0089 345 11/10/2020
0.1.0-alpha0088 366 11/10/2020
0.1.0-alpha0087 363 11/10/2020
0.1.0-alpha0086 355 11/10/2020
0.1.0-alpha0085 366 11/10/2020
0.1.0-alpha0084 350 11/10/2020
0.1.0-alpha0083 346 11/10/2020
0.1.0-alpha0082 401 11/9/2020
0.1.0-alpha0081 410 11/9/2020
0.1.0-alpha0080 403 11/9/2020
0.1.0-alpha0079 366 11/7/2020
0.1.0-alpha0077 532 11/6/2020
0.1.0-alpha0076 517 11/6/2020
0.1.0-alpha0074 432 11/6/2020
0.1.0-alpha0071 369 11/6/2020
0.0.1-ci-20201106.2 280 11/6/2020
0.0.1-ci-20201106.1 241 11/6/2020
0.0.1-ci-20201105.7 281 11/5/2020
0.0.1-ci-20201105.6 293 11/5/2020
0.0.1-ci-20201105.5 298 11/5/2020
0.0.1-ci-20201105.4 292 11/5/2020
0.0.1-ci-20201105.3 234 11/5/2020
0.0.1-ci-20201105.2 247 11/5/2020
0.0.1-ci-20201105.1 232 11/5/2020
0.0.1-ci-20201104.2 240 11/4/2020
0.0.1-ci-20201104.1 252 11/4/2020
0.0.1-ci-20201030.5 247 10/30/2020
0.0.1-ci-20201030.4 256 10/30/2020
0.0.1-ci-20201030.3 268 10/30/2020
0.0.1-ci-20201030.2 255 10/30/2020
0.0.1-ci-20201030.1 234 10/30/2020
0.0.1-ci-20201029.3 236 10/29/2020
0.0.1-ci-20201029.2 261 10/29/2020
0.0.1-ci-20201029.1 247 10/29/2020
0.0.1-ci-20201028.1 231 10/28/2020
0.0.1-ci-20201027.1 247 10/27/2020
0.0.1-ci-20201026.2 276 10/26/2020
0.0.1-ci-20201026.1 221 10/26/2020
0.0.1-ci-20201023.2 274 10/23/2020
0.0.1-ci-20201023.1 252 10/23/2020
0.0.1-ci-20201022.1 245 10/22/2020
0.0.1-ci-20201008.1 229 10/8/2020
0.0.1-ci-20201005.1 286 10/5/2020
0.0.1-ci-20200407.1 280 4/7/2020
0.0.1-ci-20200406.3 287 4/6/2020
0.0.1-ci-20200406.2 297 4/6/2020
0.0.1-ci-20200406.1 298 4/6/2020
0.0.1-ci-20200403.5 285 4/3/2020
0.0.1-ci-20200403.4 298 4/3/2020
0.0.1-ci-20200403.3 302 4/3/2020
0.0.1-ci-20200403.2 288 4/3/2020
0.0.1-ci-20200403.1 290 4/3/2020
0.0.1-ci-20200402.2 290 4/2/2020
0.0.1-ci-20200402.1 313 4/2/2020