ArcGIS Runtime SDK for iOS: AGSArcGISMapServiceSublayerInfo Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSArcGISMapServiceSublayerInfo Class Reference

Description

Information about an individual sublayer in an ArcGIS Map Service.

Instances of this class represent information about an individual sublayer in an ArcGIS Map Service.

Since
100.1
Inheritance diagram for AGSArcGISMapServiceSublayerInfo:
AGSObject <AGSJSONSerializable>

Instance Methods

(nullable AGSField *) - fieldWithName:
 
(nullable id) - toJSON:
 

Class Methods

(nullable id< AGSJSONSerializable >) + fromJSON:error:
 

Properties

NSString * attribution
 
BOOL canModifyLayer
 
BOOL canScaleSymbols
 
AGSArcGISMapServiceCapabilitiescapabilities
 
BOOL dataVersioned
 
id defaultSubtypeCode
 
BOOL defaultVisibility
 
NSString * definitionExpression
 
NSString * displayFieldName
 
AGSDrawingInfodrawingInfo
 
double effectiveMaxScale
 
double effectiveMinScale
 
AGSEnvelopeextent
 
NSArray< AGSFeatureSubtype * > * featureSubtypes
 
NSArray< AGSFeatureType * > * featureTypes
 
NSArray< AGSField * > * fields
 
AGSGeometryType geometryType
 
BOOL hasAttachments
 
BOOL hasLabels
 
BOOL hasM
 
BOOL hasZ
 
long long maxRecordCount
 
double maxScale
 
double minScale
 
AGSOwnershipBasedAccessControlInfoownershipBasedAccessControl
 
AGSIDInfoparentLayerInfo
 
NSArray< AGSRelationshipInfo * > * relationshipInfos
 
NSString * serviceDescription
 
NSInteger serviceLayerID
 
NSString * serviceLayerName
 
NSArray< AGSIDInfo * > * sublayerInfos
 
AGSArcGISMapServiceSublayerType sublayerType
 
NSString * subtypeField
 
BOOL supportsAdvancedQueries
 
BOOL supportsStatistics
 
AGSLayerTimeInfotimeInfo
 
NSString * typeIDFieldName
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 
NSURL * URL
 
BOOL useStandardizedQueries
 
NSString * version
 

Method Documentation

◆ fieldWithName:

- (nullable AGSField*) fieldWithName: (NSString *)  name

Convenience method to retrieve field by name from the fields collection.

Parameters
nameName of a field to retrieve.
Since
100.1

◆ fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject
error: (NSError **)  error 
staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters
JSONObjectNSDictionary or NSArray containing the JSON.
errorencountered during the operation, if any.
Since
100

◆ toJSON:

- (nullable id) toJSON: (NSError **)  error
requiredinherited

Returns JSON representation for this object.

Parameters
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

◆ attribution

- (NSString*) attribution
readnonatomiccopy

Attribution information of the sublayer

Since
100.1

◆ canModifyLayer

- (BOOL) canModifyLayer
readnonatomicassign

Indicates whether the sublayer supports modifying its renderer and/or its data source.

Since
100.1

◆ canScaleSymbols

- (BOOL) canScaleSymbols
readnonatomicassign

Indicates whether the text and symbols on the sublayer will be resized as the map scale varies.

Since
100.1

◆ capabilities

- (AGSArcGISMapServiceCapabilities*) capabilities
readnonatomicstrong

Capabilities of the ArcGIS Map Service that this sublayer belongs to

Since
100.1

◆ dataVersioned

- (BOOL) dataVersioned
readnonatomicassign

Indicates whether data in the service is versioned

Since
100.1

◆ defaultSubtypeCode

- (id) defaultSubtypeCode
readnonatomiccopy

The code for the default feature subtype of this sublayer

Since
100.3

◆ defaultVisibility

- (BOOL) defaultVisibility
readnonatomicassign

Indicates whether the sublayer is visible or not by default

Since
100.1

◆ definitionExpression

- (NSString*) definitionExpression
readnonatomiccopy

The sublayer's definition expression. The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. See the ArcGIS Blog article entitled "Querying Feature Services Date-Time Queries" (https://www.esri.com/arcgis-blog/products/api-rest/data-management/querying-feature-services-date-time-queries/) for more information.

Since
100.1

◆ displayFieldName

- (NSString*) displayFieldName
readnonatomiccopy

The field which should be used to display a title for features in this sublayer

Since
100.1

◆ drawingInfo

- (AGSDrawingInfo*) drawingInfo
readnonatomicstrong

Information about how features in the sublayer should be displayed

Since
100.1

◆ effectiveMaxScale

- (double) effectiveMaxScale
readnonatomicassign

The maximum scale at which this sublayer or any of its parents is visible. If the map is zoomed in beyond this scale, the sublayer will not be visible.

Since
100.1

◆ effectiveMinScale

- (double) effectiveMinScale
readnonatomicassign

The minimum scale at which this sublayer or any of its parents is visible. If the map is zoomed out beyond this scale, the sublayer will not be visible.

Since
100.1

◆ extent

- (AGSEnvelope*) extent
readnonatomicstrong

The geographic extent this sublayer covers

Since
100.1

◆ featureSubtypes

- (NSArray<AGSFeatureSubtype*>*) featureSubtypes
readnonatomiccopy

