AzureMapsControl.Components 1.10.0-alpha0010

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

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

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

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

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.0-alpha0001 129 3/27/2024
1.15.0 1,434 3/12/2024
1.15.0-alpha0002 69 3/12/2024
1.14.1 376 2/28/2024
1.14.0 893 12/22/2023
1.14.0-alpha0015 87 12/22/2023
1.13.0 20,082 9/14/2022
1.13.0-alpha0001 209 9/13/2022
1.12.0 3,000 8/3/2022
1.12.0-alpha0038 124 8/3/2022
1.12.0-alpha0028 147 7/8/2022
1.12.0-alpha0019 125 7/7/2022
1.12.0-alpha0011 128 6/14/2022
1.12.0-alpha0004 204 2/2/2022
1.12.0-alpha0003 144 2/2/2022
1.11.0 8,214 11/12/2021
1.11.0-alpha0015 194 11/12/2021
1.10.0 329 11/8/2021
1.10.0-net60-alpha0001 155 10/19/2021
1.10.0-alpha0010 183 11/8/2021
1.9.0 1,289 8/4/2021
1.9.0-alpha0006 279 8/4/2021
1.8.3 981 7/14/2021
1.8.3-beta0001 241 7/14/2021
1.8.2 410 7/13/2021
1.8.2-beta0001 264 7/13/2021
1.8.1 520 6/25/2021
1.8.1-beta0001 289 6/25/2021
1.8.0 380 6/19/2021
1.8.0-html-marker-laye0001 259 6/8/2021
1.8.0-alpha0003 259 6/19/2021
1.7.1 489 6/8/2021
1.7.1-beta0001 251 6/3/2021
1.7.0 470 5/31/2021
1.7.0-alpha0014 273 5/31/2021
1.7.0-alpha0004 238 5/18/2021
1.7.0-alpha0001 243 5/13/2021
1.6.1 535 5/18/2021
1.6.1-beta0001 242 5/18/2021
1.6.0 411 5/7/2021
1.6.0-alpha0050 266 5/7/2021
1.6.0-alpha0031 289 5/7/2021
1.6.0-alpha0015 262 5/7/2021
1.5.2 377 5/6/2021
1.5.2-beta0001 277 5/6/2021
1.5.1 617 4/30/2021
1.5.1-beta0001 231 4/30/2021
1.5.0 387 4/26/2021
1.5.0-alpha0016 249 4/23/2021
1.4.0 357 4/23/2021
1.4.0-alpha0005 246 4/20/2021
1.3.0 410 4/19/2021
1.3.0-beta0003 273 4/17/2021
1.3.0-beta0002 251 4/17/2021
1.3.0-beta0001 265 4/17/2021
1.3.0-alpha0001 244 4/16/2021
1.2.0 345 4/15/2021
1.2.0-alpha0004 216 4/15/2021
1.1.0 393 4/13/2021
1.1.0-alpha0015 218 4/13/2021
1.0.0 428 4/9/2021
1.0.0-beta0008 251 3/26/2021
1.0.0-beta0007 259 3/24/2021
1.0.0-beta0006 268 3/23/2021
1.0.0-beta0005 269 3/22/2021
1.0.0-beta0004 260 3/19/2021
1.0.0-beta0003 242 3/19/2021
1.0.0-beta0002 259 3/19/2021
1.0.0-beta0001 244 3/19/2021
0.17.1 341 4/6/2021
0.17.1-beta0001 229 4/5/2021
0.17.0 405 3/24/2021
0.16.0 358 3/23/2021
0.15.0 574 3/8/2021
0.15.0-alpha0038 272 3/8/2021
0.14.0 386 3/5/2021
0.14.0-alpha0003 230 3/5/2021
0.13.0 389 3/3/2021
0.13.0-alpha0001 241 3/3/2021
0.12.0 469 2/18/2021
0.12.0-typescript0001 250 2/18/2021
0.12.0-publish-typescri0001 243 2/18/2021
0.12.0-alpha0018 232 2/18/2021
0.11.0 379 2/17/2021
0.11.0-alpha0003 223 2/17/2021
0.10.1 373 2/15/2021
0.10.0 352 2/15/2021
0.10.0-alpha0011 215 2/15/2021
0.10.0-alpha0005 227 2/15/2021
0.9.0 418 1/24/2021
0.9.0-alpha0013 302 1/24/2021
0.9.0-alpha0006 290 1/3/2021
0.9.0-alpha0003 280 12/8/2020
0.8.1 430 1/3/2021
0.8.0 507 12/8/2020
0.8.0-beta0001 255 12/8/2020
0.8.0-alpha0005 295 11/25/2020
0.7.1 438 11/25/2020
0.7.0 422 11/25/2020
0.7.0-beta0001 293 11/25/2020
0.7.0-alpha0002 278 11/24/2020
0.6.0-beta0001 312 11/24/2020
0.6.0-alpha0005 293 11/24/2020
0.6.0-alpha0001 283 11/23/2020
0.5.2 1,645 11/24/2020
0.5.1 417 11/23/2020
0.5.0 396 11/19/2020
0.4.0 406 11/12/2020
0.3.0-beta0001 313 11/12/2020
0.3.0-alpha0019 261 11/19/2020
0.3.0-alpha0010 301 11/12/2020
0.3.0-alpha0004 306 11/12/2020
0.2.0 413 11/12/2020
0.2.0-beta0003 331 11/12/2020
0.2.0-beta0002 321 11/12/2020
0.2.0-beta0001 307 11/11/2020
0.1.0 460 11/11/2020
0.1.0-beta0002 317 11/11/2020
0.1.0-beta0001 313 11/11/2020
0.1.0-alpha0236 335 11/11/2020
0.1.0-alpha0116 302 11/11/2020
0.1.0-alpha0112 318 11/11/2020
0.1.0-alpha0097 318 11/11/2020
0.1.0-alpha0091 318 11/11/2020
0.1.0-alpha0090 323 11/10/2020
0.1.0-alpha0089 328 11/10/2020
0.1.0-alpha0088 338 11/10/2020
0.1.0-alpha0087 345 11/10/2020
0.1.0-alpha0086 332 11/10/2020
0.1.0-alpha0085 347 11/10/2020
0.1.0-alpha0084 326 11/10/2020
0.1.0-alpha0083 330 11/10/2020
0.1.0-alpha0082 379 11/9/2020
0.1.0-alpha0081 385 11/9/2020
0.1.0-alpha0080 381 11/9/2020
0.1.0-alpha0079 340 11/7/2020
0.1.0-alpha0077 511 11/6/2020
0.1.0-alpha0076 498 11/6/2020
0.1.0-alpha0074 413 11/6/2020
0.1.0-alpha0071 348 11/6/2020
0.0.1-ci-20201106.2 274 11/6/2020
0.0.1-ci-20201106.1 235 11/6/2020
0.0.1-ci-20201105.7 275 11/5/2020
0.0.1-ci-20201105.6 288 11/5/2020
0.0.1-ci-20201105.5 293 11/5/2020
0.0.1-ci-20201105.4 284 11/5/2020
0.0.1-ci-20201105.3 229 11/5/2020
0.0.1-ci-20201105.2 241 11/5/2020
0.0.1-ci-20201105.1 225 11/5/2020
0.0.1-ci-20201104.2 235 11/4/2020
0.0.1-ci-20201104.1 246 11/4/2020
0.0.1-ci-20201030.5 241 10/30/2020
0.0.1-ci-20201030.4 241 10/30/2020
0.0.1-ci-20201030.3 263 10/30/2020
0.0.1-ci-20201030.2 240 10/30/2020
0.0.1-ci-20201030.1 227 10/30/2020
0.0.1-ci-20201029.3 231 10/29/2020
0.0.1-ci-20201029.2 256 10/29/2020
0.0.1-ci-20201029.1 240 10/29/2020
0.0.1-ci-20201028.1 219 10/28/2020
0.0.1-ci-20201027.1 242 10/27/2020
0.0.1-ci-20201026.2 271 10/26/2020
0.0.1-ci-20201026.1 215 10/26/2020
0.0.1-ci-20201023.2 267 10/23/2020
0.0.1-ci-20201023.1 248 10/23/2020
0.0.1-ci-20201022.1 240 10/22/2020
0.0.1-ci-20201008.1 222 10/8/2020
0.0.1-ci-20201005.1 274 10/5/2020
0.0.1-ci-20200407.1 275 4/7/2020
0.0.1-ci-20200406.3 281 4/6/2020
0.0.1-ci-20200406.2 291 4/6/2020
0.0.1-ci-20200406.1 294 4/6/2020
0.0.1-ci-20200403.5 279 4/3/2020
0.0.1-ci-20200403.4 288 4/3/2020
0.0.1-ci-20200403.3 298 4/3/2020
0.0.1-ci-20200403.2 283 4/3/2020
0.0.1-ci-20200403.1 284 4/3/2020
0.0.1-ci-20200402.2 284 4/2/2020
0.0.1-ci-20200402.1 309 4/2/2020