AzureMapsControl.Components 1.13.0

.NET 5.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.
dotnet add package AzureMapsControl.Components --version 1.13.0
<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, C# scripting and .NET Interactive. 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 Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
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 99 9/14/2022
1.13.0-alpha0001 44 9/13/2022
1.12.0 749 8/3/2022
1.12.0-alpha0038 57 8/3/2022
1.12.0-alpha0028 82 7/8/2022
1.12.0-alpha0019 57 7/7/2022
1.12.0-alpha0011 62 6/14/2022
1.12.0-alpha0004 136 2/2/2022
1.12.0-alpha0003 73 2/2/2022
1.11.0 5,608 11/12/2021
1.11.0-alpha0015 120 11/12/2021
1.10.0 193 11/8/2021
1.10.0-net60-alpha0001 108 10/19/2021
1.10.0-alpha0010 129 11/8/2021
1.9.0 1,120 8/4/2021
1.9.0-alpha0006 211 8/4/2021
1.8.3 850 7/14/2021
1.8.3-beta0001 191 7/14/2021
1.8.2 271 7/13/2021
1.8.2-beta0001 211 7/13/2021
1.8.1 386 6/25/2021
1.8.1-beta0001 239 6/25/2021
1.8.0 254 6/19/2021
1.8.0-html-marker-laye0001 208 6/8/2021
1.8.0-alpha0003 209 6/19/2021
1.7.1 363 6/8/2021
1.7.1-beta0001 203 6/3/2021
1.7.0 344 5/31/2021
1.7.0-alpha0014 220 5/31/2021
1.7.0-alpha0004 188 5/18/2021
1.7.0-alpha0001 194 5/13/2021
1.6.1 409 5/18/2021
1.6.1-beta0001 190 5/18/2021
1.6.0 291 5/7/2021
1.6.0-alpha0050 220 5/7/2021
1.6.0-alpha0031 243 5/7/2021
1.6.0-alpha0015 213 5/7/2021
1.5.2 252 5/6/2021
1.5.2-beta0001 226 5/6/2021
1.5.1 480 4/30/2021
1.5.1-beta0001 163 4/30/2021
1.5.0 256 4/26/2021
1.5.0-alpha0016 180 4/23/2021
1.4.0 230 4/23/2021
1.4.0-alpha0005 198 4/20/2021
1.3.0 290 4/19/2021
1.3.0-beta0003 222 4/17/2021
1.3.0-beta0002 205 4/17/2021
1.3.0-beta0001 217 4/17/2021
1.3.0-alpha0001 198 4/16/2021
1.2.0 218 4/15/2021
1.2.0-alpha0004 171 4/15/2021
1.1.0 259 4/13/2021
1.1.0-alpha0015 163 4/13/2021
1.0.0 286 4/9/2021
1.0.0-beta0008 202 3/26/2021
1.0.0-beta0007 212 3/24/2021
1.0.0-beta0006 219 3/23/2021
1.0.0-beta0005 215 3/22/2021
1.0.0-beta0004 215 3/19/2021
1.0.0-beta0003 191 3/19/2021
1.0.0-beta0002 209 3/19/2021
1.0.0-beta0001 199 3/19/2021
0.17.1 211 4/6/2021
0.17.1-beta0001 183 4/5/2021
0.17.0 276 3/24/2021
0.16.0 228 3/23/2021
0.15.0 441 3/8/2021
0.15.0-alpha0038 224 3/8/2021
0.14.0 256 3/5/2021
0.14.0-alpha0003 180 3/5/2021
0.13.0 256 3/3/2021
0.13.0-alpha0001 190 3/3/2021
0.12.0 330 2/18/2021
0.12.0-typescript0001 200 2/18/2021
0.12.0-publish-typescri0001 183 2/18/2021
0.12.0-alpha0018 187 2/18/2021
0.11.0 238 2/17/2021
0.11.0-alpha0003 176 2/17/2021
0.10.1 230 2/15/2021
0.10.0 219 2/15/2021
0.10.0-alpha0011 172 2/15/2021
0.10.0-alpha0005 180 2/15/2021
0.9.0 287 1/24/2021
0.9.0-alpha0013 235 1/24/2021
0.9.0-alpha0006 249 1/3/2021
0.9.0-alpha0003 234 12/8/2020
0.8.1 292 1/3/2021
0.8.0 362 12/8/2020
0.8.0-beta0001 210 12/8/2020
0.8.0-alpha0005 248 11/25/2020
0.7.1 297 11/25/2020
0.7.0 282 11/25/2020
0.7.0-beta0001 226 11/25/2020
0.7.0-alpha0002 234 11/24/2020
0.6.0-beta0001 264 11/24/2020
0.6.0-alpha0005 246 11/24/2020
0.6.0-alpha0001 238 11/23/2020
0.5.2 1,441 11/24/2020
0.5.1 286 11/23/2020
0.5.0 266 11/19/2020
0.4.0 270 11/12/2020
0.3.0-beta0001 265 11/12/2020
0.3.0-alpha0019 214 11/19/2020
0.3.0-alpha0010 253 11/12/2020
0.3.0-alpha0004 255 11/12/2020
0.2.0 286 11/12/2020
0.2.0-beta0003 284 11/12/2020
0.2.0-beta0002 274 11/12/2020
0.2.0-beta0001 260 11/11/2020
0.1.0 319 11/11/2020
0.1.0-beta0002 267 11/11/2020
0.1.0-beta0001 259 11/11/2020
0.1.0-alpha0236 286 11/11/2020
0.1.0-alpha0116 249 11/11/2020
0.1.0-alpha0112 266 11/11/2020
0.1.0-alpha0097 254 11/11/2020
0.1.0-alpha0091 255 11/11/2020
0.1.0-alpha0090 262 11/10/2020
0.1.0-alpha0089 270 11/10/2020
0.1.0-alpha0088 278 11/10/2020
0.1.0-alpha0087 281 11/10/2020
0.1.0-alpha0086 277 11/10/2020
0.1.0-alpha0085 289 11/10/2020
0.1.0-alpha0084 270 11/10/2020
0.1.0-alpha0083 272 11/10/2020
0.1.0-alpha0082 319 11/9/2020
0.1.0-alpha0081 322 11/9/2020
0.1.0-alpha0080 326 11/9/2020
0.1.0-alpha0079 283 11/7/2020
0.1.0-alpha0077 452 11/6/2020
0.1.0-alpha0076 438 11/6/2020
0.1.0-alpha0074 352 11/6/2020
0.1.0-alpha0071 286 11/6/2020
0.0.1-ci-20201106.2 220 11/6/2020
0.0.1-ci-20201106.1 172 11/6/2020
0.0.1-ci-20201105.7 223 11/5/2020
0.0.1-ci-20201105.6 231 11/5/2020
0.0.1-ci-20201105.5 232 11/5/2020
0.0.1-ci-20201105.4 231 11/5/2020
0.0.1-ci-20201105.3 174 11/5/2020
0.0.1-ci-20201105.2 185 11/5/2020
0.0.1-ci-20201105.1 171 11/5/2020
0.0.1-ci-20201104.2 179 11/4/2020
0.0.1-ci-20201104.1 184 11/4/2020
0.0.1-ci-20201030.5 184 10/30/2020
0.0.1-ci-20201030.4 184 10/30/2020
0.0.1-ci-20201030.3 203 10/30/2020
0.0.1-ci-20201030.2 179 10/30/2020
0.0.1-ci-20201030.1 172 10/30/2020
0.0.1-ci-20201029.3 178 10/29/2020
0.0.1-ci-20201029.2 203 10/29/2020
0.0.1-ci-20201029.1 187 10/29/2020
0.0.1-ci-20201028.1 164 10/28/2020
0.0.1-ci-20201027.1 186 10/27/2020
0.0.1-ci-20201026.2 210 10/26/2020
0.0.1-ci-20201026.1 155 10/26/2020
0.0.1-ci-20201023.2 206 10/23/2020
0.0.1-ci-20201023.1 191 10/23/2020
0.0.1-ci-20201022.1 178 10/22/2020
0.0.1-ci-20201008.1 168 10/8/2020
0.0.1-ci-20201005.1 221 10/5/2020
0.0.1-ci-20200407.1 217 4/7/2020
0.0.1-ci-20200406.3 219 4/6/2020
0.0.1-ci-20200406.2 236 4/6/2020
0.0.1-ci-20200406.1 237 4/6/2020
0.0.1-ci-20200403.5 218 4/3/2020
0.0.1-ci-20200403.4 231 4/3/2020
0.0.1-ci-20200403.3 238 4/3/2020
0.0.1-ci-20200403.2 223 4/3/2020
0.0.1-ci-20200403.1 230 4/3/2020
0.0.1-ci-20200402.2 225 4/2/2020
0.0.1-ci-20200402.1 253 4/2/2020