AzureMapsControl.Components 1.14.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.14.0-alpha0015
NuGet\Install-Package AzureMapsControl.Components -Version 1.14.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.14.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.14.0-alpha0015
#r "nuget: AzureMapsControl.Components, 1.14.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.14.0-alpha0015&prerelease

// Install AzureMapsControl.Components as a Cake Tool
#tool nuget:?package=AzureMapsControl.Components&version=1.14.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 href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.css" rel="stylesheet" />
<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/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/3/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/3/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/3/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 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 is compatible.  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 is compatible.  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 156 6/18/2024
1.16.0 110 6/14/2024
1.16.0-alpha0003 69 6/14/2024
1.16.0-alpha0001 192 3/27/2024
1.15.0 3,134 3/12/2024
1.15.0-alpha0002 72 3/12/2024
1.14.1 384 2/28/2024
1.14.0 939 12/22/2023
1.14.0-alpha0015 90 12/22/2023
1.13.0 21,292 9/14/2022
1.13.0-alpha0001 217 9/13/2022
1.12.0 3,065 8/3/2022
1.12.0-alpha0038 127 8/3/2022
1.12.0-alpha0028 150 7/8/2022
1.12.0-alpha0019 127 7/7/2022
1.12.0-alpha0011 131 6/14/2022
1.12.0-alpha0004 206 2/2/2022
1.12.0-alpha0003 146 2/2/2022
1.11.0 8,273 11/12/2021
1.11.0-alpha0015 197 11/12/2021
1.10.0 333 11/8/2021
1.10.0-net60-alpha0001 158 10/19/2021
1.10.0-alpha0010 185 11/8/2021
1.9.0 1,297 8/4/2021
1.9.0-alpha0006 282 8/4/2021
1.8.3 985 7/14/2021
1.8.3-beta0001 244 7/14/2021
1.8.2 413 7/13/2021
1.8.2-beta0001 266 7/13/2021
1.8.1 524 6/25/2021
1.8.1-beta0001 291 6/25/2021
1.8.0 383 6/19/2021
1.8.0-html-marker-laye0001 261 6/8/2021
1.8.0-alpha0003 261 6/19/2021
1.7.1 493 6/8/2021
1.7.1-beta0001 254 6/3/2021
1.7.0 474 5/31/2021
1.7.0-alpha0014 275 5/31/2021
1.7.0-alpha0004 240 5/18/2021
1.7.0-alpha0001 245 5/13/2021
1.6.1 539 5/18/2021
1.6.1-beta0001 245 5/18/2021
1.6.0 414 5/7/2021
1.6.0-alpha0050 268 5/7/2021
1.6.0-alpha0031 291 5/7/2021
1.6.0-alpha0015 264 5/7/2021
1.5.2 381 5/6/2021
1.5.2-beta0001 286 5/6/2021
1.5.1 623 4/30/2021
1.5.1-beta0001 233 4/30/2021
1.5.0 390 4/26/2021
1.5.0-alpha0016 251 4/23/2021
1.4.0 361 4/23/2021
1.4.0-alpha0005 249 4/20/2021
1.3.0 414 4/19/2021
1.3.0-beta0003 276 4/17/2021
1.3.0-beta0002 253 4/17/2021
1.3.0-beta0001 267 4/17/2021
1.3.0-alpha0001 246 4/16/2021
1.2.0 349 4/15/2021
1.2.0-alpha0004 219 4/15/2021
1.1.0 397 4/13/2021
1.1.0-alpha0015 221 4/13/2021
1.0.0 432 4/9/2021
1.0.0-beta0008 254 3/26/2021
1.0.0-beta0007 261 3/24/2021
1.0.0-beta0006 276 3/23/2021
1.0.0-beta0005 271 3/22/2021
1.0.0-beta0004 262 3/19/2021
1.0.0-beta0003 244 3/19/2021
1.0.0-beta0002 261 3/19/2021
1.0.0-beta0001 246 3/19/2021
0.17.1 345 4/6/2021
0.17.1-beta0001 232 4/5/2021
0.17.0 411 3/24/2021
0.16.0 362 3/23/2021
0.15.0 580 3/8/2021
0.15.0-alpha0038 275 3/8/2021
0.14.0 390 3/5/2021
0.14.0-alpha0003 233 3/5/2021
0.13.0 393 3/3/2021
0.13.0-alpha0001 244 3/3/2021
0.12.0 473 2/18/2021
0.12.0-typescript0001 253 2/18/2021
0.12.0-publish-typescri0001 245 2/18/2021
0.12.0-alpha0018 234 2/18/2021
0.11.0 383 2/17/2021
0.11.0-alpha0003 226 2/17/2021
0.10.1 377 2/15/2021
0.10.0 355 2/15/2021
0.10.0-alpha0011 218 2/15/2021
0.10.0-alpha0005 229 2/15/2021
0.9.0 422 1/24/2021
0.9.0-alpha0013 305 1/24/2021
0.9.0-alpha0006 292 1/3/2021
0.9.0-alpha0003 282 12/8/2020
0.8.1 434 1/3/2021
0.8.0 511 12/8/2020
0.8.0-beta0001 258 12/8/2020
0.8.0-alpha0005 299 11/25/2020
0.7.1 444 11/25/2020
0.7.0 427 11/25/2020
0.7.0-beta0001 298 11/25/2020
0.7.0-alpha0002 282 11/24/2020
0.6.0-beta0001 317 11/24/2020
0.6.0-alpha0005 297 11/24/2020
0.6.0-alpha0001 286 11/23/2020
0.5.2 1,655 11/24/2020
0.5.1 421 11/23/2020
0.5.0 400 11/19/2020
0.4.0 411 11/12/2020
0.3.0-beta0001 317 11/12/2020
0.3.0-alpha0019 264 11/19/2020
0.3.0-alpha0010 304 11/12/2020
0.3.0-alpha0004 310 11/12/2020
0.2.0 418 11/12/2020
0.2.0-beta0003 335 11/12/2020
0.2.0-beta0002 324 11/12/2020
0.2.0-beta0001 310 11/11/2020
0.1.0 472 11/11/2020
0.1.0-beta0002 321 11/11/2020
0.1.0-beta0001 316 11/11/2020
0.1.0-alpha0236 343 11/11/2020
0.1.0-alpha0116 305 11/11/2020
0.1.0-alpha0112 321 11/11/2020
0.1.0-alpha0097 322 11/11/2020
0.1.0-alpha0091 322 11/11/2020
0.1.0-alpha0090 327 11/10/2020
0.1.0-alpha0089 332 11/10/2020
0.1.0-alpha0088 342 11/10/2020
0.1.0-alpha0087 349 11/10/2020
0.1.0-alpha0086 336 11/10/2020
0.1.0-alpha0085 351 11/10/2020
0.1.0-alpha0084 333 11/10/2020
0.1.0-alpha0083 334 11/10/2020
0.1.0-alpha0082 383 11/9/2020
0.1.0-alpha0081 389 11/9/2020
0.1.0-alpha0080 387 11/9/2020
0.1.0-alpha0079 345 11/7/2020
0.1.0-alpha0077 516 11/6/2020
0.1.0-alpha0076 504 11/6/2020
0.1.0-alpha0074 417 11/6/2020
0.1.0-alpha0071 352 11/6/2020
0.0.1-ci-20201106.2 279 11/6/2020
0.0.1-ci-20201106.1 239 11/6/2020
0.0.1-ci-20201105.7 279 11/5/2020
0.0.1-ci-20201105.6 292 11/5/2020
0.0.1-ci-20201105.5 297 11/5/2020
0.0.1-ci-20201105.4 290 11/5/2020
0.0.1-ci-20201105.3 233 11/5/2020
0.0.1-ci-20201105.2 245 11/5/2020
0.0.1-ci-20201105.1 229 11/5/2020
0.0.1-ci-20201104.2 239 11/4/2020
0.0.1-ci-20201104.1 251 11/4/2020
0.0.1-ci-20201030.5 245 10/30/2020
0.0.1-ci-20201030.4 253 10/30/2020
0.0.1-ci-20201030.3 267 10/30/2020
0.0.1-ci-20201030.2 250 10/30/2020
0.0.1-ci-20201030.1 233 10/30/2020
0.0.1-ci-20201029.3 235 10/29/2020
0.0.1-ci-20201029.2 260 10/29/2020
0.0.1-ci-20201029.1 245 10/29/2020
0.0.1-ci-20201028.1 229 10/28/2020
0.0.1-ci-20201027.1 246 10/27/2020
0.0.1-ci-20201026.2 276 10/26/2020
0.0.1-ci-20201026.1 220 10/26/2020
0.0.1-ci-20201023.2 272 10/23/2020
0.0.1-ci-20201023.1 252 10/23/2020
0.0.1-ci-20201022.1 244 10/22/2020
0.0.1-ci-20201008.1 228 10/8/2020
0.0.1-ci-20201005.1 278 10/5/2020
0.0.1-ci-20200407.1 280 4/7/2020
0.0.1-ci-20200406.3 284 4/6/2020
0.0.1-ci-20200406.2 294 4/6/2020
0.0.1-ci-20200406.1 297 4/6/2020
0.0.1-ci-20200403.5 282 4/3/2020
0.0.1-ci-20200403.4 291 4/3/2020
0.0.1-ci-20200403.3 301 4/3/2020
0.0.1-ci-20200403.2 287 4/3/2020
0.0.1-ci-20200403.1 287 4/3/2020
0.0.1-ci-20200402.2 289 4/2/2020
0.0.1-ci-20200402.1 312 4/2/2020