AGSEnumerations.h File Reference

Enumerations
enum	AGSConfigFileType { AGSConfFileTypeCDI = 0, AGSConfFileTypeXML }
enum	AGSDynamicLayerGPSAutoPanDrawingMode { AGSDynamicLayerGPSAutoPanDrawingModeNormal = 0, AGSDynamicLayerGPSAutoPanDrawingModeConservative, AGSDynamicLayerGPSAutoPanDrawingModeNone }
enum	AGSErrorCode { AGSErrorCodeOperationNotSupported = 10000, AGSErrorCodeNoDataTile = 10001, AGSErrorCodeSpatialReferenceNotSupported = 10002, AGSErrorCodeInvalidArgument = 10003 }
enum	AGSImageFormat {   AGSImageFormatPNG32 = 0, AGSImageFormatPNG24, AGSImageFormatPNG8, AGSImageFormatPNG,   AGSImageFormatJPG, AGSImageFormatGIF, AGSImageFormatBMP, AGSImageFormatTIFF,   AGSImageFormatJPGPNG }
enum	AGSNADirectionsManeuver {   AGSNADirectionsManeuverUnknown = 0, AGSNADirectionsManeuverStop, AGSNADirectionsManeuverStraight, AGSNADirectionsManeuverBearLeft,   AGSNADirectionsManeuverBearRight, AGSNADirectionsManeuverTurnLeft, AGSNADirectionsManeuverTurnRight, AGSNADirectionsManeuverSharpLeft,   AGSNADirectionsManeuverSharpRight, AGSNADirectionsManeuverUTurn, AGSNADirectionsManeuverFerry, AGSNADirectionsManeuverRoundabout,   AGSNADirectionsManeuverHighwayMerge, AGSNADirectionsManeuverHighwayExit, AGSNADirectionsManeuverHighwayChange, AGSNADirectionsManeuverForkCenter,   AGSNADirectionsManeuverForkLeft, AGSNADirectionsManeuverForkRight, AGSNADirectionsManeuverDepart, AGSNADirectionsManeuverTripItem,   AGSNADirectionsManeuverEndOfFerry, AGSNADirectionsManeuverRampRight, AGSNADirectionsManeuverRampLeft, AGSNADirectionsManeuverTurnLeftRight,   AGSNADirectionsManeuverTurnRightLeft, AGSNADirectionsManeuverTurnRightRight, AGSNADirectionsManeuverTurnLeftLeft, AGSNADirectionsManeuverPedestrianRamp,   AGSNADirectionsManeuverElevator, AGSNADirectionsManeuverEscalator, AGSNADirectionsManeuverStairs, AGSNADirectionsManeuverDoorPassage }
enum	AGSNADirectionsOutputType {   AGSNADirectionsOutputTypeStandard = 0, AGSNADirectionsOutputTypeComplete, AGSNADirectionsOutputTypeCompleteNoEvents, AGSNADirectionsOutputTypeInstructionsOnly,   AGSNADirectionsOutputTypeSummaryOnly }
enum	AGSNADirectionsStringType {   AGSNADirectionsStringGeneral = 0, AGSNADirectionsStringDepart, AGSNADirectionsStringArrive, AGSNADirectionsStringLength,   AGSNADirectionsStringTime, AGSNADirectionsStringSummary, AGSNADirectionsStringTimeWindow, AGSNADirectionsStringViolationTime,   AGSNADirectionsStringWaitTime, AGSNADirectionsStringServiceTime, AGSNADirectionsStringEstimatedArrivalTime, AGSNADirectionsStringCumulativeLength,   AGSNADirectionsStringStreetName, AGSNADirectionsStringAltName, AGSNADirectionsStringBranch, AGSNADirectionsStringToward,   AGSNADirectionsStringCrossStreet, AGSNADirectionsStringExit }
enum	AGSNALayerType { AGSNALayerTypeRoute = 0, AGSNALayerTypeServiceArea, AGSNALayerTypeClosestFacility }
enum	AGSNAMessageType {   AGSNAMessageTypeAbort = 0, AGSNAMessageTypeEmpty = 1, AGSNAMessageTypeError = 2, AGSNAMessageTypeInformative = 3,   AGSNAMessageTypeProcessDefinition = 50, AGSNAMessageTypeProcessStart = 100, AGSNAMessageTypeProcessStop = 101, AGSNAMessageTypeWarning = 200 }
enum	AGSNAOutputLine { AGSNAOutputLineNone = 0, AGSNAOutputLineStraight, AGSNAOutputLineTrueShape, AGSNAOutputLineTrueShapeWithMeasure }
enum	AGSNAOutputPolygon { AGSNAOutputPolygonDetailed = 0, AGSNAOutputPolygonNone, AGSNAOutputPolygonSimplified }
enum	AGSNATimeOfDayUse { AGSNATimeOfDayUseAsStartTime = 0, AGSNATimeOfDayUseAsEndTime }
enum	AGSNATravelDirection { AGSNATravelDirectionFromFacility = 0, AGSNATravelDirectionToFacility }
enum	AGSNAUnit {   AGSNAUnitCentimeters = 0, AGSNAUnitDays, AGSNAUnitDecimalDegrees, AGSNAUnitDecimeters,   AGSNAUnitFeet, AGSNAUnitHours, AGSNAUnitInches, AGSNAUnitKilometers,   AGSNAUnitMeters, AGSNAUnitMiles, AGSNAUnitMillimeters, AGSNAUnitMinutes,   AGSNAUnitNauticalMiles, AGSNAUnitPoints, AGSNAUnitSeconds, AGSNAUnitUnknown,   AGSNAUnitYards }
enum	AGSNAUTurn { AGSNAUTurnAllowBacktrack = 0, AGSNAUTurnAtDeadEndsOnly, AGSNAUTurnNoBacktrack, AGSNAUTurnAtDeadEndsAndIntersections }
enum	AGSPortalAccess { AGSPortalAccessPrivate = 0, AGSPortalAccessShared, AGSPortalAccessOrganization, AGSPortalAccessPublic }
enum	AGSPortalItemType {   AGSPortalItemTypeMapDocument = 0, AGSPortalItemTypeExplorerMap, AGSPortalItemTypeGlobeDocument, AGSPortalItemTypeSceneDocument,   AGSPortalItemTypePublishedMap, AGSPortalItemTypeMapPackage, AGSPortalItemTypeGeoprocessingPackage, AGSPortalItemTypeLocatorPackage,   AGSPortalItemTypeTilePackage, AGSPortalItemTypeWindowsMobilePackage, AGSPortalItemTypeDesktopApplicationTemplate, AGSPortalItemTypeMapTemplate,   AGSPortalItemTypeCodeSample, AGSPortalItemTypeGeoprocessingSample, AGSPortalItemTypeLayer, AGSPortalItemTypeLayerPackage,   AGSPortalItemTypeExplorerLayer, AGSPortalItemTypeDesktopAddIn, AGSPortalItemTypeExplorerAddIn, AGSPortalItemTypeMapService,   AGSPortalItemTypeGeocodingService, AGSPortalItemTypeNetworkAnalysisService, AGSPortalItemTypeGlobeService, AGSPortalItemTypeGeoprocessingService,   AGSPortalItemTypeGeodataService, AGSPortalItemTypeImageService, AGSPortalItemTypeGeometryService, AGSPortalItemTypeFeatureService,   AGSPortalItemTypeKML, AGSPortalItemTypeWMS, AGSPortalItemTypeWMTS, AGSPortalItemTypeWebMap,   AGSPortalItemTypeWebMappingApplication, AGSPortalItemTypeMobileApplication, AGSPortalItemTypeCodeAttachment, AGSPortalItemTypeFeaturedItems,   AGSPortalItemTypeFeatureCollection, AGSPortalItemTypeFeatureCollectionTemplate, AGSPortalItemTypeSymbolSet, AGSPortalItemTypeColorSet,   AGSPortalItemTypeCollectionDefinition, AGSPortalItemTypeOther }
enum	AGSPortalMode { AGSPortalModeSingleTenant = 0, AGSPortalModeMultiTenant }
enum	AGSPortalQuerySortOrder { AGSPortalQuerySortOrderAscending = 0, AGSPortalQuerySortOrderDescending }
enum	AGSSpatialRelationship {   AGSSpatialRelationshipIntersects = 0, AGSSpatialRelationshipContains, AGSSpatialRelationshipCrosses, AGSSpatialRelationshipEnvelopeIntersects,   AGSSpatialRelationshipIndexIntersects, AGSSpatialRelationshipOverlaps, AGSSpatialRelationshipTouches, AGSSpatialRelationshipWithin,   AGSSpatialRelationshipRelation }
enum	AGSWMTSServiceMode { AGSWMTSServiceModeRESTful = 0, AGSWMTSServiceModeKVP }
Functions
NSString *	AGSFileFormatForImageFormat (AGSImageFormat imageFormat)

