Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 6.25 KB

README.md

File metadata and controls

98 lines (65 loc) · 6.25 KB
Raw

ArcGIS Runtime Toolkit for iOS

doc Carthage compatible CocoaPods

The ArcGIS Runtime SDK for iOS Toolkit contains components that will simplify your iOS app development. Check out the Examples project to see these components in action or read through the Documentation to learn more about them.

To use Toolkit in your project:

Toolkit Components

  • Augmented reality (AR) - Integrates the scene view with ARKit to enable augmented reality (AR).
  • Bookmarks - Shows bookmarks, from a map, scene, or a list.
  • Compass - Shows a compass direction when the map is rotated. Auto-hides when the map points north up.
  • JobManager - Suspends and resumes ArcGIS Runtime tasks when the app is background, terminated, and relaunched.
  • LegendViewController - Displays a legend for all the layers in a map or scene contained in an AGSGeoView.
  • MeasureToolbar - Allows measurement of distances and areas on the map view.
  • PopupController - Display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics).
  • Scalebar - Displays current scale reference.
  • TemplatePickerViewController - Allows a user to choose a template from a list of AGSFeatureTemplate when creating new features.
  • 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.

Requirements

The ArcGIS Runtime Toolkit for iOS has a Target SDK version of 11.0, meaning that it can run on devices with iOS 11.0 or newer.

Instructions

Cocoapods

  1. Add pod ArcGIS-Runtime-Toolkit-iOS to your podfile
  2. Run pod install. This will download the toolkit and the ArcGIS Runtime SDK for iOS which the toolkit depends upon and then configure your project to reference them both.
  3. Add import ArcGISToolkit in your source code and start using the toolkit components

New to cocoapods? Visit cocoapods.org

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

  1. Add github "esri/arcgis-runtime-toolkit-ios" to your Cartfile
  2. Run carthage update
  3. Drag the ArcGISToolkit.framework from the Carthage/Build folder to the "TARGETS" settings for your application and drop it in the "Embedded Binaries" section in the "General" tab
  4. Add import ArcGISToolkit in your source code and start using the toolkit components

New to Carthage? Visit the Carthage GitHub page.

Note that you must also have the ArcGIS Runtime SDK for iOS installed and your project set up as per the instructions here.

Manual

  1. Ensure you have downloaded and installed ArcGIS Runtime SDK for iOS as described here
  2. Clone or download this repo.
  3. Drag and Drop the Toolkit/ArcGISToolkit.xcodeproj file into your project through the XCode Project Navigator pane.
  4. Drag the ArcGISToolkit.framework from the ArcGISToolkit.xcodeproj/ArcGISToolkit/Products folder to the "TARGETS" settings for your application and drop it in the "Embedded Binaries" section in the "General" tab
  5. Add import ArcGISToolkit in your source code and start using the toolkit components

SwiftLint

Both the Toolkit and Examples app support SwiftLint. You can install SwiftLint from here. It is not necessary to have it installed in order to build, but you will get a warning without it. The specific rules the linter uses can be found in the swiftlint.yml files in the Toolkit and Examples directories.

Additional Resources

Issues

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

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Copyright 2017 - 2020 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 file.