AGSMapServiceLayerInfo Class Reference


Description

Instances of this class represent information about a layer in an ArcGIS Server map or feature service.

Defined in:
AGSMapServiceLayerInfo.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSMapServiceLayerInfo:
<AGSCoding>

List of all members.

Public Member Functions

(NSUInteger index) - __attribute__
(BOOL visible) - __attribute__
(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:

Properties

BOOL defaultVisibility
NSUInteger layerId
NSArray * legendImages
NSArray * legendLabels
double maxScale
double minScale
NSString * name
NSInteger parentLayerID
NSArray * subLayerIDs

Member Function Documentation

- (NSUInteger index) __attribute__ ((deprecated))   

ID of the layer. The topmost layer is usually 0, and each layer follows sequentially. If a layer is added or removed from the source map document, the ID values will shift accordingly.

Since:
1.0
Deprecated:
Deprecated at 1.8. Use layerId instead.
- (BOOL visible) __attribute__ ((deprecated))   

Default visibility of the layer.

Since:
1.0
Deprecated:
Deprecated at 1.8. Use defaultVisibility instead.
- (void) decodeWithJSON: (NSDictionary *)  json   [optional, inherited]

Decode object from JSON representation.

Parameters:
json The JSON representation of the object to be decoded.
Since:
1.0
- (NSDictionary *) encodeToJSON   [optional, inherited]

Encode and return JSON representation for object.

Returns:
JSON representation of object.
Since:
1.0
- (id) initWithJSON: (NSDictionary *)  json   [optional, inherited]

Initialize and return object from JSON representation.

Parameters:
json The JSON representation of the object to be created.
Returns:
Object decoded from JSON representation.
Since:
1.0

Property Documentation

- (BOOL) defaultVisibility [read, assign]

Default visibility of the layer, as defined by the service.

Since:
1.8
- (NSUInteger) layerId [read, assign]

ID of the layer. The topmost layer is usually 0, and each layer follows sequentially. If a layer is added or removed from the source map document, the ID values will shift accordingly.

Since:
1.8
- (NSArray*) legendImages [read, retain]

An array of UIImage object representing legend swatches (images) for this layer. You need to invoke the retrieveLegendInfo method on AGSMapServiceInfo for this property to be populated.

Since:
1.8
- (NSArray*) legendLabels [read, retain]

An array of strings representing the text for each legend swatch of this layer. You need to invoke the retrieveLegendInfo method on AGSMapServiceInfo for this property to be populated.

Since:
1.8
- (double) maxScale [read, assign]

The maximum scale at which this layer is visible. If map's scale is higher than this scale, the layer won't be visible.

Since:
1.8
- (double) minScale [read, assign]

The minimum scale at which this layer is visible. If map's scale is lower than this scale, the layer won't be visible.

Since:
1.8
- (NSString*) name [read, retain]

User-friendly name of the layer.

Since:
1.0
- (NSInteger) parentLayerID [read, assign]

ID of the parent layer if this layer is part of a group layer. Otherwise, the value is -1.

Since:
1.0
- (NSArray*) subLayerIDs [read, retain]

An array of IDs of descendant layers if this layer is a parent layer. Otherwise, the value is nil.

Since:
1.0