---

Enumeration Type Documentation

enum AGSConfigFileType

Enumerator:

AGSConfFileTypeCDI
AGSConfFileTypeXML

enum AGSDynamicLayerGPSAutoPanDrawingMode

Defines the drawing behavior for a dynamic layer when the map's gps is in a navigation mode.

Since:

2.1

Enumerator:

AGSDynamicLayerGPSAutoPanDrawingModeNormal	Dynamic layer draws normally.
AGSDynamicLayerGPSAutoPanDrawingModeConservative	Dynamic layer draws only when it doesn't currently have a drawing operation in progress. This lessens the load on the server.
AGSDynamicLayerGPSAutoPanDrawingModeNone	Dynamic layer does not draw when the map is in navigation mode.

enum AGSErrorCode

Constants representing error codes.

Since:

2.1

Enumerator:

AGSErrorCodeOperationNotSupported
AGSErrorCodeNoDataTile
AGSErrorCodeSpatialReferenceNotSupported
AGSErrorCodeInvalidArgument

enum AGSImageFormat

Supported image formats.

Since:

1.0

Enumerator:

AGSImageFormatPNG32
AGSImageFormatPNG24
AGSImageFormatPNG8
AGSImageFormatPNG
AGSImageFormatJPG
AGSImageFormatGIF
AGSImageFormatBMP
AGSImageFormatTIFF
AGSImageFormatJPGPNG