The list of feature subtypes available for this sublayer. For example, a roads sublayer may contain 2 feature sub-types : highways and streets.

Since
100.3

◆ featureTypes

- (NSArray<AGSFeatureType*>*) featureTypes
readnonatomiccopy

A collection of AGSFeatureType objects representing feature sub-types in the sublayer. For example, a roads sublayer may contain 2 feature sub-types : highways and streets.

Availability:
This feature is only available with services from ArcGIS Server 10.0 or above

Since
100.1

◆ fields

- (NSArray<AGSField*>*) fields
readnonatomiccopy

The attribute fields (columns) available in this sublayer's data. The property is an array of AGSField objects.

Since
100.1

◆ geometryType

- (AGSGeometryType) geometryType
readnonatomicassign

The type of geometry contained by features in the sublayer.

Since
100.1

◆ hasAttachments

- (BOOL) hasAttachments
readnonatomicassign

Indicates whether features may have attachments.

Since
100.1

◆ hasLabels

- (BOOL) hasLabels
readnonatomicassign

Indicates whether this sublayer has labels defined.

Since
100.1

◆ hasM

- (BOOL) hasM
readnonatomicassign

Indicates whether features may contain M values

Since
100.1

◆ hasZ

- (BOOL) hasZ
readnonatomicassign

Indicates whether features may contain Z values

Since
100.1

◆ maxRecordCount

- (long long) maxRecordCount
readnonatomicassign

The maximum number of results returned by the service for any query operation

Since
100.1

◆ maxScale

- (double) maxScale
readnonatomicassign

The maximum scale at which this sublayer is visible. If the map is zoomed in beyond this scale, the sublayer will not be visible.

Since
100.1
See also
effectiveMaxScale

◆ minScale

- (double) minScale
readnonatomicassign

The minimum scale at which this sublayer is visible. If the map is zoomed out beyond this scale, the sublayer will not be visible.

Since
100.1
See also
effectiveMinScale

◆ ownershipBasedAccessControl

- (AGSOwnershipBasedAccessControlInfo*) ownershipBasedAccessControl
readnonatomicstrong

Information about ownership-based access policies governing who can edit, delete, and query features.

Since
100.1

◆ parentLayerInfo

- (AGSIDInfo*) parentLayerInfo
readnonatomicstrong

Information about this sublayer's parent sublayer. If nil, the sublayer has no parent and is at the root of the ArcGIS Map Service.

Since
100.1

◆ relationshipInfos

- (NSArray<AGSRelationshipInfo*>*) relationshipInfos
readnonatomiccopy

Information about this sublayer's relationships with other sublayers in the ArcGIS Map Service

Since
100.1

◆ serviceDescription

- (NSString*) serviceDescription
readnonatomiccopy

Description of the ArcGIS Map Service that this sublayer belongs to

Since
100.1

◆ serviceLayerID

- (NSInteger) serviceLayerID
readnonatomicassign

ID of the sublayer in the ArcGIS Map Service.

Since
100.1

◆ serviceLayerName

- (NSString*) serviceLayerName
readnonatomiccopy

Name of the sublayer in the ArcGIS Map Service.

Since
100.1

◆ sublayerInfos

- (NSArray<AGSIDInfo *>*) sublayerInfos
readnonatomiccopy

Information about this sublayer's nested (child) sublayers.

Since
100.1

◆ sublayerType

- (AGSArcGISMapServiceSublayerType) sublayerType
readnonatomicassign

The type of sublayer in the ArcGIS Map Service

Since
100.1

◆ subtypeField

- (NSString*) subtypeField
readnonatomiccopy

The name of the field which contains the sub-type information for each feature in this sublayer

See also
featureSubtypes
Since
100.3

◆ supportsAdvancedQueries

- (BOOL) supportsAdvancedQueries
readnonatomicassign

Indicates whether the sublayer supports order-by and group-by functions in query operations.

Since
100.1

◆ supportsStatistics

- (BOOL) supportsStatistics
readnonatomicassign

Indicates whether the sublayer supports statistical functions in query operations.

Since
100.1

◆ timeInfo

- (AGSLayerTimeInfo*) timeInfo
readnonatomicstrong

Time information for the sublayer, such as start time field, end time field, track id field, layers time extent and the draw time interval. Only applicable if the sublayer is time aware.

Since
100.1

◆ typeIDFieldName

- (NSString*) typeIDFieldName
readnonatomiccopy

The name of the field which contains the sub-type information for each feature.

Availability:
This feature is only available with services from ArcGIS Server 10.0 or above

Since
100.1

◆ unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON
readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns
NSDictionary containing the unknown JSON.
Since
100

◆ unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON
readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns
NSDictionary containing the unsupported JSON.
Since
100

◆ URL

- (NSURL*) URL
readnonatomicstrong

The URL of the ArcGIS Map Service sublayer.

Since
100.1

◆ useStandardizedQueries

- (BOOL) useStandardizedQueries
readnonatomicassign

Indicates whether the sublayer requires the use of standardized queries to help prevent SQL injection attacks.

Availability:
This feature is only available with services from ArcGIS Server 10.0 or above

Since
100.1

◆ version

- (NSString*) version
readnonatomiccopy

The version of the ArcGIS Map Service

Since
100.1