10.2.4: Introduction
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages

ArcGIS Runtime SDK for OS X provides an Objective-C API for developers that allows you to add mapping and GIS functionality to your Mac applications.

The API leverages functionality provided by ArcGIS Online and ArcGIS Server services through the REST interface. Map layers or webmaps (comprising individual layers) are displayed in a map using the AGSMapView class. Each layer relies on map services from ArcGIS Server or other geospatial technology such as Bing, OpenStreetmap, WMS, and so on.

You can also add Graphics on the map to display your own points or areas of interest. Tasks provide functionality such as identifying features on a map, querying features given some criteria, finding addresses, running geoprocessing jobs, performing network analysis such as routing, etc.

The API allows you to work with local geographic data. You can use tile packages to display basemaps, locators to find addresses, network datasets to compute routes, and sqlite geodatabases to view, edit, and sync vector features.

The API is provided as a framework called ArcGIS. Classes and functions defined in this framework begin with the prefix AGS. This prefix acts as a namespace and prevents naming conflicts with classes defined in your application or other frameworks you use.

You need to use a minimum of OS X 10.8 SDK to build your applications. Also, the applications you build will require a Mac running a minimum of OS X 10.8.

Setting up your XCode project using CocoaPods

If you're already using CocoaPods, setting up your project to use ArcGIS is really easy.

  • Add pod 'ArcGIS-Runtime-SDK-OSX' to your Podfile.
  • Run the command pod install on the Podfile using the Terminal application.
  • Open the project workspace (*.xcworkspace file) and add the #import <ArcGIS/ArcGIS.h> statement to any class files where you wish to use the API.

Setting up your XCode project manually

Download the SDK from https://developers.arcgis.com/os-x/ . Run the installer, this will install the ArcGIS framework under ${HOME}/Library/SDKs/ArcGIS/OSX.

The ArcGIS framework depends upon the following frameworks and libraries. These need to be added to your XCode project as references -

  • Cocoa.framework
  • CoreLocation.framework
  • OpenGL.framework
  • AVFoundation.framework
  • Quartz.framework
  • Security.framework
  • libc++.dylib

Set the project's Frameworks Search Paths setting to include ${HOME}/Library/SDKs/ArcGIS/OSX , and the Other Linker Flags setting to include the following entries: -ObjC -framework ArcGIS

Finally, you must also add the ArcGIS.bundle file found under ${HOME}/Library/SDKs/ArcGIS/OSX/ArcGIS.framework/Resources to your project. This bundle file contains the resources (images, localized strings, etc) used by the API.

Third party libraries

The ArcGIS library depends upon and already includes the following third party libraries -

The functions/classes in these libraries have been renamed/namespaced to avoid conflicts with other versions of the same libraries you may have in your project.