enum AGSNADirectionsManeuver

Constants representing maneuver types for a direction.

Since:

1.8

Enumerator:

AGSNADirectionsManeuverUnknown	Unknown
AGSNADirectionsManeuverStop	Arrive At Stop.
AGSNADirectionsManeuverStraight	Go straight.
AGSNADirectionsManeuverBearLeft	Bear left.
AGSNADirectionsManeuverBearRight	Bear righty.
AGSNADirectionsManeuverTurnLeft	Turn left.
AGSNADirectionsManeuverTurnRight	Turn right.
AGSNADirectionsManeuverSharpLeft	Make sharp left.
AGSNADirectionsManeuverSharpRight	Make sharp right.
AGSNADirectionsManeuverUTurn	Make a U-turn.
AGSNADirectionsManeuverFerry	Take ferry.
AGSNADirectionsManeuverRoundabout	Take roundabout.
AGSNADirectionsManeuverHighwayMerge	Merge to highway.
AGSNADirectionsManeuverHighwayExit	Exit highway.
AGSNADirectionsManeuverHighwayChange	Go on another highway.
AGSNADirectionsManeuverForkCenter	At fork keep center.
AGSNADirectionsManeuverForkLeft	At fork keep left.
AGSNADirectionsManeuverForkRight	At fork keep right.
AGSNADirectionsManeuverDepart	Depart stop.
AGSNADirectionsManeuverTripItem	Trip planning item.
AGSNADirectionsManeuverEndOfFerry	End of ferry.
AGSNADirectionsManeuverRampRight	Ramp right.
AGSNADirectionsManeuverRampLeft	Ramp left.
AGSNADirectionsManeuverTurnLeftRight	Turn left and immediately turn right.
AGSNADirectionsManeuverTurnRightLeft	Turn right and immediately turn left.
AGSNADirectionsManeuverTurnRightRight	Turn right and immediately turn right.
AGSNADirectionsManeuverTurnLeftLeft	Turn left and immediately turn left.
AGSNADirectionsManeuverPedestrianRamp	Pedestrian ramp.
AGSNADirectionsManeuverElevator	Elevator.
AGSNADirectionsManeuverEscalator	Escalator.
AGSNADirectionsManeuverStairs	Stairs.
AGSNADirectionsManeuverDoorPassage	Door passage.

