C#
Clone or download

README.md

ArcGIS Runtime SDK for .NET - Toolkit

The ArcGIS Runtime SDK for .NET Toolkit contains controls and utilities you can use with ArcGIS Runtime SDK for .NET.

You can use the Toolkit in your projects by:

  1. Building the source code available in this repo (see instructions below)
  2. Installing the latest stable release or pre-release from NuGet
    • Stable: NuGet
    • Pre-release: NuGet

Two concurrent and supported versions of ArcGIS Runtime SDK are available: 100.x and 10.2.x

The Toolkit for v100.x is currently in Beta: Get the latest!

Features

  • Compass: Shows a compass direction when the map is rotated. Auto-hides when the map points north up.
  • FeatureDataField: Displays and optionally allows editing of a single field attribute of a feature.
  • Legend: Displays a legend for a single layer in your map (and optionally for its sub layers).
  • MeasureToolbar: Allows measurement of distances and areas on the map view.
  • ScaleLine: Displays current scale reference.
  • SignInForm: Displays a UI dialog to enter or select credentials to use when accessing secure ArcGIS resources.
  • ChallengeHandler: Displays SignInForm when accessing secure ArcGIS resources, as well as helper classes for storing credentials in Windows' credentials cache.
  • SymbolDisplay: Renders a symbol in a control.
  • TableOfContents: Creates a tree-view of the entire map document. Optionally displays legend information for the layers.
  • TimeSlider: Allows interactively defining a temporal range (i.e. time extent) and animating time moving forward or backward. Can be used to manipulate the time extent in a MapView or SceneView.

Feature availability by platform/API

Component UWP WPF Xamarin.Android Xamarin.iOS Xamarin.Forms
Compass
FeatureDataField GitHub Issue State GitHub Issue State GitHub Issue State
Legend
LayerLegend
MeasureToolbar GitHub Issue State GitHub Issue State GitHub Issue State
ScaleLine
SignInForm
SymbolDisplay
TableOfContents N/A N/A N/A N/A
TimeSlider GitHub Issue State GitHub Issue State

Instructions for Building

  1. Confirm that your system meets the requirements for compiling the Toolkit:
    • Visual Studio 2017 Update 3 (or later) with the following workloads:
      • Universal Windows Platform development (UWP)
      • .NET desktop development (WPF)
      • Mobile development with .NET (Xamarin.Android, Xamarin.iOS, and Xamarin.Forms)
      • '.NET Core 2.0 SDK'
  2. Confirm your system meets the requirements for developing with ArcGIS Runtime SDK for .NET:
  3. Fork and then clone the repo or download the .zip file.
  4. Include (i) or reference (ii) the Toolkit in your projects:
  • Note the Toolkit references ArcGIS Runtime SDK for .NET by Nuget package. The package is automatically downloaded when you build the solution for the first time.
    1. Include the appropriate platform Projects in your Solution.
      • WPF (src\Esri.ArcGISRuntime.Toolkit\WPF\Esri.ArcGISRuntime.Toolkit.WPF.csproj)
      • UWP (\src\Esri.ArcGISRuntime.Toolkit\UWP\Esri.ArcGISRuntime.Toolkit.UWP.csproj)
      • Xamarin.Android (\src\Esri.ArcGISRuntime.Toolkit\Android\Esri.ArcGISRuntime.Toolkit.Android.csproj)
      • Xamarin.iOS (\src\Esri.ArcGISRuntime.Toolkit\iOS\Esri.ArcGISRuntime.Toolkit.iOS.csproj)
      • Xamarin.Forms (\src\Esri.ArcGISRuntime.Toolkit\XamarinForms\Esri.ArcGISRuntime.Toolkit.Xamarin.Forms.csproj)
    2. Build the Toolkit and reference the NuGet package you built.
      • Building each Toolkit project automatically creates the NuGet package for each platform in the project Output folder.
      • Create a local nuget source/feed and set it to the \Output\NuGet\Release folder.
      • Add the nuget package using the standard Nuget package manager dialog in Visual Studio.
      • See Setting Up Local NuGet Feeds for more information.

Master branch NuGet Server

If you want the latest greatest version of the toolkit, you can always get the latest NuGet packages that matches what is currently in the Master branch. These NuGet packages are automatically updated each time a pull request is merged into master. The NuGet server is available at: https://ci.appveyor.com/nuget/arcgis-toolkit-dotnet. For more information about configuring extra NuGet servers, see the Package Manager UI documentation.

System Requirements

Resources

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Anyone and everyone is welcome to contribute.

v10.2.7

Looking for the Toolkit for ArcGIS Runtime SDK for .NET v10.2.7?

Go to the 10.2.7 tag: https://github.com/Esri/arcgis-toolkit-dotnet/tree/v10.2.7

Licensing

Copyright © 2014-2018 Esri.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's license.txt file.