enum AGSNADirectionsOutputType

Defines content, verbosity of returned directions.

Since:

2.3

Availability:

This feature is only available with services from ArcGIS Server 10.1 or above

Enumerator:

AGSNADirectionsOutputTypeStandard	Standard directions output – direction text instructions, geometry, time, length, ETA. Does not include events, new types
AGSNADirectionsOutputTypeComplete	Directions output that includes all directions properties.
AGSNADirectionsOutputTypeCompleteNoEvents	Directions output that includes all directions properties except events.
AGSNADirectionsOutputTypeInstructionsOnly	Directions output that includes text instructions, time, length and ETA. Does not include geometry.
AGSNADirectionsOutputTypeSummaryOnly	Directions output that contains only summary (time and length). Detailed text instructions and geometry are not provided.

enum AGSNADirectionsStringType

Types of direction strings. These are associated with the more detailed direction info passed back from a route solving operation.

Since:

2.3

Availability:

This feature is only available with services from ArcGIS Server 10.1 or above

Enumerator:

AGSNADirectionsStringGeneral	General directions string type.
AGSNADirectionsStringDepart	Depart directions string type.
AGSNADirectionsStringArrive	Arrive directions string type.
AGSNADirectionsStringLength	Length directions string type.
AGSNADirectionsStringTime	Time directions string type.
AGSNADirectionsStringSummary	Time directions string type.
AGSNADirectionsStringTimeWindow	Time Window directions string type.
AGSNADirectionsStringViolationTime	Violation Time directions string type.
AGSNADirectionsStringWaitTime	Wait Time directions string type.
AGSNADirectionsStringServiceTime	Service Time directions string type.
AGSNADirectionsStringEstimatedArrivalTime	Estimated Arrival Time directions string type.
AGSNADirectionsStringCumulativeLength	Cumulative Length directions string type.
AGSNADirectionsStringStreetName	Street name directions string type.
AGSNADirectionsStringAltName	Alternate street name directions string type.
AGSNADirectionsStringBranch	Sign branch information directions string type.
AGSNADirectionsStringToward	Sign toward information directions string type.
AGSNADirectionsStringCrossStreet	Cross street name directions string type.
AGSNADirectionsStringExit	Sign exit number directions string type.

enum AGSNALayerType

Constant representing the type of network layer.

Since:

1.8

Enumerator:

AGSNALayerTypeRoute	Route Layer.
AGSNALayerTypeServiceArea	Service Area Layer.
AGSNALayerTypeClosestFacility	Closest Facility Layer.

enum AGSNAMessageType

Constants representing the network analyst message type.

Since:

1.8

Enumerator:

AGSNAMessageTypeAbort
AGSNAMessageTypeEmpty
AGSNAMessageTypeError
AGSNAMessageTypeInformative
AGSNAMessageTypeProcessDefinition
AGSNAMessageTypeProcessStart
AGSNAMessageTypeProcessStop
AGSNAMessageTypeWarning

enum AGSNAOutputLine

Specifies the type of lines generated by the network analyst solvers.

Since:

1.8

Enumerator:

AGSNAOutputLineNone	No polylines are generated.
AGSNAOutputLineStraight	Straight polylines between the two endpoints are generated.
AGSNAOutputLineTrueShape	Polylines based on the true network feature geometry are generated.
AGSNAOutputLineTrueShapeWithMeasure	Polylines based on the true network feature geometry are generated, and measures are added whenever possible.

enum AGSNAOutputPolygon

Contstants representing how the geometry is returned.

Since:

1.8

Enumerator:

AGSNAOutputPolygonDetailed	No polygons are generated.
AGSNAOutputPolygonNone	Simplified polygons are generated.
AGSNAOutputPolygonSimplified	Detailed polygons are generated.

enum AGSNATimeOfDayUse

Specifies the way of timeOfDay property is used.

Since:

2.3

Availability:

This feature is only available with services from ArcGIS Server 10.1 or above

Enumerator:

AGSNATimeOfDayUseAsStartTime	Use as the start time.
AGSNATimeOfDayUseAsEndTime	Use as the end time.

enum AGSNATravelDirection

Constants representing how the geometry is returned.

Since:

1.8

Enumerator:

AGSNATravelDirectionFromFacility	Tavel to the facility.
AGSNATravelDirectionToFacility	Travel from the facility.

enum AGSNAUnit

Constants representing directions length units for the AGSRouteTask.

Since:

1.8

Enumerator:

AGSNAUnitCentimeters
AGSNAUnitDays
AGSNAUnitDecimalDegrees
AGSNAUnitDecimeters
AGSNAUnitFeet
AGSNAUnitHours
AGSNAUnitInches
AGSNAUnitKilometers
AGSNAUnitMeters
AGSNAUnitMiles
AGSNAUnitMillimeters
AGSNAUnitMinutes
AGSNAUnitNauticalMiles
AGSNAUnitPoints
AGSNAUnitSeconds
AGSNAUnitUnknown
AGSNAUnitYards

enum AGSNAUTurn

Constants representing how U-Turns are handled

Since:

1.8

Enumerator:

AGSNAUTurnAllowBacktrack	Allow U-turns anywhere.
AGSNAUTurnAtDeadEndsOnly	Allow U-turns only at dead ends only.
AGSNAUTurnNoBacktrack	Don't allow U-turns anywhere.
AGSNAUTurnAtDeadEndsAndIntersections	Allow U-turns at dead ends and intersections only.

enum AGSPortalAccess

Access types on Portal, Item, Group or User.

For Portal or Organization

Determines who can view your organization as an anonymous user. AGSPortalAccessPublic means it allows anonymous users to access your organization's custom URL. AGSPortalAccessPrivate restricts access to only members of your organization.

For Portal Item

Indicates the access level of the item. If AGSPortalAccessPrivate, only the item owner can access. AGSPortalAccessShared allows the item to be shared with a specific group. AGSPortalAccessOrganization restricts item access to members of your organization. If AGSPortalAccessPublic, all users can access the item.

For Portal Group

Determines who can access the group. AGSPortalAccessPrivate gives access to only the group members. If AGSPortalAccessOrganization, all members of this organization can access the group. AGSPortalAccessPublic makes the group accessible to all.

For Portal User

Determines if other users can search for this user's name to find content and groups owned by this user and to invite this user to join their groups. AGSPortalAccessPrivate hides the user from user searches and invites. If AGSPortalAccessOrganization, only members of this user's organization can search for this user, the content and groups. AGSPortalAccessPublic makes the user findable.

Since:

2.2

Enumerator:

AGSPortalAccessPrivate	Applicable for All
AGSPortalAccessShared	Applicable for only Items
AGSPortalAccessOrganization	Applicable for Items, Groups and Users
AGSPortalAccessPublic	Applicable for All

enum AGSPortalItemType

Since:

2.2

Enumerator:

AGSPortalItemTypeMapDocument	ArcMap Document (mxd)
AGSPortalItemTypeExplorerMap	ArcGIS Explorer Document (nmf)
AGSPortalItemTypeGlobeDocument	ArcGlobe Document (3dd)
AGSPortalItemTypeSceneDocument	ArcScene Document (sxd)
AGSPortalItemTypePublishedMap	ArcReader Document (pmf)
AGSPortalItemTypeMapPackage	ArcGIS Map Package (mpk)
AGSPortalItemTypeGeoprocessingPackage	ArcGIS Geoprocessing Package (gpk)
AGSPortalItemTypeLocatorPackage	ArcGIS Locator Package (apk)
AGSPortalItemTypeTilePackage	ArcGIS Server Tile Package (tpk)
AGSPortalItemTypeWindowsMobilePackage	ArcGIS Windows Mobile Package
AGSPortalItemTypeDesktopApplicationTemplate	The Desktop Application Template (.zip) includes either a desktop add in or a toolbar.exe
AGSPortalItemTypeMapTemplate	The Map Template (.zip) contains documentation, a map and GDB folder
AGSPortalItemTypeCodeSample	Developer Sample
AGSPortalItemTypeGeoprocessingSample	Tool, Geoprocessing Sample
AGSPortalItemTypeLayer	Layer File (lyr)
AGSPortalItemTypeLayerPackage	Layer Package (lpk)
AGSPortalItemTypeExplorerLayer	ArcGIS Explorer Layer (nmc)
AGSPortalItemTypeDesktopAddIn	ArcGIS Add In (esriaddin)
AGSPortalItemTypeExplorerAddIn	ArcGIS Explorer Layer (eaz)
AGSPortalItemTypeMapService	ArcGIS Server Map Service
AGSPortalItemTypeGeocodingService	ArcGIS Server Geocoding Service
AGSPortalItemTypeNetworkAnalysisService	ArcGIS Server Network Analyst Service
AGSPortalItemTypeGlobeService	ArcGIS Server Globe Service
AGSPortalItemTypeGeoprocessingService	ArcGIS Server Geoprocessing Service
AGSPortalItemTypeGeodataService	ArcGIS Server Geodata Service
AGSPortalItemTypeImageService	ArcGIS Server Image Service
AGSPortalItemTypeGeometryService	ArcGIS Server Geometry Service
AGSPortalItemTypeFeatureService	ArcGIS Feature Service
AGSPortalItemTypeKML	Data, Map, kml
AGSPortalItemTypeWMS	Data, Service, Web Map Service, OGC
AGSPortalItemTypeWMTS	Data, Service, Web Map Tile Service, OGC
AGSPortalItemTypeWebMap	Web Map authored using the arcgis.com Javascript Web Map viewer or using ArcGIS Explorer online. Usable by web, mobile, and desktop clients
AGSPortalItemTypeWebMappingApplication	A web mapping application built using ArcGIS API for Javascript, ArcGIS API for Flex, ArcGIS API for Silverlight, Java Web Application Developer Framework, .NET Web Application Developer Framework
AGSPortalItemTypeMobileApplication	A mobile application build using the ArcGIS for iPhone SDK, ArcGIS for Android SDK, ArcGIS Mobile SDK for the Windows Mobile Platform, or the JavaScript or Flex API
AGSPortalItemTypeCodeAttachment	Code Attachment
AGSPortalItemTypeFeaturedItems	Empty Item type with relationships to items that user wants featured
AGSPortalItemTypeFeatureCollection	A feature collection is a saved web map feature layer with layer definition and a feature set
AGSPortalItemTypeFeatureCollectionTemplate	Feature Collection, Feature Service Template, Map Notes Template
AGSPortalItemTypeSymbolSet	Symbol Set
AGSPortalItemTypeColorSet	Color Set
AGSPortalItemTypeCollectionDefinition	The definition for a feature collection/web map feature layer
AGSPortalItemTypeOther

enum AGSPortalMode

Indicating whether the portal contains multiple organizations or not.

Since:

2.2

Enumerator:

AGSPortalModeSingleTenant	Only one organization
AGSPortalModeMultiTenant	Multiple organizations

enum AGSPortalQuerySortOrder

Indicates the oder of results of the portal query.

Since:

2.2

Enumerator:

AGSPortalQuerySortOrderAscending
AGSPortalQuerySortOrderDescending

enum AGSSpatialRelationship

Possible spatial relationships.

Since:

1.8

Enumerator:

AGSSpatialRelationshipIntersects
AGSSpatialRelationshipContains
AGSSpatialRelationshipCrosses
AGSSpatialRelationshipEnvelopeIntersects
AGSSpatialRelationshipIndexIntersects
AGSSpatialRelationshipOverlaps
AGSSpatialRelationshipTouches
AGSSpatialRelationshipWithin
AGSSpatialRelationshipRelation

enum AGSWMTSServiceMode

Since:

2.3

Enumerator:

AGSWMTSServiceModeRESTful
AGSWMTSServiceModeKVP

---

Function Documentation

NSString* AGSFileFormatForImageFormat

(

AGSImageFormat

imageFormat

)

Returns the image format as a string.

Since:

1.0